accounts
List accounts
get
/accounts/list
operationId: account-list

Paginated catalog of every indexed XRPL account. Uses 1-indexed page + pageSize and returns total / pageCount. Optional search applies a case-insensitive substring filter across the address, curated metadata.name, and curated metadata.category. category exact-matches the curated category (e.g. exchange, issuer, validator). verifiedOnly / kycOnly toggle metadata filters. Sort defaults to top (composite: XRP balance × log(1 + 24h-txn-count)) — see accountListSort for the full sort waterfall. Two response-shape flags control the per-row payload: metadata (default TRUE — curated metadata block) and metrics (default FALSE — per-row txns_24h / delta_24h_xrp / last_active_at / created_at / age_days plus the XRP-equivalent portfolio total). Per-row metrics + total are gated on metrics=true because computing them costs extra subqueries against account_balance_events per page row.

Unlock protected endpoints

Enter your Bearer token once to enable every protected route in this API reference.

HTTP bearer

Saved for this browser tab only. The credential is never sent until you test an endpoint.

Authorizations
NameLocationDetails
BearerAuthAuthorization header · bearerJWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.
Query Parameters
NameTypeDefaultDescription
page
integer1
pageSize
integer20
search
string
category
string
verifiedOnly
booleanfalse
kycOnly
booleanfalse
sort
enum<string>"top"
Available
topbalancetotalnamecreatedtxns_24hlast_active
sortDir
enum<string>"desc"
Available
ascdesc
metadata
booleantrue
metrics
booleanfalse
Responses
200
application/json
Successful response
FieldTypeDescription
items
object[]
Items on the current page.
items[].address
string
XRPL classic address (r-address).
items[].metadata
object
Curated metadata block. Null when the request had `metadata=false`.
items[].balance
string
Current XRP balance of the account (decimal string XRP, not drops). Source: `account_data.current_balance_drops` ÷ 1e6.
items[].total
object
Sum across the portfolio of the XRP-equivalent value of every priced asset. Only computed when the request had `metrics=true`; otherwise null. Unpriced positions are excluded from the total.
items[].metrics
object
Per-row activity metrics. Present only when the request had `metrics=true`.
items[].metrics.txns_24h
integer
Count of balance events for the account over the trailing 24h.
items[].metrics.delta_24h_xrp
object
Net signed XRP delta (decimal string, in XRP not drops) over the trailing 24h. NULL when no XRP-asset balance events landed.
items[].metrics.last_active_at
object
Timestamp of the most recent balance event for the account, Unix-seconds. NULL when the account has no recorded events.
items[].metrics.created_at
object
Account record creation timestamp, Unix-seconds. NULL until first observation.
items[].metrics.age_days
object
Days since the account was first observed on-ledger. NULL when first-seen is unknown.
page
integer
1-indexed page number of the returned page.
pageSize
integer
Items per page (echoed from the request).
total
integer
Total number of items across all pages.
pageCount
integer
Total number of pages at the requested pageSize.
Example
Json
{
  "items": [
    {
      "address": "string",
      "metadata": {
        "name": "string",
        "category": "string",
        "verified": false,
        "iconUrl": "string",
        "domain": "string"
      },
      "balance": "string",
      "total": "string",
      "metrics": {
        "txns_24h": 0,
        "delta_24h_xrp": "string",
        "last_active_at": 1745798400,
        "created_at": 1745798400,
        "age_days": 0
      }
    }
  ],
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "pageCount": 0
}
400
application/json
Invalid input data
FieldTypeDescription
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
FieldTypeDescription
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
FieldTypeDescription
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
FieldTypeDescription
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
FieldTypeDescription
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": []
}