Authentication - Reporting API

Learn how easy it is to authenticate Staking Reporting requests with the Blockdaemon Staking Reporting API.

To use the Staking Reporting API, you must authenticate your requests with your Blockdeamon API SuiteAPI key. Here's how to do it.

1. Getting an API Key

You need to get an API key to start using the Blockdeamon API Suite. If you don't have one, you can get a free one by signing up for Blockdaemon. Once you have an API key, you can authenticate your requests.

Need a Free API key?

Enjoy Rapid, Scalable, Multi-Protocol Blockchain Access with Ubiquity.

2. Using Your API Key

Once you have your API key, you can authenticate your requests. Overall, three different methods exist to authenticate Blockdeamon API Suite API requests, depending on whether you have a new or legacy API key. Let's have a look at each below.

2.1. Using Your API Key as a Query Parameter

The easiest way to authenticate a Blockdeamon API Suite request is via a special query parameter:

  • parameter: apiKey
  • value: YOUR_API_KEY

At the end of any Blockdeamon API Suite endpoint, add the following: ?apiKey=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 GET request:

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:

Note that if the query has additional parameters, replace ? with &.

2.2. Using Your API Key as a Bearer Token

You can authenticate Blockdeamon API Suite API requests by setting YOUR_API_KEY as a bearer token in the authorization header. Here are the instructions for doing this in cURL and Postman.

2.2.1. Bearer Token in cURL

When working with cURL, use the following code to set your YOUR_API_KEY as a bearer token:

--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'

2.2.2. 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. To do this, go to a request or collection tab and do the following:

  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.

Then you can run your request.

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

You can authenticate Blockdeamon API Suite requests by passing your YOUR_API_KEY in the X-API-Key header. Here are the instructions for doing this in cURL and Postman.

2.3.1. X-API-Key in cURL

When working with cURL, use the following code to set YOUR_API_KEY as a bearer token:

--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'

2.3.2. 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. Go to a request or collection tab and do the following:

  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.

Then you can run your request.

3. Getting the Result

If YOUR_API_KEY is correct, your request will be authorized, and you will get the result. For example, the requests from the sections above return the current status by a user-defined nominator address for Polkadot.

{
  "address": "1FmuvFXSkL988k8NQHeq4HDR43sHo3eEm2BbDhfuSeBs3qi",
  "status": "active",
  "commission": 1,
  "activationDate": "2022-09-23"
}

If the key is incorrect or missing, you will get this error:

{
    "status": 401,
    "type": "unauthorized",
    "title": "Invalid Token"
}

👋 Need Help?

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