Retrieve a Collection

Retrieve a Collection

get

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

collectionAddressstringRequired

Mint address for the NFT Collection

Query parameters

pagenumber | nullableOptional

limitnumber | nullableOptional

Responses

200

Returns a Collection with a paginated list of NFTs

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/v1/collections/:collectionAddress

HTTPcURLJavaScriptPython

GET /v1/collections/:collectionAddress 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",
  "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": 1,
        "projectId": 1,
        "transferable": true,
        "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

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
  }
}