v1

latestOpenAPI 3.0.02026-07-146561171.4 KB

Projects

Retrieve an NFT

This endpoint allows you to retrieve an NFT by ID.

get/v2/projects/{projectId}/nfts/{nftId}

Path parameters

projectIdinteger required

nftIdinteger required

Response

Successful response

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

idnumber 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

mintAddressstring required

Base-58 encoded string representing an on-chain address

ownerAddressstring

Wallet address for the NFT's owner

claimerAddressstring

Wallet address allowed to claim the NFT

statusstring required

Example response

{
  "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"
  },
  "mintAddress": "dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt",
  "ownerAddress": "dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt",
  "claimerAddress": "dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt"
}