API Reference

Returns details of a NFT collection by a given object type.

📘

Supported on Sui Mainnet.

🚧

The Single NFT Collection 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.

Parameter

  • objectType, string - the object type supplied for getting an NFT collection's details.

Response

  • imageURL, string - the image URL of an NFT collection.
  • name, string - the name of an NFT collection.
  • description, string - the description of an NFT collection.
  • creator, string - the address of the creator of an NFT collection.
  • projectURL, string - the URL of the project.
  • holders, integer - the number of accounts own the given NFT collection.
  • package, string - the package ID of an NFT collection.
  • totalSupply, integer - the minted number of an NFT collection.
  • standard, string - the standard the Collection is following. Could be originByte(by default) or ''.

For higher throughput, create your own API key.

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