API Reference

Projects

A Project manages a collection of related digital assets

When creating a Project, you create the collection NFT that all the digital assets will belong to. The Project also manages royalties if you intend for your digital assets to be traded on marketplaces.

Projects are uniquely identified by an ID (e.g. 24). When referencing the Project via API endpoints, use the Project ID to manage the Project or digital assets inside that Project.

Project Types

Underdog supports two different types of Projects. All digital assets within the Project are determined by the type of the Project.

StandardDescriptionUse Cases
mpl-bubblegumLeverages state compression for a 100x cost reductionmass airdrops, ticketing, advertising
mpl-coreNext-gen digital asset standard for more control and flexibilitysoulbound NFTs, generative collections, membership badges

Bubblegum

By default, Projects use the mpl-bubblegum standard.

await underdog.post(`/v2/projects`, {
  name: "Underdog Project",
  image: "https://i.imgur.com/jMHjy8x.jpeg",
});

Core

If you would like to create a Core Project with Core NFTs, pass in core: true into the API request body.

await underdog.post(`/v2/projects`, {
  name: "Underdog Project",
  image: "https://i.imgur.com/jMHjy8x.jpeg",
  core: true,
});