v1

latestSwagger 2.02026-07-1316446.5 KB

Order Margin Requirements

Return margin impact info

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.

post/accounts/{account}/order_impact

Request body

CustomerOrderIdstring

The order ID assigned by the customer.

Tickerstring

The symbol that identifies the trading product

ListingExchangestring

The exchange on which the trading product is listed (only for InstrumentType=STK)

Currencystring

The currency in which the FX pair trades (only for InstrumentType=CASH)

InstrumentTypestring

The instrument type of the contract

ContractIdnumber

The internal IB identifier for the trading product specified as an integer (can be obtained in response to /secdef request)

Quantitynumber

The number of units in the order; contracts or shares

Pricenumber

The order price

Order Type1 | 2 | 3 | 4

Market = '1' Limit = '2' Stop = '3' StopLimit = '4'

Aux Pricenumber

Required price to support Stop and Stop Limit orders

Time in Force0 | 1 | 2 | 3 | 7

Defines order's active lifetime. Day = '0' GTC (Good till Cancel) = '1' IOC (Immediate or Cancel) = '3' Open = '2' Close = '7'

Side1 | 2

Buy = '1', Sell = '2'

Response

Order impact info

EquityWithLoannumber

InitMarginnumber

InitMarginBeforenumber

MaintMarginnumber

MaintMarginBeforenumber

MarginCurrencystring

Commissionnumber

MinCommissionsnumber

MaxCommissionsnumber

CommissionsCurrencystring