Skip to content

Metadata

Metadata

A standard metadata interface

This aims to be a relatively comprehensive definition of NFT metadata, but not all metadata will fit cleanly into this shape.

Attributes:

Name Type Description
token Token

a Token interface with all information required to uniquely identify an NFT
raw_data dict

raw metadata object fetched from token uri.
standard MetadataStandard

accepted metadata standard based on the format of the metadata.
attributes list[Attribute]

list of token metadata attributes.
name str

token name.
description str

token description.
mime_type str

metadata mime type, e.g. "image/png".
image str

nested image in the metadata.
content str

nested content, e.g. video, audio, etc., in the metadata.
additional_fields list[MetadataField]

any additional metadata fields that don't fit in the defined schema.
Source code in offchain/metadata/models/metadata.py 
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
class Metadata(BaseModel):
    """A standard metadata interface

    This aims to be a relatively comprehensive definition of NFT metadata, but not all
    metadata will fit cleanly into this shape.

    Attributes:
        token (Token): a Token interface with all information required to uniquely identify an NFT

        raw_data (dict): raw metadata object fetched from token uri.
        standard (MetadataStandard): accepted metadata standard based on the format of the metadata.
        attributes (list[Attribute]): list of token metadata attributes.
        name (str, optional): token name.
        description (str, optional): token description.
        mime_type (str, optional): metadata mime type, e.g. "image/png".

        image (str, optional): nested image in the metadata.
        content (str, optional): nested content, e.g. video, audio, etc., in the metadata.

        additional_fields (list[MetadataField], optional): any additional metadata fields
            that don't fit in the defined schema.

    """  # noqa: E501

    token: Token

    raw_data: dict  # type: ignore[type-arg]
    attributes: list[Attribute]
    standard: Optional[MetadataStandard] = None
    name: Optional[str] = None
    description: Optional[str] = None
    mime_type: Optional[str] = None

    image: Optional[MediaDetails] = None
    content: Optional[MediaDetails] = None

    additional_fields: Optional[list[MetadataField]] = None

Attribute

NFT metadata atttribute

Attributes:

Name Type Description
trait_type str

the attribute key.
value str

the attribute value.
display_type str

informs how the attribute is displayed.
Source code in offchain/metadata/models/metadata.py 
26
27
28
29
30
31
32
33
34
35
36
37
class Attribute(BaseModel):
    """NFT metadata atttribute

    Attributes:
        trait_type (str, optional): the attribute key.
        value (str, optional): the attribute value.
        display_type (str, optional): informs how the attribute is displayed.
    """

    trait_type: Optional[str] = None
    value: Optional[str] = None
    display_type: Optional[str] = None

MediaDetails

Metadata media information

Attributes:

Name Type Description
size int

size of the media.
sha256 str

the SHA256 hash of the media.
uri str

the uri at which the media was found.
mime_type str

the mime type of the media.
Source code in offchain/metadata/models/metadata.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class MediaDetails(BaseModel):
    """Metadata media information

    Attributes:
        size (int, optional): size of the media.
        sha256 (str, optional): the SHA256 hash of the media.
        uri (str, optional): the uri at which the media was found.
        mime_type (str, optional): the mime type of the media.
    """

    size: Optional[int] = None
    sha256: Optional[str] = None
    uri: Optional[str] = None
    mime_type: Optional[str] = None

MetadataField

Additional metadata field that does not fit within the defined Metadata entity

Some metadata standards will have standardized additional metadata fields that are not captured in our metadata schema. For example, OpenSea allows for an 'external_url' field.

Attributes:

Name Type Description
field_name str

name of the metadata field.
type MetadataFieldType

metadata field type.
description str

a description of what this metadata field represents.
value any

the value of the metadata field.
Source code in offchain/metadata/models/metadata.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class MetadataField(BaseModel):
    """Additional metadata field that does not fit within the defined Metadata entity

    Some metadata standards will have standardized additional metadata fields that are not
    captured in our metadata schema. For example, OpenSea allows for an 'external_url' field.

    Attributes:
        field_name (str): name of the metadata field.
        type (MetadataFieldType): metadata field type.
        description (str, optional): a description of what this metadata field represents.
        value (any): the value of the metadata field.
    """  # noqa: E501

    field_name: str
    type: MetadataFieldType
    description: str
    value: Any