Granite Upgrade Activates in11d:16h:53m:24s
Primary Network

List delegators

Lists details for delegators.

GET
/v1/networks/{network}/delegators
x-glacier-api-key<token>

Api keys provide higher access to rate limits. To obtain an api key, sign up for an account at https://build.avax.network/console/utilities/data-api-keys.

In: header

Path Parameters

networkstring

Either mainnet or testnet/fuji.

Value in"mainnet" | "fuji" | "testnet"

Query Parameters

pageToken?string

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

pageSize?integer

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

Default10
Range1 <= value <= 100
rewardAddresses?string

A comma separated list of reward addresses to filter by.

sortOrder?string

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.

Value in"asc" | "desc"
delegationStatus?string

Delegation status of the node.

Value in"completed" | "active" | "pending"
nodeIds?string

A comma separated list of node ids to filter by.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://data-api.avax.network/v1/networks/mainnet/delegators?pageSize=10&rewardAddresses=P-avax1679zrp3z9mf7z4an42ddq47qzj36zv6ga20vwl%2CP-avax1s7kd0kfndlz6mh3l0etrrcmkg5y366k8e0s6cc&sortOrder=asc&delegationStatus=completed&nodeIds=NodeID-111111111111111111116DBWJs%2CNodeID-222222222222222222227DBWJs"
{
  "nextPageToken": "string",
  "delegators": [
    {
      "txHash": "string",
      "nodeId": "string",
      "rewardAddresses": [
        "string"
      ],
      "amountDelegated": "string",
      "delegationFee": "string",
      "startTimestamp": 0,
      "endTimestamp": 0,
      "grossReward": "string",
      "netReward": "string",
      "delegationStatus": "completed"
    }
  ]
}
{
  "message": "string",
  "statusCode": 400,
  "error": "Bad Request"
}
{
  "message": "string",
  "statusCode": 401,
  "error": "Unauthorized"
}
{
  "message": "string",
  "statusCode": 403,
  "error": "Forbidden"
}
{
  "message": "string",
  "statusCode": 404,
  "error": "Not Found"
}
{
  "message": "string",
  "statusCode": 429,
  "error": "Too Many Requests"
}
{
  "message": "string",
  "statusCode": 500,
  "error": "Internal Server Error"
}
{
  "message": "string",
  "statusCode": 502,
  "error": "Bad Gateway"
}
{
  "message": "string",
  "statusCode": 503,
  "error": "Service Unavailable"
}

Is this guide helpful?