v2

latestOpenAPI 3.1.02026-08-01170225.5 KB

Boost

Budget

Retrieve a single Budget by its system ID

Retrieve detailed information about a Budget Account, including contract address, chain ID, owner address, label, and members if applicable.

get/budget-accounts/:id

Path parameters

idstring required

Query for a Budget Account by system ID in the format of "chainId:address"

Example:8453:0xa904ef32d569e2ada8f4de6244bf68f36fa219f6

ID in format chainId:identifier

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

addressstring required

The address of the deployed Budget Account

ownerstring required

The address of the Budget's owner

ownerEmailstring nullable

The email address of the Budget's owner, if available

hiddenboolean required

Whether or not the Budget should be included in API responses

labelstring nullable

A label for the Budget, if available.

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"
    }
  ]
}