ibauth 0.0.6

Interactive Brokers OAuth

IBKR Authentication Workflow

import logging
import time

import ibauth

logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s [%(levelname)7s] %(message)s",
)

logging.getLogger("urllib3").setLevel(logging.WARNING)
logging.getLogger("charset_normalizer").setLevel(logging.WARNING)

if __name__ == "__main__":
    auth = ibauth.auth_from_yaml("config.yaml")

    auth.get_access_token()
    auth.get_bearer_token()

    auth.ssodh_init()
    auth.validate_sso()

    # This will keep session alive.
    for _ in range(3):
        auth.tickle()
        time.sleep(10)

    # Dynamically change the API domain.
    #
    auth.domain = "5.api.ibkr.com"

    auth.tickle()

    auth.logout()

Documentation for the IBKR Web API is here.

1. Pull the repository.

2. Create and activate a virtual environment.

3. Install dependencies from requirements.txt.

4. Create a YAML configuration file:

   client_id: ""
   client_key_id: ""
   credential: ""
   private_key_file: ""
   domain: "api.ibkr.com"
   

   The private key file will usually have a .pem extension. The domain will normally be api.ibkr.com but it's also possible to access the API via other sub-domains like 1.api.ibkr.com.

5. Run the test script.

   python auth.py
   

Installation

You can install from GitHub.

pip3 install git+https://github.com/datawookie/ibkr-oauth-flow

Deploying to PyPi

This requires UV_PUBLISH_TOKEN to be set to a PyPi token in environment.

make deploy