Skip to content

Interactive Brokers Client Portal API

An unofficial Python client for the Interactive Brokers Client Portal Web API.

Installation

pip install ibc-api

Quick Start

from ibc.client import InteractiveBrokersClient

ibc_client = InteractiveBrokersClient(
    account_number="U1234567",
)

# Authenticate (opens browser for gateway login).
ibc_client.authentication.wait_for_login()

# Grab a market data snapshot — returns typed MarketData models.
snapshots = ibc_client.market_data.snapshot(contract_ids=["265598"])
for quote in snapshots:
    print(f"{quote.conid}: Last={quote.last_price} Bid={quote.bid_price} Ask={quote.ask_price}")

Documentation

  • Getting Started — setup, authentication, first request
  • Models — typed dataclass models for requests and responses
  • API Reference — full method documentation auto-generated from source