Skip to main content
GET
/
balance-allowance
Get balance and allowance (L2)
curl --request GET \
  --url https://clob.kuest.com/balance-allowance \
  --header 'KUEST_ADDRESS: <kuest_address>' \
  --header 'KUEST_API_KEY: <kuest_api_key>' \
  --header 'KUEST_PASSPHRASE: <kuest_passphrase>' \
  --header 'KUEST_SIGNATURE: <kuest_signature>' \
  --header 'KUEST_TIMESTAMP: <kuest_timestamp>'
{
  "balance": "<string>",
  "allowances": {}
}
Returns the on-chain balance and allowance for the authenticated account.
This endpoint requires L2 authentication headers: KUEST_ADDRESS, KUEST_SIGNATURE, KUEST_TIMESTAMP, KUEST_API_KEY, and KUEST_PASSPHRASE.
Use asset_type=COLLATERAL for the collateral ERC-20 balance/allowance (omit token_id). For conditional assets, set asset_type=CONDITIONAL and pass the token_id. The response includes a balance string plus an allowances map keyed by exchange address.

Headers

​
KUEST_ADDRESS
string
required

Checksummed wallet address performing the request.

​
KUEST_API_KEY
string<uuid>
required

API key obtained from the L1 derivation endpoint.

​
KUEST_PASSPHRASE
string
required

64 character hexadecimal passphrase associated with the API key.

​
KUEST_TIMESTAMP
string
required

Millisecond epoch timestamp (string) used for freshness checks.

​
KUEST_SIGNATURE
string
required

Hex-encoded HMAC-SHA256 signature built from the L2 signing string.

Query Parameters

​
asset_type
enum<string>

Asset type to inspect.

Available options:
COLLATERAL,
CONDITIONAL
​
token_id
string

Token identifier when asset_type=CONDITIONAL.

​
signature_type
integer<int32>

Signature type used for conditional asset approvals.

Response

Balance and allowance payload.

​
balance
string
required

Balance in base units.

​
allowances
object
required

Allowance or approval per exchange address (base units or 1/0).