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

WatchlistGetWatchlistsResponse v1().watchlist().getWatchlists(WatchlistGetWatchlistsParamsparams = WatchlistGetWatchlistsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/watchlists

Get Watchlist By ID

WatchlistGetWatchlistByIdResponse v1().watchlist().getWatchlistById(WatchlistGetWatchlistByIdParamsparams = WatchlistGetWatchlistByIdParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/watchlists/{watchlist_id}

Create Watchlist

WatchlistCreateWatchlistResponse v1().watchlist().createWatchlist(WatchlistCreateWatchlistParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/watchlists

Delete Watchlist

WatchlistDeleteWatchlistResponse v1().watchlist().deleteWatchlist(WatchlistDeleteWatchlistParamsparams = WatchlistDeleteWatchlistParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/watchlists/{watchlist_id}

Add Watchlist Item

WatchlistAddWatchlistItemResponse v1().watchlist().addWatchlistItem(WatchlistAddWatchlistItemParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/watchlists/{watchlist_id}/items

Delete Watchlist Item

WatchlistDeleteWatchlistItemResponse v1().watchlist().deleteWatchlistItem(WatchlistDeleteWatchlistItemParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

ModelsExpand Collapse

class AddWatchlistItemData:

Response data for adding a watchlist item

String itemId

ID of the created item

formatuuid

class WatchlistDetail:

Detailed watchlist with all items

String id

The unique identifier for the watchlist.

formatuuid

LocalDateTime createdAt

The timestamp when the watchlist was created.

formatdate-time

List<WatchlistItemEntry> items

Items in the watchlist

String id

Item ID

formatuuid

LocalDateTime addedAt

When the item was added

formatdate-time

Optional<String> addedPrice

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

Optional<Instrument> instrument

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

String id

Unique instrument identifier (UUID)

formatuuid

String countryOfIssue

The ISO country code of the instrument’s issue

String currency

The ISO currency code in which the instrument is traded

boolean easyToBorrow

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

boolean isFractionable

Indicates if the instrument supports fractional-quantity orders

boolean isLiquidationOnly

Indicates if the instrument is liquidation only and cannot be bought

boolean isMarginable

Indicates if the instrument is marginable

boolean isPtp

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

boolean isShortProhibited

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.

boolean isThresholdSecurity

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

boolean isTradable

Indicates if the instrument is tradable

String symbol

The trading symbol for the instrument

String venue

The MIC code of the primary listing venue

Optional<String> adv

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

Optional<String> caxAdjustedPreviousClose

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.

Optional<SecurityType> instrumentType

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:

COMMON_STOCK("COMMON_STOCK")

INDEX("INDEX")

OPTION("OPTION")

CASH("CASH")

Optional<String> longMarginRate

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.

Optional<String> name

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

Optional<String> notionalAdv

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.

Optional<List<OptionExpiryDate>> optionsContractExpiryDates

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.

LocalDate date

The expiration date.

formatdate

boolean hasSettlesOnClose

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

boolean hasSettlesOnOpen

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.

DeprecatedOptional<List<LocalDate>> optionsExpiryDates

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.

Optional<String> previousClose

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

Optional<String> shortMarginRate

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.

Optional<List<TickRule>> tickRules

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.

String startPrice

Lowest price in the band, inclusive.

String tickSize

Minimum price increment within the band.

Optional<String> endPrice

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.

String name

The user-provided watchlist name.

class WatchlistEntry:

Represents a user watchlist.

String id

The unique identifier for the watchlist.

formatuuid

LocalDateTime createdAt

The timestamp when the watchlist was created.

formatdate-time

String name

The user-provided watchlist name.

class WatchlistItemEntry:

A single item in a watchlist

String id

Item ID

formatuuid

LocalDateTime addedAt

When the item was added

formatdate-time

Optional<String> addedPrice

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

Optional<Instrument> instrument

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

String id

Unique instrument identifier (UUID)

formatuuid

String countryOfIssue

The ISO country code of the instrument’s issue

String currency

The ISO currency code in which the instrument is traded

boolean easyToBorrow

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

boolean isFractionable

Indicates if the instrument supports fractional-quantity orders

boolean isLiquidationOnly

Indicates if the instrument is liquidation only and cannot be bought

boolean isMarginable

Indicates if the instrument is marginable

boolean isPtp

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

boolean isShortProhibited

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.

boolean isThresholdSecurity

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

boolean isTradable

Indicates if the instrument is tradable

String symbol

The trading symbol for the instrument

String venue

The MIC code of the primary listing venue

Optional<String> adv

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

Optional<String> caxAdjustedPreviousClose

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.

Optional<SecurityType> instrumentType

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:

COMMON_STOCK("COMMON_STOCK")

INDEX("INDEX")

OPTION("OPTION")

CASH("CASH")

Optional<String> longMarginRate

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.

Optional<String> name

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

Optional<String> notionalAdv

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.

Optional<List<OptionExpiryDate>> optionsContractExpiryDates

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.

LocalDate date

The expiration date.

formatdate

boolean hasSettlesOnClose

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

boolean hasSettlesOnOpen

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.

DeprecatedOptional<List<LocalDate>> optionsExpiryDates

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.

Optional<String> previousClose

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

Optional<String> shortMarginRate

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.

Optional<List<TickRule>> tickRules

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.

String startPrice

Lowest price in the band, inclusive.

String tickSize

Minimum price increment within the band.

Optional<String> endPrice

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.