Market Data

Add Trading Pair

Changed on

Initialize order book for a trading pair.

This endpoint dynamically adds a trading pair to a connector's order book tracker. It uses the best available connector (trading connectors are preferred over data connectors).

Args: request: Request with connector name, trading pair, optional account name, and timeout

Returns: TradingPairResponse with success status and message

Raises: HTTPException: 500 if initialization fails

post/market-data/trading-pair/add

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/market-data/trading-pair/add
  • Auth
    HTTP basic

Request body

connector_namestring required

Name of the connector (e.g., 'binance', 'binance_perpetual')

trading_pairstring required

Trading pair to add (e.g., 'BTC-USDT')

account_namestring nullable

Optional account name for trading connector preference

timeoutnumber

Timeout in seconds for order book initialization

Response

Successful Response

successboolean required

Whether the operation succeeded

connector_namestring required

Name of the connector

trading_pairstring required

Trading pair that was added/removed

messagestring required

Status message

Changes