Check Credits

The Check Credits endpoint lets you see how many Enrichley credits you have remaining, along with important rate limit information.

Endpoint

GET /me
Host: api.enrichley.io

This endpoint uses the same base URL as the rest of the Enrichley API:

https://api.enrichley.io/api/v1

All requests must include your API key in the X-Api-Key header:

X-Api-Key: YOUR_API_KEY

You can obtain your API key from the Enrichley app after signing up for a paid plan.

On success, the endpoint returns a JSON body with your remaining credits:

{
  "credits": 374259
}

In addition, a number of HTTP response headers convey rate limit and credit information:

x-ratelimit-limit – Maximum number of requests allowed in the current rate limit window (for example, 100).
x-ratelimit-remaining – Number of requests remaining in the current window (for example, 99).
x-ratelimit-reset – Unix timestamp (milliseconds) when the current window resets (for example, 1764176855000).
x-credits-remaining – Number of credits remaining on your account after this request (for example, 374259).

These headers are also modeled in the OpenAPI specification so you can inspect them directly in the API playground and in client SDKs.

X-Api-Key

string

header

required

Successful credits retrieval.

credits

integer

required

Total remaining credits for the authenticated account.