Read your rank
https://app.skylit.ai/api/nexus/v1/ranks/meYour 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
200withdata{"enabled": false}and no figures. - This is your own member rank.
account=agentor anyportanswers400 bad_request: your bot's rank isGET /api/nexus/v1/agent/rankand its EdgeGET /api/nexus/v1/agent/edge. - A figure not measured yet is left out or
null, never0. Before placement there is notier,eporp;nsays 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
accountstringLeave it out, or send
main. This is yours as a member, not an account's:agentanswers400 bad_request, and so doesport.main
Responses
- 200
Your rank, or
{"enabled": false}if ranks are switched off. - 400
Code:
bad_request.account=agentor aportwas sent (your bot's rank isGET /api/nexus/v1/agent/rank),accountis something else,rangeisn't3m,1yorall, orafterisn'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-Afterseconds, then retry. Codes:rate_limited, andstream_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-Afterwhen 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
dataobjectYour own member rank, as on your profile. A figure not measured yet is left out or
null, never0: before placement there is notier,eporp.enabledbooleanmodestringmethodVersionstringtierstringplacement, theta, delta, gamma, vega, omega or oracle.
tierNamestringThe tier's display name.
divisioninteger | null4 (IV) down to 1 (I).
divisionLabelstring | nullepintegerProgress inside the division as points, 0 to 100.
pnumberProgress toward the next tier, as a fraction.
nintegerPositions in the window.
nCountedintegerPositions that count (not scratches).
edgeRnumberAverage R per position, after fees.
sdRnumberThe spread of R per position.
netRornumber | nullNet P&L over the money put at risk, as a fraction.
activeDaysintegerlowerobjectLower bounds of
edgeRat 80%, 90% and 95% confidence. Each isnullwith fewer than two positions.statestringplacement,ranked,series(a promotion series is on) orshielded(a demotion shield is on).placementobjectseriesobject | nullA promotion series in progress, or
null.shieldobject | nullA demotion shield, or
null.nextobject | nullThe next tier and the progress toward it. A need that doesn't apply is
nullor left out.oracleSeatinteger | nulldormantbooleanstreakintegerverifiedobjectYour rank counted on verified trades only. With
n0 nothing was counted, soedgeRisnull(not measured), never 0.seasonobjectcelebrationobject | nullA promotion or placement the app hasn't shown you yet, or
null.
metaobjectWhich account and port were read.
accountstringmainagentportstring | nulluuidThe port you sent, or
null.
Last updated