Minting
Apart from the web interface, edeXa's blockchain minting functionality is also accessible through an API. To gain access, please create an account.
tip
MAINNET BASEURL
https://api-edexagw.edexa.com/bnft
TESTNET BASEURL
https://api-edexagw.io-world.com/bnft
Get Category List
GET category-list
- To retrieve the category list, you must pass your
Bearer Token
via the Authorization header.
GET: Category Listing
cURL
curl --location --request GET 'https://api-edexagw.io-world.com/bnft/category-list' \
--header 'Authorization: Bearer token'
Responses
200: Success
{
"status": 200,
"message": "Category fetched successfully",
"count": 5,
"data": [
{
"_id": "623d6********",
"name": "Custom"
},
{
"_id": "6214a********",
"name": "Cards"
},
{
"_id": "6214ac********",
"name": "Music"
},
{
"_id": "6214ac34******",
"name": "Art"
},
{
"_id": "629f4********",
"name": "Utility"
}
]
}
400: Token not passed in headers
{
"status": 400,
"message": "Authorization Token Not Found"
}
401: Token passed in headers is not valid
{
"status": 401,
"message": "Invalid auth token"
}
500: Some technical issue occured
{
"status": 500,
"message": "Something went wrong, please try again"
}
Mint NFT
POST mint-nft
- To mint an NFT, you need to pass your
Bearer Token
via the Authorization header. - Fields marked with
*
are required. category
*: The category to which your NFT belongs. You can get theid
from the Category List API.fileType
*: The type of attachment you want to mint.walletAddress
*: The wallet address where you want to mint the NFT.attributes
: The attributes of the NFT in key-value pairs, e.g.,[{"trait_type":"edeXa","value":"Blockchain"}]
Mint NFT
cURL
curl --location --request POST 'https://api-edexagw.io-world.com/bnft/mint-nft' \
--header 'Content-Type: multipart/form-data' \
--header 'Authorization: Bearer token' \
--form 'walletAddress="WALLET_ADDRESS"' \
--form 'description="DESCRIPTION"' \
--form 'title="TITLE"' \
--form 'attributes="ATTRIBUTES"' \
--form 'fileType="FILE_TYPE"' \
--form 'tags="TAGS"' \
--form 'attachments=@"IMAGE_PATH"' \
--form 'category="CATEGORY_ID"'
Parameters
Key | Value | Type | Description |
---|---|---|---|
walletAddress | `0x5*********` | String | Wallet address to mint NFT |
description | `NFT : An digital assest` | String | Description of the NFT |
title | `NFT` | String | Title of your NFT |
attributes | Array | Attributes in key-value pairs | |
fileType* | `image` | File | Type of attachment |
tags | `edeXa` | String | Tags related to your NFT |
attachments | `image.png` | Image | Attach the file you want to mint as an NFT |
category* | `67809*****************` | String | The `_id` or `id` of the Category |
Responses
200: Success
{
"status": 200,
"message": "NFT minting process start successfully"
}
400: Token not passed in headers
{
"status": 400,
"message": "Authorization Token Not Found"
}
401: Token passed in headers is not valid
{
"status": 401,
"message": "Invalid auth token"
}
404: User Not found
{
"status": 404,
"message": "User Not Found"
}
404: Category Not found
{
"status": 404,
"message": "Category Not Found"
}
500: Some technical issue occured
{
"status": 500,
"message": "Something went wrong, please try again"
}
Get NFT List
GET nft
- To retrieve the list of NFTs, you need to pass your
Bearer Token
via the Authorization header.
NFT List
cURL
curl --location --request GET 'https://api-edexagw.io-world.com/bnft/nft' \
--header 'Authorization: Bearer token'
Responses
200: Success
{
"status": 200,
"message": "NFT fetched successfully",
"data": {
"count": 1,
"nft": [
{
"_id": "62a19ce0********",
"ownBy": "0x5f045CAC8d********",
"title": "Custom NFT",
"description": "Custom NFT",
"txUrl": "https://********.******.********/tx/0xf85**********",
"visibility": 0,
"nftId": 1,
"tags": [],
"attributes": [
{ "trait_type": "a", "value": "a" },
{ "trait_type": "b", "value": "b" },
{ "trait_type": "c", "value": "c" }
],
"createdBy": "62a198be0******",
"ipfsFileHash": "QmTki******",
"ipfsJsonHash": "Qmc******",
"filePath": "bnft/**********.jpg",
"fileThumbPath": "bnft/**********.jpg",
"createdAt": "2022-06-09T07:10:24.888Z",
"gateway": 2,
"tokenId": 126,
"owner": "ffded**********"
}
]
}
}
400: Token not passed in headers
{
"status": 400,
"message": "Authorization Token Not Found"
}
401: Token passed in headers is not valid
{
"status": 401,
"message": "Invalid auth token"
}
500: Some technical issue occured
{
"status": 500,
"message": "Something went wrong, please try again"
}
Get NFT Details
GET nft?id=id
- To retrieve the details of a specific NFT, you need to pass your
Bearer Token
via the Authorization header and provide theid
query parameter. - In order to get
_id
orid
of NFT, use NFT List api.
NFT Details
cURL
curl --location --request GET 'https://api-edexagw.io-world.com/bnft/nft?id=641**********' \
--header 'Authorization: Bearer token'
Parameters
Key | Value | Type | Description |
---|---|---|---|
id* | `67809********************8` | String | The `_id` or `id` of the NFT |
Responses
200: Success
{
"status": 200,
"message": "NFT fetched successfully",
"data": {
"ownBy": "0x5f0********",
"title": "Custom NFT",
"description": "Custom NFT",
"txUrl": "https://***.********.********/tx/0xe01**************",
"price": 0,
"visibility": 0,
"nftId": 1,
"tags": [],
"attributes": [
{ "trait_type": "x", "value": "x" },
{ "trait_type": "y", "value": "y" },
{ "trait_type": "z", "value": "z" }
],
"status": 2,
"_id": "62a19ce0********",
"createdBy": "641********",
"ipfsFileHash": "QmTKi****************",
"ipfsJsonHash": "QmTk2****************",
"filePath": "bnft/**********.jpg",
"fileThumbPath": "bnft/**********.jpg",
"compressedFilePath": "bnft/**********.jpg",
"categoryId": "",
"fileMimeType": "image/jpeg",
"createdAt": "2022-03-09T07:10:24.888Z",
"updatedAt": "2022-03-09T07:10:24.888Z",
"gateway": 2,
"tokenId": 126,
"id": "62a19ce0********"
}
}
400: Token not passed in headers
{
"status": 400,
"message": "Authorization Token Not Found"
}
401: Token passed in headers is not valid
{
"status": 401,
"message": "Invalid auth token"
}
404: NFT not found
{
"status": 404,
"message": "NFT Not Found"
}
500: Some technical issue occured
{
"status": 500,
"message": "Something went wrong, please try again"
}