POST
/
api
/
v1
/
erc721
/
create
curl --location --request POST 'https://groupos.xyz/api/v1/erc721/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "chainId": 5,
    "name": "Zed Horse",
    "symbol": "ZED"
}'
{
  "success": true,
  "transactionHash": "0x58c789b7a59312ec0a659e165700db54af896d3e8b46e4aeecb33b32b88157c9",
  "transactionUrl": "https://goerli.etherscan.io/tx/0xef737091d8c3451b42659688abd86b51516a6b43ee7dbdbda53c9005d86167db",
  "token": {
    "contractAddress": "0x67F4732266C7300cca593C814d46bee72e40659F",
    "name": "Zed Horse",
    "symbol": "ZED",
    "transferable": true
  }
}

How NFT creation works

NFTs are represented on the blockchain through a smart contract that manages the accounting of who owns which NFT. To create a new NFT collection, we create a new smart contract designed to manage it and then are able to populate it with the actual tokens. The smart contract is analogous to a spreadsheet, it is the home that defines the structure and content of the records.

This API route will take in parameters for creating a new NFT collection and return an address where this new smart contract is deployed. This contract address uniquely identifies your NFT collection and will be used in other API routes.

Body

chainId
number
required

The id of the chain supporting the NFT. This cannot be changed after creation.

name
string
required

The name of the collection. This cannot be changed after creation.

symbol
string
required

The symbol of the collection. This cannot be changed after creation.

transferable
boolean
default: "true"

true if tokens are freely transferable by recipients, false if tokens cannot be transfered by owners to other addresses. This does not impact the ability to mint tokens to an address or burn tokens from an address. This can be changed after creation.

defaultMetadata
object

Default metadata to apply to every NFT in the collection, which can be overriden with token-specific metadata. This can be changed after creation.

Response

success
boolean

Indicates whether the call was successful.

transactionHash
string

Transaction hash for the newly created token collection.

transactionUrl
string

Wraps transactionHash with the appropriate network-specific URL for convenience.

token
object

The newly created token smart contract.