StudioOlympus
API Reference

Get instrument

get
https://api.clearstreet.io/studio/v2/instruments/

Get an instrument by the given symbol

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 32

The symbol for the instrument.

Query Params
string
enum
Defaults to cms

Denotes the format of the provided symbol field.

  • cms: CMS symbology for US equities, e.g. AAPL.
  • osi: OSI symbology for options, e.g. AAPL 260918C00310000.
  • composite: Composite symbology for international (non-US) equities, in the format <ticker>:<iso_country>:<iso_currency>, where iso_country is the ISO 3166-1 alpha-2 listing country and iso_currency is the ISO 4217 settlement currency. For example SHEL:GB:GBP for a share listed in Great Britain (GB) and settled in British pounds (GBP).
Allowed:
Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago

Did this page help you?