GitHub tag (with filter) PyPI build and publish PyPI - Version
This is a library for the private API of the Trade Republic online brokerage. It is not affiliated with Trade Republic Bank GmbH.
Table of Contents
This is the right section for you if all you want to do is to "just run the thing". Whether you've never run a piece of code before, or are new to Python, these steps will make it the easiest for you to run pytr.
We strongly recommend that you use uv to run pytr. Since pytr is written
in the Python programming language, you usually need to make sure you have an installation of Python on your computer
before you can run any Python program. However, uv will take care of installing an appropriate Python version for
you if you don't already have one.
To install uv on OSX/Linux, run:
curl -LsSf https://astral.sh/uv/install.sh | shOn Windows, run:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"Then, to run the latest released version of pytr:
uvx pytr@latest
If you want to use the cutting-edge version, use this command instead:
uvx --with git+https://github.com/pytr-org/pytr.git pytr
usage: pytr [-h] [-V] [-v {warning,info,debug}] [--debug-logfile DEBUG_LOGFILE] [--debug-log-filter DEBUG_LOG_FILTER] {help,login,portfolio,rates,details,dl_docs,export_transactions,get_price_alarms,set_price_alarms,get_savings_plans,completion} ... Use "pytr command_name --help" to get detailed help to a specific command Commands: {help,login,portfolio,rates,details,dl_docs,export_transactions,get_price_alarms,set_price_alarms,get_savings_plans,completion} Desired action to perform help Print this help message login Check if credentials file exists. If not create it and ask for input. Try to login. Ask for device reset if needed portfolio Show current portfolio rates Fetch current prices for a list of ISINs given as direct list or CSV input details Get details for an ISIN dl_docs Download all pdf documents from the timeline and sort them into folders. Also export account transactions (account_transactions.csv) and JSON files with all events (events_with_documents.json and other_events.json) export_transactions Read data from the TR timeline and export transactions into a file, e.g. as csv into account_transactions.csv. get_price_alarms Get current price alarms set_price_alarms Set new price alarms get_savings_plans Get current savings plans completion Print shell tab completion Options: -h, --help show this help message and exit -V, --version Print version information and quit (default: False) -v, --verbosity {warning,info,debug} Set verbosity level (default: info) (default: info) --debug-logfile DEBUG_LOGFILE Dump debug logs to a file (default: None) --debug-log-filter DEBUG_LOG_FILTER Filter debug log types (default: None)
There are two authentication methods:
Web login is the newer method that uses the same login method as app.traderepublic.com,
meaning you receive a four-digit code in the TradeRepublic app or via SMS. This will keep you logged in your primary
device, but means that you may need to repeat entering a new four-digit code ever so often when runnnig pytr.
App login is the older method that uses the same login method as the TradeRepublic app. First you need to perform a device reset - a private key will be generated that pins your "device". The private key is saved to your keyfile. This procedure will log you out from your mobile device.
pytr login
# or
pytr login --phone_no +49123456789 --pin 1234If no arguments are supplied pytr will look for them in the file ~/.pytr/credentials (the first line must contain
the phone number, the second line the pin). If the file doesn't exist pytr will ask for for the phone number and pin.
Clone the repository:
git clone https://github.com/pytr-org/pytr.git
Install dependencies:
uv sync
Run the tests to ensure everything is set up correctly:
uv run pytest
This fork changes authentication storage and logging to reduce the impact of a local file, shell-history, or debug-log disclosure:
- The PIN is never written to disk.
--store_credentialsstores only the phone number and the authenticated session cookies. - Existing legacy two-line credential files are automatically reduced to the phone number; a PIN is requested interactively if the saved session expires.
- Credential and cookie files are created with owner-only permissions (
0600). - Debug logging no longer dumps login responses, account settings, websocket payloads, or websocket errors, which can contain sensitive account data.
- The PIN should be entered interactively rather than passed as
--pin, so it does not enter shell history or appear in process arguments.
These changes address plaintext PIN persistence and accidental disclosure of
authentication/session/account data through logs. The SDK still communicates
with Trade Republic's private API and stores session cookies locally; protect
the ~/.pytr directory and avoid enabling debug logs in shared environments.
This project uses Ruff for code linting and auto-formatting, as well as Mypy for type checking.
You can auto-format the code with Ruff by running:
uv run ruff format # Format code uv run ruff check --fix-only # Remove unneeded imports, order imports, etc.
You can check the typing of the code with Mypy by running:
uv run mypy .Ruff and Mypy run as part of CI and your Pull Request cannot be merged unless it satisfies the linting, formatting checks and type checks.
- Create a pull request that bumps the version number in
pyproject.toml - After successfully merging the PR, create a new release via GitHub
and make use of the "Generate release notes" button. Tags are formatted as
vX.Y.Z. - The package will be published to PyPI from CI.
This readme contains a few automatically generated bits. To keep them up to date, simply run the following command: (Never start it from an activated venv!)
uvx mksync@0.1.5 -i README.md
This project is licensed under the MIT License. See the LICENSE file for details.