Skip to content

Client API Documentation

The Client API is the public integration surface for web terminals, mobile apps, personal cabinets, and other end-user applications.

It consists of two transport layers:

  • HTTP REST API for request-response actions and state snapshots
  • WebSocket stream for real-time incremental updates

Use this section when you need to:

  • authenticate end users
  • load account, balance, market, and trading state
  • send trade and configuration requests
  • receive quotes and account events in real time

REST API

The REST layer is used for explicit client actions.

Typical use cases: - authentication and session validation - account and balance snapshots - trading requests - market/watchlist reads - scripts, settings, and alerts management

See the overview page: REST API

REST Sections

Auth

Client authentication and session lifecycle: - sign in - sign up - check session - update password

Account

Current account state: - account profile - balance snapshot

Trade

Trading operations: - open trade - close trade - cancel pending trade - modify trade - load open trades - load trade history

Market

Market and watchlist data: - market info - asset info - short list - market watch management

Scripts

Private user scripts: - get scripts - add script - update script - delete script

Settings

Per-user settings and terminal preferences.

Alerts

Price alerts and alert history.

Prop Trading

Prop challenge discovery, purchase start and customer challenge state.

WebSocket Stream

The WebSocket layer is used for low-latency real-time delivery.

It delivers: - quotes - balance updates - trade updates - notifications - price alert events

See the overview page: WebSocket Stream

WebSocket Sections

Quotes

Real-time quotes for subscribed symbols.

See: Quotes Stream

Balance

Balance updates for the authenticated account.

See: Balance Stream

Trade

Trade events for the authenticated account.

See: Trade Stream

Notifications

Platform notifications delivered to the authenticated account.

See: Notifications Stream

Price Alerts

Triggered price alert events.

See: Price Alert Stream

A common integration flow is:

  1. Authenticate the user through REST.
  2. Load initial state through REST.
  3. Open a WebSocket connection and authorize it with the same JWT token.
  4. Subscribe to quote channels if market streaming is needed.
  5. Use REST for explicit actions and WebSocket for live updates.

Authorization

Most private REST methods require a JWT token:

Authorization: <JWT_TOKEN>

The same token is then used to authorize the WebSocket session.

Base Endpoints

REST base URL:

https://{broker_domain}

WebSocket endpoint:

wss://{broker_domain}:{ws_port}