Crossmint
Search…
Quickstart
Questions? Contact us at www.crossmint.io/support
Trying to send NFTs via Quicknode? See our Quicknode RPC API Reference​

1. Set up (development mode)

To start developing with the Minting API, we recommend you begin by developing in testnets / against our staging servers. The API is completely free and self serve for staging.
To get things set up:
1) First, create an account in the Crossmint staging console: https://staging.crossmint.io/console
2) Next, visit the projects tab by navigating to https://staging.crossmint.io/console/projects or by selecting "All projects" from the projects dropdown
3) Click into your default project, or create a new project
4) Create a new API key with scopes nfts.mint and collections.write
You're all set! Follow instructions below to create and send your first NFT!
Launching to production currently requires a verification step from our team to set up your billing account. We explain how to do this in the last section of this guide​

2. Create and send your first NFT (in staging)

Minting and delivering an NFT to a user is as simple as making one HTTP call.
curl --header "x-client-secret: <CLIENT SECRET>" \
--header "x-project-id: <PROJECT ID>" \
-X POST \
-H 'Content-Type: application/json' \
-d '{ "metadata": { "name": "Crossmint Mint API Test", "image": "https://www.crossmint.io/assets/crossmint/logo.png", "description": "Test NFT created by the Crossmint Minting API" }, "recipient": "email:[email protected]:poly" }' \
https://staging.crossmint.io/api/2022-06-09/collections/default/nfts
Copy the code snippet above, and replace:
  • <CLIENT SECRET> with the client secret obtained in the API keys section from step 1
  • <PROJECT ID> with the project ID obtained from the same API keys screen

3. Check the status of the mint

NFTs may take a few seconds to create and be reflected in the blockchain. After an NFT is minted, with the API call from step 2, you'll get an <id>. Take that <id> and replace it in the call below
curl --header "x-client-secret: <CLIENT SECRET>" \
--header "x-project-id: <PROJECT ID>" \
-X GET \
https://staging.crossmint.io/api/2022-06-09/collections/default/nfts/<id>
This call will return success once the NFT is minted.

4. Customizing the NFTs you mint

You can of course change the image, text and other content of the NFT metadata. To deep dive and see all the API has to offer:

5. Launching to production (mainnet)

To launch in production:
  1. 1.
    Create an account at https://www.crossmint.io/console
  2. 2.
    Fill out the interest form embedded below.
  3. 3.
    Replace https://staging.crossmint.io with https://www.crossmint.io/ in all your API calls
​
Copy link
Outline
1. Set up (development mode)
2. Create and send your first NFT (in staging)
3. Check the status of the mint
4. Customizing the NFTs you mint
5. Launching to production (mainnet)