POST
/
2022-06-09
/
collections
/
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": "aptos",
  "metadata": {
    "name": "Sample NFT Collection",
    "imageUrl": "https://www.crossmint.com/assets/crossmint/logo.png",
    "description": "This is a sample NFT collection",
    "symbol": "XMINT"
  },
  "fungibility": "non-fungible",
  "supplyLimit": 123,
  "payments": {
    "price": "<string>",
    "recipientAddress": "<string>"
  },
  "reuploadLinkedFiles": true
}'
{
  "id": "5263650e-6d43-4ed3-9e31-0cf593d076a4",
  "metadata": {
    "name": "Test Collection",
    "description": "Test",
    "imageUrl": "https://cdn.io/metadata.json",
    "symbol": "XMINT"
  },
  "fungibility": "semi-fungible",
  "onChain": {
    "chain": "polygon",
    "type": "erc-1155"
  },
  "actionId": "5263650e-6d43-4ed3-9e31-0cf593d076a4"
}

Authorizations

X-API-KEY
string
headerrequired

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,
astar-zkevm,
base,
base-sepolia,
bsc,
optimism,
optimism-sepolia,
polygon,
polygon-amoy,
solana,
zkyoto,
zora,
zora-sepolia
metadata
object
required
fungibility
enum<string>
default: non-fungible

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

Available options:
non-fungible,
semi-fungible
supplyLimit
number

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

payments
object

Enable payments for this collection by setting price and recipientAddress

reuploadLinkedFiles
boolean

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

Response

200 - application/json
id
string
metadata
object
fungibility
string
onChain
object
actionId
string
Burn NFTCreate Collection with ID