---
agentTools:
  projectIndex: https://thenftbrewery.readme.io/llms.txt
---

# Royalty check

This API is used to check whether a wallet address is excluded from royalty for a given NFT.<br/><br/><b>Required Parameters</b> :- <br/><br/> <b>tokenId</b> - </b>The unique identifier of the NFT. <br/><br><b>address - </b>The address of owner, royalty was set for.<br><br/><b>smart contract type</b><br> 0 for ERC 721 <br> 1 for ERC1155<br><br><b>blockchainType</b> - Blockchain network to be used: <br> <br> 0 for Ethereum and <br> 1 for Polygon <br><br> <b>networkType</b> - network type for the specified blockchain:<br> <br> For BlockchainType Ethereum:  <br><br> 0 for Ethereum Mainnet <br> 1 for Ropsten Testnet <br> 2 for Rinkeby Testnet <br><br> For BlockchainType Polygon: <br><br> 0 for Polygon Mainnet <br> 1 for Polygon Mumbai <br> <br/><b>smartContractSymbol</b> - The symbol of the smart contract.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "NFTB APIs",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "https://dev.api.thenftbrewery.com"
    }
  ],
  "components": {
    "schemas": {
      "nftRoyalityCredit": {
        "type": "object",
        "properties": {
          "tokenId": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "smartContractType": {
            "type": "integer"
          },
          "blockchainType": {
            "type": "integer"
          },
          "networkType": {
            "type": "integer"
          },
          "smartContractSymbol": {
            "type": "string"
          }
        }
      }
    }
  },
  "paths": {
    "/api/v1/royalty/isExcludedRoyalty": {
      "post": {
        "summary": "Royalty check",
        "tags": [
          "Royalty APIs"
        ],
        "description": "This API is used to check whether a wallet address is excluded from royalty for a given NFT.<br/><br/><b>Required Parameters</b> :- <br/><br/> <b>tokenId</b> - </b>The unique identifier of the NFT. <br/><br><b>address - </b>The address of owner, royalty was set for.<br><br/><b>smart contract type</b><br> 0 for ERC 721 <br> 1 for ERC1155<br><br><b>blockchainType</b> - Blockchain network to be used: <br> <br> 0 for Ethereum and <br> 1 for Polygon <br><br> <b>networkType</b> - network type for the specified blockchain:<br> <br> For BlockchainType Ethereum:  <br><br> 0 for Ethereum Mainnet <br> 1 for Ropsten Testnet <br> 2 for Rinkeby Testnet <br><br> For BlockchainType Polygon: <br><br> 0 for Polygon Mainnet <br> 1 for Polygon Mumbai <br> <br/><b>smartContractSymbol</b> - The symbol of the smart contract.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/nftRoyalityCredit"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "success"
          },
          "400": {
            "description": "Bad Request Errors"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 98,
      "1": 154,
      "2": 22,
      "3": 185,
      "4": 157,
      "5": 178,
      "6": 247,
      "7": 0,
      "8": 49,
      "9": 249,
      "10": 105,
      "11": 121
    }
  }
}
```