feat: Add core trading modules for risk management, backtesting, and execution algorithms, alongside a new ML transparency widget and related frontend dependencies.
Some checks are pending
Documentation / build-docs (push) Waiting to run
Tests / test (macos-latest, 3.11) (push) Waiting to run
Tests / test (macos-latest, 3.12) (push) Waiting to run
Tests / test (macos-latest, 3.13) (push) Waiting to run
Tests / test (macos-latest, 3.14) (push) Waiting to run
Tests / test (ubuntu-latest, 3.11) (push) Waiting to run
Tests / test (ubuntu-latest, 3.12) (push) Waiting to run
Tests / test (ubuntu-latest, 3.13) (push) Waiting to run
Tests / test (ubuntu-latest, 3.14) (push) Waiting to run
Some checks are pending
Documentation / build-docs (push) Waiting to run
Tests / test (macos-latest, 3.11) (push) Waiting to run
Tests / test (macos-latest, 3.12) (push) Waiting to run
Tests / test (macos-latest, 3.13) (push) Waiting to run
Tests / test (macos-latest, 3.14) (push) Waiting to run
Tests / test (ubuntu-latest, 3.11) (push) Waiting to run
Tests / test (ubuntu-latest, 3.12) (push) Waiting to run
Tests / test (ubuntu-latest, 3.13) (push) Waiting to run
Tests / test (ubuntu-latest, 3.14) (push) Waiting to run
This commit is contained in:
111
docs/user_manual/trade_journal.md
Normal file
111
docs/user_manual/trade_journal.md
Normal file
@@ -0,0 +1,111 @@
|
||||
# Trade Journal Guide
|
||||
|
||||
The Trade Journal provides comprehensive analysis of your trading history with advanced filtering, statistics, and export capabilities.
|
||||
|
||||
## Overview
|
||||
|
||||
The Trade Journal page (`/journal`) allows you to:
|
||||
|
||||
- View complete trade history across all symbols and order types
|
||||
- Filter trades by status, side, symbol, and date range
|
||||
- Analyze trade statistics and performance metrics
|
||||
- Export trade data to CSV for external analysis
|
||||
- Track fees, volumes, and win rates
|
||||
|
||||
## Accessing the Trade Journal
|
||||
|
||||
1. Navigate to the **Trade Journal** page from the main navigation menu
|
||||
2. The journal displays all trades for the selected trading mode (Paper or Live)
|
||||
|
||||
## Trade Statistics
|
||||
|
||||
The Trade Journal displays key statistics at the top of the page:
|
||||
|
||||
- **Total Trades**: Number of all trades matching current filters
|
||||
- **Filled Trades**: Number of successfully executed trades
|
||||
- **Total Volume**: Sum of all trade quantities
|
||||
- **Total Fees**: Cumulative fees paid across all trades
|
||||
|
||||
## Filtering Trades
|
||||
|
||||
Use the filter panel to narrow down your trade history:
|
||||
|
||||
### Status Filter
|
||||
- All
|
||||
- Filled
|
||||
- Open
|
||||
- Pending
|
||||
- Cancelled
|
||||
- Rejected
|
||||
|
||||
### Side Filter
|
||||
- All
|
||||
- Buy
|
||||
- Sell
|
||||
|
||||
### Symbol Filter
|
||||
- Enter symbol name to search (e.g., "BTC/USD")
|
||||
- Partial matching supported
|
||||
|
||||
### Date Range Filter
|
||||
- **Start Date**: Filter trades from this date onwards
|
||||
- **End Date**: Filter trades up to this date
|
||||
- Both fields optional; leave empty to show all dates
|
||||
|
||||
### Trading Mode Toggle
|
||||
- Switch between Paper Trading and Live Trading data
|
||||
|
||||
## Trade Table
|
||||
|
||||
The trade table displays detailed information for each trade:
|
||||
|
||||
- **ID**: Unique order identifier
|
||||
- **Symbol**: Trading pair (e.g., BTC/USD)
|
||||
- **Side**: Buy or Sell (color-coded chips)
|
||||
- **Type**: Order type (Market, Limit, Stop Loss, Trailing Stop, etc.)
|
||||
- **Quantity**: Order size
|
||||
- **Price**: Limit price (or "Market" for market orders)
|
||||
- **Status**: Current order status (color-coded chips)
|
||||
- **Filled**: Quantity that has been executed
|
||||
- **Fee**: Trading fee for this order
|
||||
- **Created At**: Timestamp when order was placed
|
||||
|
||||
## Exporting Data
|
||||
|
||||
To export trade data:
|
||||
|
||||
1. Apply desired filters to narrow down trades
|
||||
2. Click the **Export CSV** button
|
||||
3. A CSV file will download with all filtered trades
|
||||
4. File name includes date: `trade_journal_YYYY-MM-DD.csv`
|
||||
|
||||
The CSV includes all columns from the trade table for easy analysis in Excel, Google Sheets, or other tools.
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Performance Analysis
|
||||
- Filter by filled trades to analyze executed strategy performance
|
||||
- Use date range to analyze performance over specific periods
|
||||
- Compare buy vs sell trade performance
|
||||
|
||||
### Fee Tracking
|
||||
- View total fees to understand trading costs
|
||||
- Filter by symbol to see fees per trading pair
|
||||
- Export to calculate tax implications
|
||||
|
||||
### Strategy Review
|
||||
- Filter by order type to analyze strategy effectiveness
|
||||
- Review cancelled/rejected orders to identify issues
|
||||
- Track order types used in different market conditions
|
||||
|
||||
### Reporting
|
||||
- Export data for tax reporting
|
||||
- Create custom reports in spreadsheet software
|
||||
- Track compliance with trading limits
|
||||
|
||||
## Tips
|
||||
|
||||
- Use multiple filters together for precise analysis
|
||||
- Export data regularly for backup and external analysis
|
||||
- Review rejected/cancelled orders to identify systematic issues
|
||||
- Compare paper and live trading statistics separately
|
||||
Reference in New Issue
Block a user