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
Account Details

Get account portfolio v2

Retrieve an account portfolio details snapshot

Retrieves a snapshot of a specified account’s portfolio, including positions, equity breakdown, buying power, and open orders. The account must exist and belong to the authenticated client.

GET/userapigateway/trading/{accountId}/portfolio/v2

Parameters

Path Parameters

string

Parameters

NameTypeRequiredDescription
accountIdstringYes-

Body

application/json

No request body defined

Responses

Response

200
application/json
accountIdstringrequired

Id of the account

accountTypeenum<string>required

Type of the account

Available options: BROKERAGE,HIGH_YIELD,BOND_ACCOUNT,RIA_ASSET,TREASURY,TRADITIONAL_IRA,ROTH_IRA
buyingPowerrequired
equityobject[]required

List of equity summaries

positionsobject[]required

List of positions

ordersobject[]required

Response

404
application/json
accountIdstringrequired

Id of the account

accountTypeenum<string>required

Type of the account

Available options: BROKERAGE,HIGH_YIELD,BOND_ACCOUNT,RIA_ASSET,TREASURY,TRADITIONAL_IRA,ROTH_IRA
buyingPowerrequired
equityobject[]required

List of equity summaries

positionsobject[]required

List of positions

ordersobject[]required
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
{
  "accountId": "string",
  "accountType": "BROKERAGE",
  "buyingPower": {
    "cashOnlyBuyingPower": "string",
    "buyingPower": "string",
    "optionsBuyingPower": "string"
  },
  "equity": [
    {
      "type": "CASH",
      "value": "string",
      "percentageOfPortfolio": "string"
    }
  ],
  "positions": [
    {
      "instrument": {
        "symbol": "string",
        "name": "string",
        "type": "EQUITY"
      },
      "quantity": "string",
      "openedAt": "2023-11-07T05:31:56Z",
      "currentValue": "string",
      "percentOfPortfolio": "string",
      "lastPrice": {
        "lastPrice": "string",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "instrumentGain": {
        "gainValue": "string",
        "gainPercentage": "string",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "positionDailyGain": {
        "gainValue": "string",
        "gainPercentage": "string",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "costBasis": {
        "totalCost": "string",
        "unitCost": "string",
        "gainValue": "string",
        "gainPercentage": "string",
        "lastUpdate": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "orders": [
    {
      "orderId": "7141730d-edbf-4fdf-843b-29bb5641c190",
      "instrument": {
        "symbol": "string",
        "type": "EQUITY"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "type": "MARKET",
      "side": "BUY",
      "status": "NEW",
      "quantity": "string",
      "notionalValue": "string",
      "expiration": {
        "timeInForce": "DAY",
        "expirationTime": "2023-11-07T05:31:56Z"
      },
      "limitPrice": "string",
      "stopPrice": "string",
      "closedAt": "2023-11-07T05:31:56Z",
      "openCloseIndicator": "OPEN",
      "filledQuantity": "string",
      "averagePrice": "string",
      "legs": [
        {
          "instrument": {
            "symbol": "string",
            "type": "EQUITY"
          },
          "side": "BUY",
          "openCloseIndicator": "OPEN",
          "ratioQuantity": 123
        }
      ],
      "rejectReason": "string"
    }
  ]
}
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