Get Credits

Reveal credit balance and today's search budget.

GEThttps://api.foxreach.io/api/v1/lead-finder/credits

Requires an API key with the read scope.

Response#

dataobject

Credits and budget.

Show data

balanceinteger

Reveal credits available.

expiresAtstring

ISO 8601 timestamp of the nearest expiry, or null.

monthlyIncludedinteger

Credits the plan includes each month.

allowedCountriesarray

Alpha-2 codes searches may target. Empty means anywhere that is not blocked.

blockedCountriesarray

Alpha-2 codes that are never shown.

coveragestring

Where results come from, in words.

creditsPerPackinteger

Credits in one purchasable pack.

pricePerPackCentsinteger

Price of one pack in US cents.

searchPagesUsedTodayinteger

Search pages used today.

searchPagesAllowedTodayinteger

Search pages allowed today. Grows with reveals.

searchPagesPerRevealinteger

Extra search pages each reveal adds to today's allowance.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `read`
`404`	`Lead Finder is not enabled` while Lead Finder is switched off on this environment
`503`	`Lead Finder is not configured` when it is enabled but has no data provider key

Rate Limit#

100 requests per minute, per API key. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (unix epoch seconds).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.

Request

curl -X GET "https://api.foxreach.io/api/v1/lead-finder/credits" \
  -H "X-API-Key: otr_your_key"

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
credits = client.lead_finder.credits()

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const credits = await client.leadFinder.credits();

Response

{
  "data": {
    "balance": 99,
    "expiresAt": "2027-10-30T00:00:00+00:00",
    "monthlyIncluded": 100,
    "allowedCountries": [],
    "blockedCountries": ["DE", "FR"],
    "coverage": "every country",
    "creditsPerPack": 500,
    "pricePerPackCents": 950,
    "searchPagesUsedToday": 3,
    "searchPagesAllowedToday": 25,
    "searchPagesPerReveal": 5
  }
}

Was this page helpful?

View as MarkdownLast updated November 2, 2026