IBKR Portfolio Access Gateway

This application is implemented as a modern FastAPI backend service, engineered specifically to communicate with the Interactive Brokers (IBKR) external Application Programming Interface (API) for the purpose of sourcing up-to-the-minute asset holding records.

Component Blueprint

ibkr-gateway-endpoint ├── src │ ├── init.py │ ├── main_server.py │ ├── api_interfaces │ │ ├── init.py │ │ └── asset_endpoints │ │ ├── init.py │ │ └── holdings_routes.py │ ├── core_logic │ │ ├── init.py │ │ └── runtime_config.py │ ├── data_models │ │ ├── init.py │ │ └── account_data_schemas.py │ └── external_services │ ├── init.py │ └── ibkr_connector.py ├── requirements.lock ├── .env_vars └── README.md

Deployment Prerequisites

1. Acquire Source Code: bash git clone cd ibkr-gateway-endpoint

2. Establish Isolated Runtime Environment: bash python3 -m venv venv_ibkr source venv_ibkr/bin/activate # Use venv_ibkr\Scripts\activate on Windows systems

3. Install Required Packages: bash pip install -r requirements.lock

4. Configure Credentials: A configuration file named .env_vars must be present in the project root. Populate it with necessary authentication parameters for the IBKR connection.

5. Initiate Server Process: bash uvicorn src.main_server:app --reload

Operational Access

Once the service is operational, client applications can query the exposed RESTful interface points to retrieve account holdings. Comprehensive API specification documentation will be accessible via a web browser at http://localhost:8000/docs.

Project Licensing

This software is distributed under the terms of the MIT License.