Sign in

Returns a list of entities registered at the consensus layer.

Changed on
get/consensus/entities

Request

  • Base URL: https://nexus.oasis.io/v1
  • URL: https://nexus.oasis.io/v1/consensus/entities
  • Auth: none declared

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 entities registered at the consensus layer.

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,
  "entities": [
    {
      "id": "gb8SHLeDc69Elk7OTfqhtVgE2sqxrBCDQI84xKR+Bjg=",
      "address": "oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p"
    }
  ]
}

Changes