Collection registration

❗️

Mainnet only

This functionality is only relevant for users building on MainnetMainnet - Ethereum's mainnet, used for projects which are ready for production..

To create and update collections and metadata schema in RopstenRopsten - Ethereum's testnet, used for testing, experimenting and debugging., follow the guides here.

For users who have previously registered a collection via online form submission in either mainnet or ropsten , submit a request here containing the information specified below, depending on your request.

Overview

Submit a request here containing the information specified below, depending on the request you would like to make.

Register a Collection (Contract)

Provide the following details along with your request.

{
  "name": "Collection Name (usually Partner Name)",
  "description": "Some Description of this collection",
  "owner_public_key": "<CHANGE-ME>",
  "contract_address": "<CHANGE-ME>",
  "metadata_api_url": "https://<CHANGE-ME>",
  "icon_url": "https://<CHANGE-ME>",
  "collection_image_url": "https://<CHANGE-ME>"
}
curl -d '{
  "name": "Guild of Guardians - Dummy Example",
  "contract_address": "0xb81293e6e30e75feb769d1362dfb471b5d8850a0",
  "owner_public_key": "0x047136bc1b2b1e54286ddd0dd4f52618383fa29f1d7513a0eb4c2dd0bdb070ddfc7b48ef66e3cdc29d51cad6ef192b94844686729f4f83266f98ed2bd435502a78",
  "metadata_api_url": "https://prod-gog-presale.herokuapp.com/api/imx/nfts/0x1f2bcBF6a5d73DDA2Ca90fE9504Fa4927d857d61",
  "icon_url": "https://<CHANGE-ME>",
  "collection_image_url": "https://<CHANGE-ME>",
  "description": "Guild of Guardian - Other"
}' -H "X-Admin-Token: ***" -X POST https://api.x.immutable.com/v1/collections

Field

Required (Default Value)

Value Type / Notes

name

yes

text

description

no

text

owner_public_key

yes

Generate the Public Key

owner_address

IGNORE FOR NOW

In the future, Partners will be using this instead of generating owner_public_key.

contract_address

yes

text

metadata_api_url

no

We will crawl this url for the metadata for each asset_id you mint. Please ensure there is a valid metadata JSON response for our crawler to access <metadata_api_url>/<asset_id> for each asset (i.e. http://mymetadataendpoint.com/1).

More details about metadata can be found
here

icon_url

no

Do not put an empty text or a non-url for this as it may result in a broken icon when used.

collection_image_url

no

Used for display purposes.

Update an existing Collection

📘

How to get the Contract Address

Call the collections API: https://api.x.immutable.com/v1/collections. You can just paste this in the browser address bar. Then find the address you wish to use on the next set of API requests.

Provide the following details along with your request.

{
  "name": "Much better name",
  "icon_url": "https://example.partner.icon.url"
}
curl -d '{
  "name": "Much better name",
  "icon_url": "https://example.partner.icon.url"
}' -H "X-Admin-Token: ***" -X PATCH https://api.x.immutable.com/v1/collections/{{contract-address}}

🚧

Modifications not allowed for these fields

contract_address and owner_address are fields that should not be changed in this API call.

If metadata_api_url is modified AFTER minting, the existing NFTs that used the previous metadata_api_url will not be modified.

The new metadata_api_url will be used for new NFT mints.

Field

Required (Default value)

Value Type / Notes

name

text

description

text

icon_url

Do not put an empty text or a non-url for this as it may result in a broken icon when used.

collection_image_url

Used for display purposes.


Did this page help you?