💹Token Metadata API

Get both on-chain and off-chain metadata API for Solana tokens.

NEW — For all token metadata queries, please use the new DAS API Get Asset method.

pageGet Asset

(DEPRECATED) v0/token-metadata

You can pass up to 100 mint accounts.

Use https://api-devnet.helius.xyz/v0/token-metadata for devnet metadata.

Returns all metadata associated with an account, including data from the old token list.

POSThttps://api.helius.xyz/v0/token-metadata

Query parameters

Body

application/json

mintAccountsarray of string

includeOffChainboolean

Include offchain data referenced in the uri of the metadata account. Omitting defaults to false.

Response

200400401403404429500

Query result.

Body

application/json

accountstring

onChainAccountInfoOnChainAccountInfoResult (object)

onChainMetadataOnChainMetadataResult (object)

offChainMetadataOffChainMetadataResult (object)

legacyMetadataLegacyMetadata (object)

Data from the old SPL token list.

Request

JavaScriptCurl

const response = await fetch('https://api.helius.xyz/v0/token-metadata', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

[
  {
    "account": "text",
    "onChainAccountInfo": {
      "accountInfo": {
        "key": "text",
        "isSigner": false,
        "isWritable": false,
        "data": {
          "parsed": {
            "info": {
              "freezeAuthority": "text",
              "isInitialized": false,
              "mintAuthority": "text",
              "supply": "text"
            },
            "type": "text"
          },
          "program": "text"
        },
        "owner": "text",
        "executable": false
      },
      "error": "UNKNOWN"
    },
    "onChainMetadata": {
      "metadata": {
        "key": "text",
        "mint": "text",
        "updateAuthority": "text",
        "data": {
          "name": "text",
          "symbol": "text",
          "uri": "text",
          "creators": [
            {
              "address": "text",
              "share": "text",
              "verified": false
            }
          ]
        },
        "tokenStandard": "text",
        "primarySaleHappened": false,
        "isMutable": false,
        "collection": {
          "key": "text",
          "verified": false
        },
        "collectionDetails": {},
        "uses": {
          "useMethod": "text"
        }
      },
      "error": "UNKNOWN"
    },
    "offChainMetadata": {
      "metadata": {
        "name": "text",
        "symbol": "text",
        "attributes": [
          {
            "traitType": "text",
            "value": "text"
          }
        ],
        "image": "text",
        "properties": {
          "category": "text",
          "files": [
            {
              "uri": "text",
              "type": "text"
            }
          ],
          "creators": [
            {
              "address": "text",
              "share": "text"
            }
          ]
        }
      },
      "uri": "text",
      "error": "UNKNOWN"
    },
    "legacyMetadata": {
      "address": "text",
      "symbol": "text",
      "name": "text",
      "logoURI": "text",
      "tags": [
        "text"
      ]
    }
  }
]

Example Use Cases

Arguably the most interesting parts of the NFT such as image URL and attributes/traits are stored on the metadata. The NFT metadata endpoint can be used to either bulk fetch multiple NFTs' metadata or a single one. Some example use cases:

• NFT Photo Gallery

• Rarity calculator/analysis

• Dynamic/evolving NFTs

Code Samples

getMetadata.js

const url = "https://api.helius.xyz/v0/token-metadata?api-key=<your-key>";
const nftAddresses = [
  "BAAzgRGWY2v5AJBNZNFd2abiRXAUo56UxywKEjoCZW2",
  "8s6kQUZfdm7GSaThAcsmSs56wMinXrbk6SdNVngutrz5"
]; // Monkes
const getMetadata = async () => {
  const response = await fetch(url, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      mintAccounts: nftAddresses,
      includeOffChain: true,
      disableCache: false,
    }),
  });

  const data = await response.json();
  console.log("metadata: ", data);
};

getMetadata();