Get staking metrics for a given subnet

Gets staking metrics for a given subnet.

GET /v2/networks/{network}/metrics/{metric}

Try it

JavaScript

JavaScript

import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche({
  network: "mainnet",
});

async function run() {
  const result = await avalanche.metrics.networks.getStakingMetrics({
    metric: "validatorCount",
    startTimestamp: 1689541049,
    endTimestamp: 1689800249,
    pageSize: 10,
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

200

{
  "results": [
    {
      "value": 123,
      "timestamp": 123
    }
  ],
  "nextPageToken": "<string>"
}

Path Parameters

metric · enum<string> · required

Which network level metric to fetch.

Available options: delegatorCount, delegatorWeight, validatorCount, validatorWeight

network · enum<string> · required

Either mainnet or testnet/fuji.

Available options: mainnet, fuji, testnet

Query Parameters

startTimestamp · integer

Query param for retrieving items after a specific timestamp.

Required range: x >= 0

endTimestamp · integer

Query param for retrieving items before a specific timestamp.

Required range: x >= 0

pageToken · string

A page token, received from a previous list call. Provide this to retrieve the subsequent page.

pageSize · integer · default: 100

The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 2160.

Required range: 1 <= x <= 2160

Response

200

application/json

Successful response

results · object[] · required

Array of current metrics values at different timestamps.

Show child attributes

results. value · number · required

Aggregated value for the current metrics.

results. timestamp · number · required

Unix Epoch timestamp for which metrics are aggregated. Depending on the interval of the metric this can be at the start of the relevant hour, day, month, year, etc.

nextPageToken · string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.