Docs
Nexus/API Reference/Journal and Edge

Split your closed trades by one dimension

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

Closed trades in range, split along by. Only slices with trades come back.

  • best and worst are the slices with the highest and lowest avgPnl among those with at least minSampleForVerdict (5) measured trades, and are left out when none qualifies.

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
  • bystringdefault duration

    The dimension. Left out, duration. session is when the trade was opened, weekday the day it was closed, playbook the setup you tagged it with.

    durationsessionweekdaydirectiontickerplaybook

Responses

  • 200

    The slices.

  • 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
    • bystring
    • bucketsobject[]
    • bestobject
    • worstobject
    • minSampleForVerdictinteger
  • metaobject

    Which account was read.

    • accountstring
      mainagent
    • portstring | nulluuid

      Always null for now.

Last updated

Was this page helpful?