Skip to main content
GET
/
balance
cURL
curl --request GET \
  --url https://sandbox.onconsul.com/v1/balance \
  --header 'Authorization: Bearer <token>'
{
  "amount": "<string>",
  "last_updated": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.onconsul.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the current USDC balance of your Consul account. The balance reflects the settled funds immediately available for payouts or withdrawals. Funds are held as USDC on Base.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

OK

​
amount
string<decimal>
required
​
chain
enum<string>
required
Available options:
ethereum,
polygon,
base,
arbitrum,
optimism
​
currency
enum<string>
required
Available options:
USDC,
USDT,
USD,
BRL,
ARS,
COP,
MXN,
CAD,
EUR
​
last_updated
string<date-time>
required