Deploy Collection
The /collections/deploy
API is used to deploy a new collection of NFTs. This endpoint requires the following request parameters and provides the corresponding response.
Authentication
All requests to our API require authentication. You will need to include your API key in the header of each request. You can find your API key in the "API Keys" section of your dashboard.
Endpoint
The endpoint for the Deploy Collection API is:
POST /collectionsa/deploy
Request Headers
The following request header is required to use the Deploy Collection API:
Authorization
- Your API key
Request Parameters
The following request parameters are required for the Deploy Collection API:
-
name
: The name of the NFT collection. -
symbol
: The symbol or ticker of the NFT collection. -
maxSupply
: The maximum supply or number of NFTs that can be minted for the coll -
teamReserve
: The address where a portion of the NFTs will be reserved for the team. -
ownerAddress
: The address of the current owner of the NFT collection.
Example Request
POST /nft/deploy
Content-Type: application/json
{
"name": "My NFT Collection",
"symbol": "MYNFT",
"maxSupply": 1000,
"teamReserve": "0x123abc",
"ownerAddress": "0x456def"
}
Response
The API will respond with a JSON object containing the following information:
collectionAddress
: The address of the deployed NFT collection contract.
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"collectionAddress": "0x789xyz"
}
Error Responses
In case of an error, the API will respond with a JSON object containing an error message:
{
"error": "Error message"
}
Conclusion
The Deploy Collection API simplifies the process of deploying a new collection of NFTs. By providing the necessary request parameters such as the collection name, symbol, maximum supply, team reserve address, and owner address, businesses or developers can easily create and manage their own NFT collections. The response containing the collection address allows for easy identification and interaction with the deployed NFT collection contract.
By incorporating the Deploy Collection API into their applications or platforms, businesses can seamlessly integrate NFT collection deployment functionality and empower their users to create and participate in the exciting world of non-fungible