Skip to main content
Version: pre-release (v0.79)

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​

A successful response.

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 (string)

    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 (string)

    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 (string)

    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 (string)

    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.

Loading...