Using Propeller API

The Public API provides programmatic access to Propeller data for automation and integration with other systems. It allows users with coding knowledge to query site and survey information and directly download processed data files. This is a paid, premium feature.

What is Propeller API?

Propeller’s API lets you connect external tools directly to your Propeller data. It's a powerful way to integrate your data with everything else you use, making your day-to-day work faster and more efficient.

💡 This feature is only available to our scale-tier customers. To enable access, please reach out to your Account Executive.

Key benefits

The API is designed to save you time and effort by connecting Propeller data with other systems you use daily.

Here’s how it helps:

Integrate with your business tools

Pull project data like measurements and calculations directly into dashboards, SCADA systems, or inventory management platforms for real-time insights.
Automate your workflows

Automatically transfer survey files to your long-term storage or CAD/GIS software as soon as they’re processed, eliminating manual effort.
Access more of your data

Unlike the previous read-only API, you can now retrieve shapes and all the data associated with them.

What kind of data can you access?

The Propeller API lets you access a wide range of data points from your Propeller account.

Organizations: List all organizations or get details for a specific one.
Sites: List all sites within an organization or get details for a single site.
Workspaces: List all workspaces within a site or get details for an individual workspace.
Surveys: List surveys, view details of an individual survey, or download survey files (orthophotos, terrain, and point cloud data).
Position Monitoring Configs: View DirtMates that have been configured to act as position monitors.
Position Monitoring Epochs: Retrieve all measurements recorded by an individual DirtMate.
Shapes: User-defined polygons, lines, or points you create in Propeller. The API lets you list all shapes or get details (with their associated data).
Widgets: Access calculated results tied to a shape — such as volumes, distances, or areas.

*Cross-sections are currently not available.

Getting started

You will find step-by-step instructions and code examples in our developer documentation.

If you have feedback on the API, let us know in our community forum!

ℹ️ Note: This guide is intended for users with coding experience.

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 question mark button at the top right corner of your user portal.

Related to

Search