API Reference
App Login

Avalanche Reporting API Overview

Overview

The Avalanche Staking Reporting API provides easy access to key staking details. You can retrieve up-to-date or historical information about stakes, rewards, and validator/delegator statuses.

Supported network: Mainnet

➡️ Stake & Rewards

This endpoint returns the total rewards between specified timestamps for single or multiple addresses of the validator/delegator.

Endpoints

Validators

Endpoint
Get the Stake & Rewards of a Validator - GET /validator/rewards/{address}
Get the Stake & Rewards of Multiple Validators - POST /validator/rewards
Get the Historical Stake & Rewards of a Validator - POST /validator/history/{address}
Get the Historical Stake & Rewards of Multiple Validators - POST /validator/history

Delegators

Endpoint
Get the Stake & Rewards of a Delegator - GET /delegator/rewards/{address}
Get the Stake & Rewards of Multiple Delegators - POST /delegator/rewards
Get the Historical Stake & Rewards of a Delegator - POST /delegator/history/{address}
Get the Historical Stake & Rewards of Multiple Delegators - POST /delegator/history

Sample Object

The example object returned by the Stake & Rewards of a Delegator endpoint is shown below.

{
  "address": "P-avax16r88cypqez82s58tzy2dgttx0h96pag66msz0y",
  "currency": "AVAX",
  "metadata": {
    "commission": 2,
    "commissionAmount": 0.002773202,
    "rewardStatus": "awarded",
    "uptime": 99.9972,
    "validatorID": "NodeID-QED7MhPgqen1mmohedPfB4nTwGemN85Qd"
  },
  "return": 0.135886922,
  "startingBalance": 25,
  "timeEnd": "2023-08-17T14:00:22Z",
  "timeStart": "2023-07-18T14:29:47Z"
}

➡️ Status

This endpoint returns the current status of a validator/delegator. Possible statuses include:

  • UNKNOWN
  • ACTIVE
  • INACTIVE

Endpoints

Validators

Endpoint
Get the Status of a Validator - GET /validator/status/{address}
Get the Status of Multiple Validators - POST /validator/status

Delegators

Endpoint
Get the Status of Delegator - GET /delegator/status/{address}
Get the Status of Multiple Delegators - POST /delegator/status

Sample Object

The example object returned by the Status of a Validator endpoint is shown below.

{
  "activationDate": "2023-08-01",
  "address": "P-avax102du6lq7476s4jk93pzwnfqkvyu2jahk6vt4ym",
  "status": "inactive"
}

➡️ Staking Activity

This endpoint allows you to confirm staking activity for a validator or delegator. Returns true if a given validator address is active, false otherwise.

Endpoints

Validators

Endpoint
Verify the Staking Activity of a Validator - GET /validator/active/{address}
Verify the Staking Activity of Multiple Validators - POST /validator/active

Delegators

Endpoint
Verify the Staking Activity of a Delegator - GET /delegator/active/{address}
Verify the Staking Activity of Multiple Delegators - POST /delegator/active

Sample Object

The example object returned by the Staking Activity of a Delegator endpoint is shown below.

{
  "active": true,
  "address": "41b965acd61cbb4458eedb758afdfe17f2a26eca22afe3b235935ebba88e4590"
}

👋 Need Help?

Contact us through email or our support page for any issues, bugs, or assistance you may need.