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(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 []WatchlistItemEntry

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

Instrument InstrumentOptional

Instrument details

ID string

Unique OEMS 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

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsRestricted bool

Indicates if the instrument is restricted from trading

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.

Expiry TimeOptional

The expiration date for options instruments

formatdate

InstrumentType SecurityTypeOptional

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

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

const SecurityTypeOther SecurityType = "OTHER"

LongMarginRate stringOptional

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

Name stringOptional

The full name of the instrument or its issuer

NotionalAdv stringOptional

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.

OptionsExpiryDates []TimeOptional

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

PreviousClose stringOptional

Last close price from the security definition.

ShortMarginRate stringOptional

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

StrikePrice stringOptional

The strike price for options instruments

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

Instrument InstrumentOptional

Instrument details

ID string

Unique OEMS 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

IsLiquidationOnly bool

Indicates if the instrument is liquidation only and cannot be bought

IsMarginable bool

Indicates if the instrument is marginable

IsRestricted bool

Indicates if the instrument is restricted from trading

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.

Expiry TimeOptional

The expiration date for options instruments

formatdate

InstrumentType SecurityTypeOptional

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

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

const SecurityTypeOther SecurityType = "OTHER"

LongMarginRate stringOptional

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

Name stringOptional

The full name of the instrument or its issuer

NotionalAdv stringOptional

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.

OptionsExpiryDates []TimeOptional

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

PreviousClose stringOptional

Last close price from the security definition.

ShortMarginRate stringOptional

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

StrikePrice stringOptional

The strike price for options instruments