API Reference ibkr_api v1.0.0

View Source

Modules

IbkrApi

A comprehensive Elixir client for Interactive Brokers' Client Portal API. This library provides a clean, idiomatic Elixir interface to interact with Interactive Brokers' trading platform.

Asset class module for IBKR Client Portal API.

Historical market data bar structure for backtesting.

Backtesting engine that runs strategies against historical data.

Example usage of the IBKR backtesting framework.

Portfolio management for backtesting.

Simple Moving Average crossover strategy.

Behaviour for defining backtesting strategies.

Contract-related functionality for the IBKR Client Portal API.

Contract information within stock security definition

Contract section information within search results

Available currency pair information

Daily trading schedule information

Security definition structure

Detailed contract information from secdef/info endpoint

Trading session information

Stock security definition response

Response structure for option strikes

Complete trading schedule for an exchange

Trading time information within a trading schedule

Market Data functionality for the IBKR Client Portal API.

Historical market data bar structure.

Market data snapshot response structure with descriptive field names. All numeric field codes are mapped to their descriptive equivalents.

IbkrApi.ClientPortal.Order module for managing order placement and monitoring.

Struct representing a request to modify an existing order.

Struct representing a request to preview an order before placement.

Struct representing a request to place a new order.

Portfolio and Account management functions for IBKR Client Portal API. Handles account information, positions, allocations, summaries, and ledgers.

AccountSummary struct containing all account summary fields. Each field is a SummaryField struct with timestamp, value, currency, severity, amount, and is_null information.

Represents PnL data for a specific account. Contains daily and unrealized PnL information.

Represents a single field in an account summary response. Each field contains metadata about the value including timestamp, currency, and severity.

Response from switching accounts. Can contain different fields depending on the response