API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Watchlist

Create and manage watchlists.

Get Watchlists

client.v1.watchlist.getWatchlists(WatchlistGetWatchlistsParams { page_size, page_token } query?, RequestOptionsoptions?): WatchlistGetWatchlistsResponse { data }

GET/v1/watchlists

Get Watchlist By ID

client.v1.watchlist.getWatchlistByID(stringwatchlistID, RequestOptionsoptions?): WatchlistGetWatchlistByIDResponse { data }

GET/v1/watchlists/{watchlist_id}

Create Watchlist

client.v1.watchlist.createWatchlist(WatchlistCreateWatchlistParams { name } body, RequestOptionsoptions?): WatchlistCreateWatchlistResponse { data }

POST/v1/watchlists

Delete Watchlist

client.v1.watchlist.deleteWatchlist(stringwatchlistID, RequestOptionsoptions?): WatchlistDeleteWatchlistResponse

DELETE/v1/watchlists/{watchlist_id}

Add Watchlist Item

client.v1.watchlist.addWatchlistItem(stringwatchlistID, WatchlistAddWatchlistItemParams { instrument_id } body, RequestOptionsoptions?): WatchlistAddWatchlistItemResponse { data }

POST/v1/watchlists/{watchlist_id}/items

Delete Watchlist Item

client.v1.watchlist.deleteWatchlistItem(stringitemID, WatchlistDeleteWatchlistItemParams { watchlist_id } params, RequestOptionsoptions?): WatchlistDeleteWatchlistItemResponse

DELETE/v1/watchlists/{watchlist_id}/items/{item_id}

ModelsExpand Collapse

AddWatchlistItemData { item_id }

Response data for adding a watchlist item

item_id: string

ID of the created item

formatuuid

WatchlistDetail { id, created_at, items, name }

Detailed watchlist with all items

id: string

Watchlist ID

formatuuid

created_at: string

Creation timestamp

formatdate-time

items: Array<WatchlistItemEntry { id, added_at, added_price, instrument } >

Items in the watchlist

id: string

Item ID

formatuuid

added_at: string

When the item was added

formatdate-time

added_price?: string | null

Price when the item was added

instrument?: Instrument { id, country_of_issue, currency, 19 more } | null

Instrument details

id: string

Unique OEMS instrument identifier (UUID)

formatuuid

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?: string | null

Average daily share volume from the security definition.

expiry?: string | null

The expiration date for options instruments

formatdate

instrument_type?: SecurityType | null

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

One of the following:

"COMMON_STOCK"

"PREFERRED_STOCK"

"OPTION"

"CASH"

"OTHER"

long_margin_rate?: string | null

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

name?: string | null

The full name of the instrument or its issuer

notional_adv?: string | null

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?: Array<string> | null

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

previous_close?: string | null

Last close price from the security definition.

short_margin_rate?: string | null

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

strike_price?: string | null

The strike price for options instruments

name: string

Watchlist name

WatchlistEntry { id, created_at, name }

Represents a user watchlist.

id: string

The unique identifier for the watchlist.

formatuuid

created_at: string

The timestamp when the watchlist was created.

formatdate-time

name: string

The user-provided watchlist name.

WatchlistEntryList = Array<WatchlistEntry { id, created_at, name } >

id: string

The unique identifier for the watchlist.

formatuuid

created_at: string

The timestamp when the watchlist was created.

formatdate-time

name: string

The user-provided watchlist name.

WatchlistItemEntry { id, added_at, added_price, instrument }

A single item in a watchlist

id: string

Item ID

formatuuid

added_at: string

When the item was added

formatdate-time

added_price?: string | null

Price when the item was added

instrument?: Instrument { id, country_of_issue, currency, 19 more } | null

Instrument details

id: string

Unique OEMS instrument identifier (UUID)

formatuuid

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?: string | null

Average daily share volume from the security definition.

expiry?: string | null

The expiration date for options instruments

formatdate

instrument_type?: SecurityType | null

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

One of the following:

"COMMON_STOCK"

"PREFERRED_STOCK"

"OPTION"

"CASH"

"OTHER"

long_margin_rate?: string | null

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

name?: string | null

The full name of the instrument or its issuer

notional_adv?: string | null

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?: Array<string> | null

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

previous_close?: string | null

Last close price from the security definition.

short_margin_rate?: string | null

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

strike_price?: string | null

The strike price for options instruments

WatchlistGetWatchlistsResponse extends BaseResponse { metadata, error } { data }

data: WatchlistEntryList { id, created_at, name }

id: string

The unique identifier for the watchlist.

formatuuid

created_at: string

The timestamp when the watchlist was created.

formatdate-time

name: string

The user-provided watchlist name.

WatchlistGetWatchlistByIDResponse extends BaseResponse { metadata, error } { data }

data: WatchlistDetail { id, created_at, items, name }

Detailed watchlist with all items

id: string

Watchlist ID

formatuuid

created_at: string

Creation timestamp

formatdate-time

items: Array<WatchlistItemEntry { id, added_at, added_price, instrument } >

Items in the watchlist

id: string

Item ID

formatuuid

added_at: string

When the item was added

formatdate-time

added_price?: string | null

Price when the item was added

instrument?: Instrument { id, country_of_issue, currency, 19 more } | null

Instrument details

id: string

Unique OEMS instrument identifier (UUID)

formatuuid

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?: string | null

Average daily share volume from the security definition.

expiry?: string | null

The expiration date for options instruments

formatdate

instrument_type?: SecurityType | null

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

One of the following:

"COMMON_STOCK"

"PREFERRED_STOCK"

"OPTION"

"CASH"

"OTHER"

long_margin_rate?: string | null

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

name?: string | null

The full name of the instrument or its issuer

notional_adv?: string | null

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?: Array<string> | null

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

previous_close?: string | null

Last close price from the security definition.

short_margin_rate?: string | null

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

strike_price?: string | null

The strike price for options instruments

name: string

Watchlist name

WatchlistCreateWatchlistResponse extends BaseResponse { metadata, error } { data }

data: WatchlistEntry { id, created_at, name }

Represents a user watchlist.

id: string

The unique identifier for the watchlist.

formatuuid

created_at: string

The timestamp when the watchlist was created.

formatdate-time

name: string

The user-provided watchlist name.

WatchlistDeleteWatchlistResponse = unknown

WatchlistAddWatchlistItemResponse extends BaseResponse { metadata, error } { data }

data: AddWatchlistItemData { item_id }

Response data for adding a watchlist item

item_id: string

ID of the created item

formatuuid

WatchlistDeleteWatchlistItemResponse = unknown