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

# Get Credits

> Check remaining credits for your API key

Check the remaining credit balance for your API key. This endpoint returns your current credit count and last top-up timestamp without consuming any credits.

## Get Credits

```bash theme={null}
curl -X GET "https://search.clado.ai/api/credits" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response

The endpoint returns a JSON object with your credit information:

```json theme={null}
{
  "credits": 150,
  "last_topup_at": "2024-01-15T10:30:00Z"
}
```

### Response Fields

| Field           | Type           | Description                                            |
| --------------- | -------------- | ------------------------------------------------------ |
| credits         | integer        | Number of credits remaining in your account            |
| last\_topup\_at | string or null | ISO 8601 timestamp of your last credit purchase/top-up |

### Examples

**Check Credits:**

```bash theme={null}
curl -X GET "https://search.clado.ai/api/credits" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

**Example Response:**

```json theme={null}
{
  "credits": 247,
  "last_topup_at": "2024-01-15T10:30:00Z"
}
```

## Error Responses

| Status Code | Description                                       |
| ----------- | ------------------------------------------------- |
| 401         | Unauthorized - API key missing or invalid         |
| 404         | Not Found - Unable to retrieve credit information |
| 500         | Internal Server Error - Credit service error      |

## Notes

* This endpoint is **free** - no credits are consumed
* `last_topup_at` will be `null` if no credits have been purchased
* Use this endpoint to check balance before making credit-consuming API calls


## OpenAPI

````yaml GET /api/credits
openapi: 3.1.0
info:
  title: Clado Search & Enrichment API
  description: API for searching LinkedIn profiles and enriching contact information
  version: 1.0.0
servers:
  - url: https://search.clado.ai
    description: Production server
security:
  - bearerAuth: []
paths:
  /api/credits:
    get:
      tags:
        - Platform
      summary: Get Credits
      description: >-
        Check remaining credits for your API key. This endpoint is free and
        returns your current credit balance.
      operationId: getCredits
      responses:
        '200':
          description: Credits information retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditsResponse'
        '401':
          description: Unauthorized - API key missing or invalid
        '404':
          description: Not Found - Unable to retrieve credit information
        '500':
          description: Internal Server Error - Credit service error
components:
  schemas:
    CreditsResponse:
      type: object
      properties:
        credits:
          type: integer
          description: Number of credits remaining in your account
        last_topup_at:
          type: string
          nullable: true
          description: ISO 8601 timestamp of your last credit purchase/top-up
      required:
        - credits
      example:
        credits: 247
        last_topup_at: '2024-01-15T10:30:00Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Keys start with 'lk_'.

````