v57

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-07-2161198428.4 KB
Instruments

Get Instrument By ID

Retrieves detailed information for a specific instrument.

get/v1/instruments/{instrument_id}

Path parameters

string uuid required

Instrument identifier

OR
string required

Symbol (symbol for equities, OSI for options)

Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).

Query parameters

include_options_expiry_datesboolean nullable

When true, include unique options expiry dates for this instrument

Response

Instrument details

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "data": {
    "country_of_issue": "US",
    "currency": "USD",
    "easy_to_borrow": true,
    "id": "0f5a1a4e-5b3e-4d8f-9b7a-2b1d0e3f4a5b",
    "instrument_type": "COMMON_STOCK",
    "is_fractionable": false,
    "is_liquidation_only": false,
    "is_marginable": true,
    "is_ptp": false,
    "is_short_prohibited": false,
    "is_threshold_security": false,
    "is_tradable": true,
    "long_margin_rate": "0.25",
    "name": "Apple Inc.",
    "short_margin_rate": "0.25",
    "symbol": "AAPL",
    "venue": "XNMS"
  }
}