Create an NFT

Create an NFT

This endpoint allows you to create a new NFT.

POSThttps://api.underdogprotocol.com/v1/nfts

Authorization

bearerAuth

Body

application/json

name*string

Name for you NFT

descriptionstring

Description for your NFT

image*string

URL pointing to an image for your NFT

attributesAttributes for your NFT

Key-value pairs where the key is the attribute name and the value is the attribute value.

managedboolean

Mints the NFT in a Token Manager

upsertboolean

Allows updating an NFT if one already exists with the same owner and collection address

ownerAddressstring

Wallet Address of the owner of the NFT

collectionAddressstring

Mint address for the NFT Collection

Response

200202401403404

Returns the upserted NFT

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/v1/nfts', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "image": "text"
    }),
});
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 --request POST \
  --url https://api.underdogprotocol.com/v1/nfts \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer {token}" \
  --data '
{
        "collectionAddress": "6TpvoRVJfJe6VdqfML4yjvp9Qc49LuVNb7uzWtPRZzVV",
        "name": "Degenerate Ape",
        "image": "https://arweave.net/6TnZgDc7xDFV_0UFyPgfq2wn6UfRv8-DJgwVwoHfLG4"
}'

JavaScript

import axios from 'axios';

const createNft = async () => {
  try {
    const response = await axios.post('https://api.underdogprotocol.com/v1/nfts', {
      collectionAddress: '6TpvoRVJfJe6VdqfML4yjvp9Qc49LuVNb7uzWtPRZzVV',
      name: 'Degenerate Ape',
      image: 'https://arweave.net/6TnZgDc7xDFV_0UFyPgfq2wn6UfRv8-DJgwVwoHfLG4'
    }, {
      headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${token}`
      }
    });

    console.log(response.data);
  } catch (error) {
    console.error(error);
  }
}

Response

{
    "mintAddress": "DBqMFAaE8rxJ5emotUywQLWJStGMgGRo3vH52dcKApe6",
    "transactionId": "2eebff8e-67a6-4a30-b7e3-7cec2d3f2160"
}