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
Order Placement

Preflight single leg

Calculates the estimated financial impact of a potential trade before execution

Performs preflight calculations for a single-leg order (a transaction involving a single security) to provide comprehensive cost estimates and account impact details. Returns estimated commission, regulatory fees, order value, buying power requirements, margin impact, and other trade-specific information to help users make informed trading decisions before order placement. Note that these are estimates only, and actual execution values may vary depending on market conditions. This endpoint may be called before submitting an actual order to understand the potential financial implications.

POST/userapigateway/trading/{accountId}/preflight/single-leg

Parameters

Path Parameters

string

Request body

Required*

Parameters

NameTypeRequiredDescription
accountIdstringYes-

Body

application/json

Request Body

application/json
instrumentrequired
orderSideenum<string>required

The Order Side BUY/SELL. For Options also include the openCloseIndicator

Available options: BUY,SELL
orderTypeenum<string>required

The Type of order

Available options: MARKET,LIMIT,STOP,STOP_LIMIT
expirationrequired
quantitystring

The order quantity. Used when buying/selling whole shares and when selling fractional. Mutually exclusive with `amount`

amountstring

The order amount. Used when buying/selling shares for a specific notional value

limitPricestring

The limit price. Used when orderType = LIMIT or orderType = STOP_LIMIT

stopPricestring

The stop price. Used when orderType = STOP or orderType = STOP_LIMIT

equityMarketSessionenum<string>

The market session in which the order may execute. Extended hours are available only for DAY time-in-force equity orders and can execute any time from 4:00 a.m. ET through 8:00 p.m. ET. If omitted, the session defaults to CORE.

Available options: CORE,EXTENDED
openCloseIndicatorenum<string>

Used for options only. Indicates if this is BUY to OPEN/CLOSE

Available options: OPEN,CLOSE

Responses

Response

200
application/json
instrumentrequired
cusipstring
rootSymbolstring
rootOptionSymbolstring
estimatedCommissionstring
regulatoryFees

# GatewayRegulatoryFees Represents various regulatory fees associated with trading orders. <br/> ## Fields - **secFee** - The SEC charges a regulatory fee for sell orders that execute. The fee is based on the dollar amount of the order. - **tafFee** - The Trading Activity Fee is a FINRA fee. The fee is based on the order quantity. - **orfFee** - The Options Regulatory Fee (ORF). This is the combined exchange fee rate for all exchanges. Changes monthly. - **exchangeFee** - The exchange charges a fee for executing orders for index options. - **occFee** - The Options Clearing Corporation Fee (OCC) - **catFee** - The Consolidated Audit Trail Fee (CAT)

estimatedIndexOptionFeestring
estimatedExecutionFeestring
orderValuestringrequired
estimatedQuantitystring
estimatedCoststring
buyingPowerRequirementstring
estimatedProceedsstring
optionDetails
estimatedOrderRebate
marginRequirement
marginImpact
priceIncrement

Price increment information for option orders.

Response

400application/json

Invalid request parameters or account validation failure

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
{
  "instrument": {
    "symbol": "string",
    "type": "EQUITY"
  },
  "cusip": "string",
  "rootSymbol": "string",
  "rootOptionSymbol": "string",
  "estimatedCommission": "string",
  "regulatoryFees": {
    "secFee": "string",
    "tafFee": "string",
    "orfFee": "string",
    "exchangeFee": "string",
    "occFee": "string",
    "catFee": "string"
  },
  "estimatedIndexOptionFee": "string",
  "estimatedExecutionFee": "string",
  "orderValue": "string",
  "estimatedQuantity": "string",
  "estimatedCost": "string",
  "buyingPowerRequirement": "string",
  "estimatedProceeds": "string",
  "optionDetails": {
    "baseSymbol": "string",
    "type": "CALL",
    "strikePrice": "string",
    "optionExpireDate": "2023-11-07"
  },
  "estimatedOrderRebate": {
    "estimatedOptionRebate": "string",
    "optionRebatePercent": 123,
    "perContractRebate": "string"
  },
  "marginRequirement": {
    "longMaintenanceRequirement": "string",
    "longInitialRequirement": "string"
  },
  "marginImpact": {
    "marginUsageImpact": "string",
    "initialMarginRequirement": "string"
  },
  "priceIncrement": {
    "incrementBelow3": "string",
    "incrementAbove3": "string",
    "currentIncrement": "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