Skip to main content

How do Reveal API and Enrich API limits work?

What counts towards your monthly API limits, where to see your usage and what happens when you reach a limit.

Written by Oskar Johnson Hägglund

The Reveal API and the Enrich API each have their own monthly limits. We set them when we create your API keys. They reset at the start of each month and are separate from your Companies limit for website visitors. See How does my Companies limit work?

Where to see your usage

Open the profile menu at the bottom left, click Settings, then API Keys. Only the Owner and Admins see this page.

  • The Overview tab shows Usage this Month under each API's keys: what you've used so far and your limit, for example 1200 / 5000.

  • The Usage tab has a bar chart per API, Reveal API — Monthly Usage and Enrich API — Monthly Usage, for this month and the two before it. Hover over a bar to see the numbers. Click a name in the legend to hide or show that bar.

What counts: Reveal API

The Reveal API has two meters on the Overview tab, each with its own limit:

  • Unique Visitors: the number of different IP addresses the API found a company for this month. An IP address counts once a month, however often you look it up. Lookups that don't find a company don't count here.

  • Number of Requests: every lookup this month, whether or not a company was found. Looking up the same IP address ten times counts ten times.

The Reveal script looks up the visitor on every page view, so a visitor who views five pages adds five requests but at most one unique visitor.

If we've given you extra lookups for the current month, the meter shows them as (incl. N temporary). They're added to your limit for this month only.

What counts: Enrich API

The Enrich API has one limit. Every domain lookup this month counts, whether or not a company was found. On the Overview tab it's shown as Enriched Companies.

On the Usage tab, the chart shows two bars per month: Number of Requests is the number your limit uses, and Enriched Companies is the number of different domains that returned a company.

When you reach a limit

Once a meter reaches its limit, that API refuses lookups until the next month starts. Your keys stay valid. Your code gets HTTP status 429 (Too Many Requests) with a message that the quota has been exceeded. Refused lookups don't count towards your usage.

For the Reveal API, the first meter to fill stops all lookups. If Number of Requests is full, lookups stop even when Unique Visitors still has room. If lookups are refused while neither meter is full, contact us.

To see how close you are, check the Overview tab now and then, or have your developer watch for 429 responses. A 429 from a limit doesn't go away by retrying, so code that retries on 429 should stop until the next month or until we raise your limit.

Getting a higher limit

Contact us via the chat or support@albacross.com. We can raise your monthly limits. For the Reveal API, we can also add extra lookups for the current month only.

Related

Did this answer your question?