Create an NFT

Create an NFT

post

This endpoint allows you to create a new NFT.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

Name for you NFT

descriptionstringOptional

Description for your NFT

imagestringRequired

URL pointing to an image for your NFT

managedbooleanOptional

Mints the NFT in a Token Manager

upsertbooleanOptional

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

ownerAddressstringOptional

Wallet Address of the owner of the NFT

collectionAddressstringOptional

Mint address for the NFT Collection

Responses

200

Returns the upserted NFT

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

idnumberRequired

Unique ID for an NFT in a Project

projectIdnumberOptional

The ID of the Project the NFT is part of

transferablebooleanOptional

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

mintAddressstringRequired

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

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

ownerAddressstringOptional

Wallet addres for the NFT's owner

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

claimerAddressstringOptional

Wallet address allowed to claim the NFT

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

statusstringRequired

202Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/v1/nfts

HTTPcURLJavaScriptPython

POST /v1/nfts HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "name": "text",
  "description": "text",
  "image": "text",
  "attributes": {
    "Overall": "0",
    "Clout": "0",
    "Credibility": "0"
  },
  "managed": true,
  "upsert": true,
  "ownerAddress": "text",
  "collectionAddress": "text"
}

{
  "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 --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

Response

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