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
Market Data

Get option chain

Retrieve option chain

Returns the option chain for a given instrument. Requires the `marketdata` scope. Supported types: EQUITY, UNDERLYING_SECURITY_FOR_INDEX_OPTION.

POST/userapigateway/marketdata/{accountId}/option-chain

Parameters

Path Parameters

string

Request body

Required*

Parameters

NameTypeRequiredDescription
accountIdstringYes-

Body

application/json

Request Body

application/json
instrumentrequired
expirationDatestringrequired

The expiration date of the option chain.

Responses

Response

200
application/json
baseSymbolstringrequired

The base symbol for which the option chain belongs.

callsobject[]required

List of call quotes for the given option chain.

putsobject[]required

List of put quotes for the given option chain.

Response

400application/json

Invalid input: unsupported instrument type, nonexistent instrument, invalid account, or unauthorized access.

No response body defined

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
{
  "baseSymbol": "string",
  "calls": [
    {
      "instrument": {
        "symbol": "string",
        "type": "EQUITY"
      },
      "outcome": "SUCCESS",
      "last": "string",
      "lastTimestamp": "2023-11-07T05:31:56Z",
      "bid": "string",
      "bidSize": 123,
      "bidTimestamp": "2023-11-07T05:31:56Z",
      "ask": "string",
      "askSize": 123,
      "askTimestamp": "2023-11-07T05:31:56Z",
      "volume": 1234567890,
      "openInterest": 1234567890
    }
  ],
  "puts": [
    {
      "instrument": {
        "symbol": "string",
        "type": "EQUITY"
      },
      "outcome": "SUCCESS",
      "last": "string",
      "lastTimestamp": "2023-11-07T05:31:56Z",
      "bid": "string",
      "bidSize": 123,
      "bidTimestamp": "2023-11-07T05:31:56Z",
      "ask": "string",
      "askSize": 123,
      "askTimestamp": "2023-11-07T05:31:56Z",
      "volume": 1234567890,
      "openInterest": 1234567890
    }
  ]
}
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