Nexus/API Reference/Journal and Edge

One futures account's history

GEThttps://app.skylit.ai/api/nexus/v1/journal/futures/events

Everything that happened to one account, oldest first: started, daily lock, failed, passed, funded, payout, reset. Read only.

equityCents is null when it wasn't measured (a reset with an open position that had no price).

curl -s "https://app.skylit.ai/api/nexus/v1/journal/futures/events?account=evaluation" \
  -H "Authorization: Bearer $SKYLIT_API_KEY"

Authorization

Authorization: Bearer <your API key>

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

Query parameters

  • accountstring

    One of your futures accounts: practice (main means the same), agent, evaluation, funded, or one of your account ids. Left out, practice, or your agent's account where keys default to it. practice or agent before its first order, or an id that isn't yours, answers 404 account_not_found.

Responses

  • 200

    The read.

  • 401

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

  • 403

    futures_access_denied: futures aren't on for this account. Also account_suspended, nexus_access_denied.

  • 404

    account_not_found: practice or agent before its first order (a read never makes one), or an id that isn't one of your futures accounts. user_not_found: this Skylit account hasn't used Nexus yet.

  • 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.

  • 503

    futures_journal_unavailable: the futures journal isn't served by key on this server.

Response fields

  • dataobjectrequired
    • eventsobject[]

      Oldest first.

  • metaobject

    Which account was read.

    • accountstring

      What was read: all (every account of yours but your agent's), a selector like practice or agent, or the account id you sent.

    • accountIdstring | nulluuid

      The account read. null for all.

Last updated

Was this page helpful?