POST
/
v1
/
stake
/
rewards
/
search
Fetch staking rewards
curl --request POST \
  --url https://api.cdp.coinbase.com/platform/v1/stake/rewards/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "network_id": "ethereum-mainnet",
  "asset_id": "ETH",
  "address_ids": "[0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a]",
  "start_time": "2024-07-21T00:00:00Z",
  "end_time": "2024-07-21T00:00:00Z",
  "format": "usd"
}'
{
  "data": [
    {
      "address_id": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
      "date": "2024-07-21",
      "amount": "100",
      "state": "pending",
      "format": "usd",
      "usd_value": {
        "amount": "100",
        "conversion_price": "100",
        "conversion_time": "2024-07-21T00:00:00Z"
      }
    }
  ],
  "has_more": true,
  "next_page": "<string>"
}

Authorizations

​
Authorization
string
header
required

Enter your JSON Web Token (JWT) here. Refer to the Generate JWT section of our Authentication docs for information on how to generate your Bearer Token.

Query Parameters

​
limit
integer

A limit on the number of objects to be returned. Limit can range from 1 to 100, and the default is 50.

​
page
string

A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Maximum length: 5000

Body

application/json
​
network_id
string
required

The ID of the blockchain network.

Example:

"ethereum-mainnet"

​
asset_id
string
required

The symbol of the asset for which the staking rewards are being fetched.

Example:

"ETH"

​
address_ids
string[]
required

The onchain addresses for which the staking rewards are being fetched

Example:

"[0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a]"

​
start_time
string<date-time>
required

The start time of this reward period

Example:

"2024-07-21T00:00:00Z"

​
end_time
string<date-time>
required

The end time of this reward period

Example:

"2024-07-21T00:00:00Z"

​
format
enum<string>
default:usd
required

The format in which the rewards are to be fetched i.e native or in equivalent USD

Available options:
usd,
native
Example:

"usd"

Response

The list of staking rewards

​
data
object[]
required
​
has_more
boolean
required

True if this list has another page of items after this one that can be fetched.

​
next_page
string
required

The page token to be used to fetch the next page.