What's the correct metadata JSON format for Bitcoin ordinals collections?

Support
Support
  • Updated

If you want to add metadata to a collection mint, please refer to this article.

 

The two types of metadata

On-chain metadata is inscribed directly to Bitcoin at the same time as the asset, while off-chain metadata is applied after the collection mint is sold out. 

Here are their key differences:

On-Chain Off-Chain
Stored in the Bitcoin Blockchain: it will be visible on any Bitcoin marketplace Stored in the in-house database: it will only be visible on Gamma
Becomes immutable once inscribed Can be updated anytime upon request
Can be uploaded immediately upon submitting your collection mint Uploaded after the collection mint is sold out. Inscription IDs are provided to the creator to assist in building their metadata JSON file
Does not support old collections that are already minted Can be applied to old collections that do not have metadata associated with them

 

What's the correct On-Chain metadata JSON format for Bitcoin ordinals mint collections?

If you'd like to add on-chain metadata to your Bitcoin ordinals mint collection, we'll need a JSON file containing your file name and the associated descriptive metadata. This might include a descriptive or custom-numbered name for each inscription or other attributes that describe the visual elements of the inscription's image.


Important notes:

  1. It is important to check your on-chain metadata before submitting it, as it is permanent and cannot be changed once inscribed.
  2. Please ensure that your files are renamed numerically starting from 1. (Example: 1.png, 2.png, 3.png and so on)
  3. When you are ready, please proceed to this link to set up your collection mint.

Below is the accepted format for metadata JSON files. Please modify this to your specific collection's needs. You may add any number of associated attributes and trait names.

[
 {
   "file": "1.png",
   "meta": {
     "name": "Name 1",
     "attributes": [
       {
         "trait_type": "Gender",
         "value": "Male"
       },
       {
         "trait_type": "Rarity",
         "value": "Common"
       }
     ]
   }
 },
 {
   "file": "2.png",
   "meta": {
     "name": "Name 2",
     "attributes": [
       {
         "trait_type": "Gender",
         "value": "Female"
       },
       {
         "trait_type": "Rarity",
         "value": "Legendary"
       }
     ]
   }
 }
]

 

What's the correct Off-Chain metadata JSON format for Bitcoin ordinals mint collections?

If you'd like to add off-chain metadata to your Bitcoin ordinals collection, we'll need a JSON file containing your inscription IDs and the associated descriptive metadata. This might include things like a descriptive or custom numbered name for each inscription, or other attributes that describe the visual elements of the inscription's image.

Below is the accepted format for metadata JSON files. Please modify this to your specific collection's needs. You may add any number of associated attributes and trait names.

 

Sample JSON file (right-click download linked file)

Sample JSON preview:

[
{
"id": "inscriptionId",
"meta": {
"name": "NFT #1",
"attributes": [
{ "trait_type": "background", "value": "some-value" },
{ "trait_type": "skin", "value": "some-value" },
{ "trait_type": "shirt", "value": "some-value" },
{ "trait_type": "mouth", "value": "some-value" },
{ "trait_type": "eyes", "value": "some-value" },
{ "trait_type": "nose", "value": "some-value" },
{ "trait_type": "head", "value": "some-value" },
{ "trait_type": "handled", "value": "some-value" }
]
}
},
{
"id": "inscriptionId",
"meta": {
"name": "NFT #2",
"attributes": [
{ "trait_type": "background", "value": "some-value" },
{ "trait_type": "skin", "value": "some-value" },
{ "trait_type": "shirt", "value": "some-value" },
{ "trait_type": "mouth", "value": "some-value" },
{ "trait_type": "eyes", "value": "some-value" },
{ "trait_type": "nose", "value": "some-value" },
{ "trait_type": "head", "value": "some-value" },
{ "trait_type": "handled", "value": "some-value" }
]
}
},
]

Was this article helpful?

5 out of 6 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.