Versioning
The version in the address, the version of the contract, and what can change under your integration.
The API's path carries its major version, /v1. The contract has a version of its own, now 1.0.0-draft.10. It is a draft, and it can still change.
What can change
- New response fields, enum values and event types appear. Ignore what you do not know. A client that rejects them breaks for no reason.
- Requests stay strict. An unknown request field is rejected with
unknown_field, so send only what the contract names. - Every change is recorded. The changelog lists what moved each time these pages move to a new contract.
Versions on events
Each event carries api_version. Do not confuse it with version on an order, which counts that order's state changes.
Read the contract
openapi.json is the contract these pages are built from. The sandbox can lag it: what the deployed sandbox does not serve yet is marked on the page that names it.
These pages promise no notice period for a change while the contract is a draft.
Related guides
- Changelog: what changed, contract by contract.
- Errors: the stable codes to branch on.
- SDKs and tools: generating a client from the contract.
