Guides
The reference tells you what every endpoint does. The guides tell you in which order to call them for a real task, with the checks and the failure cases that matter in production.
#All guides
Single sign-on
Sign a user into the trader from your site with a one-time link, or let your platform sign a JWT that Octolit trusts. Sessions, logout, errors.
↗Embed the trader
The web trader inside your page or app: iframe and postMessage bridge, theming, deposit by host, native SDKs for iOS and Android.
↗Provision users & accounts
Create or update users by your own id, open live and demo accounts, pause trading, end sessions, export or erase data.
↗Money posting
Book deposits, withdrawals and credit from your cashier with an idempotency key, then reconcile with balances and webhooks.
↗Webhooks
Receive signed events, verify them, answer fast, handle retries and duplicates, rotate the secret without downtime.
↗FIX connectivity
QUOTE and TRADE sessions over TLS, logon, heartbeats, the order lifecycle, market data, limits and a certification checklist.
↗MT4 / MT5 brokers
Run the Octolit CRM and trader in front of your MetaTrader 4 or 5 server: what you provide, how orders flow, what the trader shows.
↗Building a mobile or web app? The SDK pages cover the Octolit Embed SDK for iOS, Android and the web in the same depth.
#Which guide for which use case
| You want to… | Read |
|---|---|
| You have a client area and want a "Trade" button in it | Provision users & accounts, then Single sign-on, then Embed the trader |
| Your mobile app should contain the trader | SDK for iOS or Android, plus Single sign-on for the one-time token |
| You run the cashier and book the money yourself | Money posting, then Webhooks for deposit.status and withdrawal.status |
| You need to know at once when a client deposits, trades or hits a margin call | Webhooks |
| You trade from your own system (algo, bridge, liquidity) | FIX connectivity, or the Trading API reference |
| Your clients already trade on MetaTrader | MT4 / MT5 brokers, then Provision users & accounts (MT links) |
| Your platform is the identity provider and users sign in with you | Single sign-on, the "your signed JWT" way |
#Conventions in the guides
https://api.your-brand.comhttps://live.your-brand.comX-Api-Key header, read from OCTOLIT_PARTNER_KEYX-API-Key header, read from OCTOLIT_API_KEY- Replace the two hosts with the ones your brand's API access panel shows. Every example reads the key from an environment variable; never put a key in source code.
cust_10042is the exampleexternal_id- your own client id. The guides never use the CRM's numeric client id in a path.- Code samples come in cURL, Node.js, Python, PHP, C#, Java, Go, Swift and Kotlin. Pick one tab; the choice sticks across the site.
- Every feature is a per-brand switch in the Octolit CRM. A guide names the switch it needs at the top, under "Before you start".
GET /api/external/v1/me and explains scopes in five minutes.