MY PROP JOURNAL

Playbooks

Leer playbooks con estrategias y criterios de entrada y salida.

List playbooks

GET /api/v1/playbooks

Query parameters

ParameterDescription
pagePage number (default 1)
limitPage size, max 100 (default 50)

Response

Each playbook can include nested entry_criteria, exit_criteria, and strategies.

{
  "data": [
    {
      "id": "uuid",
      "name": "Momentum Trading Playbook",
      "description": "Strategies for momentum-based trades",
      "created_at": "2024-01-01T00:00:00Z",
      "entry_criteria": [
        {
          "id": "uuid",
          "description": "Price breaks above 20-day MA with volume"
        }
      ],
      "exit_criteria": [
        {
          "id": "uuid",
          "description": "Exit at 2:1 risk/reward or end of day"
        }
      ],
      "strategies": [
        {
          "id": "uuid",
          "name": "Gap and Go",
          "description": "Trade stocks gapping up on news"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 5,
    "totalPages": 1
  }
}

Get a single playbook

GET /api/v1/playbooks/{id}

Returns one playbook with all related criteria and strategies.

Crear un playbook

Crea un nuevo playbook con estrategias y contenido enriquecido.

Endpoint: POST /api/v1/playbooks

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
titlestringSíTítulo del playbook
descriptionstringNoBreve descripción del playbook
contentobjectNoContenido JSON de TipTap
content_htmlstringNoContenido HTML (alternativa a content)
content_markdownstringNoContenido Markdown (alternativa a content)
strategy_idsarrayNoArray de UUIDs de estrategias para vincular

Ejemplo de solicitud

curl -X POST "https://app.mypropjournal.com/api/v1/playbooks" \
  -H "Authorization: Bearer mpj_tu_clave_api" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Playbook de Trading de Momentum",
    "description": "Estrategias de momentum de alta probabilidad",
    "content_markdown": "# Criterios de Entrada\n- Aumento de volumen\n- Precio por encima de VWAP\n\n# Reglas de Salida\n- Objetivo 2:1 RR",
    "strategy_ids": ["abc-123", "def-456"]
  }'

Actualizar un playbook

Actualiza un playbook existente.

Endpoint: PUT /api/v1/playbooks/{id}

Todos los campos son opcionales. Solo se actualizarán los campos proporcionados.

Ejemplo de solicitud

curl -X PUT "https://app.mypropjournal.com/api/v1/playbooks/abc-123" \
  -H "Authorization: Bearer mpj_tu_clave_api" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Título de Playbook Actualizado",
    "strategy_ids": ["abc-123", "def-456", "ghi-789"]
  }'

Eliminar un playbook

Elimina un playbook permanentemente.

Endpoint: DELETE /api/v1/playbooks/{id}

Advertencia de Eliminación en Cascada

Eliminar un playbook eliminará permanentemente en cascada los siguientes datos relacionados:

  • Todas las asociaciones de estrategia que vinculan estrategias a este playbook

Además, estas referencias se establecerán en nulo (no se eliminarán):

  • Cualquier plan de operación vinculado a este playbook
  • Cualquier libro de gráficos vinculado a este playbook

Esta acción no se puede deshacer. La respuesta de la API incluirá advertencias sobre qué datos fueron afectados.

Ejemplo de solicitud

curl -X DELETE "https://app.mypropjournal.com/api/v1/playbooks/abc-123" \
  -H "Authorization: Bearer mpj_tu_clave_api"