Skip to main content

Collection stats

Obtain fundamental statistics related to the stake collection.

Parameter

AttributeDescription
stakeCollectionIdYour collection Id given by anvil

Usage example

import { anvil } from "@ada-anvil/sdk-client";

try {
await anvil.staking.getStakeCollectionStats({ stakeCollectionId: YOUR_COLLECTION_ID });
} catch {
console.log("YOUR ERROR HANDLING");
}

Return informations

AttributeDescription
total.stakedNftsThe total number of NFTs staked within this collection
total.supplyThe total supply of stakable NFTs
breakdownA breakdown of statistics categorized by collection policy
breakdown[0].nameThe name of the collection, if available
breakdown[0].policyIdThe unique policy ID associated with the collection
breakdown[0].supplyThe total number of stakable NFTs available in this collection
breakdown[0].stakedNftsThe quantity of staked NFTs in this collection