Nexus/API Reference/Journal and Edge

Read your rank over time

GEThttps://app.skylit.ai/api/nexus/v1/ranks/me/chart

Your rank as a line over time, with your placement, promotions and demotions marked, and your pace to the next tier.

  • range is 3m, 1y or all. Left out, 1y. Anything else answers 400 bad_request.
  • enabled: false if ranks are switched off, and also while the chart is switched off.
  • This is your own member rank. account=agent or any port answers 400 bad_request: your bot's rank is GET /api/nexus/v1/agent/rank and its Edge GET /api/nexus/v1/agent/edge.
  • pace is null when there's no steady climb to measure.
  • Read only.
curl -s "https://app.skylit.ai/api/nexus/v1/ranks/me/chart?range=3m" \
  -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

    Leave it out, or send main. This is yours as a member, not an account's: agent answers 400 bad_request, and so does port.

    main
  • rangestringdefault 1y

    3m, 1y or all. Left out, 1y.

    3m1yall

Responses

  • 200

    Your rank over time.

  • 400

    Code: bad_request. account=agent or a port was sent (your bot's rank is GET /api/nexus/v1/agent/rank), account is something else, range isn't 3m, 1y or all, or after isn't an event id. 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 the account can't do this. Codes: account_suspended, nexus_access_denied, futures_access_denied.

  • 404

    Code: user_not_found. This Skylit account hasn't used Nexus yet, so there's nothing to read.

  • 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

    Try again in a moment (honour Retry-After when it's sent). Codes: stale_quote (the quote, or a stock's last trade, is more than 15 seconds old, so nothing filled), no_live_price, rules_pending, unavailable, auth_unavailable, access_check_unavailable, api_keys_unavailable, trades_api_disabled, stream_unavailable (the live stream isn't on, or the server is restarting: try again shortly, or poll the reads).

Response fields

  • dataobject

    Your rank over time.

    • enabledboolean
    • pointsobject[]
    • eventsobject[]

      Placements, promotions and demotions on the chart.

    • paceobject | null

      Weeks to the next tier at your recent pace, or null when there's no steady climb to measure.

  • metaobject

    Which account and port were read.

    • accountstring
      mainagent
    • portstring | nulluuid

      The port you sent, or null.

Last updated

Was this page helpful?