IBKR 3rd Party Web API

Tools (18)

Extracted live via the executor SDK.

• accountPortfolio.getAccounts

  Allows the caller to request a list of accounts associated with the session.

• accountPortfolio.getAccountsAccountPositions

  Returns a list of positions for the indicated account.

• accountPortfolio.getAccountsAccountSummary

  Returns a list of account and margin balances associated with the account passed in the URL

• financialInstrumentDefinitions.getSecdef

  Fields that compose security definition. Allowed combinations, (1) type and symbol and currency, or (2) type, symbol, exchange, and currency, or (3) conid

• marketData.getMarketdataExchangeComponents

  This endpoint provides a bit mapping for the bid/ask/last 'market' values in the snapshot response.

• marketData.getMarketdataSnapshot

  This endpoint allows the consumer to request a market data snapshot for one or more trading products. Consumers need to provide unique identifiers (conids) for the products in the IB product database (retrievable using the /secdef endpoint). The 'market' values are integers whose bits indicate the exchange(s) making up the quote.

  The mapping of bit to exchange is obtained from the marketdata/exchange_component endpoint. For example, if a bid has a 'market' value of 5 and the exchange_component result has the map 0 => NYSE, 1 => ISLAND, 2 => ARCA then the exchanges contributing to the bid size are NYSE and ARCA.

  Similarly, if market=2, then only ISLAND is contributing.

• oAuth.postOauthAccessToken

  Obtain an access token using the request token and the verification code you received after the user provided authorization. See section 6.3 of the OAuth v1.0a specification for more details.

• oAuth.postOauthLiveSessionToken

  In order to access protected IB resources, a live session token is required. This endpoint allows consumers to obtain a live session token to access these resources using an OAuth access token and the Diffie-Hellman prime and generator supplied during the registration process. Note this is an additional IB-specific step, and not part of the OAuth v1.0a specification. Please refer to the "OAuth at Interactive Brokers" document for more details. https://www.interactivebrokers.com/webtradingapi/oauth.pdf

• oAuth.postOauthRequestToken

  Obtain a request token. See section 6.1 of the OAuth v1.0a specification for more information. http://oauth.net/core/1.0a/#auth_step1

  Note we do not return an oauth_token_secret in the response as we are using RSA signatures rather than PLAINTEXT authentication.

• orderMarginRequirements.postAccountsAccountOrderImpact

  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.

• orders.deleteAccountsAccountOrdersCustomerOrderId

  Cancels the order with the referenced Customer Order ID for the account passed in the URL.

• orders.getAccountsAccountOrders

  Returns a list of orders for the account passed in the URL

• orders.getAccountsAccountOrdersCustomerOrderId

  Returns the order with the referenced Customer Order ID for the account passed in the URL.

• orders.postAccountsAccountOrders

  Places order

• orders.putAccountsAccountOrdersCustomerOrderId

  Allows the caller to modify the order with the referenced Customer Order ID specified in the URL. A separate Customer Order ID must be provided in the request body for the modification.

• trades.getAccountsAccountTrades

  Returns a list of trades for the account starting at the given 'since' date to the current time (now()). Timezone is UTC. Any request with a future since date or going further than one week will result in an HTTP 400 bad request response. Calling /trades without since will return all trades for the past 24 hours.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools