List all NFTs

List all NFTs

get

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

collectionAddressstringOptional

Base-58 encoded string representing an on-chain address

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

ownerAddressstringOptional

Base-58 encoded string representing an on-chain address

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

Responses

200

Returns a paginated list of NFTs

application/json

403

Forbidden

application/json

get

/v1/nfts

HTTPcURLJavaScriptPython

GET /v1/nfts HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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/nfts?limit=2" \
        -H "Authorization: Bearer {token}"

JavaScript

Response

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