Sign in

v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB
NFT Collections

Create Collection with ID

Create a collection that you can mint NFTs/SFTs from. This API is idempotent, if you call it multiple times with the same ID, only one will be created.

API scope required: collections.create

put/2022-06-09/collections/{collectionId}

Path parameters

collectionIdstring required

This is the identifier for the collection related to the request. Every project has default collections: default-solana and default-polygon.

The create-collection API will result in collections with UUID formatted collectionId. Example: 9c82ef99-617f-497d-9abb-fd355291681b

The create-collection-idempotent API allows you to specify an arbitrary identifier during the initial request. Example: your-custom-identifier

Request body

chain'aptos' | 'arbitrum' | 'arbitrum-sepolia' | 'avalanche' | 'avalanche-fuji' | 'base' | 'base-sepolia' | 'bsc' | 'chiliz' | 'chiliz-spicy-testnet' | 'ethereum' | 'ethereum-sepolia' | 'optimism' | 'optimism-sepolia' | 'polygon' | 'polygon-amoy' | 'shape' | 'shape-sepolia' | 'skale-nebula' | 'skale-nebula-testnet' | 'solana' | 'soneium-minato-testnet' | 'xai' | 'xai-sepolia-testnet' | 'zora' | 'zora-sepolia' required

Blockchain you would like to use for this collection

fungibility'non-fungible' | 'semi-fungible'

Whether or not this collection is fungible. EVM and Solana collections may be set as semi-fungible.

transferableboolean

Whether or not NFTs in this collection are transferable. Supported on EVM and Aptos chains. (For subscriptions must be set to false)

supplyLimitnumber

The maximum number of tokens that can be minted for this collection

reuploadLinkedFilesboolean

Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]

Example request

{
  "chain": "polygon",
  "metadata": {
    "name": "Sample NFT Collection",
    "imageUrl": "https://www.crossmint.com/assets/crossmint/logo.png",
    "description": "This is a sample NFT collection",
    "symbol": "TOKEN"
  }
}

Response

Success.

idstring
fungibilitystring
actionIdstring

Example response

{
  "id": "5263650e-6d43-4ed3-9e31-0cf593d076a4",
  "metadata": {
    "name": "Sample NFT Collection",
    "description": "This is a sample NFT collection",
    "imageUrl": "https://www.crossmint.com/assets/crossmint/logo.png",
    "symbol": "TOKEN"
  },
  "fungibility": "non-fungible",
  "onChain": {
    "chain": "polygon",
    "type": "erc-721"
  },
  "actionId": "5263650e-6d43-4ed3-9e31-0cf593d076a4"
}