Returns a list of validators registered at the consensus layer

Changed on

The list includes all registered entities, even those without a currently active validator node.

get/consensus/validators

Request

  • Base URL: https://nexus.oasis.io/v1
  • URL: https://nexus.oasis.io/v1/consensus/validators
  • 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.

namestring

A filter on the validator name. Every returned validator will have a name that is a superstring of the input param.

idstring

A filter on the entity or node ID (base64-encoded ed25519 public key). Returns the validator whose entity_id matches the provided value, or whose node's node_id matches the provided value.

Response

A JSON object containing a list of validators 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,
  "validators": [
    {
      "entity_address": "oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p",
      "entity_id": "gb8SHLeDc69Elk7OTfqhtVgE2sqxrBCDQI84xKR+Bjg=",
      "node_id": "lbxs4hlud9XNloIOdhJPaCahd7HtiY8QATCgGnFfCM0=",
      "escrow": {
        "active_balance": "1234567890123456789012",
        "active_shares": "1234567890123456789012",
        "debonding_balance": "1234567890123456789012",
        "debonding_shares": "1234567890123456789012",
        "self_delegation_balance": "1234567890123456789012",
        "self_delegation_shares": "1234567890123456789012",
        "active_balance_24": "1234567890123456789012"
      },
      "voting_power": "1234567890123456789012",
      "voting_power_cumulative": "1234567890123456789012",
      "start_date": "2022-10-15T00:05:34Z",
      "media": {
        "name": "WhaleStake"
      },
      "signed_blocks": [
        {
          "height": 8048956
        }
      ]
    }
  ],
  "stats": {
    "total_voting_power": "1234567890123456789012",
    "total_staked_balance": "1234567890123456789012"
  }
}

Changes

  • v16dcecc67a97eRevision changes
    • breaking

      the ////// response's property type changed from integer to no type, and format from int64 to no format for status

    • breaking

      the /////// response's property type changed from integer to no type, and format from int64 to no format for status

    • breaking

      the /////// response's property type changed from integer to no type, and format from int64 to no format for status

    • info

      added the new optional query request parameter id

    • info

      added to the ////// response property allOf list for the response status

    • info

      added to the /////// response property allOf list for the response status

    • info

      added to the /////// response property allOf list for the response status

  • v145e86f2c70b8Revision changes
    • info

      added the optional property /////// to the response with the status