OpenAPI specification

In addition to this documentation, an OpenAPI specification of the API is available. OpenAPI specifications provide a formal standard for describing HTTP APIs that are easy to read by both humans and machines.

The OpenAPI specification can be used (amongst other things) to:

Get familiar using the API

Interact with the API directly from our OpenAPI specification without having to write your own implementation. Use your API key to authorise, and you're ready to make any API requests.

Import all API endpoints into your API tools

Download the API spec JSON file and import it into the API tool of your choice (e.g. Postman). Your API tool is now set up to use the API.

Generate an API client in the language of your choice

Download the API spec JSON file and use a generator (e.g. OpenAPI Generator or Swagger Codegen) to generate an API client.