API
| Method | Endpoint | Description | Request Body | Response Body |
|---|---|---|---|---|
| POST | /login |
Authenticate and get a bearer token | Credentials | Token |
| GET | /auth/refresh_token |
Gets a new token, with extended expiry | - | Token |
| GET | /profile |
User profile | - | GetUser |
| PUT | /profile |
Update current user profile | PostUser | GetUser |
| POST | /profile |
Update current user password | PasswordChange | GetUser |
| DELETE | /profile |
Delete current user profile | - | Optional |
| GET | /prefs |
Get current user prefs | - | GetPrefs |
| PUT | /prefs |
Update current user prefs | PostPrefs | GetPrefs |
| GET | /user |
Get users profiles (admin only) | - | GetUser[] |
| GET | /user/{user_id} |
Get user profile (admin only) | - | GetUser |
| DELETE | /user/{user_id} |
Delete user profile (admin only) | - | GetUser |
| POST | /user |
Create new user (admin only) | PostUser | GetUser |
| PUT | /user |
Update user profile (admin only) | PostUser | GetUser |
| GET | /summary |
Summary across all portfolios | - | Summary |
| POST | /portfolios |
Create a new portfolio | PostPortfolio | GetPortfolio |
| GET | /portfolios |
List all portfolios | — | GetPortfolio[] |
| GET | /portfolios/{portfolio_id} |
Get a portfolio by ID | — | GetPortfolio |
| DELETE | /portfolios/{portfolio_id} |
Delete a portfolio | — | Optional |
| PUT | /portfolios/{portfolio_id} |
Update a portfolio | PostPortfolio | GetPortfolio |
| POST | /portfolios/{portfolio_id}/assets |
Add an asset to a portfolio | PostAsset | GetAsset |
| GET | /portfolios/{portfolio_id}/assets |
List assets in a portfolio | — | GetAsset[] |
| GET | /portfolios/{portfolio_id}/assets/{asset_id} |
Get an asset by ID | — | GetAsset |
| DELETE | /portfolios/{portfolio_id}/assets/{asset_id} |
Delete an asset by ID | — | Optional |
| PUT | /portfolios/{portfolio_id}/assets/{asset_id} |
Update an asset by ID | PostAsset | GetAsset |
| POST | /portfolios/{portfolio_id}/assets/{asset_id}/tx |
Create a transaction for a given asset | PostTx | GetTx |
| GET | /portfolios/{portfolio_id}/assets/{asset_id}/tx |
Get all transactions for asset | — | GetTx[] |
| GET | /portfolios/{portfolio_id}/assets/{asset_id}/tx/{tx_id} |
Get a transaction by ID | — | GetTx |
| DELETE | /portfolios/{portfolio_id}/assets/{asset_id}/tx/{tx_id} |
Delete a transaction by ID | — | Optional |
| PUT | /portfolios/{portfolio_id}/assets/{asset_id}/tx/{tx_id} |
Update a transaction by ID | PostTx | GetTx |
| DELETE | /portfolios/{portfolio_id}/assets/{asset_id}/txs |
Delete all transactions for an asset | — | Optional |
| POST | /portfolios/{portfolio_id}/assets/{asset_id}/txs |
Bulk insert transactions for an asset | PostTxsUpload | GetTx[] |
| POST | /lookup/ticker?query=TICKER |
Query for ticker details | — | YahooTickerSearchResult |
| POST | /lookup/fx/{base}/{ccy}/{date?} |
Get FX rates for base/ccy | — | Fx |