WebCrawlerAPI

API reference/Organization/Balance

Balance

Get current balance for your organization

GEThttps://api.webcrawlerapi.com/v1/organization/balance

Returns the current available balance for the authenticated organization in USD.

plain
https://api.webcrawlerapi.com/organization/balance

Format: JSON Method: GET

Request

No query parameters required.

Authentication:

  • Requires API key in Authorization header
  • Format: Bearer YOUR_API_KEY

Example:

bash
curl --request GET \
  --url 'https://api.webcrawlerapi.com/organization/balance' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Response

  • org_id - Your organization identifier
  • total_balance - Current available balance in USD (2 decimal precision), combining prepaid credits and subscription credits

Example Response

json
{
  "org_id": "clwgv3ywz000hsy99lwbk7q18",
  "total_balance": 12.34
}

Error Responses

  • 401 Unauthorized - Invalid or missing API key
    json
    {
      "error_code": "unauthorized",
      "error_message": "Unauthorized"
    }

Notes

  • Balance reflects the total spendable amount: subscription credits + prepaid balance combined
  • Credits are converted to USD (1 USD = 1,000,000 credits)
  • Balance is read from your API key's organization context — no date parameters needed