README
Overview
The SitePro API provides programmatic access to site telemetry, equipment configuration, and transaction records across your SitePro account. Use it to pull live and historical sensor data, equipment logs, and fluid hauling tickets for any site your account has access to.
| Property | Value |
|---|---|
| Base URL | https://platform.sitepro.com |
| Authentication | Bearer token |
| Format | JSON (except image downloads, which return application/zip) |
| Timestamps | UTC / ISO 8601 (e.g. 2024-01-01T00:00:00Z) |
| Rate limit | 50k req/mo/site, 100 req/min rate limit |
| Pagination | Pagination enabled for Sites endpoint only; all other endpoint records are returned in a single response |
| Data availability | All historical data is available via the API |
Authentication
All endpoints require a Bearer token in the Authorization header. Tokens are obtained by posting your API credentials to the token endpoint and expire after 1 hour.
Note: Tokens expire after 1 hour. Handle 401 responses by re-authenticating via POST /token and retrying the original request.
Permissions & Access
API access requires two things to be configured on your SitePro account:
| Requirement | Details |
|---|---|
| API Subscription | The site must be active and have the API Subscription enabled. Contact SitePro to activate this. |
| API User Permissions | Your user account must have API permissions granted by your system administrator. |
The API is permission-scoped - you will only see sites, equipment, and transactions that your account has been granted access to. If a site or piece of equipment is missing from a response, check with your system administrator that access has been granted.
Note: To activate the API Subscription for your account, contact SitePro at softwaresupport@sitepro.com.
Getting Access
Follow these steps to get up and running:
| Step | Description |
|---|---|
| 1. Register your account | Sign up or log in to your SitePro account and request API access through your system administrator. |
| 2. Enable API Subscription | Contact SitePro to activate the API Subscription on your site. See contact details in the Support section below. |
| 3. Set user permissions | Have your system administrator grant API user permissions to your account. |
| 4. Obtain your token | Post your credentials to POST /token to receive your Bearer token. See the Authentication section of the Get Started Page or Token API Endpoint. |
| 5. Keep your credentials secure | Your API credentials are your gateway to SitePro services. Do not commit them to source control or share them with untrusted applications. |
Global Behavior
Timestamps
All request and response timestamps are in UTC using ISO 8601 format. When passing date ranges in request bodies, always use UTC.
"start": "2024-01-01T00:00:00Z"
"end": "2024-02-01T00:00:00Z"
Rate limits
Each site includes 50,000 API requests per month, with a rate limit of 100 requests per minute. If you exceed your monthly allowance, usage is billed in overage buckets of 10,000 requests at $15 per bucket - automatically added as needed.
Pagination
Pagination is only enabled on the Sites endpoint. All other records matching the request parameters are returned in a single response. When querying large date ranges across many sites, consider narrowing your parameters to manage response size.
Data availability
All historical data is available via the API. There is no retention cutoff - you can query any date range from the beginning of data collection at a site.
Error Codes
The following status codes apply across all endpoints:
| Status | Meaning | What to do |
|---|---|---|
| 200 | Success | Parse the response body as JSON (or binary for image downloads) |
| 400 | Validation error | Check your request body - missing required fields, invalid date format, or out-of-range values |
| 401 | Unauthorized | Token is missing, expired, or malformed. Re-authenticate via POST /token and retry |
| 403 | Forbidden | Your account does not have access to the requested resource. Check permissions with your administrator |
| 429 | Rate limit exceeded | You have exceeded 100 requests per minute. Back off and retry after a short delay |
| 500 | Server error | Retry with exponential backoff. If it persists, contact SitePro support |
Support
For questions about API access, activation of the API Subscription, or any technical issues, contact the SitePro support team:
| Channel | Details |
|---|---|
| softwaresupport@sitepro.com | |
| Subject line | Include 'API' in the subject line to route your request to the right team |