v1

latestOpenAPI 3.0.02026-07-146561171.4 KB

Projects

Create NFTs

This endpoint allows you to create a batch of NFTs.

post/v2/projects/{projectId}/nfts/batch

Path parameters

projectIdinteger required

Request body

namestring required

Name stored as on-chain metadata

symbolstring

Symbol stored as on-chain metadata

descriptionstring

Description stored in the metadata

imagestring required

Image for your NFT. When creating an NFT, this can be a base64 encoded string or a URL pointing to an image.

animationUrlstring

URL pointing to the asset's animation.

externalUrlstring

URL pointing to an external URL defining the asset

attributesobject

Key-value pairs of your NFT attributes

receiverAddressstring

Base-58 encoded string representing an on-chain address

delegatedboolean

If true, your Project will have delegated authority to transfer or burn the asset

Example request

{
  "name": "Underdog NFT",
  "symbol": "UPDG",
  "description": "I minted this NFT with the Underdog API",
  "image": "https://hatrabbits.com/wp-content/uploads/2017/01/random.jpg",
  "animationUrl": "https://i.imgur.com/mGfz7Ig.mp4",
  "externalUrl": "https://app.underdogprotocol.com",
  "attributes": {
    "points": 10,
    "name": "LeBron"
  },
  "receiver": {
    "address": "7px1aXrdcySNHEF8aQ12iHBW5a2MVsqQU1ELkTdYAgjN",
    "namespace": "public",
    "identifier": "kevin@underdogprotocol.com"
  },
  "receiverAddress": "dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt",
  "batch": [
    {
      "name": "Underdog NFT",
      "symbol": "UPDG",
      "description": "I minted this NFT with the Underdog API",
      "image": "https://hatrabbits.com/wp-content/uploads/2017/01/random.jpg",
      "animationUrl": "https://i.imgur.com/mGfz7Ig.mp4",
      "externalUrl": "https://app.underdogprotocol.com",
      "attributes": {
        "points": 10,
        "name": "LeBron"
      },
      "receiver": {
        "address": "7px1aXrdcySNHEF8aQ12iHBW5a2MVsqQU1ELkTdYAgjN",
        "namespace": "public",
        "identifier": "kevin@underdogprotocol.com"
      },
      "receiverAddress": "dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt"
    }
  ]
}

Response

Successful response

transactionIdstring required

Transaction ID that identifies the Transaction generated by an API request

nftIdnumber required

Unique ID for an NFT in a Project

projectIdnumber

The ID of the Project the NFT is part of

transferableboolean

Whether or not the NFT can be transferred based on the Project its a part of

compressedboolean

Whether or not the NFTs in the Project are compressed