Docs
Sui NFT Standards
Metadata Requirements

Metadata Requirements

NFTs on Sui have a number of ways to store on chain data but for an NFT to display correctly on TradePort, all required data but be correctly formatted in the NFT object's fields.

The Basics

Each object must have the following fields:

  • name field - the name of the individual NFT.
  • image_url - the URL, preferably an IPFS URI, pointing to the NFT's media file. All standard image and video formats are supported on TradePort. If you are unsure about your file format, reach out to the team in Discord before launching your collection.
  • description - the description of the collection.

Attributes

Non-unique and excessive metadata is often stored in the NFT fields. This prevents us from using unknown fields as a reliable source for attributes. So, all other NFT properties that the creator needs to appear on TradePort MUST be added to the attributes field on the NFT in one of the following formats:

{
    "fields": {
        "contents": [
            {
                "fields": {
                    "key": "Background",
                    "value": "Blue"
                }
            },
            ...OTHER ATTRIBUTES...
        ]
    }
}
{
    "fields": {
        "map": {
            "fields": {
                "contents": [
                    {
                        "fields": {
                            "key": "Background",
                            "value": "Blue"
                        }
                    },
					...OTHER ATTRIBUTES...
                ]
            }
        }
    }
}