IBKR 3rd Party Web API API

by interactivebrokers.com

API keyHTTPSFinance

Overview

Interactive Brokers Web API for 3rd Party Companies

IBKR 3rd Party Web API is a finance API from interactivebrokers.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 16 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Finance
Base URL: https://www.interactivebrokers.com/tradingapi/v1
Version: 1.0.0
Endpoints: 16
OpenAPI: Specification ↗
Spec updated: 2021-07-19

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://www.interactivebrokers.com/tradingapi/v1/accounts" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("https://www.interactivebrokers.com/tradingapi/v1/accounts", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://www.interactivebrokers.com/tradingapi/v1/accounts",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/accounts`	Brokerage Accounts
POST	`/accounts/{account}/order_impact`	Return margin impact info
GET	`/accounts/{account}/orders`	Open Orders
POST	`/accounts/{account}/orders`	Place Order
GET	`/accounts/{account}/orders/{CustomerOrderId}`	Return specific order info
PUT	`/accounts/{account}/orders/{CustomerOrderId}`	Modify Order
DELETE	`/accounts/{account}/orders/{CustomerOrderId}`	Cancel Order
GET	`/accounts/{account}/positions`	Account Positions
GET	`/accounts/{account}/summary`	Account Values Summary
GET	`/accounts/{account}/trades`	Returns trades in account
GET	`/marketdata/exchange_components`	Exchange Components
GET	`/marketdata/snapshot`	Market Data Snapshot
POST	`/oauth/access_token`	Obtain a access token
POST	`/oauth/live_session_token`	Obtain a live session token
POST	`/oauth/request_token`	Obtain a request token
GET	`/secdef`	Get security definition