Skip to content

API specification

Every endpoint in this reference is also described in one machine-readable file, in the standard OpenAPI 3.1 format:

Download openapi.json

Use it to:

  • Import the API into your API client or testing tool. Then set the X-API-Key header to your key.
  • Generate a client library for your language.
  • Validate requests in your own tests.

The file describes the same endpoints, fields and errors as these pages. Response schemas list the fields you can rely on; responses may contain more.