Nexus/API Reference/Journal and Edge

Your trading behaviour

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

How you manage trades on one of your accounts, all time: how much of each trade's best return you kept, how far winners ran after you sold, how much you gave back from the peak, how far trades went against you, how long you hold and how soon you first trim. The Journal's Behaviour panel, by key. Read only.

Each figure comes with the number of trades it was measured on. captureRate is a mean; averageMissedUpside, averageApexGiveback and averageDrawdown are the median trade's (the middle one, so one outlier can't move them). A figure with a sample of 0 is null: nothing was measured, which is not the same as a measured 0. avgHoldTime and avgTimeToFirstTrim are null when there is nothing to average.

account is main (your simulated wallet) or agent (your bot's account); port is one of your ports. meta says which account and port were read.

curl -s "https://app.skylit.ai/api/nexus/v1/journal/behaviour?account=agent" \
  -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

    Which of your accounts. Left out, your default account.

    mainagent
  • portstring

    One of your port ids (GET /v1/trading/ports). An account sent beside it must agree with it.

Responses

  • 200

    Your behaviour figures on that account.

  • 400

    bad_request: account is not main or agent, or it does not agree with the port.

  • 401

    Missing or invalid key.

  • 404

    port_not_found: that port is not one of yours. user_not_found: this account has not used Nexus yet.

  • 503

    behaviour_unavailable: not available on this server yet.

Response fields

  • dataobjectrequired
    • timeframestringrequired
      all-time
    • captureRatenumber | nullrequired

      Percent of each trade's best return you kept at the exit, the mean. null when captureSample is 0.

    • captureSampleintegerrequired

      Trades it was measured on.

    • averageMissedUpsidenumber | nullrequired

      Percentage points a winner kept running after you sold, the median trade's. null when missedUpsideSample is 0.

    • missedUpsideSampleintegerrequired
    • averageApexGivebacknumber | nullrequired

      Percentage points given back from the peak to the exit, the median trade's. null when apexGivebackSample is 0.

    • apexGivebackSampleintegerrequired
    • averageDrawdownnumber | nullrequired

      How far below entry a trade went while you held it, percent, the median trade's (a positive number). null when drawdownSample is 0.

    • drawdownSampleintegerrequired
    • avgHoldTimestring | nullrequired

      Average time held, for example "1m" or "2h 5m".

    • avgTimeToFirstTrimstring | nullrequired

      Average time from entry to your first partial exit.

  • metaobjectrequired
    • accountstring
      mainagent
    • portstring | null

Last updated

Was this page helpful?