Skip to main content
The reference in this site is rendered from an OpenAPI 3.1 document, and that document is published. You can generate a client from it, load it into a request tool, or hand it to an assistant.

​
Where it is

One document per documented version:
The version in the filename is the version it describes. Take the one you send in X-Api-Version — see Versioning.

​
What it carries

Every operation, with its request and response schemas, its error bodies, and a real example on each. Each operation also declares its own servers, sandbox first, so a client generated from it points at sandbox until you change it.

​
Generating a client

Any OpenAPI 3.1 generator works. Two things worth knowing before you trust what comes out: Amounts are strings. A generator will type them as strings because that is what they are. Keep them that way and parse them as decimals — a generator that offers to coerce them to numbers is offering to round your money. A field being present in a schema is not a promise it always arrives. Most response schemas mark nothing as guaranteed, and the few that still do are being cleared as each endpoint is rewritten — so treat every response field as optional whatever the schema says, and handle absence rather than trusting a generated non-null type.

​
Keeping up with it

The document changes when the API does. Regenerate rather than hand-editing what a generator produced, and pin the version you generated from so a regeneration is a decision rather than a surprise.