Wallets

Read the current permission's remaining token and native limits

Changed on

User JWT only; partner assertions are refused. Works for workflow-sized permissions too. Pending deferred installs report stored totals with status pending. Active limits are read on chain; a failed remainder read is 503, never a stored-value fallback. Retirement read failures appear as unverified entries in an otherwise successful response.

get/wallets/{address}/budget

Request

  • Base URL
    https://api.avaprotocol.org/api/v1
  • Auth
    HTTP bearer

Path parameters

addressstring required

Lowercase or checksummed hex EOA / contract address.

Example:0x82F2Dd9a552a69f2ceD7Ff2D05c43aB8430158FB

Query parameters

chainIdinteger

The chain to operate on (a single value). Omit to use the aggregator default (the request's JWT aud chain, then the gateway default).

Response

Current limits and retirement health

chainIdinteger required

Numeric chain ID (e.g. 11155111 for Sepolia, 8453 for Base). On chain-aware trigger/node configs this is required and must be a configured chain; on query/filter params it is optional.

policyIdstring required

ULID identifier (26-char Crockford base32).

status'pending' | 'active' required
sizing'workflow' | 'budget' required
validUntilinteger required
startedAtinteger
readAtinteger required

Example response

{
  "chainId": 11155111,
  "policyId": "01JG2FE5MDVKBPHEG0PEYSDKAC",
  "erc20": [
    {
      "token": "0x82F2Dd9a552a69f2ceD7Ff2D05c43aB8430158FB"
    }
  ],
  "unmeteredPermissions": [
    {
      "target": "0x82F2Dd9a552a69f2ceD7Ff2D05c43aB8430158FB",
      "token": "0x82F2Dd9a552a69f2ceD7Ff2D05c43aB8430158FB"
    }
  ],
  "retirements": [
    {
      "policyId": "01JG2FE5MDVKBPHEG0PEYSDKAC",
      "erc20": [
        {
          "token": "0x82F2Dd9a552a69f2ceD7Ff2D05c43aB8430158FB",
          "amount": "500000000"
        }
      ],
      "native": {
        "amount": "10000000000000000"
      }
    }
  ],
  "liveApprovals": [
    {
      "token": "0x82F2Dd9a552a69f2ceD7Ff2D05c43aB8430158FB",
      "spender": "0x82F2Dd9a552a69f2ceD7Ff2D05c43aB8430158FB"
    }
  ],
  "pendingChange": {
    "preparationId": "01JG2FE5MDVKBPHEG0PEYSDKAC",
    "policyId": "01JG2FE5MDVKBPHEG0PEYSDKAC"
  }
}

Changes