La documentation est rédigée en anglais et en chinois. Les pages s'affichent ici en anglais.

Account

GET /v1/account — check your credit balance and this month's usage programmatically.

GET https://api.serphubapi.com/v1/account

Returns your current balance and usage for the current calendar month (UTC). Free to call. Useful for reconciliation and for alerting before you run out.

curl https://api.serphubapi.com/v1/account \
  -H "X-API-Key: shapi_xxxxxxxx"

Response

{
  "balance_credits": 15420,
  "gift_credits": 420,
  "gift_expires_at": "2026-11-12T09:30:00+00:00",
  "paid_credits": 15000,
  "month_usage": {
    "calls": 1284,
    "credits_charged": 11870
  }
}

Field	Type	Description
`balance_credits`	integer	Total credits available now (gift + paid).
`gift_credits`	integer	Part of the balance that is gift credits (these expire).
`gift_expires_at`	string \| null	When the gift credits expire (ISO 8601). `null` if you have no valid gift credits.
`paid_credits`	integer	Part of the balance from top-ups. Never expires.
`month_usage.calls`	integer	Calls this month that returned a result (successful or empty).
`month_usage.credits_charged`	integer	Credits spent this month.

Gift credits are always spent before paid credits. See Billing.

The balance is account-wide: all your API keys draw from it. Per-key daily limits are configured at /dashboard/keys. For per-day, per-key and per-engine breakdowns, see /dashboard/usage; to download the ledger as CSV, use /dashboard/wallet.

Errors

HTTP	Code	When
401	`invalid_api_key`	Missing, invalid or disabled key