Retrive Deployed Collection Details
The /setupLaunch API is a crucial endpoint that allows the configuration of launch parameters for a specific NFT collection. By providing the necessary request parameters, the API enables the setup of important details such as pricing, sale start times, and whitelisting for the presale phase. These parameters play a significant role in determining the success and functionality of the NFTGenesis.
Authentication
All requests to our GET 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 NFT Minting API is:
POST /collections/setupLaunch
Request Headers
The following request header is required to use the NFT Minting API:
Authorization
- Your API key
Retrive all minted NFTs
POST /collections/setupLaunch
Content-Type: application/json
Query Parameters
The following query parameters can be used to filter the API results:
Here is the explanation of the parameters you mentioned:
-
contractAddress
: The address of the NFT collection contract. -
publicMintPrice_
: The price for public minting of the NFTs. -
presaleMintPrice_
: The price for minting NFTs during the presale phase. -
presaleStartTime_
: The start time of the presale phase in UTC format. -
publicSaleStartTime_
: The start time of the public sale phase in UTC format. -
presaleWhitelistMerkelTreeRoot_
: The root hash of the Merkle tree containing addresses whitelisted for the presale.
Note: Multiple query parameters can be combined to further refine the results.
Example Request
POST /setupLaunch
Content-Type: application/json
{
"contractAddress": "0x123abc",
"publicMintPrice_": 0.1,
"presaleMintPrice_": 0.05,
"presaleStartTime_": "2023-06-01T12:00:00Z",
"publicSaleStartTime_": "2023-06-10T12:00:00Z",
"presaleWhitelistMerkelTreeRoot_": "0x456def"
}
Response
The API will respond with a JSON object containing the following information:
launchDetails
: The information or details related to the launch of the NFT collection.
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"launchDetails": {
"contractAddress": "0x123abc",
"publicMintPrice_": 0.1,
"presaleMintPrice_": 0.05,
"presaleStartTime_": "2023-06-01T12:00:00Z",
"publicSaleStartTime_": "2023-06-10T12:00:00Z",
"presaleWhitelistMerkelTreeRoot_": "0x456def"
}
}
Error Responses
In case of an error, the API will respond with a JSON object containing an error message:
{
"error": "Error message"
}
Conclusion
The /setupLaunch API is a vital component of the process, allowing for the proper configuration of launch parameters. By providing the necessary request parameters, businesses or developers can define crucial details such as pricing, sale start times, and presale whitelisting. This API streamlines the process of setting up the launch, ensuring that all necessary parameters are accurately defined.
With the flexibility offered by the /setupLaunch API, businesses and developers can easily adapt the launch parameters to meet their specific requirements. By customizing these parameters, they can optimize the launch strategy and create a successful NFT collection.