Retrieve Account Collections

📘

Supported on Sui Mainnet.

🚧

The Indexing NFT APIs on Sui is currently exclusively available to Pro Members. 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.

Parameter

• 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.

Response

object - a returned object with account collections info, next page index and total number of collections. Contains:

• data - 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.
• 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 collections held by an account.

For higher throughput, create your own API key.