v1

latestOpenAPI 3.0.02026-07-146561171.4 KB

Projects

Retrieve a Project

This endpoint allows you to retrieve a Project by providing the Project ID.

get/v2/projects/{projectId}

Path parameters

projectIdinteger required

Query parameters

pagenumber nullable

Page number

limitnumber nullable

Items per page

sortBystring

order'asc' | 'desc'

Response

Returns a Project with a paginated list of NFTs

idinteger required

mintAddressstring required

Base-58 encoded string representing an on-chain address

semifungibleboolean

Whether or not the NFTs in this project are semifungible

transferableboolean

Whether or not the NFTs in this project can be transferred

compressedboolean

Whether or not the NFTs in this project are compressed

coreboolean

Whether or not the NFTs in this project use mpl-core standard

statusstring required

sellerFeeBasisPointsinteger required

Creator royalties in basis points - 100 basis points = 1%

namestring required

Name stored as on-chain metadata

symbolstring

Symbol stored as on-chain metadata

descriptionstring

Description stored in the metadata

imagestring required

Image for your NFT. When creating an NFT, this can be a base64 encoded string or a URL pointing to an image.

animationUrlstring

URL pointing to the asset's animation.

externalUrlstring

URL pointing to an external URL defining the asset

attributesobject

Key-value pairs of your NFT attributes

Example response

{
  "mintAddress": "dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt",
  "sellerFeeBasisPoints": 100,
  "name": "Underdog NFT",
  "symbol": "UPDG",
  "description": "I minted this NFT with the Underdog API",
  "image": "https://hatrabbits.com/wp-content/uploads/2017/01/random.jpg",
  "animationUrl": "https://i.imgur.com/mGfz7Ig.mp4",
  "externalUrl": "https://app.underdogprotocol.com",
  "attributes": {
    "points": 10,
    "name": "LeBron"
  },
  "nfts": {
    "results": [
      {
        "name": "Underdog NFT",
        "symbol": "UPDG",
        "description": "I minted this NFT with the Underdog API",
        "image": "https://hatrabbits.com/wp-content/uploads/2017/01/random.jpg",
        "animationUrl": "https://i.imgur.com/mGfz7Ig.mp4",
        "externalUrl": "https://app.underdogprotocol.com",
        "attributes": {
          "points": 10,
          "name": "LeBron"
        },
        "mintAddress": "dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt",
        "ownerAddress": "dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt",
        "claimerAddress": "dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt"
      }
    ],
    "page": 1,
    "limit": 10,
    "totalPages": 1,
    "totalResults": 1
  }
}