Skip to main content
GET
/
v1
/
balance
Get Balance
curl --request GET \
  --url https://api.example.com/v1/balance
{
  "project_id": "<string>",
  "currency": "<string>",
  "available": 123,
  "pending": 123,
  "total_funded": 123,
  "total_spent": 123,
  "wallet_address": {}
}
Returns the current USDC balance, spending totals, and wallet address for the project linked to the authenticated API token. All monetary values are in micro-USDC (1 USDC = 1,000,000).
Requires a bearer token with the read permission.

​
Request

This endpoint takes no query parameters or request body.

​
Response

​
project_id
string
required
Unique project identifier.
​
currency
string
required
Always "usdc".
​
available
integer
required
Available USDC balance in micro-USDC.
​
pending
integer
required
Pending USDC balance in micro-USDC. Funds in transit that are not yet available.
​
total_funded
integer
required
Cumulative USDC funded into this project in micro-USDC.
​
total_spent
integer
required
Cumulative USDC spent from this project in micro-USDC.
​
wallet_address
string | null
required
Bridge wallet address on Base for receiving USDC deposits. null if no wallet has been created yet.

​
Examples

curl https://api.unwall.xyz/v1/balance \
  -H "Authorization: Bearer aw_live_xxxxxxxxxxxx"
Response (200 OK)
{
  "project_id": "proj_abc123",
  "currency": "usdc",
  "available": 5000000,
  "pending": 0,
  "total_funded": 5000000,
  "total_spent": 0,
  "wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f2bD28"
}