Instruments
Get Instrument By ID
Changed onRetrieves detailed information for a specific instrument.
get/v1/instruments/{instrument_id}
Request
- Base URLhttps://api.clearstreet.com
- AuthHTTP bearer
Path parameters
instrument_idstring required
Instrument identifier: either an instrument UUID or a symbol (symbol for equities, OSI for options). Non-UUID inputs are resolved server-side.
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"
},
"metadata": {
"page_number": 1,
"total_items": 42,
"total_pages": 5
},
"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"
}
}Changes
- info
added the optional property
///to the response with the status
- info
- info
added the optional property
///to the response with the status
- info