NFT Metadata

// Metadata holds decoded NFT metadata as defined by the `tokenURI` of the NFT
// contract.
//
// The decoded part of the metadata holds only those fields which are defined
// as part of the token metadata specification (such as ERC721 Metadata JSON
// Schema, ERC-1155 Metadata URI JSON Schema etc.).
message Metadata {
    // Details about original metadata resource returned by the `tokenURI`
    // (ERC-721) or `uri` (ERC-1155) methods of the contract that tracks this
    // NFT.
    //
    // In a special case, when this object is a part of the list-type endpoint
    // and contract returns URI longer than 2kB, the `uri` attribute will be
    // returned as an empty string, while `mimeType` will be filled with
    // corresponding MIME-type. To get full URI in this case – use dedicated
    // "NFT Details" endpoint.
    mnemonic.uniform.types.base.v1beta2.UriResource metadata_uri = 1;

    // Token name.
    string name = 2;

    // Token description.
    string description = 3;

    // Token image (if provided in the metadata).
    mnemonic.uniform.types.base.v1beta2.MediaUri image = 4;
}

// UriResource holds details about a resource (such as metadata, image, etc).
//
// A `uri` value in this message is not normalized and is returned as is like it was
// defined in the contract.
//
// Clients should follow the `mime_type` in order to properly handle a resource that
// this message represents.
//
// The `mime_type` holds the mime-type of an enclosed content, and not of an envelope type. Such that,
// if the `uri` represents a `base64` resource (either on-chain or remotely stored on IPFS or a server) the
// `mime_type` value will hold the mime-type of the content that is encoded by `base64`. For example, if
// a `uri` is a `base64` of a JSON content, the `mime_type` will be `application/json`.
message UriResource {
    // Original URI (may lead to HTTP(s), IPFS, base64 encoded data, etc).
    string uri = 1;

    // Detected MIME-type of the resource.
    string mime_type = 2;
}

// MediaUri holds the details about NFT media (image, animation etc), as well as provides
// a cached version if applicable.
//
// Caching is currently provided only for the following image types: `image/png`,
//  `image/jpeg`, `image/gif`, `image/svg+xml`. For any other types the original
// uri is provided.
message MediaUri {
    // A URI to the cached media resource (empty for unsupported media types).
    string uri = 1;

    // A original URI (may lead to HTTP(s) or IPFS). If this URI is a data URI or
    // an encoded SVG we will intentionally omit this field in the list responses
    // in order to prevent large payload sizes. In such cases, a `uri` should
    // be used instead which provides a cached version.
    //
    // This field is always populated in the full token metadata response.
    string uri_original = 2;

    // A MIME-type of the media resource.
    string mime_type = 3;
}

{
    "type": "object",
    "title": "Metadata",
    "properties": {
        "metadata_uri": {
            "$ref": "#/definitions/UriResource"
        },
        "name": {
            "type": "string",
            "description": "Token name."
        },
        "description": {
            "type": "string",
            "description": "Token description."
        },
        "image": {
            "$ref": "#/definitions/MediaUri",
            "description": "Token image (if provided in the metadata)."
        }
    },
    "definitions": {
        "UriResource": {
            "type": "object",
            "properties": {
                "uri": {
                    "type": "string",
                    "description": "Original URI (may lead to HTTP(s), IPFS, base64 encoded data, etc)."
                },
                "mime_type": {
                    "type": "string",
                    "description": "Detected MIME-type of the resource."
                }
            }
        },
        "MediaUri": {
            "type": "object",
            "properties": {
                "uri": {
                    "type": "string",
                    "description": "A URI to the cached media resource (empty for unsupported media types)."
                },
                "uri_original": {
                    "type": "string",
                    "description": "An original URI (may lead to HTTP(s) or IPFS)."
                },
                "mime_type": {
                    "type": "string",
                    "description": "A MIME-type of the media resource."
                }
            }
        }
    }
}

{
    "metadata": {
        "metadataUri": {
            "uri": "ipfs://QmPMc4tcBsMqLRuCQtPmPe84bpSjrC3Ky7t3JWuHXYB4aS/2596",
            "mimeType": "application/json"
        },
        "name": "Doodle #2596",
        "description": "A community-driven collectibles project featuring art by Burnt Toast. Doodles come in a joyful range of colors, traits and sizes with a collection size of 10,000. Each Doodle allows its owner to vote for experiences and activations paid for by the Doodles Community Treasury. Burnt Toast is the working alias for Scott Martin, a Canadian–based illustrator, designer, animator and muralist.",
        "image": {
            "uri": "https://ethereum.cdn.mnemonichq.com/0x8a90cab2b38dba80c64b7734e58ee1db38b8992e/2596/cc4aac0ab67cb60c67ef864c3ac5acd1febd3d6a23fffb8141fd8123ab67353f.png",
            "uriOriginal": "ipfs://QmcU7hF7r7oinete7skd15bmDXHR6khoJtkQtDaPLqU7iq",
            "mimeType": "image/png"
        }
    }
}

// A `uri` value in this message is not normalized and is returned as is like it was
// defined in the contract.
//
// Clients should follow the `mime_type` in order to properly handle a resource that
// this message represents.
//
// The `mime_type` holds the mime-type of an enclosed content, and not of an envelope
// type. Such that, if the `uri` represents a `base64` resource (either on-chain or
// remotely stored on IPFS or a server) the `mime_type` value will hold the mime-type
// of the content that is encoded by `base64`. For example, if a `uri` is a `base64`
// of a JSON content, the `mime_type` will be `application/json`.
message UriResource {
    // Original URI (may lead to HTTP(s), IPFS, base64 encoded data, etc).
    string uri = 1;

    // Detected MIME-type of the resource.
    string mime_type = 2;
}

// MediaUri holds the details about NFT media (image, animation etc), as well as
// provides a cached version if applicable.
message MediaUri {
    // A URI to the cached media resource (empty for unsupported media types).
    string uri = 1;

    // An original URI (may lead to HTTP(s) or IPFS). If this URI is a data URI
    // or an encoded SVG we will intentionally omit this field in the list
    // responses in order to prevent large payload sizes. In such cases, a `uri`
    // should be used instead which provides a cached version.
    //
    // This field is always populated in the full token metadata response.
    string uri_original = 2;

    // A MIME-type of the media resource.
    string mime_type = 3;
}

{
  "metadata": {
      "metadataUri": {
          "uri": "https://api.artblocks.io/token/235000341",
          "mimeType": "application/json"
      },
      "name": "Maps for grief #341",
      "description": "Maps for Grief explores the hyper-connected existence, filled with individuals who share common intents, ideals and feelings, but tend to live their sentiments in isolation. Its compositions oppose areas of fluid movement and immobility, revealing the structure of the piece itself: two interacting force fields that dictate the direction, as well as the strength – or absence – of movement.On the keyboard: Press A to have the lines gently animate. Use the 1/2/3 keys to inspect the fields that make up each iteration.",
      "image": {
          "uri": "https://ethereum.cdn.mnemonichq.com/0xa7d8d9ef8d8ce8992df33d8b8cf4aebabd5bd270/235000341/3eec3e3a57f2fef90c49bfa926da5b813f5674f7437d96f791dfbf7aff6ee8a2.png",
          "uriOriginal": "https://media-proxy.artblocks.io/0xa7d8d9ef8d8ce8992df33d8b8cf4aebabd5bd270/235000341",
          "mimeType": "image/png"
      }
  }
}

{
  "metadata": {
    "metadataUri": {
        "uri": "ipfs://QmeSjSinHpPnmXmspMjwiXyN6zS4E9zccariGR3jxcaWtq/2087",
        "mimeType": "application/json"
    },
    "name": "",
    "description": "",
    "image": {
        "uri": "https://ethereum.cdn.mnemonichq.com/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/2087/e7e47109f0dc797166f7615a3ff6e002092f760c98bfb499738a376fb9e91552.png",
        "uriOriginal": "ipfs://QmYhUX5fjigN2HgGmq3AcEtzVjSX3iR4EjKEoWCMTkwb6g",
        "mimeType": "image/png"
    }
  }
}

{
  "metadata": {
      "metadataUri": null,
      "name": "321",
      "description": "",
      "image": {
          "uri": "",
          "uriOriginal": "ZGF0YTppbWFnZS9zdmcreG1sO3V0ZjgsPHN2ZyB4bWxucz0iaHR0cDovL3d3dy5...<trimmed>",
          "mimeType": "image/svg+xml;base64"
      }
  }
}