IBKR Proxy

Setup

You need to have the following files in the local directory to enable the use of the IBKR OAuth service:

• config.yaml and
• privatekey.pem.

See the README for the ibauth project for documentation of the config.yaml content.

Running Locally

uv sync
uv run ibproxy --debug

Running on EC2

To run on an EC2 instance you'd do precisely the same thing as for running locally. Since the proxy is configured to only answer requests from localhost this will mean that requests from outside will not reach the proxy. In general this is a good thing.

There are ways that you can expose the proxy to the outside world. For the purpose of illustration suppose that you are running the proxy on an EC2 instance at 3.218.141.190.

Sending a Request

Just send your request to the proxy as if you were sending it to the IBKR API. For example, if you were going to request

curl "http://api.ibkr.com/v1/api/iserver/accounts"

then do this instead

curl "http://127.0.0.1:9000/v1/api/iserver/accounts"

NGINX

Unless you set up authentication this would definitely open up a can of worms.

SSH Tunnel

This is a simple and secure approach. Presumably you have SSH access to the EC2 instance. Run the following on your local machine to set up an SSH tunnel to the EC2 instance:

ssh -N -L 9000:127.0.0.1:9000 ubuntu@3.218.141.190

That will connect port 9000 on your local machine to port 9000 on the EC2 instance. Local requests on port 9000 will then be relayed via the secure tunnel to the proxy on the EC2 instance.

Development

uv sync
uv run ibproxy --debug

You can access the Swagger interface at http://127.0.0.1:9000/docs.

Local IBKR Authentication Workflow

If you are testing changes to ibauth then you can install a local copy.

1. Add this to the end of pyproject.toml:

   [tool.uv.sources]
   ibauth = { path = "../ibauth", editable = true }
   

2. uv lock --upgrade

3. uv sync

You can also set this up in one quick move:

uv add --editable ../ibauth

Tests

To run tests:

uv run pytest

The integration tests require a running proxy. To run those, first launch a proxy process and then run:

uv run pytest -m integration

There are also some tests that are marked specifically for infrequent use. To run those:

uv run pytest -m seldom