Models

Typed dataclass models provide structured access to API responses. All models are frozen (immutable) and constructed via from_dict() classmethods. Request models also provide to_dict() for building API payloads.

Response Models

Authentication

ibc.models.AuthStatus dataclass

Authentication status response from /iserver/auth/status.

from_dict(data) classmethod

Create an AuthStatus from a raw API response dict.

Accounts

ibc.models.Account dataclass

Account details from /portfolio/accounts.

from_dict(data) classmethod

Create an Account from a raw API response dict.

Contracts

ibc.models.Contract dataclass

Contract info from /iserver/contract/{conid}/info.

from_dict(data) classmethod

Create a Contract from a raw API response dict.

ibc.models.SecdefInfo dataclass

Security definition from /trsrv/secdef.

from_dict(data) classmethod

Create a SecdefInfo from a raw API response dict.

Market Data

ibc.models.MarketData dataclass

Real-time market data snapshot from /iserver/marketdata/snapshot.

from_dict(data) classmethod

Create a MarketData from a raw API response dict.

ibc.models.HistoryData dataclass

Historical market data from /iserver/marketdata/history.

from_dict(data) classmethod

Create a HistoryData from a raw API response dict.

ibc.models.HistoryBar dataclass

Single OHLCV bar from historical market data.

from_dict(data) classmethod

Create a HistoryBar from a raw API response dict.

Orders

ibc.models.Order dataclass

Live order from /iserver/account/orders.

from_dict(data) classmethod

Create an Order from a raw API response dict.

ibc.models.OrderStatus dataclass

Detailed order status from /iserver/account/order/status/{orderId}.

from_dict(data) classmethod

Create an OrderStatus from a raw API response dict.

Trades

ibc.models.Trade dataclass

Trade execution from /iserver/account/trades.

from_dict(data) classmethod

Create a Trade from a raw API response dict.

Portfolio

ibc.models.Position dataclass

Position data from /portfolio/{accountId}/positions.

from_dict(data) classmethod

Create a Position from a raw API response dict.

ibc.models.Ledger dataclass

Account ledger from /portfolio/{accountId}/ledger.

from_dict(data) classmethod

Create a Ledger from a raw API response dict.

Alerts

ibc.models.AlertResponse dataclass

Alert details from /iserver/account/{accountId}/alerts.

from_dict(data) classmethod

Create an AlertResponse from a raw API response dict.

ibc.models.AlertCondition dataclass

Single condition for an alert.

from_dict(data) classmethod

Create an AlertCondition from a raw API response dict.

Scanners

ibc.models.ScannerResult dataclass

Scanner results from /iserver/scanner/run.

from_dict(data) classmethod

Create a ScannerResult from a raw API response dict.

ibc.models.ScannerContract dataclass

A single contract in scanner results.

from_dict(data) classmethod

Create a ScannerContract from a raw API response dict.

Portfolio Analysis

ibc.models.Transactions dataclass

Transaction history from /portfolio/{accountId}/transactions.

from_dict(data) classmethod

Create a Transactions from a raw API response dict.

ibc.models.Transaction dataclass

A single transaction entry.

from_dict(data) classmethod

Create a Transaction from a raw API response dict.

ibc.models.Summary dataclass

Account summary value.

from_dict(data) classmethod

Create a Summary from a raw API response dict.

Request Models

Orders

ibc.models.OrderRequest dataclass

Order placement request for /iserver/account/{accountId}/orders.

to_dict()

Convert to the API-expected dict format.

ibc.models.ModifyOrder dataclass

Order modification request for /iserver/account/{accountId}/order/{orderId}.

to_dict()

Convert to the API-expected dict format.

Scanners

ibc.models.ScannerParams dataclass

Scanner parameters for /iserver/scanner/run.

to_dict()

Convert to the API-expected dict format.

ibc.models.ScannerFilter dataclass

A single filter for a scanner query.

from_dict(data) classmethod

Create a ScannerFilter from a raw API response dict.