OpenAPI / Swagger

The whole API is described by a live OpenAPI 3.0 spec. Explore it interactively, or generate a typed client in your language of choice.

Interactive docs

The Swagger UI lets you browse every endpoint, see schemas, and send authenticated test requests from the browser (paste an API key into the X-Inkle-Api-Key field):

api.inklemarket.com/v1/docs (interactive Swagger UI)
api.inklemarket.com/v1/docs-json (raw OpenAPI 3.0 spec)

Generate a client

Point any OpenAPI generator at the spec URL. For example, a TypeScript fetch client:

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://api.inklemarket.com/v1/docs-json \
  -g typescript-fetch -o ./inkle-client

Swap -g for python, go, rust, or any of the generator's targets.

Prefer the official SDK

For TypeScript and JavaScript we recommend the hand-tuned @inkle/sdk. It wraps the same API with typed methods, envelope unwrapping, error classification, timeouts, retries, and pagination that a generated client does not give you out of the box.