Skip to main content
GET
/
budget-accounts
Get Budgets
curl --request GET \
  --url https://api-v2.boost.xyz/budget-accounts
[
  {
    "id": "8453:0xa904ef32d569e2ada8f4de6244bf68f36fa219f6",
    "identifier": "<string>",
    "registryType": "ACTION",
    "baseImplementation": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "deployedInstance": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "txHash": "<string>",
    "blockTimestamp": "<string>",
    "blockNumber": "<string>",
    "chainId": 1,
    "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "owner": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "hidden": true,
    "members": [
      {
        "memberAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "roles": [
          123
        ],
        "email": "<string>",
        "status": "wallet_created"
      }
    ],
    "deprecated": true,
    "name": "<string>",
    "label": "<string>"
  }
]

Query Parameters

​
chainId
integer | null

Query for Budget Accounts deployed to this chain ID

Required range: x >= 0
Example:

10

​
member
string

Query for Budget Accounts where this member has permissions

Example:

"0x0d288362c8bfe919dd02fb96ee1642aaae0185e7"

​
owner
string

Query for Budget Accounts owned by this address

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

​
page
integer | null
default:1

Query for a specific page of results

Required range: x >= 0
​
pageSize
integer | null
default:10

How many items should be returned per page

Required range: x >= 0

Response

200 - application/json

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

​
id
string
required

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

Example:

"8453:0xa904ef32d569e2ada8f4de6244bf68f36fa219f6"

​
identifier
string
required

The address of the deployed Budget Account

​
registryType
enum<string>
required

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

Available options:
ACTION,
ALLOW_LIST,
BUDGET,
INCENTIVE,
VALIDATOR
​
baseImplementation
string
required

The contract address of the base implementation registered with the protocol

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

​
deployedInstance
string
required

The address of the deployed contract

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

​
txHash
string
required

The transaction hash of the contract deployment

​
blockTimestamp
string
required

A bigint string representing the block timestamp for this contract deployment

​
blockNumber
string
required

A bigint string representing the blocknumber for this contract deployment

​
chainId
integer
required

The chainID where this Budget is deployed

Required range: x >= 0
​
address
string
required

The address of the deployed Budget Account

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

​
owner
string
required

The address of the Budget's owner

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

​
hidden
boolean
required

Whether or not the Budget should be included in API responses

​
members
object[]
required

A list of members with any amount of permissions

​
deprecated
boolean
required

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

​
name
string

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

​
label
string | null

A label for the Budget, if available.