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
  • The Project Model
  • Project Types
  • Transferable Projects t
  • Non-Transferable Projects n
  • NFTs
  1. Resources

Projects

Projects are the containers for NFTs shared with you, your community, and your product.

PreviousArchitectureNextTransferable Projects

Last updated 2 years ago

On this page, we'll dive into the different Project endpoints you can use to manage Projects programmatically.

Projects represent a group of related . A Project is itself an NFT. For example, a Project can be a group of NFTs where each NFT is a membership pass.

There are two types of Projects:

We'll walk through the different Project types and how the NFTs in each Project type are different.

The Project Model

The Project model contains all the information about your Project, such as its mint address, name, and image.

Property
Description
Type

id

Unique ID for a Project

number

transferable

Whether or not the NFTs in this project can be transferred

boolean

mintAddress

Address for the Project's mint account

string

status

Whether your Project has been confirmed on-chain

string

name

Name stored as on-chain metadata

string

image

URL pointing to the image for your Project

string

description

Description stored in the metadata for your Project

string

Project Types

The Underdog API supports two types of Projects that affect how the NFTs in the Project are minted and the transferability of the NFTs in the Project.

Project Type
Project Path Param

Transferable Project

t

Non-Transferable Project

n

Transferable Projects t

NFTs in a Transferable Project are minted directly to a wallet and can be transfered freely the the owner of the NFT.

Non-Transferable Projects n

NFTs in a Non-Transferable Project are lazily minted. Only when the NFT is claimed is it minted and the claimer cannot transfer the NFT.

NFTs

The Projects endpoint includes endpoints to create, update, and manage the Project's NFTs.

The :transferable param is set to either t for a Transferable Project or n for a Non-Transferable Project. The :projectId param is set to the Project's ID.

NFTs
Transferable Projects
Non-Transferable Projects
Transferable Projects
Non-Transferable Projects
NFTs