Returns the NFT list of a NFT collection by a given object type.

πŸ“˜

Supported on Sui Mainnet.

🚧

The NFT Collection List API on Sui is currently exclusively available to Pro Members. However, non-Pro members can also enjoy a trial period with an allocation of 300 free calls. If you're interested, please register directly through here. Please note that the API Key can also be used for your RPC endpoint.

🚧

Either "objectType" or "objectTypeList" or "owner"must be filled; if both are filled, return their union.

Parameter

  • objectType, string - the object type for the collection to get the NFT list.
  • objectTypeList, string - the object type List for the collection to get the NFT list. Maximum of 3
  • owner, integer - the owner for the NFT to get the NFT list.
  • pageSize, integer - the number of records showing on each page. 20 by default and up to 50.
  • pageIndex, integer - the index of the page to retrieve. The first page is typically indexed as 1, and subsequent pages are numbered incrementally.

Response

object - a returned object with NFT collection list, next page index and total number of NFT collections. Contains:

  • data - an array of NFT objects. An empty array will be returned if there are no NFT collection.
    • imageURL, string - the image URL of an NFT.
    • type, string - the type of an NFT.
    • objectType, string - the object type of an NFT.
    • name, string - the name of an NFT.
    • owner, string - the owner ID of an NFT.
    • version, integer - the version of an NFT.
    • createdTime, integer - the timestamp indicating the exact moment of NFT creation.
    • objectId, string - the object ID of an NFT.
  • nextPageIndex, integer - the index of the next page to retrieve. Current page index will be returned if the last page is reached.
  • total, integer - the number of NFT collections.

For higher throughput, create your own API key.

Language
Authorization
Header
Click Try It! to start a request and see the response here!