Quota

API referenceEmail Finder

From the Email Finder API reference. Requests use the base URL https://app.warmerly.com/api/v1 and an API key, see Authentication.

text

GET /email-finder/quota

Returns your current monthly Email Finder usage. This endpoint is account-level, it does not require X-Project-Id.

bash

curl https://app.warmerly.com/api/v1/email-finder/quota \
  -H "X-Api-Key: wmv_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

json

{ "used": 37, "limit": 500, "remaining": 463 }

The limit depends on your plan; with no active plan the allowance is 50 lookups a month. Both POST /email-finder/lookup and POST /email-finder/bulk check remaining quota before enqueuing. A bulk request counts against quota by item count, plus any of your earlier lookups that are still queued. If the request would exceed your limit, it's rejected with 402 quota_exhausted:

json

{
  "error": {
    "code": "quota_exhausted",
    "message": "You've used 500 of 500 email lookups this month. Upgrade your plan to continue.",
    "details": {
      "label": "email lookups",
      "used": 500,
      "limit": 500,
      "topUpUrl": null,
      "upgradeUrl": "/settings/billing"
    }
  }
}

The message text varies: when credits can cover the shortfall it offers them, and details.topUp and details.topUpUrl are set.

Was this page helpful?

Quota

More from Email Finder