Instruments
Get Instruments
Retrieves a list of tradeable instruments.
get/v1/instruments
Query parameters
instrument_type'COMMON_STOCK' | 'INDEX' | 'OPTION' | 'CASH'
Security type
Filter by instrument type (e.g. COMMON_STOCK, OPTION)
Comma-separated instrument identifiers: unique identifiers or symbols (symbol for equities, OSI for options)
is_marginableboolean
Filter by marginable status
easy_to_borrowboolean
Filter by easy to borrow status
is_short_prohibitedboolean
Filter by short prohibited status
is_threshold_securityboolean
Filter by threshold security status
is_liquidation_onlyboolean
Filter by liquidation only status
is_ptpboolean
Filter by publicly traded partnership (PTP) status
page_sizeinteger
The number of items to return per page. Only used when page_token is not provided.
page_tokenstring byte
Base64URL-encoded pagination token
Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.
Response
List of instruments
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"
}
]
}