Get all instruments
Retrieves all available trading instruments with optional filtering capabilities.
Retrieves all available trading instruments with optional filtering capabilities. This endpoint returns a comprehensive list of instruments available for trading, with support for filtering by security type and various trading capabilities. All filter parameters are optional and can be combined to narrow down results.
Parameters
Query Parameters
optional set of security types to filter by ([GatewaySecurityType])
optional set of trading statuses to filter by ([ApiInstrumentDto.Trading])
optional set of fractional trading statuses to filter by ([ApiInstrumentDto.Trading])
optional set of option trading statuses to filter by ([ApiInstrumentDto.Trading])
optional set of option spread trading statuses to filter by ([ApiInstrumentDto.Trading])
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| typeFilter | array | No | optional set of security types to filter by ([GatewaySecurityType]) |
| tradingFilter | array | No | optional set of trading statuses to filter by ([ApiInstrumentDto.Trading]) |
| fractionalTradingFilter | array | No | optional set of fractional trading statuses to filter by ([ApiInstrumentDto.Trading]) |
| optionTradingFilter | array | No | optional set of option trading statuses to filter by ([ApiInstrumentDto.Trading]) |
| optionSpreadTradingFilter | array | No | optional set of option spread trading statuses to filter by ([ApiInstrumentDto.Trading]) |
Body
application/jsonNo request body defined
Responses
Response
curl --request GET \
--url https://api.public.com/userapigateway/trading/instruments \
--header 'Authorization: Bearer YOUR_API_KEY'{
"instruments": [
{
"instrument": {
"symbol": "string",
"type": "EQUITY"
},
"trading": "BUY_AND_SELL",
"fractionalTrading": "BUY_AND_SELL",
"optionTrading": "BUY_AND_SELL",
"optionSpreadTrading": "BUY_AND_SELL"
}
]
}