Skip to content

Installation

pip install fidelity-trader-api

Extras

Extra Install What it adds
cli pip install fidelity-trader-api[cli] ft command-line tool (typer + rich)
service pip install fidelity-trader-api[service] FastAPI REST service + Docker support
aws pip install fidelity-trader-api[aws] AWS Secrets Manager / SSM credential providers
dev pip install fidelity-trader-api[dev] Testing (pytest, respx, boto3)

Requirements: Python 3.10+ and a Fidelity brokerage account with Trader+ access.

Verify CLI Installation

After installing with [cli], verify the ft command is available:

ft --help

If you get "command not found", the Python Scripts directory isn't in your PATH:

Windows (PowerShell):

# Find where pip installed it
python -c "import sysconfig; print(sysconfig.get_path('scripts'))"

# Add to PATH permanently (replace path with your output above)
[Environment]::SetEnvironmentVariable("PATH", $env:PATH + ";C:\Users\YourUser\AppData\Local\Programs\Python\Python312\Scripts", "User")

# Restart your terminal, then verify
ft --help

Linux / macOS:

# Usually ~/.local/bin — add to your shell profile if needed
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Alternative — invoke without PATH setup:

python -m fidelity_trader.cli --help

Standalone CLI Binaries (No Python Required)

Pre-built standalone binaries are attached to each GitHub Release. These do not require Python to be installed.

Platform Binary Usage
Windows ft-windows-amd64.exe .\ft-windows-amd64.exe login
Linux ft-linux-amd64 chmod +x ft-linux-amd64 && ./ft-linux-amd64 login
macOS ft-macos-amd64 chmod +x ft-macos-amd64 && ./ft-macos-amd64 login

Download the binary for your platform, rename it to ft (or ft.exe), and place it somewhere in your PATH.

Go / TypeScript Clients

Pre-generated typed API clients are also attached to each release:

Artifact Contents
openapi.json OpenAPI 3.1 spec (for TypeScript tooling)
openapi-3.0.json OpenAPI 3.0.3 spec (for Go / openapi-generator)
fidelity-trader-api-go-client.tar.gz Go client package (types + HTTP client)
fidelity-trader-api-ts-client.tar.gz TypeScript type definitions

See the Client Generation guide for usage instructions.