CLclear-street
Watchlist

Add Watchlist Item

Changed on

Add an instrument to a watchlist

post/v1/watchlists/{watchlist_id}/items

Request

  • Base URL
    https://api.clearstreet.com
  • Auth
    HTTP bearer

Path parameters

watchlist_idstring uuid required

Watchlist ID

Request body

instrument_idstring required

Instrument identifier: either an instrument UUID or a symbol (symbol for equities, OSI for options). Non-UUID inputs are resolved server-side.

Response

Item added successfully

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  }
}

Changes

  • 1bd9eddeffc8Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      the request property type changed from no type to string

  • 920881a98f6cRevision changes
    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • info

      added subschema #1 subschema #2 to the request property oneOf list