Nexus/API Reference/Journal and Edge

Your futures journal stats

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

The headline figures over a range (trades, net, fees, win rate, profit factor, expectancy, largest win and loss, points per contract, average hold, streaks), the equity curve, and the same trades split by instrument, side, hour opened, weekday, hold time and account. The Journal's futures stats, by key. Read only.

Each split carries its own trade count. A figure nothing was measured for is null, never 0, next to the count it was taken over. Money is in cents and prices in index points.

curl -s "https://app.skylit.ai/api/nexus/v1/journal/futures/stats?range=7d" \
  -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

  • rangestringdefault 30d

    How far back, in futures trading days (a day runs from 6 PM ET the evening before): the last 7, 30 or 90 calendar days, the year so far, or all. Left out, 30d.

    7d30d90dytdall
  • accountstring

    Which of your futures accounts: practice, agent (your bot's), evaluation or funded (when you have exactly one running), or one of your futures account ids. main or all is every account of yours except your agent's, as the Journal shows it. Left out, that same view, or your agent's account where keys default to it; meta.account says which was read. practice or agent before its first order, or an id that isn't yours, answers 404 account_not_found.

Responses

  • 200

    The read.

  • 400

    bad_request: range isn't one of the list.

  • 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

    A range of futures trading, summarised. Money in cents.

    • rangestring
      7d30d90dytdall
    • fromstringdate

      First trading day in the range.

    • tostringdate

      Last trading day, inclusive.

    • tradesinteger
    • winsinteger
    • lossesinteger
    • netCentsinteger
    • grossCentsinteger
    • feesCentsinteger
    • winRatePctnumber | null

      null with no decided trade.

    • profitFactornumber | null

      null with no losing trade.

    • expectancyCentsinteger | null

      Net per trade. null with no trades.

    • avgWinCentsinteger | null
    • avgLossCentsinteger | null

      A positive number.

    • largestWinCentsinteger | null
    • largestLossCentsinteger | null

      A positive number.

    • pointsPerContractnumber | null

      Gross points per contract closed, only when every trade in the range is one instrument; otherwise null (see bySymbol).

    • avgHoldSecsinteger | null
    • maxWinStreakinteger
    • maxLossStreakinteger
    • currentStreakinteger

      +n for n straight winners, -n for losers, 0 otherwise.

    • equityobject[]

      Cumulative net at each trading day's close.

    • bySymbolobject[]
    • bySideobject[]
    • byHourobject[]

      ET hour the trade opened.

    • byWeekdayobject[]

      The trading day it closed on.

    • byHoldobject[]

      All five hold times, empty ones included.

    • byAccountobject[]

      By account name.

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