# Get Credits

> Reveal credit balance and today's search budget.

Requires an API key with the `read` scope.

## Response

<ResponseField name="data" type="object">
  Credits and budget.

  <Expandable title="data">
    <ResponseField name="balance" type="integer">Reveal credits available.</ResponseField>
    <ResponseField name="expiresAt" type="string">ISO 8601 timestamp of the nearest expiry, or `null`.</ResponseField>
    <ResponseField name="monthlyIncluded" type="integer">Credits the plan includes each month.</ResponseField>
    <ResponseField name="allowedCountries" type="array">Alpha-2 codes searches may target. Empty means anywhere that is not blocked.</ResponseField>
    <ResponseField name="blockedCountries" type="array">Alpha-2 codes that are never shown.</ResponseField>
    <ResponseField name="coverage" type="string">Where results come from, in words.</ResponseField>
    <ResponseField name="creditsPerPack" type="integer">Credits in one purchasable pack.</ResponseField>
    <ResponseField name="pricePerPackCents" type="integer">Price of one pack in US cents.</ResponseField>
    <ResponseField name="searchPagesUsedToday" type="integer">Search pages used today.</ResponseField>
    <ResponseField name="searchPagesAllowedToday" type="integer">Search pages allowed today. Grows with reveals.</ResponseField>
    <ResponseField name="searchPagesPerReveal" type="integer">Extra search pages each reveal adds to today's allowance.</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
```bash cURL
curl -X GET "https://api.foxreach.io/api/v1/lead-finder/credits" \
  -H "X-API-Key: otr_your_key"
```

```python Python SDK (beta)
from foxreach import FoxReach

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

```typescript TypeScript SDK (beta)
import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const credits = await client.leadFinder.credits();
```
</RequestExample>

<ResponseExample>
```json
{
  "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
  }
}
```
</ResponseExample>

## 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 |

<Note>
  Credit packs can only be bought in the dashboard. There is no API route for purchasing credits.
</Note>

## 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](/rate-limiting).