New Order Preview

POST

/iserver/account/:accountId/orders/whatif

POST

/v1/api/iserver/account/:accountId/orders/whatif

$ curl -X POST https://api.ibkr.com/v1/api/iserver/account/DU123456/orders/whatif \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "amount": {
3     "amount": "1,977.60 USD (10 Shares)",
4     "commission": "1 USD",
5     "total": "1,978.60 USD"
6   },
7   "equity": {
8     "current": "123,456",
9     "change": "-1",
10     "after": "123,455"
11   },
12   "initial": {
13     "current": "1000",
14     "change": "652",
15     "after": "1652"
16   },
17   "maintenance": {
18     "current": "900",
19     "change": "590\"\"",
20     "after": "1490"
21   },
22   "position": {
23     "current": "20",
24     "change": "10",
25     "after": "30"
26   },
27   "warn": "21/You are trying to submit an order without having market data for this instrument. \nIB strongly recommends against this kind of blind trading which may result in \nerroreous or unexpected trades.",
28   "error": null
29 }

Preview the projected effects of an order ticket or bracket of orders, including cost and changes to margin and account equity.

Path parameters

accountIdstringRequired

The account to which the order will clear.

Request

This endpoint expects an object.

orderslist of objectsOptional

Array of order tickets objects. Only one order ticket object may be submitted per request, unless constructing a bracket.

Response

Order Preview

amountobjectOptional

Describes the projected costs associated with the order ticket.

equityobjectOptional

Describes the projected change to the account's equity.

initialobjectOptional

Describes the projected change to initial margin.

maintenanceobjectOptional

Describes the projected change to maintenance margin.

positionobjectOptional

Describes the projected change to the account's position in the instrument.

warnstringOptional

Human-readable text of warning message, if applicable. Otherwise null.

errorstring or nullOptional

Human-readable text of an error message, if applicable. Otherwise null.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error