> ## Documentation Index
> Fetch the complete documentation index at: https://docs.enrichley.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Check Credits

> Check available credits for the authenticated Enrichley user.

# Check Credits

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

## Endpoint

```http theme={null}
GET /me
Host: api.enrichley.io
```

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

```text theme={null}
https://api.enrichley.io/api/v1
```

## Authentication

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

```http theme={null}
X-Api-Key: YOUR_API_KEY
```

You can find your API key on your [profile page](https://app.enrichley.io/profile) after [signing up](https://app.enrichley.io/sign-up) for a paid plan.

## Response

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

```json theme={null}
{
  "credits": 999999
}
```

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, `1700000000000`).
* `x-credits-remaining` – Number of credits remaining on your account after this request (for example, `999999`).

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


## OpenAPI

````yaml GET /me
openapi: 3.0.0
info:
  title: Enrichley API
  version: 1.0.0
  description: >-
    API for verifying email addresses (including catch-all domains) and
    enriching LinkedIn profile URLs.
servers:
  - url: https://api.enrichley.io/api/v1
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /me:
    get:
      tags:
        - Credits
      summary: Check Credits
      description: Check available credits for the authenticated user.
      operationId: checkCredits
      responses:
        '200':
          description: Successful credits retrieval.
          headers:
            x-ratelimit-limit:
              description: >-
                Maximum number of requests allowed in the current rate limit
                window.
              schema:
                type: integer
                example: 100
            x-ratelimit-remaining:
              description: Number of requests remaining in the current rate limit window.
              schema:
                type: integer
                example: 99
            x-ratelimit-reset:
              description: >-
                Unix timestamp in milliseconds when the current rate limit
                window resets.
              schema:
                type: integer
                format: int64
                example: 1700000000000
            x-credits-remaining:
              description: Number of credits remaining on your account after this request.
              schema:
                type: integer
                example: 999999
          content:
            application/json:
              schema:
                type: object
                properties:
                  credits:
                    type: integer
                    description: Total remaining credits for the authenticated account.
                required:
                  - credits
              example:
                credits: 999999
        '401':
          description: Invalid or missing API key.
        '429':
          description: Rate limit exceeded.
        '500':
          description: Server error.
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

````