Get details on a particular instrument
The Instrument Prospectus is not a direct link, the Partner may provide the "url" listed in the API response, this will take the Customer to the Investor Relations web page, which will contain the Prospectus or links to it
Results Explained
Attribute | Type | Description |
|---|---|---|
| string | Instrument identifier |
| string | Instrument symbol |
| string | Instrument official name |
`description | string | Instrument description in English |
| string | Instrument's sector |
| boolean | Ability to short instrument. Default is |
| number | Maximum share amount for any order of this instrument |
| number | Minimum share amount for any order of this instrument |
| number | Increment amount on order of this instrument |
| boolean | If |
| number | Closing price of instrument |
| string | Instrument description in Chinese (if available) |
| string | Instrument identifier |
| string | Type of instrument - values include: ETF, EQUITY, ADR, ETN, ALTERNATIVE_ASSET |
| string | Instrument's exchange. |
| string | Instruments investor relations URL |
| string | Instrument status. Reference Instrument Statuses for options |
| number | If present, number will show percentage that an exchange call will be triggered. Otherwise, standard exchange call percentage will be used |
| number | If present, number will show percentage that an house call will be triggered. Otherwise, standard house call percentage will be used |
| number | Instrument closing price of prior trading day |
| string | Instrument's logo |
| string | instrument identifier |
| string | symbol |
| string | company name |
| number | open price |
| number | bid price |
| number | ask price |
| number | low price |
| number | high price |
| number | 52-week low |
| number | 52-week high |
| number | total cumulative volume |
| number | market cap |
| number | PE Ratio |
| number | dividend yield |
| number | earning per share (EPS) |
| number | dividend |
| number | shares outstanding |
| string | last time data was updated |
| string | book value per share |
| string | cash flow per share |
| string | operating income |
| string | pb ratio |
| number | 10 day moving average |
| number | 25 day moving average |
| number | 50 day moving average |
| number | 150 day moving average |
| number | 200 day moving average |
| string | ROA |
Instrument ID Difference in UAT and Production
The
instrumentIDvalues are different between UAT and Production environments. Best practice is not to cache theinstrumentID.