NFTs API Documentation

Verify and Categorize NFTs

URL: /api/nft/verify

Method: POST

Body:

    {
        "wallet_address": "string"
    }
            

Responses:

    {
        "status": "success",
        "ordinal-nfts": [...]
    }
                

    {
        "error": "No NFTs found for this wallet address"
    }
                

    {
        "error": "An error occurred while verifying NFTs"
    }
                

Verify and Categorize Bitminer NFTs

URL: /api/nft/bitminer/verify

Method: POST

Body:

    {
        "wallet_address": "string"
    }
            

Responses:

    {
        "status": "success",
        "ordinal-nfts": {
            name: string;
            type: string;
            count: number;
            inscriptionIds: string[];
          }[]
    }
                

    {
        "error": "No NFTs found for this wallet address"
    }
                

    {
        "error": "An error occurred while verifying NFTs"
    }
                

Create Supported NFT

URL: /api/nft/create/supportednft

Method: POST

Body:

    {
        "type": "string",
        "name": "string"
    }
            

Responses:

    {
        "status": "success",
        "nft": {
            "id": "string",
            "type": "string",
            "name": "string",
            "creatorId": "string"
        }
    }
                

    {
        "error": "NFT with the same name already exists"
    }
                

    {
        "error": "An error occurred while creating the SupportedNFT"
    }
                

Create Inscription ID

URL: /api/nft/create/inscriptions

Method: POST

Body:

    {
        "supportedNFTId": "string",
        "txtfile": "file"
    }
            

Responses:

    {
        "status": "success",
        "message": "Inscription IDs created successfully",
        "createdCount": "number"
    }
                

    {
        "error": "Invalid supportedNFTId"
    }
                

    {
        "error": "An error occurred while creating the InscriptionID or Unique Constraint Violation, Please check the file for duplicates"
    }
                

Create NFT Type

URL: /api/nft/create/withoutname/nfttype

Method: POST

Body:

    {
        "type": "string"
    }
            

Responses:

    {
        "status": "success",
        "nftType": {
            "id": "string",
            "type": "string"
        }
    }
                

    {
        "error": "NFTType already exists"
    }
                

    {
        "error": "An error occurred while creating the NFTType"
    }
                

View All NFT Types

URL: /api/nft/view/all/nfttypes

Method: GET

Responses:

    {
        "status": "success",
        "nftTypes": [...]
    }
                

    {
        "error": "An error occurred while viewing the NFTTypes"
    }