List your rank events
https://app.skylit.ai/api/nexus/v1/ranks/me/eventsYour placement, promotions, demotions, series, shields and EP moves, newest first.
limitis 1 to 100 (default 20; anything outside reads 20).afteris an eventid(orevt_and the id): only events with a higher id come back.- 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. inputsholds the figures the rank was worked out from at that moment.- Read only.
curl -s "https://app.skylit.ai/api/nexus/v1/ranks/me/events?limit=5" \
-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.mainlimitintegerdefault20min 1 · max 1001 to 100. Left out, 20.
afterstringAn event
id. Only events after it come back. Not an id:400 bad_request.
Responses
- 200
Your rank events, 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
dataobjectenabledbooleaneventsobject[]Newest first.
metaobjectWhich account and port were read.
accountstringmainagentportstring | nulluuidThe port you sent, or
null.
Last updated