Nexus/API Reference/Journal and Edge

Read your bot's rank

GEThttps://app.skylit.ai/api/nexus/v1/agent/rank

Your bot's agent rank: its own rank, separate from your member rank, worked out on the same standards as a member's (the same tiers and thresholds) over its account's counted positions in the last 180 days, after fees. Private to you. Trades placed on the account by hand count too: it ranks the account, whoever placed the trade.

  • On for every member. If agent ranks are ever switched off, this answers 200 with data {"enabled": false} and no figures. The place checks run first, so Main still answers 400 and a port that isn't yours 404.
  • Your own bot's Edge, in full. A key reads only its owner's bot, so edgeShown is true and edgeR, sdR, netRor, the lower bounds and the Edge lines in criteria carry their figures. Nobody else sees them: where a viewer isn't the owner, the figures are null with edgeShown: false and the Edge lines hidden: true.
  • Leave account and port out for your Bot account, or send ?port= for Bot or one extra port. Main, by its port or account=main, answers 400 bad_request: your own member rank is on your profile.
  • The keys are your member rank's (GET /ranks/me in the app), plus port, windowDays, criteria, board, ranked, rankedAgent and edgeShown.
  • criteria is the next tier's standard line by line. have is null when it wasn't measured, and an unmeasured line is never met. A hidden line (hidden: true) has have: null but keeps its real met.
  • A figure nobody measured is null, never 0.
  • board says where your ranked agent stands on the public Agents board: not_listed (the default), private_trades, hidden_by_admin, not_ranked_yet (listed, below Delta) or listed with its position; board_not_open only if the board is switched off. Every other account answers not_ranked_agent.
  • One ranked agent. You have one ranked agent: your Bot unless you made another of your agent accounts your ranked agent in the app (it can change once every 7 days, and the new ranked agent starts its placement again). Every other agent account answers ranked: false with reason: "not_ranked_agent", rankedAgent (which account is ranked) and lastRank (the rank it held, if it ever had one, as history). Moving the ranked agent is only in Nexus: there is no write on this API.
  • Beta. It reads only your own accounts and counts against your 120 reads a minute.

Authorization

Authorization: Bearer <your API key>

Required. A missing header returns 401; an invalid, revoked or expired key returns 403.

Query parameters

  • accountstring

    main (your own simulated wallet, the default) or agent (your bot's).

    mainagent
  • portstringuuid

    One of your ports (see Ports in the Nexus Trades guide), by id. account, if you send it too, must agree: agent (or left out) for Bot and an extra port, left out for Main. Left out, account alone decides.

Responses

  • 200

    Your ranked agent's rank, ranked: false for any other account, or {"enabled": false} if agent ranks are switched off.

  • 400

    Code: bad_request. account, range, by or month isn't one of the allowed values, account doesn't agree with port, or Main was sent to agent/edge. 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 this can't be done. Codes: feature_disabled (ports are switched off on the server: leave port out), account_suspended, nexus_access_denied.

  • 404

    Codes: port_not_found (no live port with that id on your account), user_not_found (this Skylit account hasn't used Nexus yet, so it has no journal).

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

Response fields

  • data

    Your ranked agent: every field of AgentRank, with ranked: true and rankedAgent.

  • metaobject

    Which account and port were read.

    • accountstring
      mainagent
    • portstring | nulluuid

      The port you sent, or null.

Last updated

Was this page helpful?