Developer Console

Developer Blog

Crossmint Docs

API Reference

Support

Changelog

Dev Console

Console (staging)

Deprecating Polygon Mumbai and Releasing Polygon Amoy support on Staging

April 04, 2024

About Crossmint

Tap into 15+ chains in one single integration

Supported Chains

Staging vs Production

Staging vs Production Environments

Get your keys in seconds and start building

API Keys

Learn how to get your account and collection verified

Account Verification

Project & Team Management

Project and Team Management

Enterprise-grade wallets with best-in-class MPC security

Enterprise-grade wallets with best-in-class MPC security, social login and flexible custody. Get started in 5 minutes with Crossmint.

Introduction to NFT Wallets | Crossmint Docs

Introduction

Secure invisible wallets for NFT-focused applications

Secure custodial wallets for NFT-focused applications, invisible and embedded in your website or app. Get started in 5 minutes with Crossmint.

Custodial Wallets Introduction | Crossmint Docs

Overview

Custodial Wallets Overview

Create a wallet and read its content in under 5 minutes

Learn how to generate a custodial wallet and fetch its assets in under 5 minutes with Crossmint.

Custodial Wallets Quickstart | Crossmint Docs

Quickstart ⚡

Spin out wallets on-demand by passing an email (or any user identifier) to the create wallet API. Get started iwith Crossmint.

How to Create an NFT Wallet via API | Crossmint Docs

Create Wallets

Learn how to execute actions on behalf of users, like transferring NFTs, and signing messages and transactions. Get started in 5 minutes with Crossmint.

Custodial Wallet Actions | Crossmint Docs

Wallet Actions

Secure non-custodial programmable wallets

Smart Wallets Overview

Allow users to sign up using any social log-in

Build an end-to-end flow combining the most robust enterprise-grade authentication products in the market with Crossmint’s secure wallet infrastructure. Get started in 5 minutes.

Wallet Authentication | Crossmint Docs

Authentication

Allow users to connect to any website and physical location

Allow users to connect their wallets to any website and offer benefits based on the NFTs they hold or their wallet activity.

How to Connect Users to your Wallet | Crossmint Connect

Connecting the Wallet

Launch faster by using Crossmint's pre-made react components

Build a custodial wallet a few simple steps using Crossmint's pre-made react components.

How to Build an NFT Wallet with Crossmint's UI Components

Wallet UI Components

Automatically block spam NFTs from your wallets

Automatically block spam NFTs from your wallets.

Block Spam NFTs from your Wallets | Crossmint Docs

Spam Filters

Mint and distribute tokens at scale, reliably

Crossmint offers a suite of Minting Tools to create, update, delete and manage tokens, all accessible via REST APIs and a no-code dashboard. Get started in 5 minutes with Crossmint.

Minting Tools Introduction | Crossmint Docs

Learn how to mint an NFT and airdrop it to a wallet or email address. Get started in 5 minutes with Crossmint.

NFT Minting API | Create and Airdrop NFTs at Scale

Deploy smart contracts and NFT collections

Create and deploy smart contracts and NFT collections via API or directly with a no-code dashboard. Get started in 5 minutes with Crossmint.

How to Deploy an NFT Collection via API | Crossmint Docs

Create Collections

Create, mint and airdrop tokens (NFTs) at scale with a single API Call. Get started in 5 minutes with Crossmint.

How to Mint Tokens in a Single API Call (NFTs) | Crossmint Docs

Mint Tokens

Create dynamic assets, correct mistakes or remove an NFT from circulation with a single API call. Get started in 5 minutes with Crossmint.

How to Edit and Burn NFTs | Crossmint Docs

Edit and Burn Tokens

Edit and Burn NFTs

Allow users to buy your NFTs created with Crossmint

Learn how to sell your tokens (NFTs) created with Crossmint. Accept credit card and crypto payments. Get started in 5 minutes.

How to Sell Tokens (NFTs)| Crossmint Docs

Sell Tokens

Deploy a website for your users to come claim your NFTs

Deploy a website for your users to claim your NFTs with no-code. Get started in 5 minutes with Crossmint.

Set up an NFT Claims Page | Crossmint Docs

Set up a Claims Page

Follow these steps to prevent common pitfalls

Best Practices

Using Crossmint's minting infrastructure with your own smart contract

Register your smart contract and leverage Crossmint’s scalable infrastructure to mint and distribute the NFTs. Get started in 5 minutes with Crossmint.

How to Register a Smart Contract | Crossmint Docs

Bring Your Own Contract

Understand Collection and NFT metadata standards (e.g. title, description, image, other attributes) to ensure it appears correctly across wallets and marketplaces.

NFT Metadata Explained | Crossmint Docs

Metadata

Dynamic NFTs are tokens whose content changes over time. Learn how to create and update them with Crossmint.

How to Create Dynamic NFTs | Crossmint Docs

Dynamic NFTs

Learn how to craft the recipient string for minting depending on the recipient type

Specify Recipient

Obtain additional revenue from secondary market transactions

Obtain additional revenue from secondary market transactions by adding royalties to your NFT collection. Get started in 5 minutes with Crossmint.

Add Royalties to your NFT Collection | Crossmint Docs

Set Royalties

Set Collection Royalties

Listen for updates in mints, edits, collection creations and other async events

Listen for updates in mints, edits, collection creations and other async events. Get started in 5 minutes with Crossmint.

Minting Webhooks and Status APIs | Crossmint Docs

Webhooks & Status APIs

Webhooks and Status APIs

Edit your collection profile on OpenSea, Rarible and other marketplaces

Edit your collection profile on OpenSea, Rarible and other marketplaces. Get started in 5 minutes with Crossmint.

Edit your NFT Collection Profile | Crossmint Docs

Marketplace Profile

Allow your users to buy NFTs with any payment method

NFT Checkout Solution - Introduction | Crossmint Docs

Deploy a live site, hosted by Crossmint, to sell your NFTs

Get a hosted NFT storefront that is mobile-first, supports any payment method (crypto and fiat), and work for users that don't own wallets -- no coding required.

No-Code NFT Storefront - Overview | Crossmint Docs

Launch a store for your NFTs in 5 minutes, without coding

Learn how to create and deploy a store for your NFTs in 5 minutes, without coding. Start selling NFTs right now, with cross-chain and credit card payments automatically activated.

How to Create and Deploy an NFT Storefront | Crossmint Docs

Add a button to your site which opens the checkout in a pop-up or new tab

Allow your users to purchase your NFTs with any payment method, from any device, in ~30 seconds, even if they don’t have a wallet or cryptocurrency. Get started in under 5 minutes with Crossmint.

Accept Payments for your NFT Project | Crossmint Docs

Add an NFT checkout button to a demo app in under 5 minutes

Learn how to integrate an NFT Checkout into your website or app. Get started in 5 minutes with Crossmint.

NFT Checkout Integration | Crossmint Docs

Customize the payment methods available to users

Allow your users to purchase your NFTs with any payment method. Accept credit card and crosschain payments. Get started in 5 minutes with Crossmint.

NFT Payment Methods | Crossmint Docs

Select Payment Options

Modify the payment button to match the style of your website

Customize the Button UI

Send users to a specific website after a successful or cancelled purchase.

Redirect URLs

Insert the checkout on your site and gain full UX control

Integrate an NFT checkout in under 10 minutes, fully customizable and natively embedded in your website or app. Accept all cards and payment methods. Get started with Crossmint

Embedded NFT Checkout | Crossmint's Whitelabel Solutions

Embed a checkout into a demo app in under 10 minutes

Lear how to integrate a fully customizable NFT checkout on your website or app in less than 10 minutes.

How to embed an NFT Checkout | Crossmint Docs

Add cross-chain crypto payments to the embedded checkout

Allow users to pay for NFTs with any cryptocurrency. Get started in 5 minutes with Crossmint.

Accept Crypto Payments for your NFTs | Crossmint Docs

Crypto Payments

Adapt UI elements of the Embedded NFT Checkout

Customize Style

Events

This document is intended to share some of the best practices and tips for testing.

Testing Tips

Follow this checklist to ensure you are ready for launch

Production Launch

Add fiat and cross-chain crypto payments to your platform

Marketplaces & Launchpads

Start accepting payments into your contract

Bring your Own Collection

Understand the properties available on the NFT checkout

Component Properties

Webhooks

Currency & Language Localization

Allow users to purchase multiple NFTs in a single order

Purchases of Multiple NFTs

Accesslists

How to set up Crossmint if your collection is denominated in USDC

USDC Support

Explore the APIs and test them live from the browser

Create a new Crossmint custodial wallet for a user

**API scope required**: `wallets.create`


Create Wallet

Fetch the addresses of a user's Crossmint custodial wallets

**API scope required**: `wallets.read`


Get Wallets for User

Fetch the NFTs in a provided wallet

**API scope required**: `wallets:nfts.read`


Get NFTs from Wallet

Transfer NFTs from one wallet to another wallet. Intended for wallets created using `email` option.

**API scope required**: `wallets:nfts.transfer`


Transfer NFT (email)

Transfer NFTs from one wallet to another wallet. Intended for wallets created with `userId` option.

**API scope required**: `wallets:nfts.transfer`


Transfer NFT (userId)

Sign a message using a custodial wallet's key

**API scope required**: `wallets:messages.sign`


Sign Message

Mint your NFTs and deliver them to a web3 wallet or an email address

**API scope required**: `nfts.create`


Mint NFT

Mint your SFTs and deliver them to a web3 wallet or an email address

**API scope required**: `nfts.create`


Mint SFT

Get a list of all the NFTs in a given collection.

**API scope required**: `nfts.read`


Get All NFTs

Get the status and associated information for a mint operation.

**API scope required**: `nfts.read`


Mint Status

Edit a minted NFT's metadata on IPFS. 

If you are using a custom baseURI, invoking this will overwrite the specific tokenURI for the edited token.

**API scope required**: `nfts.update`


Edit NFT

Burn a minted NFT.

**API scope required**: `nfts.delete`


Burn NFT

Create a collection that you can mint NFTs/SFTs from

**API scope required**: `collections.create`


Create Collection

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`


Create Collection with ID

List all collections created under the current Crossmint project

**API scope required**: `collections.read`


Get All Collections

Get information about a specific collection.

**API scope required**: `collections.read`


Get Collection Info

Update the sales details of a collection

**API scope required**: `collections.update`


Update Collection Info

Configure royalties for all NFTs in a collection.

This API is only supported for EVM chains and implements the EIP-2981 standard.

**API scope required**: `collections.update`


Fetch the royalty configuration for a collection, from its current state
in the blockchain. 

This API is only supported on EVM chains.

If you call GET too soon after PUT/DELETE,
you may not yet see your latest changes, as they can take a few seconds to
record on the blockchain.

**API scope required**: `collections.read`


Get Royalties Config

Remove all royalties from a given collection. No new NFT sales will yield royalties to the creator. 

This API is only supported on EVM Chains.

**API scope required**: `collections.update`


Changelog

​Using Amoy for Collections on Staging

Using Amoy for Collections on Staging