what is IBKR MCP Server?
IBKR MCP Server is a FastAPI application designed to interact with the Interactive Brokers (IBKR) API to fetch portfolio details for clients.
how to use IBKR MCP Server?
To use the IBKR MCP Server, clone the repository, set up a virtual environment, install the required dependencies, configure your IBKR API credentials in a .env
file, and run the application using Uvicorn.
key features of IBKR MCP Server?
- FastAPI framework for efficient API development
- Fetches real-time portfolio details from IBKR
- API documentation available for easy access to endpoints
use cases of IBKR MCP Server?
- Accessing and managing investment portfolios through the IBKR API.
- Integrating with other financial applications for real-time data.
- Automating portfolio management tasks.
FAQ from IBKR MCP Server?
- What is required to run the IBKR MCP Server?
You need Python, FastAPI, and IBKR API credentials to run the server.
- Is there any documentation available?
Yes, API documentation is available at
http://localhost:8000/docs
once the server is running.
- Can I customize the server for my needs?
Yes, the server can be customized as per your requirements.
IBKR MCP Server
This project is a FastAPI application that interacts with the Interactive Brokers (IBKR) API to fetch portfolio details.
Project Structure
ibkr-mcp-server
├── app
│ ├── __init__.py
│ ├── main.py
│ ├── api
│ │ ├── __init__.py
│ │ └── endpoints
│ │ ├── __init__.py
│ │ └── portfolio.py
│ ├── core
│ │ ├── __init__.py
│ │ └── config.py
│ ├── models
│ │ ├── __init__.py
│ │ └── portfolio.py
│ └── services
│ ├── __init__.py
│ └── ibkr_service.py
├── requirements.txt
├── .env
└── README.md
Setup Instructions
-
Clone the repository:
git clone <repository-url> cd ibkr-mcp-server
-
Create a virtual environment:
python -m venv venv source venv/bin/activate # On Windows use `venv\Scripts\activate`
-
Install dependencies:
pip install -r requirements.txt
-
Set up environment variables: Create a
.env
file in the root directory and add your IBKR API credentials. -
Run the application:
uvicorn app.main:app --reload
Usage
Once the server is running, you can access the API endpoints to fetch portfolio details. The API documentation will be available at http://localhost:8000/docs
.
License
This project is licensed under the MIT License.