CLclear-street
Instruments

Get instrument

Changed on

Get an instrument by the given symbol

get/instruments/{symbol}

Request

  • Base URL
    https://api.clearstreet.io/studio/v2
  • Auth
    HTTP bearer

Path parameters

symbolstring required
Example:AAPL

The symbol for the instrument.

Query parameters

symbol_format'cms' | 'osi'

Denotes the format of the provided symbol field.

The format of the provided symbol.

Response

Successful response containing the associated instrument.

asset_class'other' | 'currency' | 'equity' | 'option' | 'debt' | 'fund' required

The asset class of the symbol.

primary_exchangestring required

The primary exchange for the instrument.

descriptionstring required

A description of the instrument.

Example response

{
  "symbols": [
    {
      "symbol": "AAPL"
    }
  ],
  "primary_exchange": "NASDAQ",
  "description": "Apple Inc."
}

Changes

  • 468b5da24bbfRevision changes
    • warning

      added the new currency enum value to the response property for the response status

    • warning

      added the new fund enum value to the response property for the response status