Retrieve a Collection

Retrieve a Collection

This endpoint allows you to retrieve a Collection by providing their collection address.

GEThttps://api.underdogprotocol.com/v1/collections/:collectionAddress

Authorization

bearerAuth

Path parameters

collectionAddress*string

Mint address for the NFT Collection

Query parameters

Response

200401403404

Returns a Collection with a paginated list of NFTs

Body

application/json

name*string

Name stored as on-chain metadata

symbolstring

Symbol stored as on-chain metadata

descriptionstring

Description stored in the metadata

image*string

Image URL for your NFT

animationUrlstring

Animation URL for your NFT

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

ownerAddressstring

Wallet addres for the NFT's owner

claimerAddressstring

Wallet address allowed to claim the NFT

status*string

nfts*object

Request

JavaScriptCurl

const response = await fetch('https://api.underdogprotocol.com/v1/collections/:collectionAddress', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "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",
  "nfts": {
    "results": [
      {
        "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"
      }
    ],
    "page": 1,
    "limit": 10,
    "totalPages": 1,
    "totalResults": 1
  }
}

Example

cURL

curl "https://api.underdogprotocol.com/v1/collections/6TpvoRVJfJe6VdqfML4yjvp9Qc49LuVNb7uzWtPRZzVV" \
        -H "Authorization: Bearer {token}"

JavaScript

import axios from 'axios';

const collectionAddress = '6TpvoRVJfJe6VdqfML4yjvp9Qc49LuVNb7uzWtPRZzVV';

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

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

Response

{
  "mintAddress": "6TpvoRVJfJe6VdqfML4yjvp9Qc49LuVNb7uzWtPRZzVV",
  "name": "Underdog Protocol",
  "description": "Underdog Protocol Collection",
  "image": "https://arweave.net/-RawfoOduz6O18yTuz4zOGbCokzoACaDjoogsSwMaBY",
  "collectionDetails": {},
  "status": "confirmed",
  "ownerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "nfts": {
    "results": [
      {
        "mintAddress": "DBqMFAaE8rxJ5emotUywQLWJStGMgGRo3vH52dcKApe6",
        "ownerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
        "name": "Degenerate Ape",
        "image": "https://arweave.net/8FZ8SmhuLDUH-vN0psJuq7GKpCncqGP-03UU_tjmHW8",
        "description": null,
        "status": "confirmed",
        "tokenManager": {}
      }
    ],
    "page": 1,
    "limit": 10,
    "totalPages": 1,
    "totalResults": 1
  }
}