Skip to content
Clear Street Clear Street Clear Street
Start Trading
API Reference
V1

Watchlist

Create and manage watchlists.

Get Watchlists
$ clst v1:watchlist get-watchlists
GET/v1/watchlists
Get Watchlist By ID
$ clst v1:watchlist get-watchlist-by-id
GET/v1/watchlists/{watchlist_id}
Create Watchlist
$ clst v1:watchlist create-watchlist
POST/v1/watchlists
Delete Watchlist
$ clst v1:watchlist delete-watchlist
DELETE/v1/watchlists/{watchlist_id}
Add Watchlist Item
$ clst v1:watchlist add-watchlist-item
POST/v1/watchlists/{watchlist_id}/items
Delete Watchlist Item
$ clst v1:watchlist delete-watchlist-item
DELETE/v1/watchlists/{watchlist_id}/items/{item_id}
ModelsExpand Collapse
add_watchlist_item_data: object { item_id }

Response data for adding a watchlist item

item_id: string

ID of the created item

watchlist_detail: object { id, created_at, items, name }

Detailed watchlist with all items

id: string

The unique identifier for the watchlist.

created_at: string

The timestamp when the watchlist was created.

items: array of WatchlistItemEntry { id, added_at, added_price, instrument }

Items in the watchlist

id: string

Item ID

added_at: string

When the item was added

added_price: optional string

Price when the item was added When a null/undefined value is observed, it indicates that there is no available data.

instrument: optional object { id, country_of_issue, currency, 21 more }

Instrument details When a null/undefined value is observed, it indicates that there is no available data.

id: string

Unique instrument identifier (UUID)

country_of_issue: string

The ISO country code of the instrument’s issue

currency: string

The ISO currency code in which the instrument is traded

easy_to_borrow: boolean

Indicates if the instrument is classified as Easy-To-Borrow

is_fractionable: boolean

Indicates if the instrument supports fractional-quantity orders

is_liquidation_only: boolean

Indicates if the instrument is liquidation only and cannot be bought

is_marginable: boolean

Indicates if the instrument is marginable

is_ptp: boolean

Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.

is_short_prohibited: boolean

Indicates if short selling is prohibited for the instrument. This is a standing property of the security. For the live Rule 201 circuit breaker, see short_sale_restricted on the market-data snapshot.

is_threshold_security: boolean

Indicates if the instrument is on the Regulation SHO Threshold Security List

is_tradable: boolean

Indicates if the instrument is tradable

symbol: string

The trading symbol for the instrument

venue: string

The MIC code of the primary listing venue

adv: optional string

Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.

cax_adjusted_previous_close: optional string

Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.

instrument_type: optional "COMMON_STOCK" or "INDEX" or "OPTION" or "CASH"

The type of security (e.g., Common Stock, ETF) When a null/undefined value is observed, it indicates that there is no available data.

"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
long_margin_rate: optional string

The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

name: optional string

The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.

notional_adv: optional string

Notional average daily volume (ADV multiplied by the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.

options_contract_expiry_dates: optional array of OptionExpiryDate { date, has_settles_on_close, has_settles_on_open }

Available options expiration dates for this instrument, each annotated with which settlement cycles have listed contracts on it. Present only when include_options_expiry_dates=true in the request. When a null/undefined value is observed, it indicates it does not apply.

date: string

The expiration date.

has_settles_on_close: boolean

Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.

has_settles_on_open: boolean

Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.

Deprecatedoptions_expiry_dates: optional array of string

Available options expiration dates for this instrument. Present only when include_options_expiry_dates=true in the request.

Deprecated: use options_contract_expiry_dates, which carries the same dates annotated with settlement-cycle information. When a null/undefined value is observed, it indicates it does not apply.

previous_close: optional string

Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.

short_margin_rate: optional string

The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

tick_rules: optional array of TickRule { start_price, tick_size, end_price }

Price bands this instrument quotes on, ascending. Absent when we have no schedule for it, which includes an option whose penny-program status our reference data never supplied.

start_price: string

Lowest price in the band, inclusive.

tick_size: string

Minimum price increment within the band.

end_price: optional string

Upper bound of the band, exclusive. Absent on the last band, which runs to infinity. When a null/undefined value is observed, it indicates it does not apply.

name: string

The user-provided watchlist name.

watchlist_entry: object { id, created_at, name }

Represents a user watchlist.

id: string

The unique identifier for the watchlist.

created_at: string

The timestamp when the watchlist was created.

name: string

The user-provided watchlist name.

watchlist_entry_list: array of WatchlistEntry { id, created_at, name }
id: string

The unique identifier for the watchlist.

created_at: string

The timestamp when the watchlist was created.

name: string

The user-provided watchlist name.

watchlist_item_entry: object { id, added_at, added_price, instrument }

A single item in a watchlist

id: string

Item ID

added_at: string

When the item was added

added_price: optional string

Price when the item was added When a null/undefined value is observed, it indicates that there is no available data.

instrument: optional object { id, country_of_issue, currency, 21 more }

Instrument details When a null/undefined value is observed, it indicates that there is no available data.

id: string

Unique instrument identifier (UUID)

country_of_issue: string

The ISO country code of the instrument’s issue

currency: string

The ISO currency code in which the instrument is traded

easy_to_borrow: boolean

Indicates if the instrument is classified as Easy-To-Borrow

is_fractionable: boolean

Indicates if the instrument supports fractional-quantity orders

is_liquidation_only: boolean

Indicates if the instrument is liquidation only and cannot be bought

is_marginable: boolean

Indicates if the instrument is marginable

is_ptp: boolean

Indicates if the instrument is a publicly traded partnership (PTP). PTP sales are subject to a 10% withholding tax for non-US tax residents.

is_short_prohibited: boolean

Indicates if short selling is prohibited for the instrument. This is a standing property of the security. For the live Rule 201 circuit breaker, see short_sale_restricted on the market-data snapshot.

is_threshold_security: boolean

Indicates if the instrument is on the Regulation SHO Threshold Security List

is_tradable: boolean

Indicates if the instrument is tradable

symbol: string

The trading symbol for the instrument

venue: string

The MIC code of the primary listing venue

adv: optional string

Average daily share volume from the security definition. When a null/undefined value is observed, it indicates that there is no available data.

cax_adjusted_previous_close: optional string

Corporate-action-adjusted last close; present only when an adjustment exists for the previous_close date. When a null/undefined value is observed, it indicates that there is no available data.

instrument_type: optional "COMMON_STOCK" or "INDEX" or "OPTION" or "CASH"

The type of security (e.g., Common Stock, ETF) When a null/undefined value is observed, it indicates that there is no available data.

"COMMON_STOCK"
"INDEX"
"OPTION"
"CASH"
long_margin_rate: optional string

The percent of a long position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

name: optional string

The full name of the instrument or its issuer When a null/undefined value is observed, it indicates that there is no available data.

notional_adv: optional string

Notional average daily volume (ADV multiplied by the cax-adjusted close when present, the raw previous close otherwise). When a null/undefined value is observed, it indicates that there is no available data.

options_contract_expiry_dates: optional array of OptionExpiryDate { date, has_settles_on_close, has_settles_on_open }

Available options expiration dates for this instrument, each annotated with which settlement cycles have listed contracts on it. Present only when include_options_expiry_dates=true in the request. When a null/undefined value is observed, it indicates it does not apply.

date: string

The expiration date.

has_settles_on_close: boolean

Whether this date has at least one listed contract that settles at the close (PM settlement) — the standard cycle.

has_settles_on_open: boolean

Whether this date has at least one contract that settles on the opening print (AM settlement) and can still be traded. AM-settled contracts stop trading at the close of the business day before settlement, so this turns false before the expiration date arrives. A date leaves the list once no contract on it can be traded in either settlement cycle.

Deprecatedoptions_expiry_dates: optional array of string

Available options expiration dates for this instrument. Present only when include_options_expiry_dates=true in the request.

Deprecated: use options_contract_expiry_dates, which carries the same dates annotated with settlement-cycle information. When a null/undefined value is observed, it indicates it does not apply.

previous_close: optional string

Last close price from the security definition. When a null/undefined value is observed, it indicates that there is no available data.

short_margin_rate: optional string

The percent of a short position’s value you must post as margin When a null/undefined value is observed, it indicates that there is no available data.

tick_rules: optional array of TickRule { start_price, tick_size, end_price }

Price bands this instrument quotes on, ascending. Absent when we have no schedule for it, which includes an option whose penny-program status our reference data never supplied.

start_price: string

Lowest price in the band, inclusive.

tick_size: string

Minimum price increment within the band.

end_price: optional string

Upper bound of the band, exclusive. Absent on the last band, which runs to infinity. When a null/undefined value is observed, it indicates it does not apply.