Reference
OpenAPI downloads
Both APIs are described in OpenAPI 3.1. These files generated every page of this reference, so they are the single source of truth.
Partner API v1.2
34 operations · 17 webhook events
GET https://api.your-brand.com/api/external/v1/openapi.yaml
Generate a client
shell
# TypeScript client (openapi-typescript + fetch)
npx openapi-typescript https://developers.octolit.com/openapi/octolit-partner-api-v1.yaml -o octolit-partner.d.ts
# Any language (OpenAPI Generator)
npx @openapitools/openapi-generator-cli generate \
-i https://developers.octolit.com/openapi/octolit-trading-api-v1.yaml -g python -o ./octolit-trading
# Postman / Insomnia / Bruno: File > Import > the YAML URLLive copies
Your own Octolit host serves the document that matches the version it runs (plus a plain-text broker guide at GET /api/external/v1/guide.txt and a reference page at GET /api/open/v1/docs). When they differ from the files here, your host wins.
The servers[0].url in the files is the placeholder https://api.your-brand.com; set your real host in your generator or client.