Skip to main content
GET
/
v1
/
babylon
/
finalityProviders
/
{finality_provider}
/
rewards
Get finality provider rewards metrics
curl --request GET \
  --url https://api.rated.network/v1/babylon/finalityProviders/{finality_provider}/rewards \
  --header 'Authorization: Bearer <token>'
{
  "previous": "<string>",
  "next": "<string>",
  "pages": 1,
  "results": [
    {
      "day": "2023-12-25",
      "finalityProviderAddress": "<string>",
      "finalityProviderName": "<string>",
      "btcPubkey": "<string>",
      "btcAddress": "<string>",
      "identity": "<string>",
      "fromBlockNumber": 123,
      "toBlockNumber": 123,
      "token": "<string>",
      "totalDelegationRewards": 123,
      "totalCommissionRewards": 123,
      "commissionRate": 123
    }
  ]
}
Using this endpoint, you can query the historical daily rewards of a finality provider by their unique finality_provider identifier/s. This identifier can be their Babylon address, BTC public key, or BTC address. totalDelegationRewards are the rewards, with its denomination specified by the token field, which delegators are entitled to receive from the finality provider they have staked to. The rewards from the commission a finality provider charges are given by the totalCommissionRewards. You can use the fromDate and toDate parameters to query a range of days.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
finality_provider
string
required

Query Parameters

​
limit
integer
default:10

The number of results returned per page

​
offset
integer
default:0

The number of results to skip before starting to return

​
fromDate
string<date> | null

Start date

Example:

"2023-01-01"

​
toDate
string<date> | null

End date

Example:

"2023-12-31"

Response

Successful Response

​
previous
string | null
required
​
next
string | null
required
​
pages
integer
required
Required range: x >= 0
​
results
BabylonFinalityProviderRewards · object[]
required