Type alias NftMetadata

NftMetadata: {
    animation_url?: URI | null;
    attributes?: NftMetadataAttribute[];
    description?: Markdown | null;
    external_url?: URI | null;
    image?: URI | null;
    name?: string;
}

An NFT metadata standard for interoperability with NFT marketplaces and wallets.

Type declaration

  • Optional animation_url?: URI | null

    A URL to a multi-media attachment for the item. The file extensions GLTF, GLB, WEBM, MP4, M4V, OGV, and OGG are supported, along with the audio-only extensions MP3, WAV, and OGA. animation_url also supports HTML pages, allowing you to build rich experiences and interactive NFTs using JavaScript canvas, WebGL, and more. Scripts and relative paths within the HTML page are now supported. However, access to browser extensions is not supported.

  • Optional attributes?: NftMetadataAttribute[]

    These are the attributes for the item, which will show up on the OpenSea and others NFT trading websites on the item.

    See

    https://docs.opensea.io/docs/metadata-standards#attributes

  • Optional description?: Markdown | null

    A human-readable description of the item. It could be plain text or markdown.

  • Optional external_url?: URI | null

    This is the URL that will appear below the asset's image on OpenSea and others etc. and will allow users to leave OpenSea and view the item on the site.

  • Optional image?: URI | null

    NFT will store any image here.

  • Optional name?: string

    Name of the NFT item.

See

Settings

Member Visibility

Theme