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.
Parameters
Path Parameters
Request body
Required*Parameters
Name | Type | Required | Description |
---|---|---|---|
accountId | string | Yes | - |
Body
application/jsonRequest Body
The Order Side BUY/SELL. For Options also include the openCloseIndicator
BUY
,SELL
The Type of order
MARKET
,LIMIT
,STOP
,STOP_LIMIT
The order quantity. Used when buying/selling whole shares and when selling fractional. Mutually exclusive with `amount`
The order amount. Used when buying/selling shares for a specific notional value
The limit price. Used when orderType = LIMIT or orderType = STOP_LIMIT
The stop price. Used when orderType = STOP or orderType = STOP_LIMIT
Used for options only. Indicates if this is BUY to OPEN/CLOSE
OPEN
,CLOSE
Responses
Response
# 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)
Price increment information for option orders.
Response
Invalid request parameters or account validation failure
No response body defined
curl --request POST \
--url https://api.public.com/userapigateway/trading/{accountId}/preflight/single-leg \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"instrument": {
"symbol": "string",
"type": "EQUITY"
},
"orderSide": "BUY",
"orderType": "MARKET",
"expiration": {
"timeInForce": "DAY",
"expirationTime": "2023-11-07T05:31:56Z"
},
"quantity": "string",
"amount": "string",
"limitPrice": "string",
"stopPrice": "string",
"openCloseIndicator": "OPEN"
}'
{
"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",
"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"
}
}