Get Collection and Pool Stats

Endpoint: getNftPoolStats

Method: POST

Arguments

NameTypeDescription
collectionAddressString!

The contract address of the NFT collection.

Required
endTimeInt!

The unix timestamp for the end of the requested range.

Required
exchangeAddressString!

The NFT AMM marketplace address to filter by.

Required
networkIdInt!

The network ID the NFT collection is deployed on.

Required
poolAddressString

The NFT pool address to filter by.

startTimeInt!

The unix timestamp for the start of the requested range.

Required

Response

NameTypeDescription
closeBalanceNBTStringThe pool liquidity in the network's base token at the end of the time frame.
closeNftBalanceV2StringThe number of NFTs in the pool at the end of the time frame.
collectionAddressString!The contract address of the NFT collection.
endTimeInt!The unix timestamp for the end of the time frame.
exchangeAddressString!The contract address of the NFT AMM marketplace.
expenseNBTStringThe total sell volume of the pool in the network's base token over the time frame.
highFloorNBTStringThe highest price at which the pool was willing to sell an NFT in the network's base token over the time frame.
highOfferNBTStringThe highest price at which the pool was willing to buy an NFT in the network's base token over the time frame.
lowFloorNBTStringThe lowest price at which the pool was willing to sell an NFT in the network's base token over the time frame.
lowOfferNBTStringThe lowest price at which the pool was willing to buy an NFT in the network's base token over the time frame.
networkIdInt!The network ID the NFT collection is deployed on.
nftsBoughtV2StringThe total number of NFTs bought over the time frame.
nftsSoldV2StringThe total number of NFTs sold over the time frame.
nftVolumeV2StringThe total number of NFTs bought and sold over the time frame.
openBalanceNBTStringThe pool liquidity in the network's base token at the start of the time frame.
openNftBalanceV2StringThe number of NFTs in the pool at the start of the time frame.
poolAddressStringThe contract address of the NFT pool.
poolFeesNBTStringThe sum of pool fees generated by the pool in the network's base token over the time frame.
protocolFeesNBTStringThe sum of protocol fees generated by the pool in the network's base token over the time frame.
revenueNBTStringThe total buy volume of the pool in the network's base token over the time frame.
startTimeInt!The unix timestamp for the start of the time frame.
volumeNBTStringThe total volume of the pool in the network's base token over the time frame.

Example

Based Ghouls Stats Query

Use this query to get Based Ghouls SudoSwap pool stats between 7:00AM October 13th 2022 - 7:00AM October 14th 2022.

{
  getNftPoolStats(
    collectionAddress: "0xeF1a89cbfAbE59397FfdA11Fc5DF293E9bC5Db90"
    exchangeAddress: "0xb16c1342E617A5B6E4b631EB114483FDB289c0A4"
    networkId: 1
    startTime: 1665644400
    endTime: 1665730800
  ) {
    exchangeAddress
    networkId
    collectionAddress
    startTime
    endTime
    poolAddress
    nftVolume
    nftsBought
    nftsSold
    openNftBalance
    closeNftBalance
    volumeNBT
    revenueNBT
    expenseNBT
    poolFeesNBT
    protocolFeesNBT
    lowFloorNBT
    highFloorNBT
    lowOfferNBT
    highOfferNBT
    openBalanceNBT
    closeBalanceNBT
  }
}
{
  "data": {
    "getNftPoolStats": {
      "exchangeAddress": "0xb16c1342e617a5b6e4b631eb114483fdb289c0a4",
      "networkId": 1,
      "collectionAddress": "0xef1a89cbfabe59397ffda11fc5df293e9bc5db90",
      "startTime": 1665644400,
      "endTime": 1665730800,
      "poolAddress": null,
      "nftVolume": 29,
      "nftsBought": 15,
      "nftsSold": 14,
      "openNftBalance": 66,
      "closeNftBalance": 3,
      "volumeNBT": "2562614444162741464",
      "revenueNBT": "1272870796009670880",
      "expenseNBT": "1289743648153070584",
      "poolFeesNBT": "83245278902034459",
      "protocolFeesNBT": "12888607627682841",
      "lowFloorNBT": "86338100102145061",
      "highFloorNBT": "101580003530207675",
      "lowOfferNBT": "81268437163072322",
      "highOfferNBT": "93565928406973877",
      "openBalanceNBT": "3135030314294871206",
      "closeBalanceNBT": "1186335502616431000"
    }
  }
}

Explore

👋

Join our Discord

Ask questions, share what you're working on and request new features 👬👭