Create an NFT

Create an NFT

This endpoint allows you to create a new NFT.

POSThttps://api.underdogprotocol.com/v2/projects/:transferable/:projectId/nfts

Authorization

bearerAuth

Path parameters

transferable*string

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

projectId*integer

Body

application/json

name*string

Name stored as on-chain metadata

Example: "NFT #1"

symbolstring

Symbol stored as on-chain metadata

Example: "NFT"

descriptionstring

Description stored in the metadata

Example: "This is my first NFT"

image*string

Image URL for your NFT

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

animationUrlstring

Animation URL for your NFT

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

attributesobject

Key-value pairs of your NFT attributes

receiverAddressstring

Wallet address that will receive the NFT

Example: "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp"

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

upsertboolean

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

Response

200202401403404

Returns an array of NFTs with upserted metadata

Body

application/json

name*string

Name stored as on-chain metadata

Example: "NFT #1"

symbolstring

Symbol stored as on-chain metadata

Example: "NFT"

descriptionstring

Description stored in the metadata

Example: "This is my first NFT"

image*string

Image URL for your NFT

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

animationUrlstring

Animation URL for your NFT

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

attributesobject

Key-value pairs of your NFT attributes

id*number

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

mintAddress*string

Address for the NFT's or token's mint account

Example: "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp"

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

ownerAddressstring

Wallet addres for the NFT's owner

Example: "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp"

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

claimerAddressstring

Wallet address allowed to claim the NFT

Example: "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp"

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

status*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.underdogprotocol.com/v2/projects/:transferable/:projectId/nfts', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "NFT #1",
      "image": "https://example.com/image.png"
    }),
});
const data = await response.json();

Response

200202401403404

[
  {
    "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": 0,
    "projectId": 0,
    "transferable": false,
    "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

const axios = require('axios');
let data = JSON.stringify({
  "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"
  }
});

let config = {
  method: 'post',
  url: 'https://dev.underdogprotocol.com/v2/projects/n/4/nfts',
  headers: { 
    'Authorization': 'Bearer {token}', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

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