Skip to main content

Documentation Index

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

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

Return ledger account balances for your authenticated account. Each object in the response represents one currency row with its current balance amount.

Endpoint

GET https://api.futuur.com/me/balances/

Authentication

This endpoint requires HMAC-SHA512 authentication. Include the following headers with every request:
HeaderDescription
KeyYour public API key
TimestampCurrent Unix timestamp
HMACSHA-512 signature of the request

Parameters

currency
string
If set, returns only the balance for this currency code. Matching is case-insensitive (for example, usdc and USDC both match).

Response

Returns an array of balance objects.
currency
string
required
Currency code for this balance row (for example, OOM, USDC, USDT, USD).
amount
string
required
Current balance amount in this currency. Returned as a decimal string.
For full account profile fields (username, email, KYC status, and the aggregated wallet object), use GET /me/.

Example

cURL
curl --request GET \
  --url "https://api.futuur.com/me/balances/" \
  --header "Key: YOUR_PUBLIC_KEY" \
  --header "Timestamp: 1712345678" \
  --header "HMAC: YOUR_HMAC_SIGNATURE"
Sample response
[
  { "currency": "OOM", "amount": "5000.00" },
  { "currency": "USDC", "amount": "100.00" },
  { "currency": "USDT", "amount": "0.00" },
  { "currency": "USD", "amount": "0.00" }
]
Filter by currency
curl --request GET \
  --url "https://api.futuur.com/me/balances/?currency=USDC" \
  --header "Key: YOUR_PUBLIC_KEY" \
  --header "Timestamp: 1712345678" \
  --header "HMAC: YOUR_HMAC_SIGNATURE"
Filtered response
[
  { "currency": "USDC", "amount": "100.00" }
]