Explorer
API Reference

Filter NFT Collections

Returns a list of NFT collections based on a variety of filters.

Endpoint: filterNftPoolCollections

Method: POST

Arguments

NameTypeDescription
filtersNftPoolCollectionFilters

A set of filters to apply.

limitInt

The maximum number of NFT collections to return.

offsetInt

Where in the list the server should start when returning items. Use count+page from the previous query to request the next page of results.

phraseString

A phrase to search for. Can partially match an NFT collection name.

rankings[NftPoolCollectionRanking]

A list of ranking attributes to apply.

Response

NftPoolCollectionFilterConnection

NameTypeDescription
countIntThe number of NFT collections returned.
pageIntWhere in the list the server started when returning items.
results[NftPoolCollectionFilterResult]The list of NFT collections matching the filter parameters.

NftPoolCollectionFilterResult

NameTypeDescription
balanceNBTStringThe total liquidity of the collection in the network's base token.
balanceUSDStringThe total liquidity of the collection in USD.
collectionAddressStringThe contract address of the NFT collection.
ercTypeStringThe token standard. Can be a variation of ERC-721 or ERC-1155.
exchangeAddressStringThe contract address of the NFT AMM marketplace.
expenseNBT24StringThe total sell volume of the collection in the network's base token over the past 24 hours.
expenseNBTAllStringThe total sell volume of the collection in the network's base token over the collection's lifetime.
expenseUSD24StringThe total sell volume of the collection in USD over the past 24 hours.
expenseUSDAllStringThe total sell volume of the collection in USD over the collection's lifetime.
floorNBTStringThe lowest price at which any of the collection's pools are willing to sell an NFT in the network's base token.
floorUSDStringThe lowest price at which any of the collection's pools are willing to sell an NFT in USD.
highPriceNBT24StringThe highest sale price within the collection in the network's base token in the past 24 hours.
highPriceNBTAllStringThe highest sale price within the collection in the network's base token in the collection's lifetime.
highPriceUSD24StringThe highest sale price within the collection in USD in the past 24 hours.
highPriceUSDAllStringThe highest sale price within the collection in USD in the collection's lifetime.
idString!The ID of the NFT collection (collectionAddress:exchangeAddress:networkId).
imageUrlStringThe image URL for the collection or one of the assets within the collection.
lowPriceNBT24StringThe lowest sale price within the collection in the network's base token in the past 24 hours.
lowPriceNBTAllStringThe lowest sale price within the collection in the network's base token in the collection's lifetime.
lowPriceUSD24StringThe lowest sale price within the collection in USD in the past 24 hours.
lowPriceUSDAllStringThe lowest sale price within the collection in USD in the collection's lifetime.
nameStringThe name of the NFT collection.
networkIdIntThe network ID the NFT collection is deployed on.
nftBalanceV2StringThe number of NFTs in all of the collection's pools.
nftsBought24V2StringThe number of NFTs bought in any of the collection's pools over the past 24 hours.
nftsBoughtAllV2StringThe number of NFTs bought in any of the collection's pools over the collection's lifetime.
nftsSold24V2StringThe number of NFTs sold in any of the collection's pools over the past 24 hours.
nftsSoldAllV2StringThe number of NFTs sold in any of the collection's pools over the collection's lifetime.
nftVolume24V2StringThe number of NFTs bought and sold in any of the collection's pools over the past 24 hours.
nftVolumeAllV2StringThe number of NFTs bought or sold in any of the collection's pools over the collection's lifetime.
offerNBTStringThe highest price at which any of the collection's pools are willing to buy an NFT in the network's base token.
offerUSDStringThe highest price at which any of the collection's pools are willing to buy an NFT in USD.
poolFeesNBT24StringThe sum of pool fees generated by the collection in the network's base token over the past 24 hours.
poolFeesNBTAllStringThe sum of pool fees generated by the collection in the network's base token over the collection's lifetime.
poolFeesUSD24StringThe sum of pool fees generated by the collection in USD over the past 24 hours.
poolFeesUSDAllStringThe sum of pool fees generated by the collection in USD over the collection's lifetime.
protocolFeesNBT24StringThe sum of protocol fees generated by the collection in the network's base token over the past 24 hours.
protocolFeesNBTAllStringThe sum of protocol fees generated by the collection in the network's base token over the collection's lifetime.
protocolFeesUSD24StringThe sum of protocol fees generated by the collection in USD over the past 24 hours.
protocolFeesUSDAllStringThe sum of protocol fees generated by the collection in USD over the collection's lifetime.
revenueNBT24StringThe total buy volume of the collection in the network's base token over the past 24 hours.
revenueNBTAllStringThe total buy volume of the collection in the network's base token over the collection's lifetime.
revenueUSD24StringThe total buy volume of the collection in USD over the past 24 hours.
revenueUSDAllStringThe total buy volume of the collection in USD over the collection's lifetime.
symbolStringThe symbol for the NFT collection.
timestampIntThe unix timestamp indicating the last time the data was updated. Updates every 2 hours.
totalSupplyV2String
volumeNBT24StringThe total volume of the collection in the network's base token over the past 24 hours.
volumeNBTAllStringThe total volume of the collection in the network's base token over the collection's lifetime.
volumeUSD24StringThe total volume of the collection in USD over the past 24 hours.
volumeUSDAllStringThe total volume of the collection in USD over the collection's lifetime.

Example

Filter for Collections on SudoSwap

Use this query to filter for NFT collections on SudoSwap with more than 100K USD in lifetime volume and return the collection with the highest lifetime volume.

{
  filterNftPoolCollections(
    filters: {
      volumeUSDAll: { gt: "100000" }
      exchange: "0xb16c1342e617a5b6e4b631eb114483fdb289c0a4"
    }
    rankings: { attribute: volumeUSDAll, direction: DESC }
    limit: 1
  ) {
    results {
      balanceNBT
      balanceUSD
      collectionAddress
      ercType
      exchangeAddress
      expenseNBT24
      expenseNBTAll
      expenseUSD24
      expenseUSDAll
      floorNBT
      floorUSD
      highPriceNBT24
      highPriceNBTAll
      highPriceUSD24
      highPriceUSDAll
      id
      imageUrl
      lowPriceNBT24
      lowPriceNBTAll
      lowPriceUSD24
      lowPriceUSDAll
      name
      networkId
      nftBalance
      nftVolume24
      nftVolumeAll
      nftsBought24
      nftsBoughtAll
      nftsSold24
      nftsSoldAll
      offerNBT
      offerUSD
      poolFeesNBT24
      poolFeesNBTAll
      poolFeesUSD24
      poolFeesUSDAll
      protocolFeesNBT24
      protocolFeesNBTAll
      protocolFeesUSD24
      protocolFeesUSDAll
      revenueNBT24
      revenueNBTAll
      revenueUSD24
      revenueUSDAll
      symbol
      timestamp
      totalSupply
      volumeNBT24
      volumeNBTAll
      volumeUSD24
      volumeUSDAll
    }
    count
    page
  }
}

{
  "data": {
    "filterNftPoolCollections": {
      "results": [
        {
          "balanceNBT": "231334329663140545783",
          "balanceUSD": "362324.21251926",
          "collectionAddress": "0x49cf6f5d44e70224e2e23fdcdd2c053f30ada28b",
          "ercType": "ERC721Enumerable",
          "exchangeAddress": "0xb16c1342e617a5b6e4b631eb114483fdb289c0a4",
          "expenseNBT24": "7600146795615573854",
          "expenseNBTAll": "220051023085433962899",
          "expenseUSD24": "11657.31017297",
          "expenseUSDAll": "297368.25256318",
          "floorNBT": "8439999999999999600",
          "floorUSD": "11230.6371137",
          "highPriceNBT24": "8327181603104328519",
          "highPriceNBTAll": "9169275780810293278",
          "highPriceUSD24": "13570.78798287",
          "highPriceUSDAll": "13570.78798287",
          "id": "0x49cf6f5d44e70224e2e23fdcdd2c053f30ada28b:0xb16c1342e617a5b6e4b631eb114483fdb289c0a4:1",
          "imageUrl": "thumbSm/0x49cf6f5d44e70224e2e23fdcdd2c053f30ada28b:10:1.webp",
          "lowPriceNBT24": "7639525794556587190",
          "lowPriceNBTAll": "5921844344131992724",
          "lowPriceUSD24": "11717.71074382",
          "lowPriceUSDAll": "7880.74492227",
          "name": "CloneX",
          "networkId": 1,
          "nftBalance": 34,
          "nftVolume24": 3,
          "nftVolumeAll": 89,
          "nftsBought24": 1,
          "nftsBoughtAll": 29,
          "nftsSold24": 2,
          "nftsSoldAll": 60,
          "offerNBT": "7686629172096303251",
          "offerUSD": "12526.88121496",
          "poolFeesNBT24": "752789675858171087",
          "poolFeesNBTAll": "15607655444818895954",
          "poolFeesUSD24": "1182.603816",
          "poolFeesUSDAll": "21165.28409832",
          "protocolFeesNBT24": "118792524820028251",
          "protocolFeesNBTAll": "3463836589426963484",
          "protocolFeesUSD24": "186.22660716",
          "protocolFeesUSDAll": "4675.12597365",
          "revenueNBT24": "16478634383894089072",
          "revenueNBTAll": "477343287120551709833",
          "revenueUSD24": "26111.23369193",
          "revenueUSDAll": "643955.1393137",
          "symbol": "CloneX",
          "timestamp": 1667577629,
          "totalSupply": 19416,
          "volumeNBT24": "24078781179509662926",
          "volumeNBTAll": "697394310205985672732",
          "volumeUSD24": "37768.5438649",
          "volumeUSDAll": "941323.39187688"
        }
      ],
      "count": 1,
      "page": 0
    }
  }
}

Explore

👋

Join our Discord

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