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
Trading rules & compliance
Options tools
Import your history
Accounting & tax
Delete your account
Export & import your account
Methodology
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
Account data
Download the signed-in user's whole account as one archive.
POST
Restore a previewed archive into the empty signed-in account.
POST
Validate an uploaded archive and preview what it would restore.
POST
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
Delete a user and all their data (admin only).
POST
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
Finish signing in with a two-factor code.
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
Whether two-factor is enabled for the signed-in user.
GET
Regenerate backup codes.
POST
Turn two-factor off.
POST
Begin two-factor enrolment.
POST
Confirm two-factor enrolment with a code.
POST
Clear an account lockout with an emailed unlock token.
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
Record a deposit or withdrawal.
POST
Reverse a deposit or withdrawal.
DELETE
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
Get the tax lot method.
GET
Set the tax lot method.
PATCH
Performance
Aggregated P&L performance series, equity curve and statistics.
GET
Per-dimension performance breakdown for one window.
GET
Position Groups
Create a multi-leg strategy group.
POST
Link ungrouped positions into a group.
POST
Set or clear a group's label override.
PATCH
Close every open leg of a group at once.
POST
Add one leg to an existing group.
POST
Unlink one leg from a group.
DELETE
Positions
List the user's positions.
GET
Create a position (draft).
POST
Get a position's detail.
GET
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
Get an exit fill's in-kind transfer link and eligible candidates.
GET
Link an exit fill to an entry fill as one in-kind transfer.
PUT
Remove an exit fill's in-kind transfer link.
DELETE
Upload a screenshot to a position.
POST
Serve a position screenshot (ownership-scoped).
GET
Delete a position screenshot.
DELETE
List a position's entry lots for the specific-identification picker.
GET
Reopen a same-day closed position.
POST
Replace a position's tag set.
PUT
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
Tags
List the user's tags.
GET
Create a tag.
POST
Answer the starter-tags offer.
POST
Edit a tag.
PUT
Delete a tag.
DELETE
Trading rules
List the user's trading rules.
GET
Create a trading rule.
POST
Replace a trading rule.
PUT
Delete a trading rule.
DELETE
Account deletion
The current scheduled-deletion status for the signed-in user.
GET
Request deletion of the signed-in user's own account.
POST
Cancel the signed-in user's scheduled deletion.
DELETE
Build on it
Set up a local dev environment
Architecture overview
Database & migrations
Database schema
Security model
How it's built
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.17.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.