Skip to content
Tradr docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
User Guide
Tutorials
Getting started
Log your first options trade
How-to
Log and manage positions
Use the trade calculator
Customise the dashboard
Accounts & the multi-currency ledger
Use the AI advisor (BYOK vs wallet)
Review performance & P&L
Options tools
Import trades from CSV
Connect Interactive Brokers (IBKR)
Accounting & tax
Reference
Metrics glossary
Keyboard shortcuts
Plan limits
Explanation
Hosted vs self-hosted: what's different
How the AI advisor reasons
Why journaling improves your trading
Self-hosting & Development
Tutorials
Run Tradr locally in 15 minutes
How-to
Self-host with Docker Compose
Set up a local dev environment
Back up and restore
Upgrade an instance
Configure email, Stripe, and LLM keys
Bring your own Postgres / run behind a pooler
Put TLS in front of the stack
Reference
Environment variable reference
docker-compose reference
CLI reference (tradr)
API reference
Overview
Accounts
Create an account.
POST
Set the writable-account designation (plan-tiers D18, REQ-6.6).
PUT
Update an account.
PUT
Admin
Platform statistics (admin only).
GET
Platform usage and revenue over a period (admin only).
GET
List users, cursor-paginated newest-first (admin only).
GET
Per-user admin detail (admin only).
GET
Toggle a user's admin flag (admin only).
PATCH
Advisor
List the authenticated user's conversations (cursor-paginated).
GET
Start a new conversation and stream the assistant reply (SSE).
POST
Proxy an advisor message image by index (ownership-scoped).
GET
Get a conversation plus its latest 50 messages.
GET
Delete a conversation (cascades to its messages).
DELETE
Rename a conversation (REQ-2.5).
PATCH
List a conversation's messages (newest-first, cursor-paginated).
GET
Stream an assistant reply for an existing conversation (SSE).
POST
Get the masked status of the authenticated user's Unusual Whales key.
GET
Save (or replace) the Unusual Whales market-data key.
PUT
Remove the Unusual Whales market-data key (REQ-6.2).
DELETE
List available models across the user's configured providers.
GET
Get the live options chain for a symbol from Unusual Whales (REQ-12.4).
GET
List built-in personas plus the user's own personas.
GET
Create a user-owned persona.
POST
Delete a user-owned persona.
DELETE
Update a user-owned persona.
PATCH
Set a persona as the user's default for new conversations.
POST
List the authenticated user's configured provider keys.
GET
Save (or replace) the BYOK key for a provider.
PUT
Remove the BYOK key for a provider (REQ-5.6).
DELETE
Change the default model for an existing provider key.
PATCH
Get the authenticated user's trade-data consent flag.
GET
Set the authenticated user's trade-data consent flag.
PUT
Auth
Complete a password reset with an emailed token (consume → revoke → rewrite).
POST
Request a password-reset email (no-enumeration surface).
POST
Verify an email address with an emailed token (gesture-consumed).
POST
Resend the verification email for the authenticated account.
POST
Billing
Get the authenticated user's wallet balance.
GET
Create a Stripe Checkout Session for a credit pack.
POST
Get billing availability, offered packs, the priced model list, and subscription purchasability.
GET
Create a Stripe Checkout Session for the Pro subscription.
POST
Create a Stripe Billing Portal session.
POST
Get the authenticated user's tier state (plan card / CTA / usage surface).
GET
List the authenticated user's wallet/usage history (cursor-paginated).
GET
Stripe webhook — idempotent, settled-only crediting (PUBLIC).
POST
Calculator
Size a trade from a risk basis, with fee and buying-power modelling.
POST
Changelog
List published release notes with the viewer's last-viewed floor.
GET
Mark the changelog as viewed for the authenticated user.
POST
CSV Import
Commit a previewed CSV import (consumes the preview token).
POST
Preview a CSV trade import (mints a single-use commit token).
POST
Platform
Liveness probe (DB connectivity) plus the deployed version.
GET
Performance
Aggregated P&L performance series, equity curve and statistics.
GET
Positions
Create a position (draft).
POST
Update a position.
PUT
Delete a position (any status).
DELETE
Reopen a same-day closed position (R13).
POST
Symbols
Whether the delayed-quote provider is configured (REQ-9.5).
GET
Force a symbols reference-data sync from the SEC source (admin).
POST
Ranked ticker-prefix symbol autocomplete (REQ-3.2).
GET
Delayed spot last-price for a symbol (REQ-4.2/4.6).
GET
Database schema
Explanation
Architecture overview
Monorepo layout
Database & migrations
Security model
Hosted-platform runbook (pointer)
Contributing (pointer)
GitHub
Select theme
Dark
Light
Auto
CLI reference (tradr)
tradr migrate –status, tradr storage migrate-to-inline, tradr storage gc, and tradr reset-password.