Skip to content

API referenceΒΆ

The endpoints for integrating with Busroot, with their parameters, request body and response. Internal, debug and Output Industries-only endpoints are not listed. For how to get started with the API and the SDK, see API and SDK.

  • Base address. Send requests to https://<your Busroot address>/api. The reference below shows the demo instance as its server, but your own account is at your own address.
  • Authentication. Send an API key in the x-api-key request header. An Admin generates keys on API keys.
  • Time periods. Time-based endpoints take their period as a range code, such as TODAY.
  • Download the spec. The reference is built from an OpenAPI 3.1 description: openapi.json. Your Busroot instance also publishes it at https://<your Busroot address>/api/openapi.json, and in YAML at /api/openapi.yml.

Use the filter box to find an endpoint by tag, and select an endpoint to see its details.