Developers

Broker Platform API reference

Connect your systems to the Leverate platform: query accounts, positions and transactions, create users, manage trading terms and subscribe to webhooks. Version 1.21.0. Download the OpenAPI spec

Got Questions? We’ve Got Answers

Ask us anything.

How do I authenticate with the Broker Platform API?

Every request sends a Bearer JWT in the Authorization header. Broker operations (bulk reads, account, position and transaction writes, user creation, trading terms and webhooks) need a broker token from the OAuth2 client_credentials grant at POST /api/v1/oauth/token. A system user's own automation can use a personal API token created in the back office under Tokens.

Can I get notified when something changes on the platform?

Yes. You can register signed outbound webhook endpoints (scope webhooks:manage), and the replication endpoint POST /api/v1/replication/changes streams every insert, update and delete in your firm in commit order behind one cursor.

Is live market data available through the API?

Live ticks are served over a WebSocket at /api/v1/ws, authenticated with the same Bearer header. After subscribing you receive a snapshot followed by a live stream for every instrument your workspace makes available. The WebSocket is not part of the OpenAPI spec, so it is described in the introduction of the reference.

Where can I download the API specification?

The full OpenAPI 3.1 spec is available on this page as a JSON download, so you can import it into Postman, generate a client or explore it in your own tools.