Skip to main content
You do not need to run anything to try the API. Every endpoint page in the API Reference has a playground: choose the region, paste an API key, edit the body, and send. This page covers running Swagger UI yourself for cases the playground does not reach, such as an Enterprise deployment on a private network or a spec build from a branch.

Run Swagger UI locally

Swagger UI is a static site that renders any OpenAPI document. Run it in Docker against the published spec:
Open http://localhost:8081, click Authorize, and enter your API key for ApiKeyAuth. The Servers dropdown lists the Tirdad API from the spec.
Requests from a local Swagger UI go straight to the Tirdad API with your key. Use a sandbox key while exploring.

Swagger UI, Postman, or the API reference?

OpenAPI spec