0x address or an ENS name — resolution is automatic.
GET /api/points
Request
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
address | string | Yes | 0x address or ENS name (e.g. vitalik.eth) |
Response 200
Response fields
Root
| Field | Type | Description |
|---|---|---|
address | string | Display address (ENS if resolved, otherwise 0x) |
ens | string | null | ENS name if resolved, otherwise null |
hexAddress | string | Lowercase 0x address |
resolvedAt | string | ISO timestamp of the resolution |
pointSystems | array | Per-point-system breakdown |
summary | object | Global aggregate |
pointSystems[]
| Field | Type | Description |
|---|---|---|
id | string | Point system UUID |
name | string | Point system name |
slug | string | null | Public leaderboard slug |
points | number | Total points accumulated |
events | number | Number of point events |
rank | number | null | Rank in this point system (null if blacklisted with no wallet entry) |
totalParticipants | number | null | Total number of wallets in this point system |
isBlacklisted | boolean | Whether the wallet is blacklisted |
blacklistReason | string | null | Reason for the blacklist |
blacklistedAt | string | null | ISO timestamp of the blacklist |
summary
| Field | Type | Description |
|---|---|---|
totalPointSystems | number | Number of point systems the wallet appears in |
totalPoints | number | Total points across all point systems |
blacklistedCount | number | Number of point systems where the wallet is blacklisted |
isBlacklisted | boolean | true if blacklisted in at least one point system |
Errors
| Status | Message | Cause |
|---|---|---|
400 | Missing required parameter: address | Missing address query parameter |
400 | Invalid address or ENS domain | Unrecognized format |
401 | Missing API key | No Authorization header |
401 | Invalid API key | Key not found |
403 | This API key does not have read permissions | Key lacks read permission |
Edge cases
Pre-emptive blacklist — if a wallet was blacklisted before receiving any points, it still appears inpointSystems with points: 0 and rank: null.
Unknown wallet — if the wallet does not appear in any point system, pointSystems will be empty and summary.totalPointSystems will be 0.