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,
  "available_usd": 123,
  "pending_usd": 123,
  "total_funded_usd": 123,
  "total_spent_usd": 123,
  "available_usdc": 123,
  "pending_usdc": 123,
  "total_funded_usdc": 123,
  "total_spent_usdc": 123,
  "wallet_address": {}
}
Returns the current balance, spending totals, and wallet address for the project linked to the authenticated API token. Balances are reported in both USD and USDC.
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
Default currency. Always "usd".
​
available
integer
required
Available balance in cents. This is the total spendable amount across all currencies.
​
pending
integer
required
Pending balance in cents. Funds in transit that are not yet available.
​
total_funded
integer
required
Cumulative amount funded into this project in cents.
​
total_spent
integer
required
Cumulative amount spent from this project in cents.
​
available_usd
integer
required
Available USD balance in cents.
​
pending_usd
integer
required
Pending USD balance in cents.
​
total_funded_usd
integer
required
Cumulative USD funded in cents.
​
total_spent_usd
integer
required
Cumulative USD spent in cents.
​
available_usdc
integer
required
Available USDC balance in micro-USDC (1 USDC = 1,000,000).
​
pending_usdc
integer
required
Pending USDC balance in micro-USDC.
​
total_funded_usdc
integer
required
Cumulative USDC funded in micro-USDC.
​
total_spent_usdc
integer
required
Cumulative USDC spent 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": "usd",
  "available": 5250000,
  "pending": 0,
  "total_funded": 6000000,
  "total_spent": 750000,
  "available_usd": 250000,
  "pending_usd": 0,
  "total_funded_usd": 1000000,
  "total_spent_usd": 750000,
  "available_usdc": 50000000,
  "pending_usdc": 0,
  "total_funded_usdc": 50000000,
  "total_spent_usdc": 0,
  "wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f2bD28"
}