Get Instrument Details

Get details on a particular instrument

Results Explained

Attribute

Type

Description

symbol

string

Instrument identifier

reutersPrimaryRic

string

Instrument symbol

name

string

Instrument official name

`description

string

Instrument description in English

sector

string

Instrument's sector - values include: Energy, Materials, Industrials, Consumer Discretionary, Consumer Staples, Health Care, Financials, Technology, Communication, Utilities, Real Estate.

Further Info: https://www.msci.com/our-solutions/indexes/gics

longOnly

boolean

Ability to short instrument. Default is true

orderSizeMax

number

Maximum share amount for any order of this instrument

orderSizeMin

number

Minimum share amount for any order of this instrument

orderSizeStep

number

Increment amount on order of this instrument

exchangeNickelSpread

boolean

If true, limit order for this instrument must be in increments of $0.05

close

number

Closing price of instrument

descriptionChinese

string

Instrument description in Chinese (if available)

id

string

Instrument identifier

type

string

Type of instrument - values include: ETF, EQUITY, ADR, ETN, ALTERNATIVE_ASSET

exchange

string

Instrument's exchange.

url

string

Instruments investor relations URL

status

string

Instrument status. Reference Instrument Statuses for options

exchangeThresholdOverride

number

If present, number will show percentage that an exchange call will be triggered. Otherwise, standard exchange call percentage will be used

houseThresholdOverride

number

If present, number will show percentage that an house call will be triggered. Otherwise, standard house call percentage will be used

closePrior

number

Instrument closing price of prior trading day

image

string

Instrument's logo

🚧

Instrument ID Difference in UAT and Production

The instrumentID values are different between UAT and Production environments. Best practice is not to cache the instrumentID.

Language