v1

latestOpenAPI 3.0.32026-07-173986194.3 KB

Returns a list of consensus layer accounts. Note that for performance reasons, the info returned by this endpoint may be slightly stale (<2 minutes). For the most up-to-date account state, query the single-account endpoint.

get/consensus/accounts

Query parameters

limitinteger

The maximum numbers of items to return.

offsetinteger

The number of items to skip before starting to collect the result set.

Response

A JSON object containing a list of consensus layer accounts.

total_countinteger required

The total number of records that match the query, i.e. the number of records the query would return with limit=infinity.

is_total_count_clippedboolean required

Whether total_count is clipped for performance reasons.

Example response

{
  "total_count": 412,
  "is_total_count_clipped": true,
  "accounts": [
    {
      "address": "oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p",
      "available": "1234567890123456789012",
      "escrow": "1234567890123456789012",
      "debonding": "1234567890123456789012",
      "delegations_balance": "1234567890123456789012",
      "debonding_delegations_balance": "1234567890123456789012",
      "first_activity": "2022-03-01T00:00:00Z",
      "allowances": [
        {
          "address": "oasis1qprtzrg97jk0wxnqkhxwyzy5qys47r7alvfl3fcg",
          "amount": "1234567890123456789012"
        }
      ],
      "stats": {
        "total_sent": "1234567890123456789012",
        "total_received": "1234567890123456789012",
        "num_txns": 4184
      }
    }
  ]
}