MY PROP JOURNAL

Rules

Strategy rules and automated trade rule evaluations.

Overview

Rules are strategy_rules records defined inside your strategies. They are evaluated automatically against trades and produce trade_rule_evaluations results.

Rule scopes:

  • account — Applied at the account level across all trades
  • trade — Evaluated per individual trade

Common rule types:

  • max_trade_risk
  • max_position_size_tiers
  • max_scale_ins
  • mandatory_break

When you fetch a single trade via GET /api/v1/trades/{id}, the response includes attached strategies with their rules and any trade_rule_evaluations with result, severity, violation_data, and rule_snapshot.


List rules

Endpoint: GET /api/v1/rules

Query parameters

ParameterTypeDescription
pageintegerPage number (default 1)
limitintegerItems per page, max 100 (default 20)
scopestringFilter by scope: account or trade
rule_typestringFilter by rule type
strategy_idstringFilter by strategy UUID
categorystringFilter by category

Example

curl "https://app.mypropjournal.com/api/v1/rules?scope=trade&strategy_id=uuid" \
  -H "Authorization: Bearer mpj_your_api_key_here"

Example response

{
  "data": [
    {
      "id": "uuid",
      "strategy_id": "uuid",
      "description": "Max 1% risk per trade",
      "sort_order": 0,
      "category": "risk",
      "rule_type": "max_trade_risk",
      "scope": "trade",
      "parameters": { "max_risk_percent": 1 },
      "is_template_based": false,
      "target_account_id": null,
      "strategies": {
        "id": "uuid",
        "title": "Risk Management",
        "type": "risk_management"
      }
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 20,
    "offset": 0,
    "has_more": false
  }
}

Get single rule

Endpoint: GET /api/v1/rules/{id}

Returns the full rule with parameters and parent strategy details.


Trade rule evaluations

Rule evaluations are returned as part of the enriched trade detail response. Each evaluation includes:

FieldTypeDescription
resultstringEvaluation outcome
severitystringViolation severity level
violation_dataobjectDetails about the violation
rule_snapshotobjectSnapshot of the rule at evaluation time
evaluated_atstringTimestamp of evaluation

See Trades for the full enriched trade response.