Skip to content
▴
Tradr
docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
← tradr.cloud
Start here
User guide
Getting started
Log and manage positions
Use the trade calculator
Customise the dashboard
Accounts & the multi-currency ledger
Review performance & P&L
Options tools
Import your history
Accounting & tax
Metrics glossary
Plan limits
Run it yourself
Install with Docker Compose
Upgrade an instance
Back up and restore
Configure email, Stripe, and LLM keys
Bring your own Postgres / run behind a pooler
Put TLS in front of the stack
Environment variables
Operational metrics (Prometheus)
CLI reference (tradr)
API reference
Overview
Accounts
Create an account.
POST
Set the default account.
PUT
Add sample data.
POST
Set the writable-account designation.
PUT
Update an account.
PUT
Delete an account.
DELETE
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
Factory-reset a user's data to their post-registration state (admin only).
POST
What a factory reset would delete for this user (admin only).
GET
Auth
Sign in and start a session.
POST
End the current session.
POST
Get the signed-in user.
GET
Complete a password reset with an emailed token (consume → revoke → rewrite).
POST
Request a password-reset email (no-enumeration surface).
POST
Create an account and start a session.
POST
Verify an email address with an emailed token (gesture-consumed).
POST
Resend the verification email for the authenticated account.
POST
Get the onboarding preference.
GET
Update part of the onboarding preference.
PATCH
Get the reporting timezone.
GET
Set the reporting timezone.
PUT
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
Brokerages
List brokerages.
GET
Create a brokerage.
POST
Get one brokerage.
GET
Edit a brokerage or its fee schedule.
PUT
Delete a brokerage.
DELETE
Duplicate a brokerage.
POST
Count the positions booked against a brokerage.
GET
Calculator
Size a trade from a risk basis, with fee and buying-power modelling.
POST
Get the calculator's buying-power basis.
GET
Set the calculator's buying-power basis.
PUT
Changelog
List published release notes with the viewer's last-viewed floor.
GET
Mark the changelog as viewed for the authenticated user.
POST
Platform
Public instance posture the SPA needs before rendering a form.
GET
Liveness probe (DB connectivity) plus the deployed version.
GET
CSV Import
Commit a previewed CSV import (consumes the preview token).
POST
Preview a CSV trade import (mints a single-use commit token).
POST
Dashboard
Get the dashboard layout.
GET
Save the dashboard layout, the theme, or both.
PUT
Get the stored theme preference.
GET
Re-issue the theme cookie.
POST
Accounting
Get the combined balance across all accounts.
GET
List the user's exchange rates.
GET
Add or update an exchange rate.
POST
Preview what a rate change would do to the dashboard total.
POST
Delete an exchange rate.
DELETE
List an account's ledger entries.
GET
Reconcile an account's cash balance to a stated figure.
POST
Get the display currency.
GET
Set the display currency.
PUT
Expenses
List trading expenses.
GET
Record an expense.
POST
Total the commissions paid in a year.
GET
Summarise a tax year.
GET
Delete an expense.
DELETE
Edit an expense.
PATCH
Get the tax jurisdiction.
GET
Set the tax jurisdiction.
PATCH
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
Add a fill to a position.
POST
Edit a fill.
PUT
Delete a fill.
DELETE
Reopen a same-day closed position.
POST
Symbols
Whether the delayed-quote provider is configured.
GET
Force a symbols reference-data sync from the SEC source (admin).
POST
Ranked ticker-prefix symbol autocomplete.
GET
Delayed spot last-price for a symbol.
GET
Build on it
Set up a local dev environment
Architecture overview
Database & migrations
Database schema
Security model
Contributing
Why it works this way
Hosted vs self-hosted: what's different
Why journaling improves your trading
GitHub
Select theme
Dark
Light
Auto
These docs describe Tradr
v0.14.0
. Running an older release? Check the
release notes
for what changed.
Why journaling improves your trading
The product thesis: structured lifecycle logging beats spreadsheets.