List all NFTs

List all NFTs

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

get

/v1/nfts

Authorizations

Query parameters

collectionAddressstring

Base-58 encoded string representing an on-chain address

Example: EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp

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

ownerAddressstring

Base-58 encoded string representing an on-chain address

Example: EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

403

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 NFTs

Example

cURL

curl "https://api.underdogprotocol.com/v1/nfts?limit=2" \
        -H "Authorization: Bearer {token}"

JavaScript

import axios from 'axios';

const getNfts = async () => {
  try {
    const response = await axios.get('https://api.underdogprotocol.com/v1/nfts', {
      params: {
        limit: 2
      },
      headers: {
        'Authorization': `Bearer ${token}`
      }
    });

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

Response

{
  "results": [
    {
      "mintAddress": "FrvZAJ1qZ2vhV17nFdEmw66N3FW5QiHFt6HdqsEh8QNq",
      ...
    },
    {
      "mintAddress": "7eYfyPfnGzxp8A9TrQJEpKwVCC8nP9viHRRGJ89WzFJB",
      ...
    },
    {
      "mintAddress": "61YbMJWQbboN3PUQen9MrxF53eMkGcnhEVrkX24TcTqK",
      ...    
    }
  ],
  "limit": 3,
  "page": 1,
  "totalPages": 3,
  "totalResults": 8
}