Read an NFT Collection

You can read the details of an NFT collection by sending a GET request to the /nft/<nft_collection_name> endpoint.

Reads the details for an NFT collection.

GET https://api.playfix.io/nft/<nft_collection_name>

Path Parameters

Name	Type	Description
nft_collection_name*	String	A unique name of the NFT collection, automatically generated by Playfix. It begins with "nfts/" followed by a ULID.

Headers

Name	Type	Description
Authorization*	String	Bearer <your_access_token>

200: OK Successfully read the NFT collection details.

{
  "name": "<nft_collection_name>",
  "project": "<project_name>",
  "standard": "NFT_STANDARD_UNSPECIFIED",
  "title": "Carz",
  "description": "NFT Car Collection",
  "itemCount": "0",
  "imageCoverUrl": "https://ipfs-gateway.playfix.io/ipfs/QmbAVZQhTmRwy57pr4NWuDMhxAC9yzU21GtaGP1f6bay8W",
  "imageCoverCid": "QmbAVZQhTmRwy57pr4NWuDMhxAC9yzU21GtaGP1f6bay8W",
  "config": {
    "name": "Carz",
    "symbol": "CRS",
    "itemPrice": 0.01,
    "baseUri": "",
    "burnable": true,
    "pausable": true,
    "ownerAddress": "<your_wallet_address>"
    },
  "network": "NETWORK_POLYGON_MUMBAI",
  "contractAddress" : "",
  "deployTxHash": ""
}

Example Curl API Call

curl --request GET \
  --url https://api.playfix.io/nft/<nft_collection_name> \
  --header 'Authorization: Bearer <your_access_token>'

Example Python API Call

import requests

r = requests.get(
    "https://api.playfix.io/nft/<nft_collection_name>",
    headers = {
        "Authorization": "Bearer <your_access_token>"
        }
    )

print(r.text)

Replace <nft_collection_name> with the value of name from the NFT collection you've created earlier.

Response Body

{
  "name": "<nft_collection_name>",
  "project": "<project_name>",
  "standard": "NFT_STANDARD_UNSPECIFIED",
  "title": "Carz",
  "description": "NFT Car Collection",
  "itemCount": "0",
  "imageCoverUrl": "https://ipfs-gateway.playfix.io/ipfs/QmbAVZQhTmRwy57pr4NWuDMhxAC9yzU21GtaGP1f6bay8W",
  "imageCoverCid": "QmbAVZQhTmRwy57pr4NWuDMhxAC9yzU21GtaGP1f6bay8W",
  "config": {
    "name": "Carz",
    "symbol": "CRS",
    "itemPrice": 0.01,
    "baseUri": "",
    "burnable": true,
    "pausable": true,
    "ownerAddress": "<your_wallet_address>"
    },
  "network": "NETWORK_POLYGON_MUMBAI",
  "contractAddress" : "",
  "deployTxHash": ""
}

The response fields are the same as in the NFT collection creation process.