Get NFT Metadata

Get NFT data in either raw or structured format

Get NFT Metadata- Raw/Unstructured

Auth: PRODUCT

Get raw/unstructured NFT data

GET https://api.gaimin.gg/api/public/v1/player/tokens/raw

Retrieve the unmodified raw metadata associated with a specific player, identified by their player token. The endpoint returns only the raw metadata for NFTs present in the player's wallet and previously allowlisted to the product.

Headers

Request Body

ProductNftDto:
- tokenId
- address
- Chain
- metadataLink
- rawMetadata (JsonNode)

Example response:
{
  "data": [
    {
      "tokenId": "1",
      "address": "0x868676dcaf5495c31955466561b8a3c786f87dba",
      "chain": "POLYGON",
      "metadataLink": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/metadata/0000000000000000000000000000000000000000000000000000000000000001.json",
      "rawMetadata": {
        "name": "Chestplate of the Arthropod",
        "description": "Do you ever get the feeling something’s crawling on your skin? With this Chestplate, that won’t happen again!",
        "imageUrl": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/images/01-Chestplate%20of%20the%20Arthropod.png",
        "maxSupply": 600,
        "attributes": [
          {
            "trait_type": "Rarity",
            "name": "Rarity",
            "value": "Uncommon"
          },
          {
            "display_type": "boost_number",
            "trait_type": "Minecraft attribute: Armor",
            "name": "Minecraft attribute: Armor",
            "value": 5
          },
          {
            "display_type": "number",
            "trait_type": "Minecraft enchantment: Projectile Protection",
            "name": "Minecraft enchantment: Projectile Protection",
            "value": 2
          },
          {
            "trait_type": "Minecraft item",
            "name": "Minecraft item",
            "value": "Chestplate"
          }
        ],
        "minecraftItem": {
          "name": "Chestplate of the Arthropod",
          "description": "Do you ever get the feeling something’s crawling on your skin? With this Chestplate, that won’t happen again!",
          "rarity": "UNCOMMON",
          "parentItem": "DIAMOND_CHESTPLATE",
          "attributes": [
            {
              "name": "GENERIC_ARMOR",
              "value": 5
            }
          ],
          "enchantments": [
            {
              "name": "PROTECTION_PROJECTILE",
              "value": 2
            }
          ]
        },
        "pack": {
          "name": "Alpha",
          "description": "First Gaimcraft NFT pack",
          "totalAmount": 28,
          "symbol": "ipfs://QmbZjUA7J7TZmfy7VBoqSTb5f4epkLu4UV56oNDystNBDZ",
          "symbolImage": "ALPH",
          "releaseDate": "2022-04-27"
        }
      }
    },
    {
      "tokenId": "2",
      "address": "0x868676dcaf5495c31955466561b8a3c786f87dba",
      "chain": "POLYGON",
      "metadataLink": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/metadata/0000000000000000000000000000000000000000000000000000000000000002.json",
      "rawMetadata": {
        "name": "Helmet of the Coleoptera",
        "description": "Bug’s are pesky, but with this helmet, you’ll be able to delete them from any server!",
        "imageUrl": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/images/02-Helmet%20of%20the%20Coleoptera.png",
        "maxSupply": 150,
        "attributes": [
          {
            "trait_type": "Rarity",
            "name": "Rarity",
            "value": "Rare"
          },
          {
            "display_type": "boost_number",
            "trait_type": "Minecraft attribute: Armor",
            "name": "Minecraft attribute: Armor",
            "value": 7
          },
          {
            "display_type": "number",
            "trait_type": "Minecraft enchantment: Thorns",
            "name": "Minecraft enchantment: Thorns",
            "value": 3
          },
          {
            "trait_type": "Minecraft item",
            "name": "Minecraft item",
            "value": "Helmet"
          }
        ],
        "minecraftItem": {
          "name": "Helmet of the Coleoptera",
          "description": "Bug’s are pesky, but with this helmet, you’ll be able to delete them from any server!",
          "rarity": "RARE",
          "parentItem": "DIAMOND_HELMET",
          "attributes": [
            {
              "name": "GENERIC_ARMOR",
              "value": 7
            }
          ],
          "enchantments": [
            {
              "name": "THORNS",
              "value": 3
            }
          ]
        },
        "pack": {
          "name": "Alpha",
          "description": "First Gaimcraft NFT pack",
          "totalAmount": 28,
          "symbol": "ipfs://QmbZjUA7J7TZmfy7VBoqSTb5f4epkLu4UV56oNDystNBDZ",
          "symbolImage": "ALPH",
          "releaseDate": "2022-04-27"
        }
      }
    }
  ],
  "success": true
}

Example Request:

curl --location 'https://api.qa.gaimin.gg/api/public/v1/player/tokens/raw?playerToken=eyJhbGciOiJFUzI1NiJ9.eyJzdWIiOiIwMHU2OHltczIwclRZYmdWRTR4NyIsImV4cCI6MTY3NjAzNzM1NX0.UAFqjq9lLJ8em4C9OsaMEX8vQQZiz1pkzKe35yF-ZVwZszWznP0iXh61sPNfGFnA4pDTlD6LXi2VLLjbS8MIpw&chains=POLYGON&chains=MUMBAI' \
--header 'accept: */*' \
--header 'X-Api-Key: 8dcaa202-7048-4c19-a30c-f7c7a9e5658c'

Example Response:

{
  "data": [
    {
      "tokenId": "27",
      "address": "0x868676dcaf5495c31955466561b8a3c786f87dba",
      "chain": "POLYGON",
      "metadataLink": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/metadata/000000000000000000000000000000000000000000000000000000000000001b.json",
      "rawMetadata": {
        "name": "Rainbow Sword",
        "description": "It feels... Lucky!",
        "imageUrl": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/images/27-Rainbow%20Sword.png",
        "maxSupply": 1800,
        "attributes": [
          {
            "trait_type": "Rarity",
            "name": "Rarity",
            "value": "Common"
          },
          {
            "display_type": "number",
            "trait_type": "Minecraft enchantment: Looting",
            "name": "Minecraft enchantment: Looting",
            "value": 1
          },
          {
            "trait_type": "Minecraft item",
            "name": "Minecraft item",
            "value": "Sword"
          }
        ],
        "minecraftItem": {
          "name": "Rainbow Sword",
          "description": "It feels... Lucky!",
          "rarity": "COMMON",
          "parentItem": "DIAMOND_SWORD",
          "attributes": [],
          "enchantments": [
            {
              "name": "LOOT_BONUS_MOBS",
              "value": 1
            }
          ]
        },
        "pack": {
          "name": "Alpha",
          "description": "First Gaimcraft NFT pack",
          "totalAmount": 28,
          "symbol": "ipfs://QmbZjUA7J7TZmfy7VBoqSTb5f4epkLu4UV56oNDystNBDZ",
          "symbolImage": "ALPH",
          "releaseDate": "2022-04-27"
        }
      }
    },
    {
      "tokenId": "1",
      "address": "0x868676dcaf5495c31955466561b8a3c786f87dba",
      "chain": "POLYGON",
      "metadataLink": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/metadata/0000000000000000000000000000000000000000000000000000000000000001.json",
      "rawMetadata": {
        "name": "Chestplate of the Arthropod",
        "description": "Do you ever get the feeling something’s crawling on your skin? With this Chestplate, that won’t happen again!",
        "imageUrl": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/images/01-Chestplate%20of%20the%20Arthropod.png",
        "maxSupply": 600,
        "attributes": [
          {
            "trait_type": "Rarity",
            "name": "Rarity",
            "value": "Uncommon"
          },
          {
            "display_type": "boost_number",
            "trait_type": "Minecraft attribute: Armor",
            "name": "Minecraft attribute: Armor",
            "value": 5
          },
          {
            "display_type": "number",
            "trait_type": "Minecraft enchantment: Projectile Protection",
            "name": "Minecraft enchantment: Projectile Protection",
            "value": 2
          },
          {
            "trait_type": "Minecraft item",
            "name": "Minecraft item",
            "value": "Chestplate"
          }
        ],
        "minecraftItem": {
          "name": "Chestplate of the Arthropod",
          "description": "Do you ever get the feeling something’s crawling on your skin? With this Chestplate, that won’t happen again!",
          "rarity": "UNCOMMON",
          "parentItem": "DIAMOND_CHESTPLATE",
          "attributes": [
            {
              "name": "GENERIC_ARMOR",
              "value": 5
            }
          ],
          "enchantments": [
            {
              "name": "PROTECTION_PROJECTILE",
              "value": 2
            }
          ]
        },
        "pack": {
          "name": "Alpha",
          "description": "First Gaimcraft NFT pack",
          "totalAmount": 28,
          "symbol": "ipfs://QmbZjUA7J7TZmfy7VBoqSTb5f4epkLu4UV56oNDystNBDZ",
          "symbolImage": "ALPH",
          "releaseDate": "2022-04-27"
        }
      }
    },
    {
      "tokenId": "3",
      "address": "0xf7c72cc843b019415c5caeb4fa2669716901ccac",
      "chain": "MUMBAI",
      "metadataLink": "https://storage.googleapis.com/gaimin_nft/interoperable/xmas_2212/metadata/0000000000000000000000000000000000000000000000000000000000000003.json",
      "rawMetadata": {
        "name": "Gingerbread Time",
        "description": "Run, run as fast as you can, you can't stop me in the Gingerbread Man! ",
        "imageUrl": "https://storage.googleapis.com/gaimin_nft/interoperable/xmas_2212/images/gingerbread_time.png",
        "maxSupply": 1800,
        "attributes": [
          {
            "trait_type": "Rarity",
            "name": "Rarity",
            "value": "Uncommon"
          },
          {
            "trait_type": "GTAV item",
            "name": "GTAV item",
            "value": "Bodysuit"
          }
        ],
        "gtaItem": {
          "name": "Gingerbread Time",
          "description": "Run, run as fast as you can, you can't stop me in the Gingerbread Man! ",
          "type": "CLOTHING",
          "modelName": "GINGERBREAD_TIME"
        }
      }
    }
  ],
  "success": true
}

Get NFT Metadata - Structured

Auth: PRODUCT

Get structured NFT data

GET https://api.gaimin.gg /api/public/v1/player/tokens

Retrieve the formatted metadata (due to provided parameters) associated with a specific player, identified by their player auth token. The endpoint returns only metadata for NFTs present in the player's wallet and previously allowlisted to the product.

Headers

Request Body

ProductNftDto:
- Chain
- tokenId
- Address
- formattedMetadata
     - Name
     - Description
     - Image
     - List <ProductTokenAttributes>
         -Name
         - value

Example Response:

{
  "data": [
    {
      "tokenId": "1",
      "address": "0x868676dcaf5495c31955466561b8a3c786f87dba",
      "chain": "POLYGON",
      "metadataLink": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/metadata/0000000000000000000000000000000000000000000000000000000000000001.json",
      "formattedMetadata": {
        "name": "Chestplate of the Arthropod",
        "description": "Do you ever get the feeling something’s crawling on your skin? With this Chestplate, that won’t happen again!",
        "image": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/images/01-Chestplate%20of%20the%20Arthropod.png",
        "attributes": [
          {
            "name": "Rarity",
            "value": "Uncommon"
          },
          {
            "name": "Minecraft attribute: Armor",
            "value": "5.0"
          },
          {
            "name": "Minecraft enchantment: Projectile Protection",
            "value": "2"
          },
          {
            "name": "Minecraft item",
            "value": "Chestplate"
          }
        ]
      }
    },
    {
      "tokenId": "2",
      "address": "0x868676dcaf5495c31955466561b8a3c786f87dba",
      "chain": "POLYGON",
      "metadataLink": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/metadata/0000000000000000000000000000000000000000000000000000000000000002.json",
      "formattedMetadata": {
        "name": "Helmet of the Coleoptera",
        "description": "Bug’s are pesky, but with this helmet, you’ll be able to delete them from any server!",
        "image": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/images/02-Helmet%20of%20the%20Coleoptera.png",
        "attributes": [
          {
            "name": "Rarity",
            "value": "Rare"
          },
          {
            "name": "Minecraft attribute: Armor",
            "value": "7.0"
          },
          {
            "name": "Minecraft enchantment: Thorns",
            "value": "3"
          },
          {
            "name": "Minecraft item",
            "value": "Helmet"
          }
        ]
      }
    }
  ],
  "success": true
}

Example Request:

curl --location 'https://api.qa.gaimin.gg/api/public/v1/player/tokens?playerToken=eyJhbGciOiJFUzI1NiJ9.eyJzdWIiOiIwMHU2OHltczIwclRZYmdWRTR4NyIsImV4cCI6MTY3NjAzNzM1NX0.UAFqjq9lLJ8em4C9OsaMEX8vQQZiz1pkzKe35yF-ZVwZszWznP0iXh61sPNfGFnA4pDTlD6LXi2VLLjbS8MIpw&chains=POLYGON&chains=MUMBAI' \
--header 'accept: */*' \
--header 'X-Api-Key: 8dcaa202-7048-4c19-a30c-f7c7a9e5658c'

Example Response:

{
  "data": [
    {
      "tokenId": "27",
      "address": "0x868676dcaf5495c31955466561b8a3c786f87dba",
      "chain": "POLYGON",
      "metadataLink": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/metadata/000000000000000000000000000000000000000000000000000000000000001b.json",
      "formattedMetadata": {
        "name": "Rainbow Sword",
        "description": "It feels... Lucky!",
        "image": null,
        "attributes": [
          {
            "name": "Rarity",
            "value": "Common"
          },
          {
            "name": "Minecraft enchantment: Looting",
            "value": "1"
          },
          {
            "name": "Minecraft item",
            "value": "Sword"
          }
        ]
      }
    },
    {
      "tokenId": "1",
      "address": "0x868676dcaf5495c31955466561b8a3c786f87dba",
      "chain": "POLYGON",
      "metadataLink": "https://storage.googleapis.com/gaimin_nft/gaimcraft/alpha_2204/metadata/0000000000000000000000000000000000000000000000000000000000000001.json",
      "formattedMetadata": {
        "name": "Chestplate of the Arthropod",
        "description": "Do you ever get the feeling something’s crawling on your skin? With this Chestplate, that won’t happen again!",
        "image": null,
        "attributes": [
          {
            "name": "Rarity",
            "value": "Uncommon"
          },
          {
            "name": "Minecraft attribute: Armor",
            "value": "5.0"
          },
          {
            "name": "Minecraft enchantment: Projectile Protection",
            "value": "2"
          },
          {
            "name": "Minecraft item",
            "value": "Chestplate"
          }
        ]
      }
    },
    {
      "tokenId": "3",
      "address": "0xf7c72cc843b019415c5caeb4fa2669716901ccac",
      "chain": "MUMBAI",
      "metadataLink": "https://storage.googleapis.com/gaimin_nft/interoperable/xmas_2212/metadata/0000000000000000000000000000000000000000000000000000000000000003.json",
      "formattedMetadata": {
        "name": "Gingerbread Time",
        "description": "Run, run as fast as you can, you can't stop me in the Gingerbread Man! ",
        "image": null,
        "attributes": [
          {
            "name": "Rarity",
            "value": "Uncommon"
          },
          {
            "name": "GTAV item",
            "value": "Bodysuit"
          }
        ]
      }
    }
  ],
  "success": true
}

Last updated