Nexus/API Reference/Journal and Edge

Read your rank

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

Your own member rank, the one on your profile: tier, division, EP, progress to the next tier, any series or shield.

  • Ranks are on for every member. If they're ever switched off, it answers 200 with data {"enabled": false} and no figures.
  • 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.
  • A figure not measured yet is left out or null, never 0. Before placement there is no tier, ep or p; n says how many positions were counted.
  • Read only. It reads only your own rank.
curl -s "https://app.skylit.ai/api/nexus/v1/ranks/me" \
  -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

Responses

  • 200

    Your rank, or {"enabled": false} if ranks are switched off.

  • 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 own member rank, as on your profile. A figure not measured yet is left out or null, never 0: before placement there is no tier, ep or p.

    • enabledboolean
    • modestring
    • methodVersionstring
    • tierstring

      placement, theta, delta, gamma, vega, omega or oracle.

    • tierNamestring

      The tier's display name.

    • divisioninteger | null

      4 (IV) down to 1 (I).

    • divisionLabelstring | null
    • epinteger

      Progress inside the division as points, 0 to 100.

    • pnumber

      Progress toward the next tier, as a fraction.

    • ninteger

      Positions in the window.

    • nCountedinteger

      Positions that count (not scratches).

    • edgeRnumber

      Average R per position, after fees.

    • sdRnumber

      The spread of R per position.

    • netRornumber | null

      Net P&L over the money put at risk, as a fraction.

    • activeDaysinteger
    • lowerobject

      Lower bounds of edgeR at 80%, 90% and 95% confidence. Each is null with fewer than two positions.

    • statestring

      placement, ranked, series (a promotion series is on) or shielded (a demotion shield is on).

    • placementobject
    • seriesobject | null

      A promotion series in progress, or null.

    • shieldobject | null

      A demotion shield, or null.

    • nextobject | null

      The next tier and the progress toward it. A need that doesn't apply is null or left out.

    • oracleSeatinteger | null
    • dormantboolean
    • streakinteger
    • verifiedobject

      Your rank counted on verified trades only. With n 0 nothing was counted, so edgeR is null (not measured), never 0.

    • seasonobject
    • celebrationobject | null

      A promotion or placement the app hasn't shown you yet, or null.

  • metaobject

    Which account and port were read.

    • accountstring
      mainagent
    • portstring | nulluuid

      The port you sent, or null.

Last updated

Was this page helpful?