v1

latestOpenAPI 3.1.02026-07-1288262495.0 KB

Primary Network Rewards

List pending rewards

Lists pending rewards on the Primary Network for the supplied addresses.

get/v1/networks/{network}/rewards:listPending

Path parameters

network'mainnet' | 'fuji' | 'testnet' required

Either mainnet or testnet/fuji.

Query parameters

addressesstring

A comma separated list of X-Chain or P-Chain wallet addresses, starting with "avax"/"fuji", "P-avax"/"P-fuji" or "X-avax"/"X-fuji". One of addresses or nodeIds is required.

pageTokenstring

A page token, received from a previous list call. Provide this to retrieve the subsequent page.

pageSizeinteger

The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.

nodeIdsstring

A comma separated list of node ids to filter by. One of addresses or nodeIds is required.

sortOrder'asc' | 'desc'

The order by which to sort results. Use "asc" for ascending order, "desc" for descending order. Sorted by timestamp or the sortBy query parameter, if provided.

Response

Successful response

nextPageTokenstring

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.

Example response

{
  "pendingRewards": [
    {
      "addresses": [
        "avax1h2ccj9f5ay5acl6tyn9mwmw32p8wref8vl8ctg"
      ],
      "estimatedReward": {
        "assetId": "th5aLdWLi32yS9ED6uLGoMMubqHjzMsXhKWwzP6yZTYQKYzof",
        "name": "Avalanche",
        "symbol": "AVAX",
        "denomination": 9,
        "amount": "5001000"
      }
    }
  ]
}