List all Collections

List all Collections

This endpoint allows you to retrieve a paginated list of all your Collections. By default, a maximum of ten Collections are shown per page.

get

/v1/collections

Authorizations

Query parameters

pagenumber | nullable

limitnumber | nullable

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.underdogprotocol.com/v1/collections' \
  --header 'Authorization: Bearer JWT'

200

401

200

{
  "page": 1,
  "limit": 10,
  "totalPages": 1,
  "totalResults": 1,
  "results": [
    {
      "name": "NFT #1",
      "symbol": "NFT",
      "description": "This is my first NFT",
      "image": "https://example.com/image.png",
      "animationUrl": "https://example.com/animation.mp4",
      "id": 1,
      "projectId": 1,
      "transferable": true,
      "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
      "ownerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
      "claimerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
      "status": "text",
      "attributes": {
        "Points": "40000",
        "Nickname": "LeGoat"
      }
    }
  ]
}

Returns a paginated list of Collections

Example

cURL

curl "https://api.underdogprotocol.com/v1/collections?limit=1&page=1" \
        -H "Authorization: Bearer {token}"

JavaScript

import axios from 'axios';

const getCollections = () => {
  try {
    const response = await axios.get('https://api.underdogprotocol.com/v1/collections', {
      params: {
        limit: 1,
        page: 1
      },
      headers: {
        'Authorization': `Bearer ${token}`
      }
    });

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

Response

{
    "results":[{
        "mintAddress":"FrvZAJ1qZ2vhV17nFdEmw66N3FW5QiHFt6HdqsEh8QNq",
        "name":"NBA",
        "description":"",
        "image":"https://arweave.net/57PrJ_-S-m2BXOSkaUN2t5ibsjbSrCjElSVUQXXyCq0",
        "attributes":[],
        "uri":"https://arweave.net/DnftYIM2sNZQBXm7qzRiFoUP0S7QtN4q_GkmIcv1UJ8",
        "collectionDetails":{},
        "ownerAddress":"EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp"
    }],
    "page": 1,
    "limit": 1,
    "totalPages": 2,
    "totalResults": 2
}