Endpoint reference

Interactive reference for every Broker Platform API endpoint, generated from the live API definition.

The same reference is served on your platform host

Your platform serves this reference live at /api/docs, and the raw OpenAPI document for code generation at /api/docs/openapi.json, on the same host your credential is issued for. The copy below is for browsing here; the one on your host always describes the exact version you are calling.

The streaming surface is not here

OpenAPI cannot describe a WebSocket, so the multiplexed socket at /api/v1/ws does not appear below. Its contract is WebSocket streaming.