Skip to main content
GET
Error

Authorizations

donate-api-key
string
header
required

Developer API key. Required for config create/list/delete and project analytics. Optional on public GET reads (anonymous callers are IP rate-limited). Obtain from the Developer dashboard.

Headers

donate-api-key
string

Optional. Omit for the anonymous IP budget (~20 req/min). Keys share their organization billing-tier limit.

Minimum string length: 1

Path Parameters

chainId
integer
required

Chain ID

address
string
required

Token address

Query Parameters

includeHidden
enum<string>

Include hidden coins when computing leaderboard rank (default false). Financial stats are unchanged.

Available options:
true,
false

Response

Charity token stats including configs.

usdDonatedE6
string
required
donationCount
string
required
firstDonationDate
string | null
required
lastDonationDate
string | null
required
moderation
object | null
required

Discovery decision, or null when the token has not been recorded locally. Direct lookups remain available when hidden.

allTimeDonationRank
integer | null
required

Rank by all-time donations in the requested leaderboard (includeHidden); null if excluded or no recorded leaderboard entry

Required range: x > 0
activeConfig
object
required
previousConfigs
object[]
required