Programmatic Access
For bots, algo trading, or other integrations, use the REST and WebSocket APIs described in this documentation.
Authentication Model
- Trading endpoints (orders, positions, mass quote) require a short-lived Bearer token (see Authentication)
- Public endpoints (instruments, transparency, VIP tier schedule) require no account token
- WebSocket trading authenticates via
loginwith a Bearer token; optional encrypted session framing is described in Encryption & Transport
Available APIs
| Interface | Protocol | Use Case |
|---|---|---|
| REST | HTTPS | Auth, orders, mass quote (Prime/Apex), positions, stats, tiers, referrals, settlement status, instruments, market data proxies |
| WebSocket | WSS | Order updates (/ws/orders), order submission (/ws/trading), user events (/ws/user), external venue data (/ws/gomarket) |
| SSE | HTTP | Real-time stats (/events/stats), notifications (/events/notifications) |
Quick Start
- Get your wallet address — This is your
userIdfor all API calls - Obtain handshake token — For WebSocket connections (provided during onboarding)
- Place your first order — See Place Order
- Subscribe to updates — Connect to Order Updates
Market makers on Prime/Apex tiers can use Mass Quote for batch cancel-replace. See System Status for degraded mode (202 / 1502) behavior.
SDKs
Official client libraries for REST and WebSocket trading:
Rate Limits
Different tiers have different rate limits. See Rate Limits for details.