Get Started

The Blockdaemon Staking Reporting API provides developers access to various staking information across blockchain protocols. The API lets you access data, including validator status, rewards, and activity.

Follow the steps below to get started with the Staking API for free today.

Step 1. Sign Up for an API Key

To use the Blockdaemon Staking API, you need an API key. Sign up on the Blockdaemon website to create an account and obtain your API key from the dashboard.

Get Your Free API Key!

Enjoy Rapid and Scalable Multichain Access!

Step 2. Get Familiar with API Endpoints

Explore the various endpoints provided by the Staking API to interact with blockchain networks. For a full list of endpoints, refer to the Staking Reporting API Documentation.

Step 3. Authenticate Your API Requests

To authenticate your API requests, use one of these methods:

3.1. Using Your API Key as a Query Parameter

Add your API key as a query parameter in the URL:

  • parameter: apiKey
  • value: YOUR_API_KEY

For example, to get the status for Polkadot using the Staking Reporting API, use:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/status/{address}?apiKey=YOUR_API_KEY

Authentication with a query parameter can be used with any tool - no additional actions are needed.

📘

Info:

If there are other query parameters, replace ? with &.

3.2. Using Your API Key as a Bearer Token

- Bearer Token in cURL

Add your API key as a bearer token in the header:

--header 'Authorization: Bearer YOUR_API_KEY'

For example, to get the current status by a user-defined nominator address for Polkadot using our Staking Reporting API, use the following code:

curl --request GET 'https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/status/{address}' \
--header 'Authorization: Bearer YOUR_API_KEY'

Or, if you prefer to use short options, run the following:

curl -X GET 'https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/status/{address}' \
-H 'Authorization: Bearer YOUR_API_KEY'

- Bearer Token in Postman

In Postman, you can set YOUR_API_KEY as a bearer token not only for a particular request but also for a collection of requests.

  1. Navigate to the Authorization or Auth tab.
  2. Select Bearer Token from the Type drop-down menu.
  3. Paste YOUR_API_KEY into the Token input box.

3.3. Using Your API Key as an X-API-Key

- X-API-Key in cURL

Add your API key as X-API-Key in the header:

--header 'X-API-Key: YOUR_API_KEY'

For example, to get the current status by a user-defined nominator address for Polkadot using our Staking Reporting API, use the following cURL request:

curl --request GET 'https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/status/{address}' \
--header 'X-API-Key: YOUR_API_KEY' 

Or, if you prefer to use short options, run the following:

curl -X GET 'https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/status/{address}' \
-H 'X-API-Key: YOUR_API_KEY'

- X-API-Key in Postman

In Postman you can set YOUR_API_KEY as an X-API-Key not only for a particular request but also for a collection of requests.

  1. Navigate to the Authorization or Auth tab.
  2. Select API Key from the Type drop-down menu.
  3. Paste your YOUR_API_KEY into the Value input box.
  4. Ensure the Add to option is set to Header.

Step 4. Test the API

To test the API, send a simple request to your chosen endpoint. For example, send a GET request to get a validator status, and the API will return the data in JSON format.

Option 1: Use the API Reference Docs

Try the GET the Status of a Validator request in the API reference docs. Before using the interactive features, make sure you generate an API key.

Option 2: Use Your Preferred API Platform

You can also use an API platform like Postman. Use this endpoint to get a list of validators:

https://svc.blockdaemon.com/reporting/staking/v1/ethereum/mainnet/validator/status

Step 5. Integrate the API Into Your Application

Once you have tested the API and are familiar with its endpoints, you can integrate the API into your application to access multi-chain staking data.

👋 Need Help?

Contact us through email or our support page for any issues, bugs, or assistance you may need.