Get Detailed NFT Stats

Returns bucketed stats for a given NFT collection.

Endpoint: getDetailedNftStats

Method: POST

Arguments

NameTypeDescription
bucketCountInt

The number of aggregated values to receive.
Note: Each duration has predetermined bucket sizes.
The first n-1 buckets are historical. The last bucket is a snapshot of current data.
duration day1: 6 buckets (4 hours each) plus 1 partial bucket
duration hour12: 12 buckets (1 hour each) plus 1 partial bucket
duration hour4: 8 buckets (30 min each) plus 1 partial bucket
duration hour1: 12 buckets (5 min each) plus 1 partial bucket
duration min5: 5 buckets (1 min each) plus 1 partial bucket
For example, requesting 11 buckets for a min5 duration will return the last 10 minutes worth of data plus a snapshot for the current minute.

collectionAddressString!

The contract address of the NFT collection.

Required
durations[DetailedNftStatsDuration]

The list of durations to get detailed pair stats for.

groupingString

The marketplace address to filter by. Can be used to get marketplace-specific metrics, otherwise uses all.

networkIdInt!

The network ID the NFT collection is deployed on.

Required
timestampInt

The unix timestamp for the stats. Defaults to current.

Response

NameTypeDescription
collectionAddressString!The contract address of the NFT collection.
groupingStringThe marketplace address or all. Can be used to get marketplace-specific metrics.
networkIdInt!The network ID the NFT collection is deployed on.
stats_day1WindowedDetailedNftStatsThe breakdown of stats over a 24 hour window.
stats_day30WindowedDetailedNftStatsThe breakdown of stats over a 30 day window.
stats_hour1WindowedDetailedNftStatsThe breakdown of stats over an hour window.
stats_hour4WindowedDetailedNftStatsThe breakdown of stats over a 4 hour window.
stats_hour12WindowedDetailedNftStatsThe breakdown of stats over a 12 hour window.
stats_week1WindowedDetailedNftStatsThe breakdown of stats over a 7 day window.

Picking Duration

The duration chosen as input for the query will be used in the following ways:

  • Provides the currentValue, previousValue, and percent change between the two.
  • Determines the bucket size and default bucketCount (the number of buckets per window) that will be returned.

Buckets Explained

DurationBucket SizeDefault bucketCount
5 minutes1 minute5 + 1 = 6
15 minutes1 minute15 + 1 = 16
1 hour5 minutes12 + 1 = 13
4 hours30 minutes8 + 1 = 9
12 hours1 hour12 + 1 = 13
1 day4 hours6 + 1 = 7
1 week12 hours14 + 1 = 15
30 days1 day30 + 1 = 31

Bucket sizes are predetermined for each duration. The first n-1 buckets are always historical, while the last bucket is a snapshot of current data. Defaults for bucketCount are displayed above, but can be overridden by query input to receive more or less aggregated values.

For example, requesting a min5 duration with a bucketCount of 11 at 12:00:30PM will return

  • aggregated stats and the percent change between
    • the most current 5 minute window (11:55AM-12:00PM),
    • the previous 5 minute window (11:50AM-11:55AM).
  • 10 completed aggregated stats for each minute over those 10 minutes (11:50AM-11:51AM ... 11:59AM-12:00PM) plus 1 partial snapshot of stats for the current minute (12:00:00PM-12:00:30PM).
    • the first 5 stats will add up to the previousValue,
    • the second 5 stats will add up to the currentValue.

Explore

👋

Join our Discord

Ask questions, share what you're working on and request new features :two-men-holding-hands::two-women-holding-hands: