Docs
Nexus/API Reference/Journal and Edge

Read your journal's headline figures

GEThttps://app.skylit.ai/api/nexus/v1/journal/stats

The figures the Journal shows first, over closed trades in range: trades, win rate, net P&L, profit factor, your best and worst trade, and consistency.

  • measuredTrades is how many trades carry a realized P&L. netPnl: 0 with measuredTrades: 0 means nothing was measured, not a breakeven.
  • winRate leaves breakeven trades out. profitFactor is 0 when nothing was lost, and consistencyPercent is 0 when nothing was won: neither is a score.
  • meta says which account was read.

Authorization

Authorization: Bearer <your API key>

Required. A missing header returns 401; an invalid, revoked or expired key returns 403.

Query parameters

  • accountstring

    main (your own simulated wallet, the default) or agent (your bot's).

    mainagent
  • rangestringdefault 30d

    How far back, in New York time. Left out, 30d.

    7d30d90dytdall

Responses

  • 200

    The figures.

  • 400

    Code: bad_request. account, range, by or month isn't one of the allowed values, or account=main was sent to agent/edge. The message says which.

  • 401

    No key, or a key that isn't valid. Codes: missing_api_key, invalid_api_key.

  • 403

    The key works but this can't be read. Codes: feature_disabled (you sent port: ports aren't available yet, so leave it out), account_suspended, nexus_access_denied.

  • 404

    Code: user_not_found. This Skylit account hasn't used Nexus yet, so it has no journal.

  • 429

    Over a rate limit. Wait Retry-After seconds, then retry. Codes: rate_limited, and stream_limit_reached (too many live streams open: 3 per key, 6 per account).

  • 500

    Something went wrong on our side. If you sent a clientOrderId, retry with the same one. Code: internal_error.

Response fields

  • dataobject
    • rangestring
    • tradesinteger
    • contractsinteger
    • measuredTradesinteger

      Trades that carry a realized P&L. Every money figure is over these only.

    • winsinteger
    • lossesinteger
    • breakeveninteger
    • winRatenumber

      Wins over wins plus losses, as a percent.

    • netPnlnumber
    • avgWinnumber
    • avgLossnumber

      Per losing trade, positive.

    • profitFactornumber

      Gross profit over gross loss. 0 when nothing was lost.

    • bestTradeobject
    • worstTradeobject
    • consistencyPercentnumber

      Your biggest green day as a share of everything won. Lower is steadier. 0 when nothing was won.

    • biggestDayobject

      One day in New York time. realizedPnl is over measured trades only, and null when none was measured.

    • activeDaysinteger
    • greenDaysinteger
    • redDaysinteger
  • metaobject

    Which account was read.

    • accountstring
      mainagent
    • portstring | nulluuid

      Always null for now.

Last updated

Was this page helpful?