v3

OpenAPI 3.1.0raw.githubusercontent.com2026-04-080024.9 KB

Usage

Check usage and quota

Returns the current plan tier, billing period, spendable wallet, daily free allowance, and rate limit for the authenticated account.

get/v1/usage

Usage information

tierstring required

Current subscription tier, typically free, pro, or enterprise.

plan_code'free' | 'pro' | 'enterprise' required

Normalized billing plan code.

period_startstring date required

Billing period start date (YYYY-MM-DD).

period_endstring date required

Billing period end date (YYYY-MM-DD).

credits_limitinteger required

Included monthly credits for the current tier.

credits_usedinteger required

Credits used in the current billing period.

credits_remaininginteger required

Remaining spendable credits in the account wallet.

wallet_balanceinteger required

Total spendable credits currently available.

rate_limit_per_secinteger required

Maximum requests per second for this tier.

api_keys_activeinteger required

Number of active API keys.

billing_holdboolean required

Whether the billing account is currently blocked pending review.

daily_free_remaininginteger required

Remaining free searches for the current UTC day.

daily_free_limitinteger required

Total free searches available per UTC day.