Introduction

The RoadSense APIs allow you to programmatically access RoadSense services. You can use these APIs to retrieve information about your account, use core RoadSense tools, and more.

Getting Started

💡

Please note that the API is still in BETA and changes might be occur

The RoadSense API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Each API endpoint in this documentation is described using several parts:

  • The HTTP method. Includes GET, POST.
  • The base path. All URLs referenced in the documentation have the base path https://api.roadsense.tech. This base path goes before the endpoint path.
  • The endpoint path. For example, /v2/realtime/snapshot.
  • Required properties. These properties must be included in a request.
  • Optional properties. These properties can be included in a request to customize the query.
  • Code examples. Each endpoint has example requests in cURL format.

Access token

https://api.roadsense.tech/{endpoint}&token={your_access_token}

Access to RoadSense API endpoints requires a valid access token, which will connect API requests to your account. You need to supply a valid access token by using the token query parameter in every request.