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

GET/v1/instruments

Get Instrument By ID

GET/v1/instruments/{instrument_id}

Search Instruments

GET/v1/instruments/search

Get Option Contracts

GET/v1/instruments/options/contracts

ModelsExpand Collapse

ContractType = "CALL" or "PUT"

The type of options contract

One of the following:

"CALL"

"PUT"

ExerciseStyle = "AMERICAN" or "EUROPEAN"

The exercise style of an options contract

One of the following:

"AMERICAN"

"EUROPEAN"

Instrument object { 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: optional string

Average daily share volume from the security definition.

expiry: optional string

The expiration date for options instruments

formatdate

instrument_type: optional SecurityType

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

One of the following:

"COMMON_STOCK"

"PREFERRED_STOCK"

"OPTION"

"CASH"

"OTHER"

long_margin_rate: optional string

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

name: optional string

The full name of the instrument or its issuer

notional_adv: optional string

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

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

previous_close: optional string

Last close price from the security definition.

short_margin_rate: optional string

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

strike_price: optional string

The strike price for options instruments

InstrumentCore object { 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: optional string

Average daily share volume from the security definition.

expiry: optional string

The expiration date for options instruments

formatdate

instrument_type: optional SecurityType

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

One of the following:

"COMMON_STOCK"

"PREFERRED_STOCK"

"OPTION"

"CASH"

"OTHER"

long_margin_rate: optional string

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

name: optional string

The full name of the instrument or its issuer

notional_adv: optional string

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

Last close price from the security definition.

short_margin_rate: optional string

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

strike_price: optional string

The strike price for options instruments

InstrumentCoreList = array of 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: optional string

Average daily share volume from the security definition.

expiry: optional string

The expiration date for options instruments

formatdate

instrument_type: optional SecurityType

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

One of the following:

"COMMON_STOCK"

"PREFERRED_STOCK"

"OPTION"

"CASH"

"OTHER"

long_margin_rate: optional string

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

name: optional string

The full name of the instrument or its issuer

notional_adv: optional string

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

Last close price from the security definition.

short_margin_rate: optional string

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

strike_price: optional string

The strike price for options instruments

ListingType = "STANDARD" or "FLEX" or "OTC"

The listing type of an options contract

One of the following:

"STANDARD"

"FLEX"

"OTC"

OptionsContract object { 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: optional number

Open interest (number of outstanding contracts), if available

formatint64

underlying_instrument_id: optional string

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid

OptionsContractList = array of 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: optional number

Open interest (number of outstanding contracts), if available

formatint64

underlying_instrument_id: optional string

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid

InstrumentGetInstrumentsResponse = BaseResponse { metadata, error }

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

Average daily share volume from the security definition.

expiry: optional string

The expiration date for options instruments

formatdate

instrument_type: optional SecurityType

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

One of the following:

"COMMON_STOCK"

"PREFERRED_STOCK"

"OPTION"

"CASH"

"OTHER"

long_margin_rate: optional string

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

name: optional string

The full name of the instrument or its issuer

notional_adv: optional string

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

Last close price from the security definition.

short_margin_rate: optional string

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

strike_price: optional string

The strike price for options instruments

InstrumentGetInstrumentByIDResponse = BaseResponse { metadata, error }

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

Average daily share volume from the security definition.

expiry: optional string

The expiration date for options instruments

formatdate

instrument_type: optional SecurityType

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

One of the following:

"COMMON_STOCK"

"PREFERRED_STOCK"

"OPTION"

"CASH"

"OTHER"

long_margin_rate: optional string

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

name: optional string

The full name of the instrument or its issuer

notional_adv: optional string

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

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

previous_close: optional string

Last close price from the security definition.

short_margin_rate: optional string

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

strike_price: optional string

The strike price for options instruments

InstrumentSearchInstrumentsResponse = BaseResponse { metadata, error }

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

Average daily share volume from the security definition.

expiry: optional string

The expiration date for options instruments

formatdate

instrument_type: optional SecurityType

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

One of the following:

"COMMON_STOCK"

"PREFERRED_STOCK"

"OPTION"

"CASH"

"OTHER"

long_margin_rate: optional string

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

name: optional string

The full name of the instrument or its issuer

notional_adv: optional string

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

Last close price from the security definition.

short_margin_rate: optional string

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

strike_price: optional string

The strike price for options instruments

InstrumentGetOptionContractsResponse = BaseResponse { metadata, error }

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

Open interest (number of outstanding contracts), if available

formatint64

underlying_instrument_id: optional string

OEMS instrument ID of the underlying instrument, if resolvable

formatuuid