Before you start
Prepare the following:- a valid API key for your Organization
- network access to the API host over HTTPS
- an HTTP client such as cURL, Postman, or an HTTP library
Base URL and versioning
Use the versioned public base URL:Authentication
All endpoints require an API key. Send it with either header:Rate limits
Requests are limited per Organization.
The API returns
429 Too Many Requests when the limit is exceeded. API usage limits may also apply per Object on position endpoints.
Response format
A successful response containsstatusCode and result. The result can be an object or array, depending on the endpoint.
Quickstart workflow
1
Verify the API key
Start with the Object list because it has no path or query parameters.
2
Read one Object
Use an
id returned by the first request.3
Read latest positions
Request multiple Object IDs in one call.
Common HTTP outcomes
Integration checklist
- Store API keys in secure secrets storage, not source code.
- Use HTTPS in every environment.
- Add retry and backoff handling for
429. - Log response status and request identifiers available to your client.
- Parse datetime values as ISO 8601 UTC timestamps.
