Get Balance

GET /api/open/v1/balance

Request parameters

None.

Request example

curl https://www.routeapi.ai/api/open/v1/balance \
  -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"

Response example

{
  "success": true,
  "message": "",
  "data": {
    "balance": 10.00,
    "used_amount": 0.14,
    "request_count": 3,
    "currency": "USD",
    "currency_symbol": "$"
  }
}

Response fields

Field	Type	Description
`balance`	number	Account balance, two decimals
`used_amount`	number	Total amount used, two decimals
`request_count`	integer	Total request count
`currency`	string	Site display currency: `USD`, `CNY`, or `CUSTOM`
`currency_symbol`	string	Currency symbol: `$`, `¥`, or the site’s custom symbol

Notes

Amount fields in other Platform API endpoints use the currency returned here.
Very small amounts may show as 0.00.
For common error codes, see Platform API errors.