Retrieve an NFT

Retrieve a Collection

This endpoint allows you to retrieve a NFT by providing their mint address.

GEThttps://api.underdogprotocol.com/v1/nfts/:mintAddress

Authorization

bearerAuth

Path parameters

mintAddress*string

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

Example: "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp"

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

Response

200403404

Returns an 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/:mintAddress', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200403404

{
  "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 "https://api.underdogprotocol.com/v1/nfts/7eYfyPfnGzxp8A9TrQJEpKwVCC8nP9viHRRGJ89WzFJB" \
        -H "Authorization: Bearer {token}"

JavaScript

import axios from 'axios';

const mintAddress = '7eYfyPfnGzxp8A9TrQJEpKwVCC8nP9viHRRGJ89WzFJB';

const getNft = async () => {
  try {
    const response = await axios.get(`https://api.underdogprotocol.com/v1/nfts/${mintAddress}`, {
      headers: {
        'Authorization': `Bearer ${token}`
      }
    });

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

Response

{
  "mintAddress": "7eYfyPfnGzxp8A9TrQJEpKwVCC8nP9viHRRGJ89WzFJB",
  "name": "Sacramento Kings",
  "description": "",
  "image": "https://arweave.net/U0PFVZ_LszARt7OgfSiLl--OrRmczn0cNAjw4tYerVQ",
  "attributes": [
    {
      "trait_type": "best player",
      "value": "Chris Webber"
    }
  ],
  "collectionAddress": "FrvZAJ1qZ2vhV17nFdEmw66N3FW5QiHFt6HdqsEh8QNq",
  "ownerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp"
}