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

Watchlist

Create and manage watchlists.

Get Watchlists
client.V1.Watchlist.GetWatchlists(ctx, query) (*V1WatchlistGetWatchlistsResponse, error)
GET/v1/watchlists
Get Watchlist By ID
client.V1.Watchlist.GetWatchlistByID(ctx, watchlistID) (*V1WatchlistGetWatchlistByIDResponse, error)
GET/v1/watchlists/{watchlist_id}
Create Watchlist
client.V1.Watchlist.NewWatchlist(ctx, body) (*V1WatchlistNewWatchlistResponse, error)
POST/v1/watchlists
Delete Watchlist
client.V1.Watchlist.DeleteWatchlist(ctx, watchlistID) (*V1WatchlistDeleteWatchlistResponse, error)
DELETE/v1/watchlists/{watchlist_id}
Add Watchlist Item
client.V1.Watchlist.AddWatchlistItem(ctx, watchlistID, body) (*V1WatchlistAddWatchlistItemResponse, error)
POST/v1/watchlists/{watchlist_id}/items
Delete Watchlist Item
client.V1.Watchlist.DeleteWatchlistItem(ctx, itemID, body) (*V1WatchlistDeleteWatchlistItemResponse, error)
DELETE/v1/watchlists/{watchlist_id}/items/{item_id}
ModelsExpand Collapse
type AddWatchlistItemData struct{…}

Response data for adding a watchlist item

ItemID string

ID of the created item

formatuuid
type WatchlistDetail struct{…}

Detailed watchlist with all items

ID string

Watchlist ID

formatuuid
CreatedAt Time

Creation timestamp

formatdate-time

Items in the watchlist

ID string

Item ID

formatuuid
AddedAt Time

When the item was added

formatdate-time
AddedPrice stringOptional

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

Instrument InstrumentOptional

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

ID string

Unique instrument identifier (UUID)

formatuuid
CountryOfIssue string

The ISO country code of the instrument’s issue

Currency string

The ISO currency code in which the instrument is traded

EasyToBorrow bool

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

IsFractionable bool

Indicates if the instrument supports fractional-quantity orders

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsPtp bool

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

IsShortProhibited bool

Indicates if short selling is prohibited for the instrument

IsThresholdSecurity bool

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

IsTradable bool

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 stringOptional

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

DeprecatedExpiry TimeOptional

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

formatdate
InstrumentType SecurityTypeOptional

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

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
LongMarginRate stringOptional

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 stringOptional

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

NotionalAdv stringOptional

Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.

OptionsExpiryDates []TimeOptional

Available options expiration dates for this instrument. Present only when include_options_expiry_dates=true in the request. When a null/undefined value is observed, it indicates it does not apply.

PreviousClose stringOptional

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

ShortMarginRate stringOptional

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.

DeprecatedStrikePrice stringOptional

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

Name string

Watchlist name

type WatchlistEntry struct{…}

Represents a user watchlist.

ID string

The unique identifier for the watchlist.

formatuuid
CreatedAt Time

The timestamp when the watchlist was created.

formatdate-time
Name string

The user-provided watchlist name.

type WatchlistEntryList []WatchlistEntry
ID string

The unique identifier for the watchlist.

formatuuid
CreatedAt Time

The timestamp when the watchlist was created.

formatdate-time
Name string

The user-provided watchlist name.

type WatchlistItemEntry struct{…}

A single item in a watchlist

ID string

Item ID

formatuuid
AddedAt Time

When the item was added

formatdate-time
AddedPrice stringOptional

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

Instrument InstrumentOptional

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

ID string

Unique instrument identifier (UUID)

formatuuid
CountryOfIssue string

The ISO country code of the instrument’s issue

Currency string

The ISO currency code in which the instrument is traded

EasyToBorrow bool

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

IsFractionable bool

Indicates if the instrument supports fractional-quantity orders

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsPtp bool

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

IsShortProhibited bool

Indicates if short selling is prohibited for the instrument

IsThresholdSecurity bool

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

IsTradable bool

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 stringOptional

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

DeprecatedExpiry TimeOptional

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.

formatdate
InstrumentType SecurityTypeOptional

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

One of the following:
const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"
const SecurityTypeOption SecurityType = "OPTION"
const SecurityTypeCash SecurityType = "CASH"
LongMarginRate stringOptional

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 stringOptional

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

NotionalAdv stringOptional

Notional average daily volume (ADV multiplied by previous close price). When a null/undefined value is observed, it indicates that there is no available data.

OptionsExpiryDates []TimeOptional

Available options expiration dates for this instrument. Present only when include_options_expiry_dates=true in the request. When a null/undefined value is observed, it indicates it does not apply.

PreviousClose stringOptional

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

ShortMarginRate stringOptional

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.

DeprecatedStrikePrice stringOptional

Deprecated. Always null. When a null/undefined value is observed, it indicates it does not apply.