Retrieve Collection Holders

Returns holders 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 supplied for getting holders of an NFT collection.
  • pageSize, integer - the number of records showing on each page. 20 by default and up to 50.
  • pageNumber, integer - the index of the page to retrieve. The first page is typically indexed as 1, and subsequent pages are numbered incrementally.

Returns

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

  • data - an array of NFT collection holder objects. An empty array will be returned if there are no holders.
    • owner, string - the address of the owner of an NFT collection.
    • count, integer - the number of holders of an NFT collection.
  • 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 holders of an NFT collection.

For higher throughput, create your own API key.

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