Preview Order
/accounts/{accountId}/previewOrderPreview an order before submission. Returns a confirmId and structured confirmation details. Use this to validate the order, check for sufficient buying power, calculate fees and show the validation results to the human. The human can then decline or proceed with order placement, in this case pass confirmId to Place Order to submit.
Path Parameters
The account identifier.
Body Parameters
Security symbol. Example: AAPL.
Order direction.
Order type.
Whether the order size is specified by quantity or notional amount.
Asset class.
Order time-in-force.
Trading session.
Order quantity. Required when quantityType is qty.
Order notional amount. Required when quantityType is amount.
Limit price. Required for limit and stopLimit order types.
Stop trigger price. Required for stop and stopLimit order types.
Position direction.
Take-profit leg.
Stop-loss leg.
Request Example
{
"instrument": "BAC",
"side": "buy",
"type": "limit",
"quantityType": "qty",
"qty": "100",
"limitPrice": "30.0",
"category": "stock",
"durationType": "day",
"extendHours": "reg"
}Response
Preview generated successfully.
Status indicator. ok on success.
Error message if the preview could not be generated.
Confirmation token to pass back as confirmId when calling Place Order.
Informational sections to display to the user before order submission.
Section heading.
Warning messages for the section.
Error messages for the section.
Response
Error response.
Error code string, e.g. invalid_grant.
Human-readable error message.
Response Example
{
"s": "ok",
"d": {
"confirmId": "0000001",
"sections": [
{
"header": "Estimated",
"rows": [
{
"label": "Estimated Cost",
"value": "$1,000.00"
}
],
"warnings": [
"A warning is some message that should be shown to the user, but not necessarily preventing from executing the order."
],
"errors": [
"The order can not be executed right now because of errors specified here."
]
}
]
}
}