Skip to main content
POST
Deploy a new NFT drop using server wallet

Authorizations

Authorization
string
header
required

Secret key for authentication

Body

application/json

Deploy drop data

chainId
number
default:1868
required

Blockchain chain ID

Example:

1868

name
string
required

Name of the NFT drop

Example:

"My NFT Drop"

mode
enum<string>
default:standard
required

Mode of the NFT drop. Default to STANDARD.

Available options:
standard,
badge
Example:

"standard"

defaultTokenMetadata
object
required

Default token metadata for the NFT drop. Required if metadataStorageType is s3 or metadata-api.

description
string

Drop description

Example:

"This is a description of the NFT drop"

symbol
string
default:DEMO

Symbol of the NFT drop

Example:

"DEMO"

totalSupply
number
default:1000

Total supply of the NFT drop

Example:

1000

unitPrice
number
default:0

Unit price of the NFT drop

Example:

0

startTime
string<date-time>

Start time of the NFT drop

Example:

"2025-01-01T00:00:00Z"

limitPerWallet
number
default:0

Limit per wallet

whitelist
string

Whitelist

Example:

"0xfb43B1aCdcC86FEbDd7Ad80fff571C8F912423D9,20,0.00001\n0xfBf3736070C6fa64D818dEc78166a553D07cEcF8,20,0.00001\n0xDdBECdfE4E43260fdA3721c20c4022cceF4AED19,20,0.00001"

currencyAddress
string

ERC20 currency address. If not provided, the default currency is ETH.

creatorFeeAddress
string

Creator fee recipient address

creatorFeeBps
number
default:0

Creator fee basis points (0-10000)

projectId
string

Project ID

Example:

"123"

metadataStorageType
enum<string>
default:s3

Type of metadata storage. Default to S3.

Available options:
s3,
metadata-api,
self-hosted
Example:

"s3"

baseUri
string

Base URI for the NFT drop. Required if metadataStorageType is self-hosted.

Example:

"https://my-nft-drop.com/metadata/"

Response

201 - application/json

Drop deployed successfully

drop
object
required

The drop that was deployed

transactions
object[]
required

The transactions that were sent to deploy the drop