API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Instruments

Retrieve core details and discovery endpoints for tradable instruments.

Get Instruments

$ clst v1:instruments get-instruments

GET/v1/instruments

Get Instrument By ID

$ clst v1:instruments get-instrument-by-id

GET/v1/instruments/{instrument_id}

Search Instruments

$ clst v1:instruments search-instruments

GET/v1/instruments/search

Get Option Contracts

$ clst v1:instruments get-option-contracts

GET/v1/instruments/options/contracts

ModelsExpand Collapse

contract_type: "CALL" or "PUT"

The type of options contract

"CALL"

"PUT"

exercise_style: "AMERICAN" or "EUROPEAN"

The exercise style of an options contract

"AMERICAN"

"EUROPEAN"

instrument: object { id, country_of_issue, currency, 18 more }

Represents a tradable financial instrument.

id: string

Unique 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_fractionable: boolean

Indicates if the instrument supports fractional-quantity orders

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_ptp: boolean

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

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. When a null/undefined value is observed, it indicates that there is no available data.

instrument_type: optional "COMMON_STOCK" or "INDEX" or "OPTION" or "CASH"

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

"COMMON_STOCK"

"INDEX"

"OPTION"

"CASH"

long_margin_rate: optional string

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: optional string

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

notional_adv: optional string

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.

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. When a null/undefined value is observed, it indicates it does not apply.

previous_close: optional string

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

short_margin_rate: optional string

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.

instrument_core: object { id, country_of_issue, currency, 17 more }

id: string

Unique 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_fractionable: boolean

Indicates if the instrument supports fractional-quantity orders

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_ptp: boolean

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

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. When a null/undefined value is observed, it indicates that there is no available data.

instrument_type: optional "COMMON_STOCK" or "INDEX" or "OPTION" or "CASH"

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

"COMMON_STOCK"

"INDEX"

"OPTION"

"CASH"

long_margin_rate: optional string

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: optional string

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

notional_adv: optional string

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.

previous_close: optional string

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

short_margin_rate: optional string

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.

instrument_core_list: array of InstrumentCore { id, country_of_issue, currency, 17 more }

id: string

Unique 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_fractionable: boolean

Indicates if the instrument supports fractional-quantity orders

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_ptp: boolean

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

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. When a null/undefined value is observed, it indicates that there is no available data.

instrument_type: optional "COMMON_STOCK" or "INDEX" or "OPTION" or "CASH"

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

"COMMON_STOCK"

"INDEX"

"OPTION"

"CASH"

long_margin_rate: optional string

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: optional string

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

notional_adv: optional string

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.

previous_close: optional string

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

short_margin_rate: optional string

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.

listing_type: "STANDARD" or "FLEX" or "OTC"

The listing type of an options contract

"STANDARD"

"FLEX"

"OTC"

options_contract: object { id, contract_type, currency, 14 more }

An options contract with options-specific metadata

id: string

Instrument identifier

contract_type: "CALL" or "PUT"

Whether this is a CALL or PUT

"CALL"

"PUT"

currency: string

ISO currency code

exchange: string

MIC code of the primary listing venue

exercise_style: "AMERICAN" or "EUROPEAN"

Exercise style

"AMERICAN"

"EUROPEAN"

expiry: string

Expiration date

is_liquidation_only: boolean

Whether the contract is liquidation-only

is_marginable: boolean

Whether the contract is marginable

is_tradable: boolean

Whether the contract is tradable

listing_type: "STANDARD" or "FLEX" or "OTC"

Listing type

"STANDARD"

"FLEX"

"OTC"

multiplier: string

Contract multiplier (100 for standard options)

strike_price: string

Strike price

symbol: string

OSI symbol (e.g. “AAPL 251219C00150000”)

is_settle_on_open: optional boolean

Whether the option settles on the opening price (AM settlement), if known When a null/undefined value is observed, it indicates that there is no available data.

last_trade_cutoff: optional string

Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.

open_interest: optional number

Open interest (number of outstanding contracts), if available When a null/undefined value is observed, it indicates that there is no available data.

underlying_instrument_id: optional string

Instrument ID of the underlying instrument, when available When a null/undefined value is observed, it indicates that there is no available data.

options_contract_list: array of OptionsContract { id, contract_type, currency, 14 more }

id: string

Instrument identifier

contract_type: "CALL" or "PUT"

Whether this is a CALL or PUT

"CALL"

"PUT"

currency: string

ISO currency code

exchange: string

MIC code of the primary listing venue

exercise_style: "AMERICAN" or "EUROPEAN"

Exercise style

"AMERICAN"

"EUROPEAN"

expiry: string

Expiration date

is_liquidation_only: boolean

Whether the contract is liquidation-only

is_marginable: boolean

Whether the contract is marginable

is_tradable: boolean

Whether the contract is tradable

listing_type: "STANDARD" or "FLEX" or "OTC"

Listing type

"STANDARD"

"FLEX"

"OTC"

multiplier: string

Contract multiplier (100 for standard options)

strike_price: string

Strike price

symbol: string

OSI symbol (e.g. “AAPL 251219C00150000”)

is_settle_on_open: optional boolean

Whether the option settles on the opening price (AM settlement), if known When a null/undefined value is observed, it indicates that there is no available data.

last_trade_cutoff: optional string

Last moment the option can trade (UTC), if known When a null/undefined value is observed, it indicates that there is no available data.

open_interest: optional number

Open interest (number of outstanding contracts), if available When a null/undefined value is observed, it indicates that there is no available data.

underlying_instrument_id: optional string

Instrument ID of the underlying instrument, when available When a null/undefined value is observed, it indicates that there is no available data.