Broker API
OnlyTrade exposes two API surfaces:
| API | Audience | What it does |
|---|---|---|
Trade API (/api/v1, /ws/v1) | the trader | log in, place/modify/close orders, stream prices and account events — the calls the trading terminal makes. |
| Broker API (this section) | the broker / prop firm | provision and manage clients from your CRM — create accounts, set group rules and risk, fund and withdraw, log a client into the terminal. |
The Trade API is what your end-users trade through. The Broker API is what you operate the business with — it's the layer a prop firm or broker integrates into their own CRM, dashboard, or onboarding funnel.
Every back-office endpoint has an interactive Try It panel in the dedicated
Broker API Reference — the
same live reference style as the trader API, scoped to the back-office. The full
machine-readable spec is published at
/openapi/onlytrade-brand.json.
What you can do
- Authenticate your backend with a machine-to-machine
client_credentialskey — no human password in your servers. - Provision clients — create live, demo, or prop accounts, set passwords, approve/decline KYC, move accounts between groups.
- Configure groups & risk — leverage, spread, commission, and prop-firm risk limits (daily loss, total drawdown, profit target), inherited down a group tree.
- Fund accounts — deposit, withdraw, adjust, and credit, with a full transactions ledger.
- Log a client into the terminal from your CRM.
- Onboard self-service signups / free trials straight from your website.
Before you start
- Read Environments & testing — test everything against demo accounts (no real money) before you touch live balances.
- The API uses one consistent response envelope and error model.
- See Rate limits and the Changelog.
Integrating in days, not months
Most brokers go live in under 15 days with a single developer. See the Onboarding guide for the step-by-step path.