/mintFreeNFT

🚨 You'll need to contact dev@usewinter.com for your API keys!

This set of APIs is for when you want to mint specifically a FREE NFT directly from a smart contract.

An example use case is if you want to reward a user with a free loyalty NFT!

POST https://winter-api.usewinter.com/mintNFT

This API will return back all NFTs associated with a given email

Request Body

NameTypeDescription

projectId*

Integer

projectId set up in Winter's dashboard (a project ID will correspond to smart contract address, ABI, etc)

chain*

String

Chain to mint on

email

String

Optional string to send user an email confirmation

mintParams

JSON

Optional JSON object with extra mint params (e.g. if you want to specify a specific tier of an item, this is what you use)

{
   "project_id":104,
   "success": true,
   "mint_id":"01a2e7b5fb11d9342320b3edd1006800",
   "token_id":19,
   "tokenuri":"ipfs://QmQxTMxsAtkNodUJ26mbtchsnqTekKqgDvkjnzWir4vTxZ/19",
   "token_symbol":"MATIC",
   "smart_contract_address":"0xc9a1c857172974978641fde7463c22f4a6111d77",
   "txHash": "0x8259801df6220e4e47960fcdd0dff998973ee70bb1e24688370460fba8a8ae49"
}

This API will return back if the mint was success or failure and additional details such as tx hash, token_id, and other details!

E.g. /mintFreeNFT returns:

{
   "project_id":104,
   "success": true,
   "mint_id":"01a2e7b5fb11d9342320b3edd1006800",
   "token_id":19,
   "tokenuri":"ipfs://QmQxTMxsAtkNodUJ26mbtchsnqTekKqgDvkjnzWir4vTxZ/19",
   "token_symbol":"MATIC",
   "smart_contract_address":"0xc9a1c857172974978641fde7463c22f4a6111d77",
   "txHash": "0x8259801df6220e4e47960fcdd0dff998973ee70bb1e24688370460fba8a8ae49"
}

Last updated