Staking Data API provides methods for retrieving various data related to the network. This section describes the available network methods along with descriptions and recommendations for their usage.

Methods

Get Supply Data

Endpoint: GET /api/v1/{network}/data/network/supply-data

Description: Retrieve network supply data, offering insights into the overall supply dynamics of the network.

Utilize this endpoint to collect information on the network's supply and analyze the data to improve your comprehension of the network's economic state.

Get Last Staking Period

Endpoint: GET /api/v1/{network}/data/network/last-staking-period

Description: Retrieve information about the last staking period (epoch, era etc.) on the network.

Utilize this endpoint to retrieve historical data on the network's staking periods and analyze the information to discern trends or alterations in staking behavior.

Get Network APY

Endpoint: GET /api/v1/{network}/data/network/apy

Description: Retrieve the Annual Percentage Yield (APY) for the network based on the specified staking period (epoch, era etc.).

Utilize this endpoint to compute and track the APY for various staking periods, and grasp the fluctuations in network APY over time to facilitate well-informed staking decisions.

Get Network APR

Endpoint: GET /api/v1/{network}/data/network/apr

Description: Retrieve the Annual Percentage Rate (APR) for the network based on the specified staking period (epoch, era, etc.).

Utilize this endpoint to compute and track the APR for various staking periods, and grasp the fluctuations in network APR over time to facilitate well-informed staking decisions.

Get Validators Count

Endpoint: GET /api/v1/{network}/data/network/validators-count

Description: Retrieve the count of validators on the network for the specified staking period (epoch, era etc.).

Utilize this endpoint to oversee the count of participating validators in the network and assess validator count data for evaluations of network health.

Get Delegators Count

Endpoint: GET /api/v1/{network}/data/network/delegators-count

Description: Retrieve the count of delegators on the network for the specified staking period (epoch, era etc.).

Utilize this endpoint to evaluate the involvement of delegators in staking and analyze the data on delegators count to comprehend trends in user participation.

Get Network Stake

Endpoint: GET /api/v1/{network}/data/network/stake

Description: Retrieve information about the network's total stake for the specified staking period (epoch, era etc.).

Utilize this endpoint to obtain data on the overall staking amount in the network.

Get Network Rewards

Endpoint: GET /api/v1/{network}/data/network/rewards

Description: Retrieve information about the network's rewards for the specified staking period (epoch, era etc.).

Use this endpoint to retrieve data on rewards distributed across various staking periods, and analyze the reward data to comprehend the economic incentives within the network.

Get Exit Queue

Endpoint: GET /api/v1/{network}/data/network/exit-queue

Description: This method allows you to retrieve information in days about the network exit queue. The exit queue contains validators who have requested to exit the network, and they must wait for a certain period before safely exit.

Utilize this endpoint to track validators within the exit queue and comprehend the waiting duration necessary for validators to safely exit.

This method is only relevant for the Ethereum network.

Get Staking Queue

Endpoint: GET /api/v1/{network}/data/network/staking-queue

Description: Retrieve information about the network staking queue in days, which provides insights into the current staking activities on the network.

Use this endpoint to evaluate staking activities and analyze the staking queue data to gain insights into the current state of network staking.

This method is only relevant for the Ethereum network.

What's Next?