Skip to content
ProspectAPIs

API reference / Email verification

Your email verification stats

Written and maintained by The ProspectAPIs team

GET/v1/email/verify/stats

GET /v1/email/verify/stats is the ProspectAPIs operation emailVerifyStats, in the Email verification group of the REST API. Your own verification mix over the last days (1 to 90, default 30): totals by status, how many were charged and how many were served from a recent result, and the catch-all and unknown shares. Free. Cost: free. Send your API key as a Bearer token in the Authorization header.

How this fits with the rest of the email verification API, with worked examples, is in the email verification guide.

Parameters

Parameters of GET /v1/email/verify/stats
NameInTypeDescription
daysqueryintegerWindow in days.

An unknown query parameter is refused with a 400 rather than ignored, so a typo never widens a search you pay for.

Responses

Response codes of GET /v1/email/verify/stats
StatusMeaning
200The mix.
400The request was invalid (e.g. a bad filter or input); nothing was charged.
401The API key is missing or invalid.

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens.

200 response fields

The mix. The body is a EmailVerifyStats.

Fields of the 200 response
FieldTypeDescription
days requiredinteger
total requiredinteger
by_status requiredobject
by_status.validinteger
by_status.invalidinteger
by_status.catch-allinteger
by_status.unknowninteger
charged requiredinteger
served_from_cache requiredinteger
catch_all_share requirednumber0 to 1.
unknown_share requirednumber0 to 1.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl
curl https://api.prospectapis.com/v1/email/verify/stats \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY"
JavaScript (fetch)
const res = await fetch("https://api.prospectapis.com/v1/email/verify/stats", {
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}` },
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);
Python (requests)
import os, requests

res = requests.get(
    "https://api.prospectapis.com/v1/email/verify/stats",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

This call is free: it never spends credits, so you can call it as often as the rate limit allows. Metered calls on the same key report your balance after each response in X-Credits-Remaining, and GET /v1/account shows it at any time.

The email verification guide covers this area end to end. Previous operation: Verify email addresses. Next operation: Report what happened when you sent. Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values.

Was this page helpful?