Balances: Vault / user / address
A single balances endpoint. A balance is an aggregation of ledger accounts (available: can be spent; reserved: locked by pending transfers but still belongs to the owner). Balances are a denormalization of the double-entry journal and are updated atomically with the entries.
ISOLATION: a user sees balances ONLY for their own addresses; an admin sees the entire Vault. Filters: ?addressId= (your own address), ?token=, ?summary=true (totals only, for the dashboard), ?purpose= (filters the account list; totals always include the available/reserved breakdown). Vault-level accounts (external/adjustment) aren't included in totals.
curl -X GET "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/test_vault/balances?summary=true&addressId=123%20Main%20St&token=usdt&purpose=available&includeShared=true&limit=42&cursor=example_string" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/test_vault/balances?summary=true&addressId=123%20Main%20St&token=usdt&purpose=available&includeShared=true&limit=42&cursor=example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/test_vault/balances?summary=true&addressId=123%20Main%20St&token=usdt&purpose=available&includeShared=true&limit=42&cursor=example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/test_vault/balances?summary=true&addressId=123%20Main%20St&token=usdt&purpose=available&includeShared=true&limit=42&cursor=example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/test_vault/balances?summary=true&addressId=123%20Main%20St&token=usdt&purpose=available&includeShared=true&limit=42&cursor=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"vaultId": "example_string",
"totals": [
{
"token": {
"code": "example_string",
"symbol": "example_string",
"decimals": 42
},
"available": "example_string",
"availableDecimal": "example_string",
"reserved": "example_string",
"reservedDecimal": "example_string"
}
],
"accounts": [
{
"id": "example_string",
"purpose": "available",
"balance": "example_string",
"balanceDecimal": "example_string",
"token": {
"id": "example_string",
"code": "example_string",
"symbol": "example_string",
"decimals": 42
},
"address": {
"id": "example_string",
"address": "123 Main St",
"label": "example_string"
}
}
],
"nextCursor": "example_string"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/api/v1/vaults/{code}/balancesTarget server for requests. Edit to use your own host.
Session token. Mobile/services. The web uses a cookie.
API key (sent in cookie)
Unique Vault code (slug)
true means totals only, without the account list
Balance of a specific address (all its tokens; it must be mine)
Filter by token code
Account list filter (doesn't affect totals)
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Session token. Mobile/services. The web uses a cookie.
API Key for authentication. Provide your API key in the cookie.
Path Parameters
Query Parameters
Balance of a specific address (all its tokens; it must be mine)
Account list filter (doesn't affect totals)
availablereservedexternaladjustmentResponses
Per-token aggregates (available/reserved)
Absent with ?summary=true
Account pagination; absent with ?summary=true