Retrieve an NFT

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

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

mintAddressstringRequired

Base-58 encoded string representing an on-chain address

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

Responses

200Success

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

404

Not Found

application/json

get/v2/nfts/:mintAddress

GET /v2/nfts/:mintAddress HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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 --location --request GET 'https://dev.underdogprotocol.com/v2/nfts/Dic1tC9yBhaDerQpV8ZBAsruBUKQsRWtCWysG965ADWi' \
--header 'Authorization: Bearer {token}'

JavaScript

const axios = require('axios');

let config = {
  method: 'get',
  url: 'https://dev.underdogprotocol.com/v2/nfts/Dic1tC9yBhaDerQpV8ZBAsruBUKQsRWtCWysG965ADWi',
  headers: { 
    'Authorization': 'Bearer d098077945e454.c76459c2fa07476788b3cbf7d60273fd'
  }
};

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

Response

{
    "mintAddress": "Dic1tC9yBhaDerQpV8ZBAsruBUKQsRWtCWysG965ADWi",
    "ownerAddress": "3ZBGxWRQdKTaXRcyLapMn1LaSU5TbKnBKJ6m2jBERKAp",
    "name": "LeGoat",
    "image": "https://underdog-test-bucket-dev.s3.amazonaws.com/Dic1tC9yBhaDerQpV8ZBAsruBUKQsRWtCWysG965ADWi/image.png",
    "attributes": {
        "points": "40000"
    }
}