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.

• Complete API coverage for Interactive Brokers' Client Portal API
• Authentication and session management
• Account information and portfolio management
• Order placement and management
• Market data and contract information
• Trading operations
• Profile management

Add ibkr_api to your list of dependencies in mix.exs:

def deps do
  [
    {:ibkr_api, "~> 0.1.0"}
  ]
end

# Authenticate with the IBKR Client Portal API
{:ok, auth_response} = IbkrApi.ClientPortal.Auth.ping_server()

# List your accounts
{:ok, accounts} = IbkrApi.ClientPortal.Account.list_accounts()

# Get account summary
account_id = hd(accounts).account_id
{:ok, summary} = IbkrApi.ClientPortal.Account.account_summary(account_id)

• Tutorials: Step-by-step guides to get you started

  • Getting Started
  • Authentication

• How-To Guides: Practical guides for specific tasks

  • Account Management
  • Trading

• Reference: Technical information and API details

  • API Reference

• Explanation: Background information and concepts

  • Architecture

To use this library, you need:

1. An Interactive Brokers account
2. The Client Portal Gateway running locally or on a server
3. Elixir 1.15 or later

Contributions are welcome! Please feel free to submit a Pull Request.

This project is licensed under the MIT License - see the LICENSE file for details.