v1

latestOpenAPI 3.0.02026-07-146561171.4 KB

Projects

Create a Project

This endpoint allows you to create a new Project.

post/v2/projects

Request body

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.

semifungibleboolean

Whether or not the NFTs in this project are semifungible

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

coreboolean

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

sellerFeeBasisPointsinteger

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

Example request

{
  "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"
  },
  "sellerFeeBasisPoints": 100
}

Response

Successful response

projectIdinteger required

transactionIdstring uuid required

mintAddressstring

Base-58 encoded string representing an on-chain address

Example response

{
  "mintAddress": "dustFPTV7dujoJjgkKtf6is3bYaFEy1nswS23vxHfvt"
}