🎉 Welcome to the OpenTrack API!

With the OpenTrack API, customers integrate freight visibility features directly into their own code. For example, they use the API to display the latest status of their shipping containers or to trigger automatic workflows based on real-world events detected by OpenTrack.

The resource documentation describes requests and responses in detail for each endpoint. Our API uses predictable, resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and relies on standard HTTP response codes, authentication, and verbs.

We also offer webhooks, enabling your systems to receive real-time updates on your containers.

To learn more about how we recommend you use our API, see our Tracking Best Practices.

It is likely that this API will evolve in subsequent versions. With your welcomed feedback, suggestions, and feature requests, we will continue to actively develop and iterate on this API.

OpenTrack is a technology company first and foremost, with the goal of providing the best public API the industry has ever seen.

LLMs.txt

If you use AI language models in your development work, OpenTrack now provides an LLMs.txt file: https://developers.opentrack.co/llms.txt

This is designed to provide context on our API to large language models in a way that's easy for them to ingest, so you can move faster to complete your integration.

🚦 Authentication

To begin using the OpenTrack API, follow these steps to authenticate your requests:

Log in to your OpenTrack dashboard.
While logged in, navigate to Settings using the left-hand menu.
Under the Developers section of Settings, copy your Opentrack-API-Key.
Include this API key in the header of your requests to authenticate with the OpenTrack API.
Start sending requests by referring to the API Reference.

💬 Contact Support

Please email us at [email protected] for any support and inquiries.

✏️ Backwards-compatible changes

We consider certain changes to be non-breaking and may implement them without updating the API version. To ensure stability, please follow defensive coding practices. The following are considered backwards-compatible changes:

Adding an attribute, resource, or optional parameter
Adding a new possible value to an enum-type attribute
Adding new webhook event types

📘
For any assistance please contact [email protected]