This endpoint allows the consumer to check the impact that an order would have on the account, including margin, NLV and estimated commission costs. To specify the contract, you provide a value for the ContractId field, OR Ticker/ListingExchange/InstrumentType=STK for stocks OR Ticker/Currency/InstrumentType=CASH for FX.
643 matches
13 actions
IBKR 3rd Party Web
13 actions
- Account PositionsGETv1.0.0
- Account Values SummaryGETv1.0.0
- Brokerage AccountsGETv1.0.0
- Cancel OrderDELETEv1.0.0
- Exchange ComponentsGETv1.0.0
- Get security definitionGETv1.0.0
- Market Data SnapshotGETv1.0.0
- Modify OrderPUTv1.0.0
- Open OrdersGETv1.0.0
- Place OrderPOSTv1.0.0
- Return margin impact infoPOSTv1.0.0
- Return specific order infoGETv1.0.0
- Returns trades in accountGETv1.0.0
Finance/IBKR 3rd Party Web
Return margin impact info
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
{
"type": "object",
"properties": {
"Aux Price": {
"type": "number",
"description": "Required price to support Stop and Stop Limit orders"
},
"ContractId": {
"type": "number",
"description": "The internal IB identifier for the trading product specified as an integer (can be obtained in response to /secdef request)"
},
"Currency": {
"type": "string",
"description": "The currency in which the FX pair trades (only for InstrumentType=CASH)"
},
"CustomerOrderId": {
"type": "string",
"description": "The order ID assigned by the customer."
},
"InstrumentType": {
"type": "string",
"description": "The instrument type of the contract"
},
"ListingExchange": {
"type": "string",
"description": "The exchange on which the trading product is listed (only for InstrumentType=STK)"
},
"Order Type": {
"type": "number",
"description": "Market = '1'\nLimit = '2'\nStop = '3'\nStopLimit = '4'\n",
"enum": [
1,
2,
3,
4
]
},
"Price": {
"type": "number",
"description": "The order price"
},
"Quantity": {
"type": "number",
"description": "The number of units in the order; contracts or shares"
},
"Side": {
"type": "number",
"description": "Buy = '1', Sell = '2'",
"enum": [
1,
2
]
},
"Ticker": {
"type": "string",
"description": "The symbol that identifies the trading product"
},
"Time in Force": {
"type": "number",
"description": "Defines order's active lifetime.\nDay = '0'\nGTC (Good till Cancel) = '1'\nIOC (Immediate or Cancel) = '3'\nOpen = '2'\nClose = '7'\n",
"enum": [
0,
1,
2,
3,
7
]
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
{
"type": "object",
"properties": {
"Commission": {
"type": "number"
},
"CommissionsCurrency": {
"type": "string"
},
"EquityWithLoan": {
"type": "number"
},
"InitMargin": {
"type": "number"
},
"InitMarginBefore": {
"type": "number"
},
"MaintMargin": {
"type": "number"
},
"MaintMarginBefore": {
"type": "number"
},
"MarginCurrency": {
"type": "string"
},
"MaxCommissions": {
"type": "number"
},
"MinCommissions": {
"type": "number"
}
}
}