Honeycluster Docs – Paginated richlist for a token

richlist

Paginated richlist for a token

get

/richlist/token/{tokenSlug}

operationId: richlist-token

Paginated richlist for a single token, ordered by absolute balance DESC with the account address as a deterministic tiebreaker. Each row carries the holder's balance plus curated account metadata (name, verified, verifiedBy, category) when available — unknown accounts surface those fields as null/false. The issuer account is excluded. Cursor is base64 of {balance, address} and must be passed verbatim to fetch subsequent pages. Reflects current trustline balances (live, not a snapshot).

Authorizations

Name	Location	Details
`BearerAuth`	Authorization header · bearer	JWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.

Path Parameters

Name	Type	Default	Description
`tokenSlug` required	string		Natural token identifier in `currency.issuer` form. Example: `USD.rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B`.

Query Parameters

Name	Type	Default	Description
`cursor`	string
`limit`	integer	`50`

Responses

200

application/json

Successful response

Field	Type	Description
`items`	object[]	Holder rows ordered by \|balance\| DESC.
`items[].address`	string	XRPL classic address of the trustline holder.
`items[].balance`	string	Current token balance held by the account, as a decimal string.
`items[].name`	object	Curated display name for the account, or `null` when metadata is unknown.
`items[].verified`	boolean	Whether the account's identity has been verified by a curated source. `false` when metadata is unknown.
`items[].verifiedBy`	object	Source that verified the account (e.g. `xrpscan`, `bithomp`), or `null`.
`items[].category`	object	Classification for the account (e.g. `exchange`, `issuer`, `project`), or `null`.
`nextCursor`	object	Opaque cursor to fetch the next page, or `null` when the current page is the last.

Example

Json

{
  "items": [
    {
      "address": "string",
      "balance": "string",
      "name": "string",
      "verified": false,
      "verifiedBy": "string",
      "category": "string"
    }
  ],
  "nextCursor": "string"
}

400

application/json

Invalid input data

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401

application/json

Authorization not provided

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403

application/json

Insufficient access

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

404

application/json

Not found

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500

application/json

Internal server error

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}