API

Get Started

WelcomeQuickstartExamplesChangelogSDKs and Tools

Authorization

POSTCreate personal access token

List Accounts

GETGet accounts

Account Details

GETGet account portfolio v2GETGet history

Instrument Details

GETGet all instrumentsGETGet instrument

Market Data

POSTGet quotesPOSTGet option expirationsPOSTGet option chain

Order Placement

POSTPreflight single legPOSTPreflight multi legPOSTPlace orderPOSTPlace multileg orderGETGet orderDELETECancel order

Option Details

GETGet option greeks_1
HelpFeedback
Instrument Details

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.

GET/userapigateway/trading/instruments

Parameters

Query Parameters

array

optional set of security types to filter by ([GatewaySecurityType])

array

optional set of trading statuses to filter by ([ApiInstrumentDto.Trading])

array

optional set of fractional trading statuses to filter by ([ApiInstrumentDto.Trading])

array

optional set of option trading statuses to filter by ([ApiInstrumentDto.Trading])

array

optional set of option spread trading statuses to filter by ([ApiInstrumentDto.Trading])

Parameters

NameTypeRequiredDescription
typeFilterarrayNooptional set of security types to filter by ([GatewaySecurityType])
tradingFilterarrayNooptional set of trading statuses to filter by ([ApiInstrumentDto.Trading])
fractionalTradingFilterarrayNooptional set of fractional trading statuses to filter by ([ApiInstrumentDto.Trading])
optionTradingFilterarrayNooptional set of option trading statuses to filter by ([ApiInstrumentDto.Trading])
optionSpreadTradingFilterarrayNooptional set of option spread trading statuses to filter by ([ApiInstrumentDto.Trading])

Body

application/json

No request body defined

Responses

Response

200
application/json
instrumentsobject[]
The Public Individual API is for your own personal, non-commercial use. Unauthorized access is prohibited. You are responsible for all trades made via the API. Learn more
{
  "instruments": [
    {
      "instrument": {
        "symbol": "string",
        "type": "EQUITY"
      },
      "trading": "BUY_AND_SELL",
      "fractionalTrading": "BUY_AND_SELL",
      "optionTrading": "BUY_AND_SELL",
      "optionSpreadTrading": "BUY_AND_SELL",
      "instrumentDetails": null
    }
  ]
}
The Public Individual API is for your own personal, non-commercial use. Unauthorized access is prohibited. You are responsible for all trades made via the API. Learn more