Skip to content

Method - open

Creates a new instrument set in the current workspace (same path as the watchlist / “open” flow) for a single exchange, market type, and symbol. This is separate from assign: assign only updates the linked symbol for an existing set that already uses that link color. To open a new set, use open (or open_aggregated); optional linking_type controls which color slot the new set is tied to, similar to the watchlist.

Request

FieldTypeRequiredDescription
methodstringYesMust be "open".
exchangenumberYesExchange id. See Reference.
market_typenumberYes0 = Spot, 1 = Futures.
symbolstringYesDisplay symbol, e.g. TRXUSDT. See Reference.
linking_typenumber or stringNoIf omitted or null, behavior matches the watchlist: an available link slot is chosen when a new set is created. 0 = None (unlinked), 1 = LinkAuto (treated like "pick available" for opening). 2+ = a specific link color. You may also send a string, e.g. "Link1". See Reference.

Example (linked to Red, Link1)

json
{
  "method": "open",
  "exchange": 0,
  "market_type": 1,
  "symbol": "TRXUSDT",
  "linking_type": 2
}

Response

Success:

json
{
  "status": "ok"
}

Error (missing fields):

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

Error (unknown symbol / pair):

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

Error (no window):

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

Error (cannot create set):

json
{
  "status": "error",
  "error_code": 1008,
  "message": "Unable to create instrument set (check workspace chart/order book options)."
}

Other generic errors (invalid JSON, unknown method) follow the same pattern as on Method - assign.