v2

latestOpenAPI 3.1.02026-08-01170225.5 KB

Boost

Budget

Get Budgets

Accepts pagination, and filter options like owner address, chain ID, and permissioned member address.

get/budget-accounts

Query parameters

chainIdinteger nullable

Query for Budget Accounts deployed to this chain ID

Example:10

memberstring

Query for Budget Accounts where this member has permissions

Example:0x0d288362c8bfe919dd02fb96ee1642aaae0185e7

ownerstring

Query for Budget Accounts owned by this address

Example:0x378632819f39c74c4f56b1429e760739c5fb51b7

pageinteger nullable

Query for a specific page of results

pageSizeinteger nullable

How many items should be returned per page

Response

Returns whether or not the token is blocked on given chain id

idstring required

The system ID in the format of "chainId:address"

identifierstring required

The address of the deployed Budget Account

registryType'ACTION' | 'ALLOW_LIST' | 'BUDGET' | 'INCENTIVE' | 'VALIDATOR' required

The type of Boost Protocol V2 component; either ACTION, ALLOW_LIST, BUDGET, INCENTIVE, or VALIDATOR

baseImplementationstring required

The contract address of the base implementation registered with the protocol

deployedInstancestring required

The address of the deployed contract

txHashstring required

The transaction hash of the contract deployment

blockTimestampstring required

A bigint string representing the block timestamp for this contract deployment

blockNumberstring required

A bigint string representing the blocknumber for this contract deployment

chainIdinteger required

The chainID where this Budget is deployed

namestring

A unique name for the Budget, if not updated later, then this will be a random UUID

labelstring nullable

A label for the Budget, if available.

addressstring required

The address of the deployed Budget Account

ownerstring required

The address of the Budget's owner

hiddenboolean required

Whether or not the Budget should be included in API responses

deprecatedboolean required

Will be true if Budget Account is based off of a deprecated budget implementation.

Example response

[
  {
    "id": "8453:0xa904ef32d569e2ada8f4de6244bf68f36fa219f6",
    "baseImplementation": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "deployedInstance": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "owner": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "members": [
      {
        "memberAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      }
    ]
  }
]