Retrieve Account's Collections

Returns all collections held by an account.

📘

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.

Parameters

  • owner, string - a 32 Byte address with '0x' as prefix. The address to search for the collections.
  • pageSize, integer - the number of records showing on each page. 20 by default and up to 50.
  • paegIndex, integer - the index of the page to retrieve. The first page is typically indexed as 1, and subsequent pages are numbered incrementally.

Return

Array - an array of NFT collections under an account. An empty array will be returned if there is no collection under the account.

  • imageURL, string - the image URL of an NFT collection.
  • name, string - the name of an NFT collection.
  • objectType, string - the object type of an NFT collection.
  • quantity, integer - the number of NFTs held by the account.
  • package, string - the package ID of an NFT collection.
  • projectURL, string - the URL of the project.
  • description, string - the description of an NFT collection.
  • standard, string - the standard the NFT collection is following.

For higher throughput, create your own API key.

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