Create an NFT

Create an NFT

post

This endpoint allows you to create a new NFT.

Authorizations

bearerAuth

Path parameters

transferablestringRequired

Value must be either 't' for transferable or 'n' for non-transferable

projectIdintegerRequired

Body

application/json

namestringRequired

Name stored as on-chain metadata

Example: NFT #1

symbolstringOptional

Symbol stored as on-chain metadata

Example: NFT

descriptionstringOptional

Description stored in the metadata

Example: This is my first NFT

imagestringRequired

Image URL for your NFT

Example: https://example.com/image.png

animationUrlstringOptional

Animation URL for your NFT

Example: https://example.com/animation.mp4

receiverAddressstringOptional

Wallet address that will receive the NFT

Example: EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDpPattern: ^[A-HJ-NP-Za-km-z1-9]*$

upsertbooleanOptional

If true, will update the NFT if one with the same owner / claimer exists

Responses

200

Returns an array of NFTs with upserted metadata

application/json

202Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/v2/projects/:transferable/:projectId/nfts

HTTPcURLJavaScriptPython

POST /v2/projects/:transferable/:projectId/nfts HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "name": "NFT #1",
  "symbol": "NFT",
  "description": "This is my first NFT",
  "image": "https://example.com/image.png",
  "animationUrl": "https://example.com/animation.mp4",
  "attributes": {
    "Points": "40000",
    "Nickname": "LeGoat"
  },
  "receiverAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "upsert": true
}

[
  {
    "name": "NFT #1",
    "symbol": "NFT",
    "description": "This is my first NFT",
    "image": "https://example.com/image.png",
    "animationUrl": "https://example.com/animation.mp4",
    "attributes": {
      "Points": "40000",
      "Nickname": "LeGoat"
    },
    "id": 1,
    "projectId": 1,
    "transferable": true,
    "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
    "ownerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
    "claimerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
    "status": "text"
  }
]

Example

cURL

curl --location --request POST 'https://dev.underdogprotocol.com/v2/projects/n/4/nfts' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "LeGoat",
    "image": "https://sportshub.cbsistatic.com/i/r/2023/02/08/aa0a798f-6268-41ba-9be4-ea4ee03fd817/thumbnail/1200x675/421458d6419a36da2aaad75e10b2e347/king.jpg",
    "attributes": {
        "points": "38390"
    }
}'

JavaScript

Response

{
    "transactionId": "c3f66040-89f2-4692-9987-e7d0465179ab",
    "mintAddress": "Dic1tC9yBhaDerQpV8ZBAsruBUKQsRWtCWysG965ADWi"
}