seo

GET /v1/seo/quota

The research allowance for this account.

All seo endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The endpoint checks sites.view; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/seo/quota \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

How many domain lookups this plan includes each day, how many are left, any purchased lookups still unspent, and what buying more costs. can_look_up is authoritative and is not the same as remaining > 0: an account that is suspended or unpaid may have lookups left and still not be permitted to spend them.

Response

NameTypeRequiredWhat it is
daily_allowanceintegerYesLookups included per day. -1 means unlimited.
used_todayintegerYesPlan-funded lookups run since midnight UTC.
plan_remainingintegerNo—
top_up_remainingintegerNoPurchased lookups still unspent. These do not expire.
remainingintegerYes—
is_unlimitedbooleanNo—
can_look_upbooleanYesWhether a lookup would be permitted right now. Not the same as remaining > 0: a suspended or unpaid account may have lookups left and still be refused.
in_good_standingbooleanNo—
packsobject[]YesPacks of extra lookups available to buy.

Errors this endpoint can return

401 · 403