GET
/
v1
/
networks
/
{network}
/
delegators
import { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
  network: "mainnet",
});

async function run() {
  const result = await avaCloudSDK.data.primaryNetwork.listDelegators({
    pageSize: 10,
    rewardAddresses: "P-avax1679zrp3z9mf7z4an42ddq47qzj36zv6ga20vwl,P-avax1s7kd0kfndlz6mh3l0etrrcmkg5y366k8e0s6cc",
    sortOrder: "asc",
    delegationStatus: "completed",
    nodeIds: "NodeID-111111111111111111116DBWJs,NodeID-222222222222222222227DBWJs",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();
{
  "nextPageToken": "<string>",
  "delegators": [
    {
      "txHash": "<string>",
      "nodeId": "<string>",
      "rewardAddresses": [
        "<string>"
      ],
      "amountDelegated": "<string>",
      "delegationFee": "<string>",
      "startTimestamp": 123,
      "endTimestamp": 123,
      "grossReward": "<string>",
      "netReward": "<string>",
      "delegationStatus": "completed"
    }
  ]
}

Authorizations

​
x-glacier-api-key
string
header
required

Api keys provide higher access to rate limits. To obtain an api key, sign up for an account at https://avacloud.io/.

Path Parameters

​
network
enum<string>
required

Either mainnet or testnet/fuji.

Available options:
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
default:10

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

Required range: 1 <= x <= 100
​
rewardAddresses
string

A comma separated list of reward addresses to filter by.

​
sortOrder
enum<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.

Available options:
asc,
desc
​
delegationStatus
enum<string>

Delegation status of the node.

Available options:
completed,
active,
pending
​
nodeIds
string

A comma separated list of node ids to filter by.

Response

200
application/json

Successful response

The response is of type object.