Referencia de Filtros | My Prop Journal

Descripción General

Esta página proporciona una referencia completa de todos los filtros y parámetros de consulta disponibles en los endpoints de la API de My Prop Journal. Los filtros te ayudan a refinar resultados, buscar contenido y recuperar exactamente los datos que necesitas.

Parámetros Universales

Estos parámetros están disponibles en todos los endpoints LIST:

Parámetro	Tipo	Predeterminado	Descripción
`limit`	integer	20	Número de resultados por página (1-100)
`offset`	integer	0	Desplazamiento de paginación para resultados

Filtros de Cuentas

Endpoint: /api/v1/accounts

Parámetro	Tipo	Valores	Descripción
`type`	string	`prop`, `retail`	Tipo de cuenta
`archived`	string/boolean	`all`, `active`, `archived`, `true`, `false`	Filtrar por estado de archivo
`firm`	string	nombre de empresa	Filtrar cuentas prop por nombre de empresa
`account_type`	string	`evaluation`, `funded` (prop)	Clasificación de tipo de cuenta
`status`	string	varía por tipo de cuenta	Estado de cuenta
`search`	string	cualquier texto	Buscar número de cuenta, apodo o empresa
`sort_by`	string	`balance`, `net_pnl`, `created_at`, `account_number`, `account_size`, `gross_pnl`	Campo de ordenamiento
`sort_order`	string	`asc`, `desc`	Dirección de ordenamiento

Ejemplos:

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

Filtros de Operaciones

Endpoint: /api/v1/trades

Parámetro	Tipo	Valores	Descripción
`account_id`	string	UUID	Filtrar por cuenta específica
`instrument`	string	símbolo	Filtrar por ticker/símbolo
`direction`	string	`long`, `short`	Dirección de la operación
`outcome`	string	`win`, `loss`, `breakeven`	Resultado de la operación
`tags`	string	UUIDs separados por comas	Filtrar por IDs de etiquetas
`strategy_id`	string	UUID	Filtrar por estrategia
`playbook_id`	string	UUID	Filtrar por playbook
`start_date`	string	AAAA-MM-DD	Fecha de entrada inicio
`end_date`	string	AAAA-MM-DD	Fecha de entrada fin
`min_pnl`	number	decimal	P&L mínimo
`max_pnl`	number	decimal	P&L máximo
`min_rrr`	number	decimal	Ratio riesgo-recompensa mínimo
`max_rrr`	number	decimal	Ratio riesgo-recompensa máximo
`has_notes`	boolean	`true`, `false`	Tiene notas de operación
`has_writeup`	boolean	`true`, `false`	Tiene análisis asociado
`search`	string	cualquier texto	Buscar notas, instrumentos o cuentas
`sort_by`	string	`entry_date`, `pnl`, `rrr`, `duration`	Campo de ordenamiento
`sort_order`	string	`asc`, `desc`	Dirección de ordenamiento

Ejemplos:

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

Filtros de Análisis de Operaciones

Endpoint: /api/v1/trade-writeups

Parámetro	Tipo	Valores	Descripción
`account_id`	string	UUID	Filtrar por cuenta
`trade_group_id`	string	UUID	Filtrar por operación específica
`tags`	string	UUIDs separados por comas	Filtrar por IDs de etiquetas
`start_date`	string	AAAA-MM-DD	Fecha de creación inicio
`end_date`	string	AAAA-MM-DD	Fecha de creación fin
`search`	string	cualquier texto	Buscar título o contenido
`content_format`	string	`json`, `html`, `markdown`	Formato de contenido de respuesta
`include_media`	boolean	`true`, `false`	Incluir URLs de medios extraídos

Filtros de Planes de Trading

Endpoint: /api/v1/trade-plans

Parámetro	Tipo	Valores	Descripción
`account_id`	string	UUID	Filtrar por cuenta
`tags`	string	UUIDs separados por comas	Filtrar por IDs de etiquetas
`start_date`	string	AAAA-MM-DD	Fecha de creación inicio
`end_date`	string	AAAA-MM-DD	Fecha de creación fin
`search`	string	cualquier texto	Buscar título o contenido
`content_format`	string	`json`, `html`, `markdown`	Formato de contenido de respuesta
`include_media`	boolean	`true`, `false`	Incluir URLs de medios extraídos

Filtros de Estrategias

Endpoint: /api/v1/strategies

Parámetro	Tipo	Valores	Descripción
`type`	string	`entry`, `exit`, `both`	Tipo de estrategia
`tags`	string	UUIDs separados por comas	Filtrar por IDs de etiquetas
`search`	string	cualquier texto	Buscar nombre o descripción
`content_format`	string	`json`, `html`, `markdown`	Formato de contenido de respuesta
`include_media`	boolean	`true`, `false`	Incluir URLs de medios extraídos

Filtros de Tarjetas de Reporte

Endpoint: /api/v1/report-cards

Parámetro	Tipo	Valores	Descripción
`account_id`	string	UUID	Filtrar por cuenta
`period_type`	string	`daily`, `weekly`, `monthly`, `quarterly`, `yearly`	Período del reporte
`tags`	string	UUIDs separados por comas	Filtrar por IDs de etiquetas
`start_date`	string	AAAA-MM-DD	Filtro de fecha de inicio del período
`end_date`	string	AAAA-MM-DD	Filtro de fecha de fin del período
`search`	string	cualquier texto	Buscar título o contenido
`content_format`	string	`json`, `html`, `markdown`	Formato de contenido de respuesta
`include_media`	boolean	`true`, `false`	Incluir URLs de medios extraídos

Filtros de Pagos

Endpoint: /api/v1/payouts

Parámetro	Tipo	Valores	Descripción
`account_id`	string	UUID	Filtrar por cuenta
`firm`	string	nombre de empresa	Filtrar por empresa prop
`status`	string	`pending`, `processing`, `completed`, `failed`	Estado del pago
`start_date`	string	AAAA-MM-DD	Fecha de pago inicio
`end_date`	string	AAAA-MM-DD	Fecha de pago fin
`search`	string	cualquier texto	Buscar referencia, cuenta o estado
`include_cumulative`	boolean	`true`, `false`	Incluir cálculos acumulativos

Filtros de Documentos

Endpoint: /api/v1/documents

Parámetro	Tipo	Valores	Descripción
`account_id`	string	UUID	Filtrar por cuenta
`category`	string	`payout-confirmation`, `evaluation-pass-certificate`, `account-scale-certificate`, `receipt`	Categoría de documento
`start_date`	string	AAAA-MM-DD	Fecha de subida inicio
`end_date`	string	AAAA-MM-DD	Fecha de subida fin
`search`	string	cualquier texto	Buscar nombre de documento o número de cuenta

Reglas de Combinación de Filtros

Múltiples filtros se combinan con lógica AND

GET /api/v1/trades?outcome=win&direction=long
# Devuelve: operaciones que son AMBOS ganadoras Y largas

Valores separados por comas usan lógica OR

GET /api/v1/trades?tags=uuid1,uuid2
# Devuelve: operaciones con uuid1 O uuid2

La búsqueda usa lógica OR entre campos

GET /api/v1/trades?search=AAPL
# Busca: notas O instrumentos O números de cuenta

Los rangos de fechas son inclusivos

GET /api/v1/trades?start_date=2024-01-01&end_date=2024-01-31
# Devuelve: operaciones del 1 al 31 de enero (inclusivo)

Mejores Prácticas

Usa filtros específicos - Refina los resultados tanto como sea posible para respuestas más rápidas
Combina filtros - Usa múltiples filtros juntos para obtener exactamente lo que necesitas
Pagina conjuntos de resultados grandes - Siempre usa limit y offset para consultas grandes
Cachea resultados de filtros - Cachea combinaciones de filtros comúnmente usadas
Codifica valores de URL - Siempre codifica valores de filtros (espacios, caracteres especiales)
Prueba filtros - Prueba combinaciones de filtros antes de confiar en ellas en producción

En esta página12 secciones