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. Projects
  3. Methods

Retrieve a Project

PreviousCreate a ProjectNextUpdate a Project

Last updated 2 years ago

Example

curl --location --request GET 'https://dev.underdogprotocol.com/v2/projects/n/4' \
--header 'Authorization: Bearer {token}'
const axios = require('axios');

let config = {
  method: 'get',
  url: 'https://dev.underdogprotocol.com/v2/projects/n/4',
  headers: { 
    'Authorization': 'Bearer d098077945e454.c76459c2fa07476788b3cbf7d60273fd'
  }
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
Response
{
    "id": 4,
    "transferable": false,
    "status": "confirmed",
    "mintAddress": "7eq4L3mxaaZxLw5JGP2dDtoYA71vPoRvszSUYSbqxGgF",
    "ownerAddress": "3ZBGxWRQdKTaXRcyLapMn1LaSU5TbKnBKJ6m2jBERKAp",
    "name": "Project #420",
    "image": "https://underdog-test-bucket-dev.s3.amazonaws.com/7eq4L3mxaaZxLw5JGP2dDtoYA71vPoRvszSUYSbqxGgF/image.png",
    "nfts": {
        "results": [],
        "page": 1,
        "limit": 10,
        "totalPages": 0,
        "totalResults": 0
    }
}

Retrieve a Project

get

This endpoint allows you to retrieve a Project by providing the Project type (n or t) and Project ID.

Authorizations
Path parameters
transferablestringRequired

Value must be either 't' for transferable or 'n' for non-transferable

projectIdintegerRequired
Query parameters
pagenumber | nullableOptional
limitnumber | nullableOptional
sortBystringOptional
orderBystring ยท enumOptionalPossible values:
Responses
200
Returns a Project with a paginated list of NFTs
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
get
GET /v2/projects/:transferable/:projectId HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer JWT
Accept: */*
{
  "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,
  "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
  "transferable": true,
  "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
  }
}
  • GETRetrieve a Project
  • Example