LeakCheck API v2 Pro

https://wiki.leakcheck.io/en/api/api-v2-pro
Admin
LeakCheck API v2 Pro offers a fast, REST-compliant interface for querying extensive databases of...
Tokens:1,240
Snippets:4
Trust Score:9.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Sample Unsuccessful API Query Response (LeakCheck v2 Pro)

Source: https://wiki.leakcheck.io/en/api/api-v2-pro/index

This JSON structure illustrates a query to the LeakCheck API v2 Pro where no data was found. It indicates success, zero results, and the remaining quota.

```json
{
    "success": true,
    "found": 0,
    "quota": 400,
    "result": []
}
```

--------------------------------

### Sample Successful API Query Response (LeakCheck v2 Pro)

Source: https://wiki.leakcheck.io/en/api/api-v2-pro/index

This JSON structure represents a successful query to the LeakCheck API v2 Pro where data was found. It includes success status, the number of results, remaining quota, and detailed information about the found records.

```json
{
    "success": true,
    "found": 1,
    "quota": 400,
    "result": [
        {
            "email": "example@example.com",
            "source": {
                "name": "BreachedWebsite.net",
                "breach_date": "2019-07",
                "unverified": 0,
                "passwordless": 0,
                "compilation": 0
            },
            "first_name": "Example",
            "last_name": "Example",
            "username": "leakcheck",
            "fields": ["first_name", "last_name", "username"]
        }
    ]
}
```

--------------------------------

### API Authorization Header

Source: https://wiki.leakcheck.io/en/api/api-v2-pro/index

This snippet demonstrates how to include the 'X-API-Key' header for authenticating requests to the LeakCheck API v2 Pro. Ensure you replace 'YOUR_API_KEY' with your actual API key.

```http
Accept: application/json
X-API-Key: 8cb2237d0679ca88db6464eac60da96345513964
```

--------------------------------

### API v2 Pro - Query Endpoint

Source: https://wiki.leakcheck.io/en/api/api-v2-pro/index

This endpoint allows you to search for data breaches associated with a given query. You can specify the search type using the `type` query parameter.

```APIDOC
## GET /api/v2/query/{query}

### Description
Searches for data breaches associated with the provided query. The search type can be automatically detected or explicitly set via the `type` query parameter.

### Method
GET

### Endpoint
`/api/v2/query/{query}`

### Parameters
#### Path Parameters
- **query** (string) - Required - The value to search for (e.g., email, username, phone number, hash).

#### Query Parameters
- **type** (string) - Optional - The type of data to search for. Allowed values: `auto`, `email`, `domain`, `keyword`, `username`, `phone`, `hash`, `phash` (Enterprise only), `origin` (Enterprise only), `password` (Enterprise only).
- **limit** (integer) - Optional - The maximum number of results to return (default is 100, max is 1000).
- **offset** (integer) - Optional - The number of results to skip (max is 2500).

### Request Example
```
GET https://leakcheck.io/api/v2/query/example@example.com?type=email&limit=10
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **found** (integer) - The number of records found.
- **quota** (integer) - The number of remaining queries on your account.
- **result** (array) - An array of objects, where each object contains details about a data breach.
  - **email** (string) - The email address associated with the breach.
  - **source** (object) - Information about the data source.
    - **name** (string) - The name of the breached website or service.
    - **breach_date** (string) - The date of the breach.
    - **unverified** (integer) - Flag indicating if the breach is unverified.
    - **passwordless** (integer) - Flag indicating if the breach is passwordless.
    - **compilation** (integer) - Flag indicating if the breach is a compilation.
  - **first_name** (string) - The first name found in the breach.
  - **last_name** (string) - The last name found in the breach.
  - **username** (string) - The username found in the breach.
  - **dob** (string) - Date of birth.
  - **address** (string) - Address.
  - **zip** (string) - Zip code.
  - **phone** (string) - Phone number.
  - **password** (string) - Password found in the breach.
  - **fields** (array) - A list of fields available for this record.

#### Response Example (Data Found)
```json
{
    "success": true,
    "found": 1,
    "quota": 400,
    "result": [
        {
            "email": "example@example.com",
            "source": {
                "name": "BreachedWebsite.net",
                "breach_date": "2019-07",
                "unverified": 0,
                "passwordless": 0,
                "compilation": 0
            },
            "first_name": "Example",
            "last_name": "Example",
            "username": "leakcheck",
            "fields": ["first_name", "last_name", "username"]
        }
    ]
}
```

#### Response Example (No Data Found)
```json
{
    "success": true,
    "found": 0,
    "quota": 400,
    "result": []
}
```

### Error Handling
- **401**: Missing X-API-Key header
- **400**: Invalid X-API-Key, Invalid type, Invalid email, Invalid query, Invalid domain, Too short query (< 3 characters), Invalid characters in query
- **429**: Too many requests
- **403**: Active plan required, Limit reached
- **422**: Could not determine search type automatically
```
Tokens:
Raw