POST
/
2022-06-09
/
collections
/
{collectionId}
/
nfts
/
Batch Mint NFTs
curl --request POST \
  --url https://staging.crossmint.com/api/2022-06-09/collections/{collectionId}/nfts/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "nfts": [
    {
      "recipient": "email:testy@crossmint.com:polygon",
      "metadata": {
        "name": "Crossmint Example NFT",
        "image": "https://www.crossmint.com/assets/crossmint/logo.png",
        "description": "My NFT created via the mint API!",
        "animation_url": "",
        "attributes": [
          {
            "display_type": "boost_number",
            "trait_type": "<string>",
            "value": "<string>"
          }
        ]
      },
      "compressed": true,
      "id": "<string>"
    }
  ]
}'
{
  "results": [
    {
      "id": "<string>",
      "onChain": {
        "status": "<string>",
        "chain": "<string>",
        "contractAddress": "<string>",
        "subscription": {
          "expiresAt": "2023-11-07T05:31:56Z"
        }
      },
      "actionId": "<string>"
    }
  ]
}
Enterprise feature. Contact us for access.
The recommended batch size is 125 NFTs or less per request.

Authorizations

X-API-KEY
string
header
required

Obtained in the Crossmint developer console

Path Parameters

collectionId
string
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 intitial request. Example: your-custom-identifer

Body

application/json
nfts
object[]
required

Array of objects describing the NFTs to mint to recipients.

Response

Success.

results
object[]
required