Get your own standing

Your rank and value on every shown board for one period and category, including a rank outside the list, plus your win rate and how many markets you have had decided. A rank is null when you are unranked there (opted out, or no activity in the period) or STX hides that board.

GET

https://demo.stxapp.iohttps://demo.stxapp.cahttps://api.on.stxapp.ca/api/v1/leaderboard/me

Try it ▶

Try it

Base URL

Key ID stx_access_keyPrivate key (PEM or base64 seed) stx_private_key

Request

Send requestShow signed headersClear saved key

Every endpoint, in one place: the full Try it.

Signing happens in your browser with WebCrypto. Your private key is never sent anywhere; Send request sends your key ID and the signature to the demo host above. Only demo hosts are offered. The key ID and private key are saved in this browser's local storage, per jurisdiction, until you click Clear saved key. Use a demo key here, never a production one.

Parameters

Name	In	Type	Required	Description
period	query	daily | weekly | monthly | yearly | all	no	The ranking window, on America/New_York calendar days: daily is today, weekly from Monday, monthly from the 1st, yearly from 1 January, all lifetime. Default weekly.
category	query	string	no	all (default) or a sport key, as in a row’s top_sport, e.g. basketball. An unknown key has no rankings: an empty board, or an unranked standing on /me.

Responses

Status	Description	Schema
200	Success	LeaderboardStanding
400	A parameter was missing or invalid.	Error
401	No credential, a bad signature, or a bearer token that is expired, invalid or not a member’s. With any signing header present the API-key rules apply and the body is {“error”:“Missing or invalid API key credentials”}; otherwise {“error”:“Unauthorized”}.	Error
403	The account behind this key is not active, for example it is pending approval or suspended. Body: {“error”:“Your account is suspended. Contact support.”}, the message naming the account’s status.	Error
404	The leaderboard is not enabled in this environment. Body: {“error”:“Leaderboard is not enabled”}	Error

Example

Request:

curl --request GET \
  --url 'https://demo.stxapp.io/api/v1/leaderboard/me' \
  --header 'X-STX-ACCESS-KEY: <key-id>' \
  --header 'X-STX-ACCESS-TIMESTAMP: <unix-ms>' \
  --header 'X-STX-ACCESS-SIGNATURE: <base64-ed25519>'

Response 200:

{
  "biggest_win": "string",
  "category": "string",
  "markets": "string",
  "opted_in": false,
  "period": "daily",
  "predictions": "string",
  "profit": "string",
  "return": "string",
  "settled_markets": 0,
  "streak": "string",
  "volume": "string",
  "win_rate": null,
  "win_rate_rank": "string"
}

Response fields

Field	Type	Description
biggest_win		Your rank and biggest single-market win; null when unranked or the board is hidden.
category	string	The category asked for.
markets		Your rank and markets settled; null when unranked or the board is hidden.
opted_in	boolean	Whether you appear on public boards. false is why every rank is null for an opted-out member.
period	string	The period asked for.
predictions		Your rank and contracts settled; null when unranked or the board is hidden.
profit		Your rank and net profit; null when unranked or the board is hidden.
return		Your rank and return (profit ÷ volume), 0.0–1.0; needs $500 of volume; null when unranked or the board is hidden.
settled_markets	integer	Markets decided (won or lost) in the period. 0 when unranked.
streak		Your rank and longest winning streak; null when unranked or the board is hidden.
volume		Your rank and notional traded; null when unranked or the board is hidden.
win_rate	number	Share of decided markets you won, 0.0–1.0. null until at least 10 markets have been decided in the period; a market settled at zero profit is neither a win nor a loss.
win_rate_rank		Your rank and win rate, 0.0–1.0; needs 10 decided markets to rank; null when unranked or the board is hidden.