Metadata schema registration

❗️

Ropsten only

This functionality is only available in RopstenRopsten - Ethereum's testnet, used for testing, experimenting and debugging. and is not yet available on MainnetMainnet - Ethereum's mainnet, used for projects which are ready for production.. To create and update collections and metadata schema in mainnet, use this form.

This functionality is not available for users who have previously registered a collection via online form submission. To update existing collections, submit a request here.

Requests may take up to 2 business days (AEST).

🚧

Requirements


Add collection metadata schema

Only the project owner can add metadata schema to a collection.

Example schema

Read more about asset metadata

Each property of the metadata schema contains the following fields:


Field

Required (Default value)

Value Type / Notes

name

yes

text

type

no ("text")

https://docs.x.immutable.com/docs/asset-metadata#property-type-mapping

filterable

no (false)

boolean

If set to true, then the particular metadata's "name" will show up in the filters that are used by marketplaces and other ecosystem projects.

Example payload:

{
  "metadata": [
    {
      "name": "some-metadata-name",
      "type": "discrete",
      "filterable": true
    },
    {
      "name": "rare",
      "type": "boolean",
      "filterable": true
    },
    {
      "name": "image_url"
    }
  ]
}

📘

View example code

The repository imx-examples provides easy to use examples. Follow the instructions in the README to get started.


To add missing attributes that were not submitted in the original request you can execute this call multiple times. Just add the missing attributes and they shall be appended.

Submitting the same metadata schema attribute will cause the error:

{"code":"metadata_key_already_exists","message":"Metadata key(s) already exist"}

Update collection metadata schema by name

Only the project owner can perform updates to collection metadata schema. Each property of the metadata schema can be updated individually.

📘

View example code

The repository imx-examples provides easy to use examples. Follow the instructions in the README to get started.


Updating the "filterable" attribute of a metadata schema property


🚧

Expensive API call on "filterable": true

This API call may take a few seconds to a few minutes as it will trigger a re-scan of all the assets for the {{contract-address}} to get the up to date the filter values.


Updating the "type" attribute of a metadata schema property


🚧

Filterable Text is not allowed

If passing both "filterable": true and the "type": "text", this API call will return an error. This error will also be triggered when passing "filterable": true and the metadata "type" is already "text".

🚧

Metadata refresh

For collections on ropsten, submit requests for metadata refreshes through our Support Team here. Requests may take up to 2 business days (AEST).


Did this page help you?