---
updatedAt: 2025-06-25T21:54:42.000Z
agentTools:
  projectIndex: https://docs.nftgo.io/llms.txt
---

# Get royalty payers by contract

Retrieve all royalty payers of a specific NFT contract.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "egg-swagger",
    "description": "swagger-ui for egg",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://data-api.nftgo.io"
    }
  ],
  "tags": [
    {
      "name": "Collection",
      "description": ""
    }
  ],
  "paths": {
    "/eth/v1/contract/{contract_address}/royalty-payers": {
      "get": {
        "tags": [
          "Collection"
        ],
        "summary": "Get royalty payers by contract ",
        "description": "Retrieve all royalty payers of a specific NFT contract. ",
        "operationId": "eth_v1_contract_{contract_address}_royalty-payers",
        "parameters": [
          {
            "name": "contract_address",
            "in": "path",
            "description": "Address of the NFT contract ",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d"
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The index of data segments. The returned data is divided into many segments. One segment is returned at a time. {offset} parameter indicates the index of data segments. Default is 0. ",
            "schema": {
              "type": "number"
            },
            "example": 0
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The size of a returned data segment. Default is 20. ",
            "schema": {
              "type": "number"
            },
            "example": 20
          },
          {
            "name": "sort_by",
            "in": "query",
            "description": "Sort By the specified metrics: royalty_expense, outstanding_royalty_expense. Default is royalty_expense. ",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/GetRoyaltyPayersByContractSortByEnum"
                }
              ],
              "description": "An enumeration.",
              "default": "royalty_expense"
            }
          },
          {
            "name": "asc",
            "in": "query",
            "description": "Whether to sort results in ascending order. Default is false. ",
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response ",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetRoyaltyPayersByContractResponse"
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "address_tag": {
        "required": [
          "address",
          "blockchain",
          "is_blue_chip_holder",
          "is_contract",
          "is_multi_sign_wallet",
          "is_super_blue_chip_holder",
          "is_whale"
        ],
        "type": "object",
        "properties": {
          "blockchain": {
            "type": "string",
            "description": "The blockchain symbol"
          },
          "address": {
            "type": "string",
            "description": "The address on the blockchain"
          },
          "ens": {
            "type": "string",
            "description": "Ethereum Name Service"
          },
          "das": {
            "type": "string",
            "description": "Bit domain name"
          },
          "alias": {
            "type": "string",
            "description": "NFTGO alias name"
          },
          "is_whale": {
            "type": "string",
            "description": "Whether the address is a whale"
          },
          "is_contract": {
            "type": "string",
            "description": "Whether the address is a contract address"
          },
          "is_blue_chip_holder": {
            "type": "string",
            "description": "Whether the address is a blue chip holder"
          },
          "is_super_blue_chip_holder": {
            "type": "string",
            "description": "Whether the address is a super blue chip holder"
          },
          "is_multi_sign_wallet": {
            "type": "string",
            "description": "Whether the address is a multi-signature wallet"
          }
        }
      },
      "contract_model": {
        "required": [
          "address",
          "blockchain",
          "name",
          "type"
        ],
        "type": "object",
        "properties": {
          "blockchain": {
            "type": "string",
            "description": "The blockchain of the NFT contract",
            "example": "ETH"
          },
          "address": {
            "type": "string",
            "description": "The contract address of the NFT contract",
            "example": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d"
          },
          "type": {
            "type": "string",
            "description": "Type of contract",
            "example": "ERC721"
          },
          "name": {
            "type": "string",
            "description": "NFT contract name",
            "example": "Bored Ape Yacht Club"
          }
        }
      },
      "collection_model": {
        "required": [
          "categories",
          "collection_id",
          "contracts",
          "description",
          "discord_url",
          "has_rarity",
          "instagram_url",
          "logo",
          "name",
          "official_website_url",
          "opensea_slug",
          "opensea_url",
          "slug",
          "telegram_url",
          "twitter_url"
        ],
        "type": "object",
        "properties": {
          "collection_id": {
            "type": "string",
            "description": "The collection id of the collection",
            "example": "6113f83c3126bb611b9b119d"
          },
          "name": {
            "type": "string",
            "description": "Collection name",
            "example": "Bored Ape Yacht Club"
          },
          "slug": {
            "type": "string",
            "description": "A slug is generated from a collection name by using applying lower-case to all letters in the collection name and replacing all spaces with a '-'",
            "example": "bored-ape-yacht-club"
          },
          "opensea_slug": {
            "type": "string",
            "description": "OpenSea slug of the collection",
            "example": "boredapeyachtclub"
          },
          "description": {
            "type": "string",
            "description": "Collection description",
            "example": "Limited Edition Jame Bond NFT"
          },
          "official_website_url": {
            "type": "string",
            "description": "Official website url of the collection",
            "example": "https://boredapeyachtclub.com/"
          },
          "opensea_url": {
            "type": "string",
            "description": "OpenSea url of the collection",
            "example": "https://opensea.io/collection/boredapeyachtclub"
          },
          "logo": {
            "type": "string",
            "description": "The url or base64 data of image or video associated with the collection",
            "example": "https://i.seadn.io/gae/Ju9CkWtV-1Okvf45wo8UctR-M9He2PjILP0oOvxE89AyiPPGtrR3gysu1Zgy0hjd2xKIgjJJtWIc0ybj4Vd7wv8t3pxDGHoJBzDB?w=500&auto=format"
          },
          "contracts": {
            "type": "array",
            "description": "The list of contracts of the collection",
            "example": [
              "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d"
            ],
            "items": {
              "type": "string"
            }
          },
          "categories": {
            "type": "array",
            "description": "List of categor(ies) that a collection belongs to",
            "example": [
              "PFP"
            ],
            "items": {
              "type": "string"
            }
          },
          "discord_url": {
            "type": "string",
            "description": "Discord url of the collection",
            "example": "https://discord.gg/3P5K3dzgdB"
          },
          "instagram_url": {
            "type": "string",
            "description": "Instagram url of the collection",
            "example": "https://www.instagram.com/boredapeyachtclub/"
          },
          "twitter_url": {
            "type": "string",
            "description": "Twitter url of the collection",
            "example": "https://twitter.com/BoredApeYC"
          },
          "telegram_url": {
            "type": "string",
            "description": "Telegram url of the collection",
            "example": "https://t.me/boredapeyachtclub"
          },
          "has_rarity": {
            "type": "boolean",
            "description": "Whether the collection has rarity rankings",
            "example": true
          }
        }
      },
      "royalty_payer_info": {
        "required": [
          "address_tag",
          "average_royalty_fee_rate_per_sale",
          "holdings",
          "outstanding_royalty_expense",
          "revenue",
          "royalty_expense",
          "sold"
        ],
        "type": "object",
        "properties": {
          "address_tag": {
            "$ref": "#/components/schemas/address_tag"
          },
          "royalty_expense": {
            "$ref": "#/components/schemas/eth_usd_value"
          },
          "outstanding_royalty_expense": {
            "$ref": "#/components/schemas/eth_usd_value"
          },
          "sold": {
            "type": "number",
            "description": "The number of NFTs sold by this address",
            "example": 10
          },
          "holdings": {
            "type": "number",
            "description": "The number of NFTs held by this address",
            "example": 10
          },
          "revenue": {
            "$ref": "#/components/schemas/eth_usd_value"
          },
          "average_royalty_fee_rate_per_sale": {
            "type": "number",
            "description": "The average royalty fee rate that the address paid to this NFT contract, round to 5 decimal places",
            "example": 0.1
          }
        }
      },
      "GetRoyaltyPayersByContractResponse": {
        "required": [
          "collection",
          "contract",
          "royalty_payers",
          "total"
        ],
        "type": "object",
        "properties": {
          "total": {
            "type": "number",
            "description": "Total number of royalty payers",
            "example": 100
          },
          "royalty_payers": {
            "type": "array",
            "description": "List of royalty payers",
            "items": {
              "$ref": "#/components/schemas/royalty_payer_info"
            }
          },
          "contract": {
            "$ref": "#/components/schemas/contract_model"
          },
          "collection": {
            "$ref": "#/components/schemas/collection_model"
          }
        }
      },
      "eth_usd_value": {
        "required": [
          "eth",
          "usd"
        ],
        "type": "object",
        "properties": {
          "eth": {
            "type": "number",
            "description": "The value of ETH.",
            "example": 100
          },
          "usd": {
            "type": "number",
            "description": "The value of USD.",
            "example": 100
          }
        }
      },
      "GetRoyaltyPayersByContractSortByEnum": {
        "title": "GetRoyaltyPayersByContractSortByEnum",
        "enum": [
          "royalty_expense",
          "outstanding_royalty_expense"
        ],
        "type": "string",
        "description": "An enumeration."
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    }
  },
  "x-original-swagger-version": "2.0",
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ]
}
```