Retrieve Collection NFT List

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

📘

Supported on Sui Mainnet.

🚧

For the Indexing APIs on Sui, we currently only open them for whitelisted users. If you're interested, please submit your request here or contact us via Discord or Email.

Params

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

Returns

Array - an array of NFT objects.

  • 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.
  • Description, string - the description 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.

For higher throughput, create your own API key.

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