Underdog Protocol
  • API Documentation
  • Quickstart
  • Guides
    • Postman
    • Endpoints
    • Authentication
    • Pagination
    • Errors
    • Webhooks
    • Architecture
  • Resources
    • Projects
      • Transferable Projects
      • Non-Transferable Projects
      • NFTs
        • List all NFTs
        • Search NFTs
        • Create an NFT
        • Retrieve an NFT
        • Update an NFT
        • Generate Claim Link
        • Revoke an NFT
        • Burn an NFT
      • Methods
        • List all Projects
        • Create a Project
        • Retrieve a Project
        • Update a Project
        • Retrieve Project Stats
    • NFTs
      • Retrieve an NFT
      • Generate Claim Transaction
    • Orgs
      • List all Orgs
    • Transactions
      • List all Transactions
      • Retrieve a Transaction
    • Webhooks
      • List all Webhooks
      • Create a Webhook
      • Delete a Webhook
    • V1
      • Collections
        • List all Collections
        • Create a Collection
        • Retrieve a Collection
      • NFTs
        • List all NFTs
        • Create an NFT
        • Retrieve an NFT
        • Update an NFT
      • Managed NFTs
        • Claim
        • Revoke
  • Examples
    • Zapier Integrations
      • Zapier + Viral Loops
      • Zapier + Github + OpenAI
      • Zapier + Github
      • Zapier + Mailchimp
      • Zapier + Shopify
      • Zapier + Calendly
      • Zapier + Hubspot
      • Zapier + Typeform
    • Underdog with Airtable
      • Create a Project
      • Create NFT on Form Submission
      • Send a Claim Link
      • Updating NFTs
    • Web3 Blog
    • Mint NFTs on iPhone
  • Use Cases
    • Solana Mobile
    • Parcl
Powered by GitBook
On this page
  1. Resources
  2. V1
  3. NFTs

List all NFTs

PreviousNFTsNextCreate an NFT

Last updated 2 years ago

Example

curl "https://api.underdogprotocol.com/v1/nfts?limit=2" \
        -H "Authorization: Bearer {token}"
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
}

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
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
GET /v1/nfts HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer JWT
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
}
  • GETList all NFTs
  • Example