GET /api/v1/catalog/contracts

Parameters

Name	Location	Details
`packageId`	query / optional	string ["@ballkidz/defifa","@bananapus/721-hook-v6","@bananapus/address-registry-v6","@bananapus/buyback-hook-v6","@bananapus/core-v6","@bananapus/deploy-all-v6","@bananapus/distributor-v6","@bananapus/fee-project-deployer-v6","@bananapus/jbx-distributor-v6","@bananapus/omnichain-deployers-v6","@bananapus/ownable-v6","@bananapus/permission-ids-v6","@bananapus/project-handles-v6","@bananapus/project-payer-v6","@bananapus/router-terminal-v6","@bananapus/suckers-v6","@bananapus/swap-split-hook-v6","@bananapus/univ4-lp-split-hook-v6","@bananapus/univ4-router-v6","@bannynet/core-v6","@croptop/core-v6","@openzeppelin/contracts","@rev-net/core-v6"]
`category`	query / optional	string `["contract","abstract","interface","library","script"]`
`chainId`	query / optional	integer `[1,10,8453,42161,84532,421614,11155111,11155420]`
`deployedOnly`	query / optional	boolean
`executableOnly`	query / optional	boolean
`offset`	query / optional	integer
`limit`	query / optional	integer

Response 200

Field Type Details

protocolVersion

integer
required

Values: [6]

provenance object
required

packages array
required

exclusions

array
required

Fields

Field	Type	Details
`path`	string required
`reason`	string required

items

array
required

Fields

Field Type Details

id string
required

name string
required

packageId string
required

category string
required

executable boolean
required

methodCounts

object
required

Fields

Field	Type	Details
`read`	integer required
`write`	integer required

chains

array
required

Fields

Field	Type	Details
`chainId`	integer required	Values: `[1,10,8453,42161,84532,421614,11155111,11155420]`
`status`	string required	Values: `["published","missing"]`
`addresses`	array required
`instances`	array required

total integer
required

nextOffset one of
required

JSON schema

{
  "type": "object",
  "properties": {
    "protocolVersion": {
      "$ref": "#/components/schemas/ProtocolVersion"
    },
    "provenance": {
      "type": "object",
      "additionalProperties": true
    },
    "packages": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "exclusions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          }
        },
        "required": [
          "path",
          "reason"
        ],
        "additionalProperties": false
      }
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "packageId": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "executable": {
            "type": "boolean"
          },
          "methodCounts": {
            "type": "object",
            "properties": {
              "read": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "write": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "read",
              "write"
            ],
            "additionalProperties": false
          },
          "chains": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "chainId": {
                  "$ref": "#/components/schemas/ChainId"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "published",
                    "missing"
                  ]
                },
                "addresses": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Address"
                  }
                },
                "instances": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "address": {
                        "$ref": "#/components/schemas/Address"
                      },
                      "retired": {
                        "type": "boolean",
                        "description": "Historical artifact retained for decoding; not a default destination."
                      },
                      "generation": {
                        "type": "string",
                        "enum": [
                          "current",
                          "previous",
                          "v1"
                        ],
                        "description": "Router/buyback release generation, independent of chain or project migration."
                      }
                    },
                    "required": [
                      "address",
                      "retired"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "chainId",
                "status",
                "addresses",
                "instances"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "name",
          "packageId",
          "category",
          "executable",
          "methodCounts",
          "chains"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "nextOffset": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "protocolVersion",
    "provenance",
    "packages",
    "exclusions",
    "items",
    "total",
    "nextOffset"
  ],
  "additionalProperties": false
}