Get started

Objects

Watchlist

A named list of instruments, shared with the app.

Object: watchlistId prefix: wl_

Fields

Load a watchlist into a query with ids, or through POST /instruments/search with ids: watchlist.instrument_ids.

  • objectstring

    Always "watchlist".

  • idstring

    "wl_" and a random suffix.

  • namestring

    Name shown in the app.

  • instrument_idsstring[]

    Instruments on the list, in the order they were added.

  • pinnedboolean

    Pinned watchlists are listed first.

  • created_atstring · ISO 8601

    Creation time.

  • updated_atstring · ISO 8601

    Last change.

Example
{
  "object": "watchlist",
  "id": "wl_6adccafe1c9b331c1d1bbfcc",
  "name": "Treasury candidates",
  "instrument_ids": [
    "ins_4c29f40abec73e1b",
    "ins_0abd5ec576be07e6",
    "ins_2f32db0cbfbb54dd"
  ],
  "pinned": false,
  "created_at": "2026-10-24T15:13:02.567Z",
  "updated_at": "2026-10-24T15:13:02.567Z"
}