List nodes

GET 
/api/v2/nodes

Get a list of the nodes on the network along with the related information.

Request

Query Parameters

epochSeq uint64

Return the node list for the given epoch. If not set, the node list for the current epoch will be returned.

pagination.first int32

Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

pagination.after string

If paging forwards, the cursor string for the last row of the previous page.

pagination.last int32

Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

pagination.before string

If paging forwards, the cursor string for the first row of the previous page.

pagination.newestFirst boolean

Whether to order the results with the newest records first. If not set, the default value is true.

Responses

200

A successful response.

application/json

Schema

Schema

nodes object

Page of node data and corresponding page information.

edges object[]

Page of node data and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Data specific to a single node on the Vega network.

avatarUrl string

Avatar url.

delegations object[]

Node's delegations.

Array [

amount string

Amount delegated. This field is an unsigned integer scaled to the asset's decimal places.

epochSeq string

Epoch of delegation.

nodeId string

Node ID to delegate to.

party string

Party which is delegating.

]

epochData object

Information about epoch.

offline int32

Total number of offline epochs since node was created.

online int32

Total number of online epochs since node was created.

total int32

Total number of epochs since node was created.

ethereumAddress string

Ethereum public key of the node.

id string

Node ID i.e. the node's wallet ID.

infoUrl string

URL where users can find out more information on the node.

location string

Country code for the location of the node.

maxIntendedStake string

Max amount of (wanted) stake. This field is an unsigned integer scaled to the asset's decimal places.

name string

Node name.

pendingStake string

Amount of stake on the next epoch. This field is an unsigned integer scaled to the asset's decimal places.

pubKey string

Public key of the node operator.

rankingScore object

Node ranking information.

performanceScore string

Performance based score.

previousStatus Validation status of the node

Possible values: [VALIDATOR_NODE_STATUS_UNSPECIFIED, VALIDATOR_NODE_STATUS_TENDERMINT, VALIDATOR_NODE_STATUS_ERSATZ, VALIDATOR_NODE_STATUS_PENDING]

Default value: VALIDATOR_NODE_STATUS_UNSPECIFIED

Status of the validator in the previous epoch.

rankingScore string

Final score.

stakeScore string

Stake based score - no anti-whaling.

status Validation status of the node

Possible values: [VALIDATOR_NODE_STATUS_UNSPECIFIED, VALIDATOR_NODE_STATUS_TENDERMINT, VALIDATOR_NODE_STATUS_ERSATZ, VALIDATOR_NODE_STATUS_PENDING]

Default value: VALIDATOR_NODE_STATUS_UNSPECIFIED

Status of the validator in the current epoch.

votingPower int64

Tendermint voting power of the validator.

rewardScore object

Node reward score.

multisigScore string

Multisig score.

normalisedScore string

Normalised validator score for rewards.

performanceScore string

Performance based score.

rawValidatorScore string

Stake based score - with anti-whaling.

validatorScore string

Un-normalised score.

validatorStatus Validation status of the node

Possible values: [VALIDATOR_NODE_STATUS_UNSPECIFIED, VALIDATOR_NODE_STATUS_TENDERMINT, VALIDATOR_NODE_STATUS_ERSATZ, VALIDATOR_NODE_STATUS_PENDING]

Default value: VALIDATOR_NODE_STATUS_UNSPECIFIED

Status of the validator for reward.

stakedByDelegates string

Amount of stake that has been delegated by token holders. This field is an unsigned integer scaled to the asset's decimal places.

stakedByOperator string

Amount the node operator has put up themselves. This field is an unsigned integer scaled to the asset's decimal places.

stakedTotal string

Total amount staked on node. This field is an unsigned integer scaled to the asset's decimal places.

status Node status type

Possible values: [NODE_STATUS_UNSPECIFIED, NODE_STATUS_VALIDATOR, NODE_STATUS_NON_VALIDATOR]

Default value: NODE_STATUS_UNSPECIFIED

Node status.

tmPubKey string

Public key of Tendermint.

]

pageInfo object

Page information that is used for fetching further pages.

endCursor string

End cursor.

hasNextPage boolean

Indicator if there is a next page.

hasPreviousPage boolean

Indicator if there is a previous page.

startCursor string

Start cursor.

Example (from schema)

{
  "nodes": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "avatarUrl": "string",
          "delegations": [
            {
              "amount": "string",
              "epochSeq": "string",
              "nodeId": "string",
              "party": "string"
            }
          ],
          "epochData": {
            "offline": 0,
            "online": 0,
            "total": 0
          },
          "ethereumAddress": "string",
          "id": "string",
          "infoUrl": "string",
          "location": "string",
          "maxIntendedStake": "string",
          "name": "string",
          "pendingStake": "string",
          "pubKey": "string",
          "rankingScore": {
            "performanceScore": "string",
            "previousStatus": "VALIDATOR_NODE_STATUS_UNSPECIFIED",
            "rankingScore": "string",
            "stakeScore": "string",
            "status": "VALIDATOR_NODE_STATUS_UNSPECIFIED",
            "votingPower": 0
          },
          "rewardScore": {
            "multisigScore": "string",
            "normalisedScore": "string",
            "performanceScore": "string",
            "rawValidatorScore": "string",
            "validatorScore": "string",
            "validatorStatus": "VALIDATOR_NODE_STATUS_UNSPECIFIED"
          },
          "stakedByDelegates": "string",
          "stakedByOperator": "string",
          "stakedTotal": "string",
          "status": "NODE_STATUS_UNSPECIFIED",
          "tmPubKey": "string"
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "string"
    }
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...