Skip to content

Method - open_aggregated

Opens a set that includes the same display symbol across all exchanges that list that pair (the same "aggregated" set as in the app). The set is not tied to a link color (linking_type is not used).

Request

FieldTypeRequiredDescription
methodstringYesMust be "open_aggregated".
exchangenumberYesOne exchange id the pair is known on. See Reference.
market_typenumberYes0 = Spot, 1 = Futures.
symbolstringYesDisplay symbol, e.g. TRXUSDT.
titlestringNoTab title. If empty, the display symbol of the pair is used. The server also accepts a string under extra.title if title is not set.

Example

json
{
  "method": "open_aggregated",
  "exchange": 0,
  "market_type": 0,
  "symbol": "TRXUSDT",
  "title": "TRX (all)"
}

Response

Success:

json
{
  "status": "ok"
}

Error (missing fields):

json
{
  "status": "error",
  "error_code": 1003,
  "message": "Missing 'exchange', 'market_type', or 'symbol'."
}

Error (unknown symbol):

json
{
  "status": "error",
  "error_code": 1005,
  "message": "Unknown symbol or exchange for the given market type."
}

Error (no exchanges):

json
{
  "status": "error",
  "error_code": 1006,
  "message": "No exchanges found for this pair."
}

Error (no window):

json
{
  "status": "error",
  "error_code": 1007,
  "message": "No workspace window available."
}

Other generic errors match Method - assign.