Skip to main content
The PitPath Chrono API gives you programmatic access to sim racing timing data, event management, lap records, competitor registration, and hardware configuration. All communication goes over HTTPS, and every request and response body uses JSON.

Base URL

All resource endpoints are nested under /api/v1/:
The API version is also returned in the API-Version response header (value: 1.0).

Authentication

Most endpoints require you to pass an API key in the X-API-Key request header.
The following GET endpoints are public and do not require an API key:
  • GET /api/v1/events
  • GET /api/v1/tracks
  • GET /api/v1/cars
  • GET /api/v1/simulators
  • GET /api/v1/brands
  • GET /api/v1/signup-fields
All other endpoints — including rigs, laps, participants, api-keys, and licenses — require a valid X-API-Key header. Requests without a key or with an invalid key return 401 Unauthorized.
You can manage your API keys through the /api/v1/api-keys resource. See the API Keys reference for details on creating and revoking keys.

Content type

Set Content-Type: application/json on all requests that include a body. The API always returns application/json response bodies.

Available resources

Example request

The following example retrieves all events using curl:
For an endpoint that requires authentication, add the X-API-Key header:

Health check

Use the health endpoint to verify that the service is running. This endpoint does not require authentication.
A healthy instance returns:

OpenAPI and Swagger UI

The machine-readable OpenAPI specification is available at /api-docs. You can explore and test all endpoints interactively through the Swagger UI at /swagger-ui.