TigerTrust publishes a live OpenAPI 3.1 specification that documents every API endpoint, request and response schema, authentication requirement, and error code. It is the single source of truth for integrators, SDK authors, and anyone building automation against the TigerTrust API.

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

FormatURLNotes
Interactive browser/api/docsRedoc-powered, no authentication needed
JSON/api/openapi.jsonFor SDK generators and programmatic tooling
YAML/api/openapi.yamlRaw source, human-readable
All three URLs are public — no API key or session is required to read the specification.

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 with openapi.info.version. Install via your normal package manager — no hand-authored client required.
LanguagePackageInstall
TypeScript@tigertrust/sdk-typescriptnpm install @tigertrust/sdk-typescript
Gogithub.com/tigertrust/tigertrust-sdk-gogo get github.com/tigertrust/tigertrust-sdk-go@latest
Pythontigertrust-sdkpip install tigertrust-sdk
Each SDK exposes one service class per API tag with typed request and response models. Autocomplete, compile-time contract enforcement, and language-native error handling come standard.

Generate a custom client

Prefer a different target (Rust, Java, Ruby, Swift)? Any OpenAPI 3.1-compatible generator works with the JSON spec:
npx @openapitools/openapi-generator-cli generate \
  -i https://your-instance.tigertrust.io/api/openapi.json \
  -g rust \
  -o ./sdk/rust
Replace -g rust with any generator target your language ecosystem supports.

Authentication

API key and session authentication for protected endpoints.

Pagination and Errors

Standard response envelope and error codes used across all endpoints.