Filters Reference | My Prop Journal

Overview

This page provides a comprehensive reference for all filters and query parameters available across My Prop Journal API endpoints. Filters help you narrow down results, search content, and retrieve exactly the data you need.

Universal Parameters

These parameters are available on all LIST endpoints:

Parameter	Type	Default	Description
`limit`	integer	20	Number of results per page (1-100)
`offset`	integer	0	Pagination offset for results

Accounts Filters

Endpoint: /api/v1/accounts

Parameter	Type	Values	Description
`type`	string	`prop`, `retail`	Account type
`archived`	string/boolean	`all`, `active`, `archived`, `true`, `false`	Filter by archive status
`firm`	string	firm name	Filter prop accounts by firm name
`account_type`	string	`evaluation`, `funded` (prop) or `individual`, `joint`, etc. (retail)	Account type classification
`status`	string	varies by account type	Account status
`search`	string	any text	Search account number, nickname, or firm
`sort_by`	string	`balance`, `net_pnl`, `created_at`, `account_number`, `account_size`, `gross_pnl`	Sort field
`sort_order`	string	`asc`, `desc`	Sort direction

Examples:

GET /api/v1/accounts?type=prop&archived=active&firm=FTMO&sort_by=balance&sort_order=desc
GET /api/v1/accounts?type=retail&search=savings&sort_by=current_balance

Trades Filters

Endpoint: /api/v1/trades

Parameter	Type	Values	Description
`account_id`	string	UUID	Filter by specific account
`instrument`	string	symbol	Filter by ticker/symbol
`direction`	string	`long`, `short`	Trade direction
`outcome`	string	`win`, `loss`, `breakeven`	Trade result
`tags`	string	comma-separated UUIDs	Filter by tag IDs
`strategy_id`	string	UUID	Filter by strategy
`playbook_id`	string	UUID	Filter by playbook
`start_date`	string	YYYY-MM-DD	Entry date start
`end_date`	string	YYYY-MM-DD	Entry date end
`min_pnl`	number	decimal	Minimum P&L
`max_pnl`	number	decimal	Maximum P&L
`min_rrr`	number	decimal	Minimum risk-reward ratio
`max_rrr`	number	decimal	Maximum risk-reward ratio
`has_notes`	boolean	`true`, `false`	Has trade notes
`has_writeup`	boolean	`true`, `false`	Has associated write-up
`search`	string	any text	Search notes, instruments, or accounts
`sort_by`	string	`entry_date`, `pnl`, `rrr`, `duration`	Sort field
`sort_order`	string	`asc`, `desc`	Sort direction

Examples:

GET /api/v1/trades?account_id=uuid&outcome=win&min_pnl=100&tags=uuid1,uuid2
GET /api/v1/trades?direction=long&has_writeup=true&sort_by=pnl&sort_order=desc
GET /api/v1/trades?start_date=2024-01-01&end_date=2024-01-31&strategy_id=uuid

Trade Write-ups Filters

Endpoint: /api/v1/trade-writeups

Parameter	Type	Values	Description
`account_id`	string	UUID	Filter by account
`trade_group_id`	string	UUID	Filter by specific trade
`tags`	string	comma-separated UUIDs	Filter by tag IDs
`start_date`	string	YYYY-MM-DD	Creation date start
`end_date`	string	YYYY-MM-DD	Creation date end
`search`	string	any text	Search title or content
`content_format`	string	`json`, `html`, `markdown`	Response content format
`include_media`	boolean	`true`, `false`	Include extracted media URLs

Examples:

GET /api/v1/trade-writeups?account_id=uuid&search=breakout&content_format=markdown
GET /api/v1/trade-writeups?tags=uuid1&include_media=true

Trade Plans Filters

Endpoint: /api/v1/trade-plans

Parameter	Type	Values	Description
`account_id`	string	UUID	Filter by account
`tags`	string	comma-separated UUIDs	Filter by tag IDs
`start_date`	string	YYYY-MM-DD	Creation date start
`end_date`	string	YYYY-MM-DD	Creation date end
`search`	string	any text	Search title or content
`content_format`	string	`json`, `html`, `markdown`	Response content format
`include_media`	boolean	`true`, `false`	Include extracted media URLs

Examples:

GET /api/v1/trade-plans?search=quarterly&content_format=markdown&include_media=true

Strategies Filters

Endpoint: /api/v1/strategies

Parameter	Type	Values	Description
`type`	string	`entry`, `exit`, `both`	Strategy type
`tags`	string	comma-separated UUIDs	Filter by tag IDs
`search`	string	any text	Search name or description
`content_format`	string	`json`, `html`, `markdown`	Response content format
`include_media`	boolean	`true`, `false`	Include extracted media URLs

Examples:

GET /api/v1/strategies?type=entry&search=breakout&content_format=html

Report Cards Filters

Endpoint: /api/v1/report-cards

Parameter	Type	Values	Description
`account_id`	string	UUID	Filter by account
`period_type`	string	`daily`, `weekly`, `monthly`, `quarterly`, `yearly`	Report period
`tags`	string	comma-separated UUIDs	Filter by tag IDs
`start_date`	string	YYYY-MM-DD	Period start date filter
`end_date`	string	YYYY-MM-DD	Period end date filter
`search`	string	any text	Search title or content
`content_format`	string	`json`, `html`, `markdown`	Response content format
`include_media`	boolean	`true`, `false`	Include extracted media URLs

Examples:

GET /api/v1/report-cards?account_id=uuid&period_type=monthly&start_date=2024-01-01

Chart Books Filters

Endpoint: /api/v1/chart-books

Parameter	Type	Values	Description
`account_id`	string	UUID	Filter by account
`strategy_id`	string	UUID	Filter by strategy
`playbook_id`	string	UUID	Filter by playbook
`tags`	string	comma-separated UUIDs	Filter by tag IDs
`search`	string	any text	Search title or notes

Examples:

GET /api/v1/chart-books?strategy_id=uuid&search=SPY&tags=uuid1

Playbooks Filters

Endpoint: /api/v1/playbooks

Parameter	Type	Values	Description
`account_id`	string	UUID	Filter by account
`tags`	string	comma-separated UUIDs	Filter by tag IDs
`search`	string	any text	Search name or description
`content_format`	string	`json`, `html`, `markdown`	Response content format
`include_media`	boolean	`true`, `false`	Include extracted media URLs

Examples:

GET /api/v1/playbooks?search=momentum&content_format=markdown

Payouts Filters

Endpoint: /api/v1/payouts

Parameter	Type	Values	Description
`account_id`	string	UUID	Filter by account
`firm`	string	firm name	Filter by prop firm
`status`	string	`pending`, `processing`, `completed`, `failed`	Payout status
`start_date`	string	YYYY-MM-DD	Payout date start
`end_date`	string	YYYY-MM-DD	Payout date end
`search`	string	any text	Search reference, account, or status
`include_cumulative`	boolean	`true`, `false`	Include cumulative calculations

Examples:

GET /api/v1/payouts?firm=FTMO&status=completed&include_cumulative=true
GET /api/v1/payouts?start_date=2024-01-01&end_date=2024-01-31&search=PAYOUT

Documents Filters

Endpoint: /api/v1/documents

Parameter	Type	Values	Description
`account_id`	string	UUID	Filter by account
`category`	string	`payout-confirmation`, `evaluation-pass-certificate`, `account-scale-certificate`, `receipt`	Document category
`start_date`	string	YYYY-MM-DD	Upload date start
`end_date`	string	YYYY-MM-DD	Upload date end
`search`	string	any text	Search document name or account number

Examples:

GET /api/v1/documents?category=payout-confirmation&account_id=uuid
GET /api/v1/documents?search=certificate&start_date=2024-01-01

Performance Filters

Endpoint: /api/v1/performance

Parameter	Type	Values	Description
`account_id`	string	UUID	Filter by account
`start_date`	string	YYYY-MM-DD	Date range start
`end_date`	string	YYYY-MM-DD	Date range end
`instrument`	string	symbol	Filter by instrument
`strategy_id`	string	UUID	Filter by strategy
`tags`	string	comma-separated UUIDs	Filter by tag IDs

Detailed Performance: /api/v1/performance/detailed

Additional parameters for granular metrics.

Calendar Performance: /api/v1/performance/calendar

Additional parameters: year, month

Grouped Performance: /api/v1/performance/grouped

Additional parameter: group_by (instrument, strategy, tag, day_of_week, hour_of_day)

Filter Combination Rules

Multiple filters are combined with AND logic

GET /api/v1/trades?outcome=win&direction=long
# Returns: trades that are BOTH wins AND long

Comma-separated values use OR logic

GET /api/v1/trades?tags=uuid1,uuid2
# Returns: trades with uuid1 OR uuid2

Search uses OR logic across fields

GET /api/v1/trades?search=AAPL
# Searches: notes OR instruments OR account numbers

Date ranges are inclusive

GET /api/v1/trades?start_date=2024-01-01&end_date=2024-01-31
# Returns: trades from Jan 1 through Jan 31 (inclusive)

Best Practices

Use specific filters - Narrow down results as much as possible for faster responses
Combine filters - Use multiple filters together to get exactly what you need
Paginate large result sets - Always use limit and offset for large queries
Cache filter results - Cache commonly used filter combinations
URL encode values - Always URL encode filter values (spaces, special characters)
Test filters - Test filter combinations before relying on them in production

Filter Examples by Use Case

Get Recent Winning Trades

GET /api/v1/trades?outcome=win&sort_by=entry_date&sort_order=desc&limit=10

Find All Trades for a Strategy

GET /api/v1/trades?strategy_id=uuid&start_date=2024-01-01

Get Completed Payouts This Month

GET /api/v1/payouts?status=completed&start_date=2024-01-01&end_date=2024-01-31

Search Documentation

GET /api/v1/documents?search=certificate&category=evaluation-pass-certificate

Get Active Funded Accounts

GET /api/v1/accounts?type=prop&archived=false&account_type=funded

On this page16 sections

Overview

Universal Parameters

Accounts Filters

Trades Filters

Trade Write-ups Filters

Trade Plans Filters

Strategies Filters

Report Cards Filters

Chart Books Filters

Playbooks Filters

Payouts Filters

Documents Filters

Performance Filters

Filter Combination Rules

Best Practices

Filter Examples by Use Case

Get Recent Winning Trades

Find All Trades for a Strategy

Get Completed Payouts This Month

Search Documentation

Get Active Funded Accounts