What it is
The specification is generated from the platform source and kept in sync with every release. It is available in JSON and YAML formats for import into any OpenAPI-compatible toolchain, and as a self-contained interactive HTML page where you can browse and search every endpoint without writing a line of code.When to use it
- Import the spec into Postman, Insomnia, or Stoplight to build and test requests against your workspace.
- Generate a typed API client in your language of choice using any OpenAPI code generator.
- Review request and response schemas when building a custom integration or automation script.
- Validate your API usage against the authoritative spec before opening a support ticket.
Access the spec
| Format | URL | Notes |
|---|---|---|
| Interactive browser | /api/docs | Redoc-powered, no authentication needed |
| JSON | /api/openapi.json | For SDK generators and programmatic tooling |
| YAML | /api/openapi.yaml | Raw source, human-readable |
Browse interactively
Open/api/docs in a browser to explore every endpoint with a searchable sidebar, rendered request and response examples, and authentication scheme documentation. This is the fastest way to understand a specific endpoint without reading raw JSON.
Official SDKs
TigerTrust publishes typed client libraries in three languages, all auto-generated from the same OpenAPI spec and versioned lock-step withopenapi.info.version. Install via your normal package manager — no hand-authored client required.
| Language | Package | Install |
|---|---|---|
| TypeScript | @tigertrust/sdk-typescript | npm install @tigertrust/sdk-typescript |
| Go | github.com/tigertrust/tigertrust-sdk-go | go get github.com/tigertrust/tigertrust-sdk-go@latest |
| Python | tigertrust-sdk | pip install tigertrust-sdk |
Generate a custom client
Prefer a different target (Rust, Java, Ruby, Swift)? Any OpenAPI 3.1-compatible generator works with the JSON spec:-g rust with any generator target your language ecosystem supports.
Related
Authentication
API key and session authentication for protected endpoints.
Pagination and Errors
Standard response envelope and error codes used across all endpoints.