v1

latestOpenAPI 3.0.02026-07-146561171.4 KB

Collections

Retrieve NFT Collection

get/v2/collections/{mintAddress}

Path parameters

mintAddressstring required

Base-58 encoded string representing an on-chain address

Example:dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt

Query parameters

pagenumber nullable

Page number

limitnumber nullable

Items per page

ownerAddressstring

Base-58 encoded string representing an on-chain address

Example:dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt

identifierstring

namespacestring

Response

Returns an NFT Collection with a paginated list of NFTs

mintAddressstring required

Base-58 encoded string representing an on-chain address

statusstring required

transferableboolean

Whether or not the NFTs in this project can be transferred

compressedboolean

Whether or not the NFTs in this project are compressed

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.

externalUrlstring

URL pointing to an external URL defining the asset

animationUrlstring

URL pointing to the asset's animation.

attributesobject

Key-value pairs of your NFT attributes

Example response

{
  "mintAddress": "dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt",
  "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",
  "externalUrl": "https://app.underdogprotocol.com",
  "animationUrl": "https://i.imgur.com/mGfz7Ig.mp4",
  "attributes": {
    "points": 10,
    "name": "LeBron"
  },
  "nfts": {
    "results": [
      {
        "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"
      }
    ],
    "page": 1,
    "limit": 10,
    "totalPages": 1,
    "totalResults": 1
  }
}