Create Collection

curl --request POST \
  --url https://staging.crossmint.com/api/2022-06-09/collections/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "chain": "polygon",
  "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",
  "transferable": true,
  "supplyLimit": 123,
  "payments": {
    "price": "<string>",
    "recipientAddress": "<string>",
    "currency": "<string>"
  },
  "subscription": {
    "enabled": false
  },
  "reuploadLinkedFiles": true
}
'

{
  "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",
  "subscription": {
    "enabled": true
  }
}

POST

2022-06-09

collections

Create Collection

curl --request POST \
  --url https://staging.crossmint.com/api/2022-06-09/collections/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "chain": "polygon",
  "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",
  "transferable": true,
  "supplyLimit": 123,
  "payments": {
    "price": "<string>",
    "recipientAddress": "<string>",
    "currency": "<string>"
  },
  "subscription": {
    "enabled": false
  },
  "reuploadLinkedFiles": true
}
'

{
  "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",
  "subscription": {
    "enabled": true
  }
}

Authorizations

X-API-KEY

string

header

required

Obtained in the Crossmint developer console

Body

application/json

chain

enum<string>

required

Blockchain you would like to use for this collection

Available options:

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

Example:

"polygon"

metadata

object

required

Show child attributes

metadata.name

string

required

Collection name (Max length: 32)

Maximum string length: 32

Example:

"Sample NFT Collection"

metadata.description

string

required

A description of the NFT collection

Maximum string length: 64

Example:

"This is a sample NFT collection"

metadata.imageUrl

string

URL pointing to an image that represents the collection

Example:

"https://www.crossmint.com/assets/crossmint/logo.png"

metadata.symbol

string

Shorthand identifier for the NFT collection (Max length: 10). Defaults to 'TOKEN'

Maximum string length: 10

Example:

"TOKEN"

fungibility

enum<string>

default:non-fungible

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

Available options:

non-fungible,

semi-fungible

transferable

boolean

default:true

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

supplyLimit

number

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

payments

object

Enable payments for this collection by setting price, recipientAddress and currency

Show child attributes

payments.price

string

The price of the token in native currency for the selected chain

payments.recipientAddress

string

The wallet address to receive payouts

payments.currency

string

The currency for the price of the NFT. Defaults to the native currency of the chain

subscription

object

Show child attributes

subscription.enabled

boolean

default:false

Whether subscriptions are enabled for this collection

Example:

false

reuploadLinkedFiles

boolean

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

Response

Success.

string

Example:

"5263650e-6d43-4ed3-9e31-0cf593d076a4"

metadata

object

Show child attributes

metadata.name

string

Example:

"Sample NFT Collection"

metadata.description

string

Example:

"This is a sample NFT collection"

metadata.imageUrl

string

Example:

"https://www.crossmint.com/assets/crossmint/logo.png"

metadata.symbol

string

Example:

"TOKEN"

fungibility

string

Example:

"non-fungible"

onChain

object

Show child attributes

onChain.chain

string

Example:

"polygon"

onChain.type

string

Example:

"erc-721"

actionId

string

Example:

"5263650e-6d43-4ed3-9e31-0cf593d076a4"

subscription

object

Show child attributes

subscription.enabled

boolean

Burn NFT Create Collection (Idempotent)

Introduction

Tokens (NFTs, SFTs)

Verifiable Credentials (VCs)

IP (Story Protocol)

Create Collection

Authorizations

Body

Response