zkbcy7ja.nx.link

{
  "parameters": [
    {
      "description": "The blockchain network identifier where the contract is deployed.",
      "in": "path",
      "name": "chainId",
      "required": true,
      "schema": {
        "description": "The blockchain network identifier where the contract is deployed.",
        "examples": [
          1,
          8453,
          137,
          56,
          43114,
          42161,
          10
        ],
        "exclusiveMinimum": 0,
        "type": "integer"
      }
    },
    {
      "description": "The smart contract address or ENS name.",
      "in": "path",
      "name": "address",
      "required": true,
      "schema": {
        "description": "The smart contract address or ENS name.",
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "description": "Contract metadata from the thirdweb contract metadata service.",
            "properties": {
              "result": {
                "properties": {
                  "compiler": {
                    "description": "Compiler information including version.",
                    "properties": {
                      "version": {
                        "description": "Solidity compiler version used to compile the contract.",
                        "type": "string"
                      }
                    },
                    "required": [
                      "version"
                    ],
                    "type": "object"
                  },
                  "language": {
                    "description": "Programming language of the contract (e.g., 'Solidity').",
                    "type": "string"
                  },
                  "output": {
                    "description": "Compilation output including ABI and documentation.",
                    "properties": {
                      "abi": {
                        "description": "Contract ABI (Application Binary Interface) as an array of function/event/error definitions.",
                        "items": {},
                        "type": "array"
                      },
                      "devdoc": {
                        "additionalProperties": {},
                        "description": "Developer documentation extracted from contract comments.",
                        "type": "object"
                      },
                      "userdoc": {
                        "additionalProperties": {},
                        "description": "User documentation extracted from contract comments.",
                        "type": "object"
                      }
                    },
                    "type": "object"
                  },
                  "settings": {
                    "description": "Compilation settings including optimization and target configuration.",
                    "properties": {
                      "compilationTarget": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "description": "Compilation target mapping source file names to contract names.",
                        "type": "object"
                      },
                      "evmVersion": {
                        "description": "EVM version target for compilation.",
                        "type": "string"
                      },
                      "libraries": {
                        "additionalProperties": {},
                        "description": "Library addresses for linking.",
                        "type": "object"
                      },
                      "metadata": {
                        "description": "Metadata settings for compilation.",
                        "properties": {
                          "bytecodeHash": {
                            "description": "Hash method used for bytecode metadata.",
                            "type": "string"
                          }
                        },
                        "type": "object"
                      },
                      "optimizer": {
                        "description": "Optimizer settings used during compilation.",
                        "properties": {
                          "enabled": {
                            "description": "Whether optimizer is enabled.",
                            "type": "boolean"
                          },
                          "runs": {
                            "description": "Number of optimizer runs.",
                            "type": "number"
                          }
                        },
                        "type": "object"
                      },
                      "remappings": {
                        "description": "Import remappings used during compilation.",
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "type": "object"
                  },
                  "version": {
                    "description": "Metadata format version.",
                    "type": "number"
                  }
                },
                "type": "object"
              }
            },
            "required": [
              "result"
            ],
            "type": "object"
          }
        }
      },
      "description": "Successfully retrieved contract metadata"
    },
    "400": {
      "description": "Invalid request parameters"
    },
    "401": {
      "description": "Authentication required. The request must include a valid `x-secret-key` header for backend authentication."
    },
    "404": {
      "description": "Contract metadata not found"
    },
    "429": {
      "description": "Rate limit exceeded"
    },
    "500": {
      "description": "Internal server error"
    }
  }
}