Changes the current ticker. The active window is always notified. When a named binding is provided, that binding's linked panels are also updated.

Accepts two request formats: a ticker pattern string (e.g. BINANCE:BTCUSDT.p) or explicit fields (exchange + market + ticker).

A binding is a named group of linked panels inside MetaScalp (e.g. a chart, order book, and trade feed showing the same ticker). Bindings are numbered "001"–"500" and configured by the user in the MetaScalp UI.

Opens a combo layout for the specified ticker in the MetaScalp UI.

Returns all currently active exchange connections. Use the id from the response to query orders, positions, balances, or to subscribe via WebSocket.

Field	Type	Description
id	integer	Connection ID — use for all exchange operations
name	string	User-defined connection name
exchange	string	Exchange name
exchangeId	integer	Exchange identifier
market	string	Market display name
marketType	integer	Market type enum value
state	integer	0=Disconnected, 1=Connecting, 2=Connected, 3=Reconnecting, 4=Resetting
viewMode	boolean	Read-only (no trading)
demoMode	boolean	Paper trading

Returns details for a single connection by ID.

Returns all available trading pairs on a connection with price/size precision, trading status, and constraints.

Returns open orders for a specific ticker on a connection. The Ticker query parameter is required.

Field	Type	Description
id	integer	Exchange order ID
ticker	string	Trading pair
clientId	string?	Client-generated order ID
side	integer	0 None, 1 Buy, 2 Sell
price	decimal	Order price
size	decimal	Order size
filledSize	decimal	Filled amount
filledPrice	decimal	Execution price (0 if not yet filled)
remainingSize	decimal	Remaining amount
status	integer	0 New, 1 Open, 2 Closed
type	integer	0 Limit, 1 Stop, 2 StopLoss, 3 TakeProfit, 4 Market
triggerPrice	decimal?	Trigger price for stop/conditional orders
createDate	string (ISO)	Order creation timestamp

Returns all open positions on a connection (futures/margin markets).

Returns account balances for all assets on a connection.

Places a new order on the exchange through a connection. Returns an auto-generated clientId for order tracking and executionTimeMs indicating how long the exchange request took (in milliseconds).

Field	Type	Required	Description
ticker	string	yes	Trading pair symbol
side	integer	yes	1 Buy, 2 Sell
price	decimal	yes*	Order price (*required for non-market orders)
size	decimal	yes	Order size (must be > 0)
type	integer	no	0 Limit (default), 1 Stop, 2 StopLoss, 3 TakeProfit, 4 Market
reduceOnly	boolean	no	Close-only, default false

Cancels an existing order on the exchange.

Field	Type	Required	Description
ticker	string	yes	Trading pair symbol
orderId	integer	yes	Exchange order ID
type	integer	no	Order type (default 0 Limit)

Cancels all open orders for a given ticker on the exchange.

Field	Type	Required	Description
ticker	string	yes	Trading pair symbol

Returns cancelledCount: 0 if there are no open orders for that ticker.

Connect via WebSocket to receive real-time updates for your exchange connections. Subscribe by connection ID for order, position, balance, and finres events. Subscribe by connection ID + ticker for real-time trade and order book market data.

Connection

The WebSocket server shares the same port as the HTTP API (17845–17855). Connect to ws://127.0.0.1:{port}/.

Message format

All messages (inbound and outbound) are JSON with this envelope:

{ "type": "message_type", "data": { ... } }

Inbound messages (client → server)

Connection-level — subscribe by connection ID for order, position, balance, and finres updates:

Type	Data	Description
subscribe	{ "connectionId": 123 }	Subscribe to updates for a connection. Connection must be active. Idempotent.
unsubscribe	{ "connectionId": 123 }	Stop receiving updates for a connection. Idempotent.

Market data — subscribe by connection ID + ticker for trade or order book updates:

Type	Data	Description
trade_subscribe	{ "connectionId": 123, "ticker": "BTCUSDT" }	Subscribe to real-time trade updates for a specific ticker. Idempotent.
trade_unsubscribe	{ "connectionId": 123, "ticker": "BTCUSDT" }	Stop receiving trade updates for that ticker. Idempotent.
orderbook_subscribe	{ "connectionId": 123, "ticker": "BTCUSDT" }	Subscribe to order book updates (snapshot + incremental). Idempotent.
orderbook_unsubscribe	{ "connectionId": 123, "ticker": "BTCUSDT" }	Stop receiving order book updates for that ticker. Idempotent.

Outbound messages (server → client)

Acknowledgements:

Type	When	Data fields
subscribed	After successful connection subscribe	connectionId
unsubscribed	After successful connection unsubscribe	connectionId
trade_subscribed	After successful trade subscribe	connectionId, ticker
trade_unsubscribed	After successful trade unsubscribe	connectionId, ticker
orderbook_subscribed	After successful order book subscribe	connectionId, ticker
orderbook_unsubscribed	After successful order book unsubscribe	connectionId, ticker
error	Invalid message, bad connection ID, or missing ticker	error (string)

Connection-level updates:

Type	When	Data fields
order_update	Order created/changed/filled/cancelled	connectionId, orderId, ticker, side, type, price, filledPrice, size, filledSize, fee, feeCurrency, status, time
position_update	Position opened/changed/closed	connectionId, positionId, ticker, side, size, avgPrice, avgPriceFix, avgPriceDyn, status
balance_update	Account balance changed	connectionId, balances[] with coin, total, free, locked
finres_update	Financial results updated	connectionId, finreses[] with currency, result, fee, funds, available, blocked

Market data updates:

Type	When	Data fields
trade_update	New trades for subscribed ticker	connectionId, ticker, trades[] with price, size, side, time
orderbook_snapshot	Full order book on subscribe	connectionId, ticker, asks[], bids[], bestAsk, bestBid — each with price, size, type
orderbook_update	Incremental order book changes	connectionId, ticker, updates[] with price, size, type

Lifecycle

Event	Behavior
Client connects	Session created. No updates until subscribe.
Subscribe (valid ID)	Server responds with subscribed. Order, position, balance, finres updates start flowing.
Subscribe (invalid ID)	Server responds with error. No subscription created.
Subscribe (already subscribed)	Idempotent — responds with confirmation, no duplicate events.
Trade/orderbook subscribe (valid)	Server responds with trade_subscribed / orderbook_subscribed. Market data starts flowing for that ticker.
Trade/orderbook subscribe (invalid)	Server responds with error (bad connection ID or missing ticker).
Unsubscribe	Server responds with confirmation. Updates stop for that subscription.
Client disconnects	All subscriptions (connection-level and market data) are cleaned up automatically.
Multiple connections	A single client can subscribe to multiple connection IDs and multiple tickers simultaneously.

Example payloads

// Subscribe
{ "type": "subscribe", "data": { "connectionId": 1 } }

// Server confirms
{ "type": "subscribed", "data": { "connectionId": 1 } }

// Order update pushed by server
{
  "type": "order_update",
  "data": {
    "connectionId": 1,
    "orderId": 98765,
    "ticker": "BTCUSDT",
    "side": "Buy",
    "type": "Limit",
    "price": 65000.0,
    "filledPrice": 64980.5,
    "size": 0.01,
    "filledSize": 0.0,
    "fee": 0.0013,
    "feeCurrency": "USDT",
    "status": "New",
    "time": "2025-03-24T14:30:00+00:00"
  }
}

// Position update pushed by server
{
  "type": "position_update",
  "data": {
    "connectionId": 1,
    "positionId": 4321,
    "ticker": "ETHUSDT",
    "side": "Buy",
    "size": 1.5,
    "avgPrice": 3200.00,
    "avgPriceFix": 3200.00,
    "avgPriceDyn": 3195.50,
    "status": "Open"
  }
}

// Balance update pushed by server
{
  "type": "balance_update",
  "data": {
    "connectionId": 1,
    "balances": [
      { "coin": "USDT", "total": 10000.0, "free": 8500.0, "locked": 1500.0 },
      { "coin": "BTC", "total": 0.5, "free": 0.5, "locked": 0.0 }
    ]
  }
}

// FinRes update pushed by server
{
  "type": "finres_update",
  "data": {
    "connectionId": 1,
    "finreses": [
      { "currency": "USDT", "result": 250.50, "fee": 12.30, "funds": 10000.0, "available": 8500.0, "blocked": 1500.0 },
      { "currency": "BTC", "result": 0.005, "fee": 0.0001, "funds": 0.5, "available": 0.5, "blocked": 0.0 }
    ]
  }
}

// Subscribe to trades for a specific ticker
{ "type": "trade_subscribe", "data": { "connectionId": 1, "ticker": "BTCUSDT" } }

// Server confirms trade subscription
{ "type": "trade_subscribed", "data": { "connectionId": 1, "ticker": "BTCUSDT" } }

// Trade update pushed by server
{
  "type": "trade_update",
  "data": {
    "connectionId": 1,
    "ticker": "BTCUSDT",
    "trades": [
      { "price": 65123.50, "size": 0.15, "side": "Buy", "time": "2026-03-16T12:00:01.234+00:00" },
      { "price": 65123.00, "size": 0.03, "side": "Sell", "time": "2026-03-16T12:00:01.235+00:00" }
    ]
  }
}

// Subscribe to order book for a specific ticker
{ "type": "orderbook_subscribe", "data": { "connectionId": 1, "ticker": "BTCUSDT" } }

// Server confirms order book subscription
{ "type": "orderbook_subscribed", "data": { "connectionId": 1, "ticker": "BTCUSDT" } }

// Order book snapshot (full state, sent once on subscribe)
{
  "type": "orderbook_snapshot",
  "data": {
    "connectionId": 1,
    "ticker": "BTCUSDT",
    "asks": [
      { "price": 65124.00, "size": 1.20, "type": "Ask" },
      { "price": 65125.00, "size": 0.85, "type": "Ask" }
    ],
    "bids": [
      { "price": 65123.00, "size": 2.50, "type": "Bid" },
      { "price": 65122.00, "size": 1.10, "type": "Bid" }
    ],
    "bestAsk": { "price": 65124.00, "size": 1.20, "type": "BestAsk" },
    "bestBid": { "price": 65123.00, "size": 2.50, "type": "BestBid" }
  }
}

// Order book incremental update
{
  "type": "orderbook_update",
  "data": {
    "connectionId": 1,
    "ticker": "BTCUSDT",
    "updates": [
      { "price": 65124.00, "size": 0.90, "type": "Ask" },
      { "price": 65126.00, "size": 0.50, "type": "Ask" },
      { "price": 65123.00, "size": 2.80, "type": "Bid" }
    ]
  }
}

// Unsubscribe from market data
{ "type": "trade_unsubscribe", "data": { "connectionId": 1, "ticker": "BTCUSDT" } }
{ "type": "orderbook_unsubscribe", "data": { "connectionId": 1, "ticker": "BTCUSDT" } }

// Unsubscribe from connection
{ "type": "unsubscribe", "data": { "connectionId": 1 } }

// Error (invalid connection)
{ "type": "error", "data": { "error": "Connection 999 not found or not active" } }