What is the Public API?
The Public API (Application Programming Interface) provides programmatic access to your Propeller data, enabling automation and integration with systems like GIS or CAD software. While Propeller makes it quick and easy to interact with data in the browser, the API allows you to retrieve survey data from all your sites using code, streamlining workflows and enhancing integration with your internal systems.
Key Features:
- Query information about organizations, sites, surveys, and survey output files.
- Obtain direct download links for survey files.
Important Notes:
- The API is a paid premium feature. Contact your Account Executive to enable access.
- Using the API requires coding knowledge.
- The public API will only allow access to pre-processed data—specifically, data processed using the Propeller workflow.
The Public API is a powerful solution for those looking to enhance automation or connect Propeller data with other tools.
You can query information about your organizations, sites, surveys, and survey output files, and you can download the files directly through the API with URL links.
Why is the API Useful?
The API allows development teams to build custom integrations with the Propeller platform, enabling seamless workflows and efficient data management. With the API, you can automate tasks like downloading and importing survey files into third-party software, reducing manual effort and enhancing productivity.
What Can You Do with the API?
Here are a few examples of how teams use the API:
- Synchronize Survey Files: Automatically transfer survey data from Propeller to another system.
- Automated File Access: Once surveys finish processing, you can access orthophotos, terrain, or point cloud data and download the raw files automatically.
- Integrate with CAD/GIS Tools: Pull terrain files into a local private WMS server for use across CAD or GIS applications.
- Archive Data: Schedule weekly transfers of survey files to long-term backup storage for archiving.
- Set Up Alerts: Automate notifications, such as sending an email or assigning a task when a new site or survey is created in Propeller.
- Deep System Integration: To achieve a comprehensive integration, synchronize Propeller’s entire information tree (Organizations, Sites, Surveys, and Survey files) with another application.
How to Get Started
Please review the Getting Started guide in our developer documentation to begin using the API.
If you have feedback on the API, let us know!
I still can't do it!
We wrote these articles to equip you with everything you need to get the job done on your own, but we understand that sometimes this isn't sufficient.
If you're stuck, you can connect with our support team by clicking the support button on the top right corner of your user portal.
Related to