Broker API
Connect your own CRM or service straight
to the Match-Trader platform. Users, trading accounts,
balances, trading and live data streams over
REST and gRPC. No Match-Trade CRM required.
REST gRPC streams AI skill v2
Onboard a client from our CRM: create the user, open a trading account in our standard group and fund it with 1,000.
/v1/user-accountsCreates the user. A 409 means the email already exists
/v1/user-accounts/{uuid}/trading-accountsOpens the trading account in the group you named
/v1/trading-accounts/{login}/depositPosts the deposit once. Deposits aren’t idempotent, so it never retries blindly
getTradingAccountInfoChangedStreamSubscribes, so your CRM sees account changes as they happen
Client onboarded on demo. Tell me when to run it against production.
Example: an AI assistant with the Broker API skill, on the demo environment.
Still on the original Broker API?
It will be deprecated at the end of 2026. Move to Broker API v2 if you run your own or a third-party CRM, or to CRM-API
if you run Match-Trade CRM.
What it covers
The full set of administrative and trading operations. Your broker ID travels in the token, so every call is scoped to your brokerage.
User accounts
Create, update and delete users, one at a time or in bulk; change passwords; issue one-time login tokens
Trading accounts
Create, update and delete; look up by login, user or ID
Balance operations
Deposits, withdrawals, credit in and credit out
Trading
Open, edit, close (fully, partially or all at once) and reopen positions; pending and correction orders
Trading data
Order history, open and closed positions, pending orders, ledgers, candles, groups, platform logs and balance snapshots
Real-time streams
Quotations with markup, positions, order updates, ledgers, equity, account, symbol and group changes, trading events over gRPC
Prediction markets
Bets and their outcomes
Build the integration
by asking
Our Broker API skill teaches AI assistants like Claude how Broker API v2 works. Describe the flow you need and the assistant writes and runs the calls, or checks how your current integration is set up.
https://github.com/match-trade/Broker-API-skillShips with a Python client and CLI, the gRPC .proto, a catalogue of every endpoint and snippets for Node.js/TypeScript, cURL and Java.
What the assistant already knows
- Deposits, withdrawals and credit operations aren’t idempotent: a blind retry can book twice.
- Trading-account updates must send the current version,
or they’re rejected. - Trade calls return an acknowledgement,
not the final position state. - Bulk operations can partly fail, with an error message
for each item that did. - Streams send a heartbeat about every 30 seconds;
when they stop, it reconnects with backoff. - It uses the demo environment by default and refuses production hosts unless you ask for them.
For anything that connects
to the platform directly
CRM providers Brokerages with their own or a third-party CRM Risk-management tools Other third-party services
Running Match-Trade CRM?
Tools that work alongside the Match-Trade CRM should use CRM-API, which also exposes CRM data like leads, notes and timeline events.
From token to production
Three steps from your first test call to a live integration
on your own production host.
Step 01
Get a token
Request it from Match-Trade IT Support.
It stays valid until revoked.
Step 02
Build on demo
The demo environment is shared between integrators, so use test data only.
Step 03
Go live over TLS
Point your integration at your brokerage’s own production host.
Start with the docs
Every endpoint and gRPC stream is in the Broker API v2 reference.
