Interface OpenSeaNftMetadata

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

interface OpenSeaNftMetadata {
    animation_url: string;
    attributes?: OpenSeaNftAttribute[];
    background_color?: string;
    description: string;
    external_url?: string;
    image: string;
    image_data?: string;
    name: string;
    youtube_url?: string;
}

Hierarchy (view full)

Properties

animation_url attributes? background_color? description external_url? image image_data? name youtube_url?

Properties

animation_url

animation_url: string

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

attributes?: OpenSeaNftAttribute[]

These are the attributes for the item, which will show up on the OpenSea page for the item.

Optional background_color

background_color?: string

Background color of the item on OpenSea. Must be a six-character hexadecimal without a pre-pended #.

description

description: string

A human readable description of the item. Markdown is supported.

Optional external_url

external_url?: string

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

image

image: string

This is the URL to the image of the item. Can be just about any type of image (including SVGs, which will be cached into PNGs by OpenSea), and can be IPFS URLs or paths. We recommend using a 350 x 350 image.

Optional image_data

image_data?: string

Raw SVG image data, if you want to generate images on the fly (not recommended). Only use this if you're not including the image parameter.

name

name: string

Name of the item.

Optional youtube_url

youtube_url?: string

A URL to a YouTube video.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc