Docs
Balance Query

Balance Query

Check your wallet balance

Balance Query

Check your current wallet balance and account status.

Query Balance

Endpoint: POST /api/v1/open/balance/query

Request

No request body required.

curl --location --request POST 'https://your-api-domain.com/api/v1/open/balance/query' \
--header 'RT-AccessCode: YOUR_ACCESS_CODE' \
--header 'RT-SecretKey: YOUR_SECRET_KEY' \
--data ''

Response Parameters

NameTypeDescription
successBooleantrue = succeeded, false = failed
errorCodeStringError code when failed
errorMsgStringError message
obj.balanceIntegerAvailable balance * 10,000
obj.currencyCodeStringCurrency code
obj.lastUpdatedStringLast update timestamp (UTC)

Example Success Response

{
    "errorCode": null,
    "errorMsg": null,
    "success": true,
    "obj": {
        "balance": 5000000,
        "currencyCode": "USD",
        "lastUpdated": "2024-01-15 12:30:45"
    }
}

Converting Balance

Balance is returned as value * 10,000. To get USD amount:

const rawBalance = 5000000;
const usdBalance = rawBalance / 10000;
// Result: $500.00

Low Balance Alerts

The system sends webhook notifications when your balance falls below certain thresholds:

ThresholdNotification
25%Warning: Balance at 25%
10%Critical: Balance at 10%

Make sure to configure your webhook to receive low balance alerts.

Best Practices

  1. Monitor balance regularly - Check before placing large orders
  2. Set up webhooks - Get notified of low balance automatically
  3. Maintain buffer - Keep enough balance for peak ordering periods
  4. Top up proactively - Don't wait until balance is critical