Nexus/API Reference/Journal and Edge

One futures trade in full

GEThttps://app.skylit.ai/api/nexus/v1/journal/futures/trips/{id}

One of your futures trades: its fills, the path price took while it was open, and how far that went for and against you, in points per contract from the average entry. Read only.

closedAt, avgExitPrice, exitPoints and givebackPoints are null while it is open. Someone else's trade answers 404 trip_not_found, the same as one that doesn't exist.

curl -s "https://app.skylit.ai/api/nexus/v1/journal/futures/trips/cb6f0fe2-33a5-431a-a4de-3daefb8464b6" \
  -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.

Path parameters

  • idstringuuidrequired

    The trade's tripId (from GET /api/nexus/v1/journal/futures/trades).

Responses

  • 200

    The read.

  • 400

    bad_request: the id isn't a UUID.

  • 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

    trip_not_found: not one of your trades. 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

    One futures trade in full. Excursions are in points per contract from the average entry.

    • idstringuuid
    • accountIdstringuuid
    • accountNamestring
    • symbolstring
    • rootstring
    • sidestring
      longshort
    • openedAtstringdate-time
    • closedAtstring | nulldate-time

      null while it is open.

    • maxQtyinteger
    • contractsinteger

      Closed so far.

    • avgEntryPricenumber
    • avgExitPricenumber | null

      null while open, or when a reset ended it.

    • highPricenumber
    • highAtstringdate-time
    • lowPricenumber
    • lowAtstringdate-time
    • bestPointsnumber

      Points per contract in the trade's favour (0 if it never went there).

    • worstPointsnumber

      Points per contract against it (0 or below).

    • exitPointsnumber | null

      null while open, or when a reset ended it.

    • givebackPointsnumber | null

      Best minus exit. null while open, or when a reset ended it.

    • pointValueCentsinteger
    • tickSizenumber
    • grossCentsinteger

      Realised so far.

    • feesCentsinteger
    • netCentsinteger
    • fillsobject[]
    • pathobject[]

      The price while it was open.

    • notestring

      Your note, or an empty string.

    • exitReasonstring

      Sent only as reset: a practice account reset cleared the position with no closing fill.

      reset

Last updated

Was this page helpful?