Skip to content
Clear Street Clear Street
Get started
API Reference
V1

Instruments

Retrieve core details and discovery endpoints for tradable instruments.

Get Instruments
client.v1.instruments.getInstruments(InstrumentGetInstrumentsParams { easy_to_borrow, instrument_ids, instrument_type, 7 more } query?, RequestOptionsoptions?): InstrumentGetInstrumentsResponse { data }
GET/v1/instruments
Get Instrument By ID
client.v1.instruments.getInstrumentByID(InstrumentIDOrSymbolinstrumentID, InstrumentGetInstrumentByIDParams { include_options_expiry_dates } query?, RequestOptionsoptions?): InstrumentGetInstrumentByIDResponse { data }
GET/v1/instruments/{instrument_id}
Search Instruments
client.v1.instruments.searchInstruments(InstrumentSearchInstrumentsParams { q, asset_class, country, 5 more } query, RequestOptionsoptions?): InstrumentSearchInstrumentsResponse { data }
GET/v1/instruments/search
Get Option Contracts
client.v1.instruments.getOptionContracts(InstrumentGetOptionContractsParams { contract_type, expiry, page_size, 3 more } query?, RequestOptionsoptions?): InstrumentGetOptionContractsResponse { data }
GET/v1/instruments/options/contracts
ModelsExpand Collapse
ContractType = "CALL" | "PUT"

The type of options contract

One of the following:
"CALL"
"PUT"
ExerciseStyle = "AMERICAN" | "EUROPEAN"

The exercise style of an options contract

One of the following:
"AMERICAN"
"EUROPEAN"
Instrument { id, country_of_issue, currency, 19 more }

Represents a tradable financial instrument.

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

InstrumentCore { id, country_of_issue, currency, 18 more }
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.

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

InstrumentCoreList = Array<InstrumentCore { id, country_of_issue, currency, 18 more } >
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.

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

ListingType = "STANDARD" | "FLEX" | "OTC"

The listing type of an options contract

One of the following:
"STANDARD"
"FLEX"
"OTC"
OptionsContract { id, contract_type, currency, 12 more }

An options contract with options-specific metadata

id: string

OEMS instrument identifier

formatuuid
contract_type: ContractType

Whether this is a CALL or PUT

One of the following:
"CALL"
"PUT"
currency: string

ISO currency code

exchange: string

MIC code of the primary listing venue

exercise_style: ExerciseStyle

Exercise style

One of the following:
"AMERICAN"
"EUROPEAN"
expiry: string

Expiration date

formatdate
is_liquidation_only: boolean

Whether the contract is liquidation-only

is_marginable: boolean

Whether the contract is marginable

is_restricted: boolean

Whether the contract is restricted from trading

listing_type: ListingType

Listing type

One of the following:
"STANDARD"
"FLEX"
"OTC"
multiplier: string

Contract multiplier (100 for standard options)

strike_price: string

Strike price

symbol: string

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

open_interest?: number | null

Open interest (number of outstanding contracts), if available

formatint64
underlying_instrument_id?: string | null

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid
OptionsContractList = Array<OptionsContract { id, contract_type, currency, 12 more } >
id: string

OEMS instrument identifier

formatuuid
contract_type: ContractType

Whether this is a CALL or PUT

One of the following:
"CALL"
"PUT"
currency: string

ISO currency code

exchange: string

MIC code of the primary listing venue

exercise_style: ExerciseStyle

Exercise style

One of the following:
"AMERICAN"
"EUROPEAN"
expiry: string

Expiration date

formatdate
is_liquidation_only: boolean

Whether the contract is liquidation-only

is_marginable: boolean

Whether the contract is marginable

is_restricted: boolean

Whether the contract is restricted from trading

listing_type: ListingType

Listing type

One of the following:
"STANDARD"
"FLEX"
"OTC"
multiplier: string

Contract multiplier (100 for standard options)

strike_price: string

Strike price

symbol: string

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

open_interest?: number | null

Open interest (number of outstanding contracts), if available

formatint64
underlying_instrument_id?: string | null

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid
InstrumentGetInstrumentsResponse extends BaseResponse { metadata, error } { data }
data: InstrumentCoreList { id, country_of_issue, currency, 18 more }
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.

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

InstrumentGetInstrumentByIDResponse extends BaseResponse { metadata, error } { data }
data: Instrument { id, country_of_issue, currency, 19 more }

Represents a tradable financial instrument.

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

InstrumentSearchInstrumentsResponse extends BaseResponse { metadata, error } { data }
data: InstrumentCoreList { id, country_of_issue, currency, 18 more }
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.

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

InstrumentGetOptionContractsResponse extends BaseResponse { metadata, error } { data }
data: OptionsContractList { id, contract_type, currency, 12 more }
id: string

OEMS instrument identifier

formatuuid
contract_type: ContractType

Whether this is a CALL or PUT

One of the following:
"CALL"
"PUT"
currency: string

ISO currency code

exchange: string

MIC code of the primary listing venue

exercise_style: ExerciseStyle

Exercise style

One of the following:
"AMERICAN"
"EUROPEAN"
expiry: string

Expiration date

formatdate
is_liquidation_only: boolean

Whether the contract is liquidation-only

is_marginable: boolean

Whether the contract is marginable

is_restricted: boolean

Whether the contract is restricted from trading

listing_type: ListingType

Listing type

One of the following:
"STANDARD"
"FLEX"
"OTC"
multiplier: string

Contract multiplier (100 for standard options)

strike_price: string

Strike price

symbol: string

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

open_interest?: number | null

Open interest (number of outstanding contracts), if available

formatint64
underlying_instrument_id?: string | null

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid