Skip to content
Clear Street Clear Street
Get started
API Reference
V1

Watchlist

Create and manage watchlists.

Get Watchlists
$ clear-street v1:watchlist get-watchlists
GET/v1/watchlists
Get Watchlist By ID
$ clear-street v1:watchlist get-watchlist-by-id
GET/v1/watchlists/{watchlist_id}
Create Watchlist
$ clear-street v1:watchlist create-watchlist
POST/v1/watchlists
Delete Watchlist
$ clear-street v1:watchlist delete-watchlist
DELETE/v1/watchlists/{watchlist_id}
Add Watchlist Item
$ clear-street v1:watchlist add-watchlist-item
POST/v1/watchlists/{watchlist_id}/items
Delete Watchlist Item
$ clear-street 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

Watchlist ID

created_at: string

Creation timestamp

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

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

Instrument details

id: string

Unique OEMS 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_liquidation_only: boolean

Indicates if the instrument is liquidation only and cannot be bought

is_marginable: boolean

Indicates if the instrument is marginable

is_restricted: boolean

Indicates if the instrument is restricted from trading

is_short_prohibited: boolean

Indicates if short selling is prohibited for the instrument

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.

expiry: optional string

The expiration date for options instruments

instrument_type: optional "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more

The type of security (e.g., Common Stock, ETF)

"COMMON_STOCK"
"PREFERRED_STOCK"
"OPTION"
"CASH"
"OTHER"
long_margin_rate: optional string

The percent of a long position’s value you must post as margin

name: optional string

The full name of the instrument or its issuer

notional_adv: optional string

Notional ADV (adv × previous_close). The primary liquidity signal used by /instruments/search ranking. Computed at response time so it stays consistent with whatever adv and previous_close show.

options_expiry_dates: optional array of string

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

previous_close: optional string

Last close price from the security definition.

short_margin_rate: optional string

The percent of a short position’s value you must post as margin

strike_price: optional string

The strike price for options instruments

name: string

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

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

Instrument details

id: string

Unique OEMS 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_liquidation_only: boolean

Indicates if the instrument is liquidation only and cannot be bought

is_marginable: boolean

Indicates if the instrument is marginable

is_restricted: boolean

Indicates if the instrument is restricted from trading

is_short_prohibited: boolean

Indicates if short selling is prohibited for the instrument

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.

expiry: optional string

The expiration date for options instruments

instrument_type: optional "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more

The type of security (e.g., Common Stock, ETF)

"COMMON_STOCK"
"PREFERRED_STOCK"
"OPTION"
"CASH"
"OTHER"
long_margin_rate: optional string

The percent of a long position’s value you must post as margin

name: optional string

The full name of the instrument or its issuer

notional_adv: optional string

Notional ADV (adv × previous_close). The primary liquidity signal used by /instruments/search ranking. Computed at response time so it stays consistent with whatever adv and previous_close show.

options_expiry_dates: optional array of string

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

previous_close: optional string

Last close price from the security definition.

short_margin_rate: optional string

The percent of a short position’s value you must post as margin

strike_price: optional string

The strike price for options instruments