Interactivebrokers

IBKR 3rd Party Web API

Interactive Brokers Web API for 3rd Party Companies

Finance & banking#openapi#financial

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Interactive Brokers Web API for 3rd Party Companies

Endpoints 16

Account & Portfolio

  • GETBrokerage Accounts/accounts?account=stringAllows the caller to request a list of accounts associated with the session.
  • GETAccount Positions/accounts/:account/positionsReturns a list of positions for the indicated account.
  • GETAccount Values Summary/accounts/:account/summaryReturns a list of account and margin balances associated with the account passed in the URL

Order Margin Requirements

  • POSTReturn margin impact info/accounts/:account/order_impactThis endpoint allows the consumer to check the impact that an order would have on the account, including margin, NLV and estimated commission costs. To…

Orders

  • GETOpen Orders/accounts/:account/ordersReturns a list of orders for the account passed in the URL
  • POSTPlace Order/accounts/:account/ordersPlaces order
  • GETReturn specific order info/accounts/:account/orders/:CustomerOrderIdReturns the order with the referenced Customer Order ID for the account passed in the URL.
  • PUTModify Order/accounts/:account/orders/:CustomerOrderIdAllows 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…
  • DELETECancel Order/accounts/:account/orders/:CustomerOrderIdCancels the order with the referenced Customer Order ID for the account passed in the URL.

Trades

  • GETReturns trades in account/accounts/:account/tradesReturns 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…

Market Data

  • GETExchange Components/marketdata/exchange_componentsThis endpoint provides a bit mapping for the bid/ask/last 'market' values in the snapshot response.
  • GETMarket Data Snapshot/marketdata/snapshotThis endpoint allows the consumer to request a market data snapshot for one or more trading products. Consumers need to provide unique identifiers (conids)…

OAuth

  • POSTObtain a access token/oauth/access_tokenObtain 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…
  • POSTObtain a live session token/oauth/live_session_tokenIn 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…
  • POSTObtain a request token/oauth/request_tokenObtain 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…

Financial Instrument Definitions

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

API details

Base URL
https://www.interactivebrokers.com/tradingapi/v1
Authentication
An API key in the portal header
Operations
16 operations on 13 pathsGET 9POST 5PUT 1DELETE 1
Main resources
Orders 5Account & Portfolio 3OAuth 3Market Data 2Financial Instrument Definitions 1Order Margin Requirements 1Trades 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the IBKR 3rd Party Web API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the IBKR 3rd Party Web API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the portal header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Brokerage Accounts” (GET /accounts?account=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the IBKR 3rd Party Web API?

Interactive Brokers Web API for 3rd Party Companies It is listed under Finance & banking and has 16 endpoints.

Who publishes the IBKR 3rd Party Web API?

It is listed from Interactivebrokers's public API description (an OpenAPI document), not published by Interactivebrokers on Swastik Codes. Anyone who controls interactivebrokers.com can claim the profile by adding a DNS TXT record.

What is the base URL of the IBKR 3rd Party Web API?

Requests go to https://www.interactivebrokers.com/tradingapi/v1. Endpoint paths are added to this base URL.

How do I authenticate with the IBKR 3rd Party Web API?

With an API key in the portal header.

How many endpoints does the IBKR 3rd Party Web API have?

16 operations on 13 paths (9 GET, 5 POST, 1 PUT, 1 DELETE). The largest groups are Orders, Account & Portfolio, OAuth, Market Data.

Is forking the IBKR 3rd Party Web API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.