Create a Project

Create a Project

This endpoint allows you to create a new Project.

post

/v2/projects

Authorizations

Body

namestringrequired

Name stored as on-chain metadata

Example: NFT #1

symbolstring

Symbol stored as on-chain metadata

Example: NFT

descriptionstring

Description stored in the metadata

Example: This is my first NFT

imagestringrequired

Image URL for your NFT

Example: https://example.com/image.png

transferablebooleanrequired

Whether or not the NFTs in this project can be transferred

animationUrlstring

Animation URL for your NFT

Example: https://example.com/animation.mp4

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.underdogprotocol.com/v2/projects' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "NFT #1",
    "symbol": "NFT",
    "description": "This is my first NFT",
    "image": "https://example.com/image.png",
    "transferable": true,
    "animationUrl": "https://example.com/animation.mp4"
  }'

202

401

403

404

202

{
  "transactionId": "text",
  "projectId": 1,
  "transferable": true,
  "mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp"
}

Example

cURL

curl --location --request POST 'https://dev.underdogprotocol.com/v2/projects' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Project #420",
    "image": "https://hatrabbits.com/wp-content/uploads/2017/01/random-word-1.jpg",
    "transferable": false
}'

JavaScript

const axios = require('axios');
let data = JSON.stringify({
  "name": "Project #420",
  "image": "https://hatrabbits.com/wp-content/uploads/2017/01/random-word-1.jpg",
  "transferable": false
});

let config = {
  method: 'post',
  url: 'https://dev.underdogprotocol.com/v2/projects',
  headers: { 
    'Authorization': 'Bearer {token}', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

{
    "projectId": 4,
    "transferable": false,
    "transactionId": "f6818014-838c-45db-bf9e-70a55ffb14d6",
    "mintAddress": "7eq4L3mxaaZxLw5JGP2dDtoYA71vPoRvszSUYSbqxGgF"
}