Nft
Create an NFT with pinned file and metadata
The metadata JSON file will look like this:
{
"name": "My Awesome NFT",
"description": "This is an NFT that represents my creativity as a digital artist!",
"properties": [
{
"trait_type": "Color",
"value": "Red"
},
{
"trait_type": "Rarity",
"value": "Medium"
}
]
}POSThttps://api.w3ipfs.aioz.network/api/nft/
Query
cid asset cid
Headers
pinning_api_key* PINNING-API-KEY
pinning_secret_key* PINNING-SECRET-KEY
Body
file* Read stream representing the file
metadata Optional stringified object
Response
201: Created
curl --location --request POST 'https://api.w3ipfs.aioz.network/api/nft/' \
--header 'pinning_api_key: KEY' \
--header 'pinning_secret_key: SECRET' \
--form 'metadata=@"/sample.json"' \
--form 'file=@"/test.png"'Retrieve an nft by its ID
GEThttps://api.w3ipfs.aioz.network/api/nft/:nftId
Parameters
nftId* nftId
Headers
pinning_api_key* PINNING-API-KEY
pinning_secret_key* PINNING-SECRET-KEY
Response
200: OK
curl --location --request GET 'https://api.w3ipfs.aioz.network/api/nft/f0cda369-2846-414d-8e8d-8c0394113bef' \
--header 'pinning_api_key: KEY' \
--header 'pinning_secret_key: SECRET'Retrieve nfts associated with a user ID
GEThttps://api.w3ipfs.aioz.network/api/nft/nfts/
Query
offset (default 0)
limit (default 10)
pinned Filter by pinned status (options: all, true, false) (default all)
sortBy Field to sort by (options: created_at, size, name). Defaults to created_at
sortOrder Sort direction (options: ASC, DESC). Defaults to DESC
Headers
pinning_api_key* PINNING-API-KEY
pinning_secret_key* PINNING-SECRET-KEY
Response
200: OK
curl --location --request GET 'https://api.w3ipfs.aioz.network/api/nft/nfts/?offset=0&limit=10&pinned=true&sortBy=name&sortOrder=ASC' \
--header 'pinning_api_key: KEY' \
--header 'pinning_secret_key: SECRET'