Skip to content
ChordChordChord Docs

Weekly or season leaderboard

GET
/points/leaderboard
curl --request GET \
  --url 'https://api.getchord.xyz/v1/points/leaderboard?scope=week&limit=100'

Wallets ranked by points for one week or the whole season, with base points, referral and streak bonuses, volume, trades, days active and tier. 503 NOT_ENABLED while the program is off on the deployment.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
scope
string
default: week
Allowed values: week season
week
string

Week number or current.

limit
integer
default: 100 >= 1 <= 200

Responses

Section titled “ Responses ”

200

Section titled “200”
Media typeapplication/json
object
chain
integer
season
integer
scope
string
week
integer | null
weekBounds
object
from

Unix time, seconds, UTC.

integer
to

Unix time, seconds, UTC.

integer
seasonStart

Unix time, seconds, UTC.

integer
currentWeek
integer
weekPool
number
rows
Array<object>
object
rank
integer
wallet

EVM address, hex, case-insensitive.

string
/^0x[a-fA-F0-9]{40}$/
points
number
basePoints
number
referralBonus
number
streakBonus
number
volumeUsd
number
trades
integer
daysActive
integer
tier
string | null
lastTradeTs

Unix time, seconds, UTC.

integer
totalWallets
integer
totalPoints
number
totalVolumeUsd
number
indexedToBlock
integer | null
updatedAt

Unix time, milliseconds — when the server built this answer.

integer
Examplegenerated
{
  "chain": 1,
  "season": 1,
  "scope": "example",
  "week": 1,
  "weekBounds": {
    "from": 1,
    "to": 1
  },
  "seasonStart": 1,
  "currentWeek": 1,
  "weekPool": 1,
  "rows": [
    {
      "rank": 1,
      "wallet": "example",
      "points": 1,
      "basePoints": 1,
      "referralBonus": 1,
      "streakBonus": 1,
      "volumeUsd": 1,
      "trades": 1,
      "daysActive": 1,
      "tier": "example",
      "lastTradeTs": 1
    }
  ],
  "totalWallets": 1,
  "totalPoints": 1,
  "totalVolumeUsd": 1,
  "indexedToBlock": 1,
  "updatedAt": 1
}

400

Section titled “400”

Invalid parameters — error names the check that failed (INVALID_PARAMS, BAD_ADDRESS, BAD_LIMIT, BAD_HOURS, …).

Media typeapplication/json

Every non-2xx body.

object
error
required

Stable machine code, e.g. INVALID_PARAMS, NOT_READY, RATE_LIMIT_EXCEEDED.

string
message

For humans.

string
statusCode

HTTP status, when included.

integer
Example
{
  "error": "INVALID_PARAMS",
  "message": "amount must be an integer string in the token's smallest unit"
}

503

Section titled “503”

The lane behind this endpoint is not ready or not enabled here (NOT_READY, CHAIN_NOT_ENABLED, NOT_ENABLED, *_UNAVAILABLE). Retry later; do not treat it as an empty answer.

Media typeapplication/json

Every non-2xx body.

object
error
required

Stable machine code, e.g. INVALID_PARAMS, NOT_READY, RATE_LIMIT_EXCEEDED.

string
message

For humans.

string
statusCode

HTTP status, when included.

integer
Example
{
  "error": "INVALID_PARAMS",
  "message": "amount must be an integer string in the token's smallest unit"
}