### GET /search/raw/part

Source: https://docs.leakradar.io/openapi.json

Fetches the textual content for a specific raw entry block.

```APIDOC
## GET /search/raw/part

### Description
Fetch the textual content for a specific raw entry block. If the block is not unlocked, the content is censored unless `auto_unlock=true` succeeds.

### Method
GET

### Endpoint
/search/raw/part

### Parameters
#### Query Parameters
- **container_id** (integer) - Required - Container identifier.
- **entry_path** (string) - Required - Path of the entry inside the container.
- **seq** (integer) - Required - Block sequence number (0-based).
- **trim_overlap** (boolean) - Optional - When true, drop the overlapping prefix shared with the previous block, defaults to false.
- **overlap_chars** (integer) - Optional - Number of characters to trim when `trim_overlap=true`, defaults to 256, max 8192.
- **auto_unlock** (boolean) - Optional - Attempt to unlock the block using points when necessary, defaults to false.

### Response
#### Success Response (200)
- **part** (object) - Describes the block and its content.
  - **seq** (integer) - Sequence number of the part.
  - **content** (string) - The textual content of the part (possibly censored).
  - **unlocked** (boolean) - Whether the part was unlocked.

#### Response Example
```json
{
  "part": {
    "seq": 0,
    "content": "This is the content of the block.",
    "unlocked": true
  }
}
```
```

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

### Get File Info

Source: https://docs.leakradar.io/openapi.json

Fetches metadata for a specific raw entry within a container.

```APIDOC
## GET /container/file_info

### Description
Return the stored metadata for a raw entry located in the container tree.

### Method
GET

### Endpoint
/container/file_info

### Parameters
#### Query Parameters
- **container_id** (integer) - Required - Container Id
- **entry_path** (string) - Required - The full path to the entry.

### Response
#### Success Response (200)
- **file_info** (object) - Metadata of the file entry.
```

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

### Get File Info

Source: https://docs.leakradar.io/

Fetches metadata for a specific raw entry using its container ID and entry path.

```json
{
  "container_id": "string",
  "entry_path": "string",
  "entry_name": "string",
  "size_bytes": 0,
  "sha256_original": "string"

}
```

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

### GET /container/tree

Source: https://docs.leakradar.io/openapi.json

Lists entries located under a given prefix within a container.

```APIDOC
## GET /container/tree

### Description
List entries located under a given prefix within a container.

Pagination uses `page`/`page_size`.

### Method
GET

### Endpoint
/container/tree

### Parameters
#### Query Parameters
- **container_id** (integer) - Required - Container identifier.
- **prefix** (string) - Optional - The prefix to list entries under.
- **page** (integer) - Optional - Page number, defaults to 1.
- **page_size** (integer) - Optional - Number of results per page.

### Response
#### Success Response (200)
- **items** (array) - List of entries.
- **total** (integer) - Total number of entries.
- **page** (integer) - Current page number.
- **page_size** (integer) - Number of results per page.

#### Response Example
```json
{
  "items": [
    {
      "path": "/folder/file.txt",
      "type": "file",
      "size": 1024,
      "modified_at": "2023-10-27T10:00:00Z"
    }
  ],
  "total": 50,
  "page": 1,
  "page_size": 10
}
```
```

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

### Get User Preferences

Source: https://docs.leakradar.io/

Retrieves the authenticated user's current preferences. Defaults are applied if no preferences have been saved.

```json
{
  "hide_passwords": false
}
```

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

### GET /search/raw/parts

Source: https://docs.leakradar.io/openapi.json

Lists metadata about the blocks (parts) of a raw entry within a container.

```APIDOC
## GET /search/raw/parts

### Description
Return metadata about the blocks (parts) of a raw entry.

### Method
GET

### Endpoint
/search/raw/parts

### Parameters
#### Query Parameters
- **container_id** (integer) - Required - Container identifier.
- **entry_path** (string) - Required - Path of the entry inside the container.
- **page** (integer) - Optional - Pagination parameter, defaults to 1.
- **page_size** (integer) - Optional - Pagination parameter, defaults to 100, max 1000.

### Response
#### Success Response (200)
- **items** (array) - List of parts.
- **total** (integer) - Total number of parts.
- **page** (integer) - Current page number.
- **page_size** (integer) - Number of parts per page.
- **window** (object) - Optional - Window information.

#### Response Example
```json
{
  "items": [
    {
      "seq": 0,
      "size": 512,
      "unlocked": true
    }
  ],
  "total": 5,
  "page": 1,
  "page_size": 10,
  "window": {
    "start": 0,
    "end": 4
  }
}
```
```

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

### Get Domain Report PDF

Source: https://docs.leakradar.io/

Retrieves a PDF report for a specified domain. Ensure you have the correct domain and necessary authorization.

```bash
curl -X GET "https://api.leakradar.io/search/domain/{domain}/report/pdf" \
     -H "accept: application/pdf"
```

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

### JSON Response Sample for Email Search

Source: https://docs.leakradar.io/

An example of a successful response structure when searching for emails. The actual content will vary.

```json
[
  {
    "id": "string",
    "url": "string",
    "username": "string",
    "username_masked": "string",
    "password": "string",
    "password_strength": 0,
    "unlocked": false,
    "is_email": true,
    "added_at": "2019-08-24T14:15:22Z",
    "status": "string"
}

]
```

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

### Get File Info

Source: https://docs.leakradar.io/

Fetches metadata for a raw entry located in the container tree, identified by its container ID and entry path.

```APIDOC
## GET /container/file_info

### Description
Fetches metadata for a raw entry located in the container tree.

### Method
GET

### Endpoint
https://api.leakradar.io/container/file_info

### Parameters
#### Query Parameters
- **container_id** (integer) - Required - The ID of the container.
- **entry_path** (string) - Required - The path of the entry within the container.

### Responses
#### Success Response (200)
Entry metadata returned successfully.
- **container_id** (string) - The ID of the container.
- **entry_path** (string) - The path of the entry.
- **entry_name** (string) - The name of the entry.
- **size_bytes** (integer) - The size of the entry in bytes.
- **sha256_original** (string) - The SHA256 hash of the original file.

#### Error Responses
- **401** - Authentication required.
- **404** - Entry not found in the index.
- **422** - Validation Error.
- **500** - Search error.
```

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

### Get Domain Leak Report

Source: https://docs.leakradar.io/

Returns a domain leak report. In unauthenticated mode (`light=true`), it provides sampled counts. Authenticated users can get exact counts and password statistics (`light=false`). The `include_search_count` parameter can be enabled for recent search activity.

```json
{
  "employees_compromised": 0,
  "third_parties_compromised": 0,
  "customers_compromised": 0,
  "blacklisted_value": "string",
  "searched_by_count": 0

}
```

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

### Response Sample for List Raw File Downloads

Source: https://docs.leakradar.io/

This JSON response lists raw file downloads. It includes an array of download items, each with details like ID, file names, download tokens, size, creation date, and download URLs. It also provides pagination information and a blacklisted value.

```json
{
  "items": [
    {
      "id": 0,
      "raw_file_id": 0,
      "container_id": 0,
      "file_name": "string",
      "original_file_name": "string",
      "download_token": "string",
      "size_bytes": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "success": true,
      "download_url": "string",
      "expires_in": 0,
      "download_expires_at": "2019-08-24T14:15:22Z",
      "file_password": "string"
}
],
  "total": 0,
  "page": 0,
  "page_size": 0,
  "blacklisted_value": "string"

}
```

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

### Get User Profile

Source: https://docs.leakradar.io/openapi.json

Retrieves the profile of the authenticated user.

```APIDOC
## GET /profile

### Description
Return the profile of the authenticated user.

### Method
GET

### Endpoint
/profile

### Response
#### Success Response (200)
- **UserBase** (object) - User profile details.

#### Error Responses
- **401** - Unauthorized. Invalid or missing authentication token.
- **404** - User not found.
- **422** - Validation error: invalid request parameters.
- **429** - Too many requests: rate limit exceeded.
```

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

### Create Team Invitation Response (200 OK)

Source: https://docs.leakradar.io/

This is a sample successful response when an invitation is created. It includes details of the invitation sent.

```json
{
  "id": 0,
  "invited_email": "user@example.com",
  "invited_name": "string",
  "role": "string",
  "status": "string",
  "expires_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "invited_by": {
    "id": 0,
    "email": "user@example.com",
    "first_name": "string",
    "last_name": "string"
},
  "accepted_user_id": 0,
  "token": "string"

}
```

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

### Response Sample for Creating an Unlocked List

Source: https://docs.leakradar.io/

This is a sample JSON response after successfully creating an unlocked list. It returns the details of the newly created list, including its ID, name, color, timestamps, and an initial item count of 0.

```json
{
  "id": 0,
  "name": "string",
  "color": "string",
  "created_at": "string",
  "updated_at": "string",
  "items_count": 0

}
```

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

### List Parts Response Sample

Source: https://docs.leakradar.io/

This JSON response lists the parts of a reservation, including their part number, ETag, and size.

```json
{
  "reservation_id": 0,
  "parts": [
    {
      "part_number": 0,
      "etag": "string",
      "size": 0
}
]

}
```

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

### List immediate subfolders

Source: https://docs.leakradar.io/

Aggregates the immediate subfolders located under the provided prefix, supporting pagination.

```APIDOC
## GET /container/subfolders

### Description
Aggregate the immediate subfolders located under the provided prefix. Pagination is `page`/`page_size`. The server hides any cursor and handles deep paging internally.

### Method
GET

### Endpoint
https://api.leakradar.io/container/subfolders

### Parameters
#### Query Parameters
- **container_id** (integer) - Required - Container identifier.
- **prefix** (string) - Optional - Default: "" folder prefix, ex: 'db/users' ('' = root of container).
- **page** (integer) - Optional - Pagination parameter. Default: 1.
- **page_size** (integer) - Optional - Pagination parameter. Default: 100.

### Responses
#### Success Response (200)
Subfolders listed successfully.

#### Error Responses
- **401**: Authentication required.
- **422**: Validation Error.
- **500**: Search query failed.
```

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

### List Notifications Response Sample

Source: https://docs.leakradar.io/

This is a sample response structure for listing all notifications. It includes detailed information about each notification and its linked method.

```json
[
  {
    "id": 0,
    "type": "email",
    "value": "string",
    "second_value": "string",
    "headers": [
      {
        "name": "string",
        "value": "string"
}
],
    "timestamp": "2019-08-24T14:15:22Z"
}

]
```

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

### Get dark web statistics

Source: https://docs.leakradar.io/openapi.json

Returns overall statistics about the dark web index.

```APIDOC
## GET /search/dark-web/stats

### Description
Returns overall statistics about the dark web index.

### Method
GET

### Endpoint
/search/dark-web/stats

### Responses
#### Success Response (200)
- **stats** (DarkWebStatsResponse) - An object containing dark web statistics.

#### Error Responses
- **401** - Authentication required.
```

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

### Download Raw File

Source: https://docs.leakradar.io/openapi.json

Initiates the download of a specific raw file. This endpoint returns a temporary redirect to a presigned URL for the file. The download link is valid for a limited time and may expire or fail if the download is too old or was previously unsuccessful.

```APIDOC
## POST /profile/raw/downloads/{download_id}/file

### Description
Downloads a raw file through the platform. Returns a temporary redirect to a presigned URL for the raw file.

### Method
POST

### Endpoint
/profile/raw/downloads/{download_id}/file

### Parameters
#### Path Parameters
- **download_id** (integer) - Required - The ID of the download.
#### Query Parameters
- **token** (string or null) - Optional - A token for accessing the file.
```

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

### Get Unlocked Leaks

Source: https://docs.leakradar.io/openapi.json

Retrieves a paginated list of unlocked leaks with various filtering options.

```APIDOC
## GET /profile/unlocked

### Description
Retrieves a paginated list of unlocked leaks. Supports filtering by email domain, host, TLD, password strength, and date added. You can also force AND logic for filters.

### Method
GET

### Endpoint
/profile/unlocked

### Parameters
#### Query Parameters
- **email_domain** (array[string]) - Optional - Email domains to include.
- **email_domain_not** (array[string]) - Optional - Exclude email domains containing these values.
- **email_host** (array[string]) - Optional - Email host must contain.
- **email_host_not** (array[string]) - Optional - Exclude email hosts containing these values.
- **email_tld** (array[string]) - Optional - Email TLD(s) to include (multi).
- **email_tld_not** (array[string]) - Optional - Email TLD(s) to exclude (multi).
- **password_strength** (PasswordStrengthCategory-Input | null) - Optional - Filter by password strength category. too_weak = score 0-2, weak = 3-4, medium = 5-7, strong = 8+.
- **added_from** (date-time | null) - Optional - Only include leaks indexed on/after this UTC datetime.
- **added_to** (date-time | null) - Optional - Only include leaks indexed on/before this UTC datetime.
- **force_and** (boolean | null) - Optional - When true, values within each field are combined with AND instead of OR.

### Response
#### Success Response (200)
- **PaginatedUnlockedLeaksResponse** - Unlocked leaks returned successfully.

#### Error Response
- **401** - Authentication required.
- **422** - Validation Error
```

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

### Response Sample for Domain URL Export

Source: https://docs.leakradar.io/

This is a sample JSON response structure for a successful domain URL export request.

```json
{
  "items": [
    {
      "url": "string",
      "occurrences": 0
}
],
  "total": 0,
  "page": 0,
  "page_size": 0,
  "blacklisted_value": "string"

}
```

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

### Whoami Response (200)

Source: https://docs.leakradar.io/

Successful response for the GET /ingest/whoami endpoint, returning user identity information.

```json
{
  "id": 0,
  "email": "string",
  "display_name": "string",
  "is_uploader": true

}
```

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

### Part URL Response Sample

Source: https://docs.leakradar.io/

This JSON response provides a pre-signed URL for uploading a file part, along with its expiration time and part number.

```json
{
  "url": "string",
  "expires_in": 0,
  "part_number": 0

}
```

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

### List Notifications (GET /notifications)

Source: https://docs.leakradar.io/

Retrieves a list of all notifications for the authenticated user. Requires Bearer authentication.

```json
[
  {
    "id": 0,
    "method_id": 0,
    "type": "email",
    "second_type": "ALL",
    "value": "string",
    "filters": { },
    "last_searched_at": "2019-08-24T14:15:22Z",
    "is_active": true,
    "timestamp": "2019-08-24T14:15:22Z",
    "method_type": "email",
    "method_value": "string",
    "auto_unlock": true,
    "max_points": 0,
    "daily_spent": 0,
    "daily_reset_at": "2019-08-24T14:15:22Z",
    "total_notifications": 0,
    "total_cost": 0
  }

]
```

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

### Get Domain Report PDF

Source: https://docs.leakradar.io/

Generates a PDF report for a given domain. Requires appropriate authorization.

```APIDOC
## GET /search/domain/{domain}/report/pdf

### Description
Retrieves a PDF report for the specified domain.

### Method
GET

### Endpoint
https://api.leakradar.io/search/domain/{domain}/report/pdf

### Parameters
#### Path Parameters
- **domain** (string) - Required - The domain for which to generate the report.

### Responses
#### Success Response (200)
- **PDF report** - The generated PDF report for the domain.
#### Error Responses
- **400** - Bad request - invalid domain.
- **401** - Unauthorized.
- **404** - Domain not found or no data available.
- **422** - Validation Error
```

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

### Resolve Path Options

Source: https://docs.leakradar.io/

Resolves an entry path by hydrating all parent folder segments. Allows prefetching files and subfolders.

```json
{
  "container_id": 1,
  "entry_path": "",
  "options": {
    "prefetch_files": true,
    "max_subfolders": 1000,
    "file_page_size": 200,
    "prefetch_parts": {
      "seq": 0,
      "limit": 1
}
}

}
```

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

### Get User Preferences

Source: https://docs.leakradar.io/openapi.json

Retrieves the authenticated user's preferences. Defaults are applied if no preferences have been saved.

```APIDOC
## GET /profile/preferences

### Description
Return the authenticated user's preferences. Defaults are used when no preferences have been saved yet.

### Method
GET

### Endpoint
/profile/preferences

### Responses
#### Success Response (200)
- **Preferences returned.**
  - Schema: `#/components/schemas/UserPreferencesRead`

#### Error Responses
- **401** - Unauthorized.
```

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

### List Balance Logs

Source: https://docs.leakradar.io/openapi.json

Retrieves a paginated list of balance log entries (points and GB changes) for the authenticated user's account. Team members can view the owner's aggregated logs.

```APIDOC
## GET /profile/activities/balance-logs

### Description
Return a paginated list of balance log entries (points and GB changes) for the authenticated user's account.

Team members see the owner's aggregated logs.

### Method
GET

### Endpoint
/profile/activities/balance-logs

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number, defaults to 1.
- **page_size** (integer) - Optional - Number of items per page, defaults to 20, max 100.
- **order_by** (string) - Optional - Field to order by, defaults to 'created_at'.
- **order_dir** (string) - Optional - Direction of ordering (asc/desc), defaults to 'desc'.

### Responses
#### Success Response (200)
- **Balance logs returned successfully.**
  - Schema: `#/components/schemas/PaginatedResponse_BalanceLogItem_`

#### Error Responses
- **401** - Authentication required.
- **404** - Page out of range.
- **422** - Validation Error
```

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

### Create an Unlocked List

Source: https://docs.leakradar.io/

Creates a new list to organize your unlocked leaks. List names must be unique and are case-insensitive.

```APIDOC
## Create an Unlocked List 

Create a new list to organize your unlocked leaks.

##### Authorizations:
_BearerAuth_
##### Request Body schema: application/json
required
namerequired| string (Name)  [ 1 .. 80 ] characters   
---|---  
color| Color (string) or Color (null) (Color)   
### Responses
**200**
Successful Response
**422**
Validation Error
post/profile/unlocked/lists
Production API
https://api.leakradar.io/profile/unlocked/lists
###  Request samples 
  * Payload

Content type
application/json
Copy
`{
  * "name": "string",
  * "color": "string"

}`
###  Response samples 
  * 200
  * 422

Content type
application/json
Copy
`{
  * "id": 0,
  * "name": "string",
  * "color": "string",
  * "created_at": "string",
  * "updated_at": "string",
  * "items_count": 0

}`
```

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

### Get available dark web sources

Source: https://docs.leakradar.io/openapi.json

Returns a list of all scraped forum sources with their post counts.

```APIDOC
## GET /search/dark-web/sources

### Description
Returns a list of all scraped forum sources with their post counts.

### Method
GET

### Endpoint
/search/dark-web/sources

### Responses
#### Success Response (200)
- **sources** (DarkWebSourcesResponse) - A list of dark web sources and their post counts.

#### Error Responses
- **401** - Authentication required.
```

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

### Get Part URL for Ingest

Source: https://docs.leakradar.io/

Obtains a pre-signed URL for uploading a specific part of a file during the ingestion process.

```APIDOC
## POST /ingest/part-url

### Description
Generates a pre-signed URL to upload a specific part of a file during the multi-part ingestion process.

### Method
POST

### Endpoint
/ingest/part-url

### Parameters
#### Request Body
- **reservation_id** (integer) - Required - The ID of the file reservation.
- **part_number** (integer) - Required - The number of the part to upload (1 to 10000).
- **content_length** (integer) - Required - The size of the part in bytes (greater than 0).

### Request Example
```json
{
  "reservation_id": 0,
  "part_number": 1,
  "content_length": 0
}
```

### Responses
#### Success Response (200)
Successful Response. Returns an object with the upload URL, expiration time, and part number.

#### Response Example (200)
```json
{
  "url": "string",
  "expires_in": 0,
  "part_number": 0
}
```

#### Error Responses
- **422** Validation Error
```

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

### Get Statistics

Source: https://docs.leakradar.io/

Retrieves statistics for leaks, raw lines, and dark web posts. Supports Bearer authentication.

```APIDOC
## GET /stats

### Description
Retrieves statistics for leaks, raw lines, and dark web posts.

### Method
GET

### Endpoint
https://api.leakradar.io/stats

### Responses
#### Success Response (200)
Statistics returned successfully.
- **leaks** (object) - Statistics related to leaks.
  - **total** (integer)
  - **today** (integer)
  - **per_week** (array)
  - **this_week** (integer)
  - **this_month** (integer)
- **raw_lines** (object) - Statistics related to raw lines.
  - **total** (integer)
  - **today** (integer)
  - **per_week** (array)
  - **this_week** (integer)
  - **this_month** (integer)
- **dark_web_posts** (object) - Statistics related to dark web posts.
  - **total** (integer)

### Response Example
```json
{
  "leaks": {
    "total": 0,
    "today": 0,
    "per_week": [],
    "this_week": 0,
    "this_month": 0
  },
  "raw_lines": {
    "total": 0,
    "today": 0,
    "per_week": [],
    "this_week": 0,
    "this_month": 0
  },
  "dark_web_posts": {
    "total": 0
  }
}
```
```

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

### Browse the container tree

Source: https://docs.leakradar.io/

Lists entries located under a given prefix within a container, supporting pagination.

```APIDOC
## GET /container/tree

### Description
List entries located under a given prefix within a container. Pagination uses `page`/`page_size`.

### Method
GET

### Endpoint
https://api.leakradar.io/container/tree

### Parameters
#### Query Parameters
- **container_id** (integer) - Required - Container identifier.
- **prefix** (string) - Optional - Default: "" folder prefix, ex: 'db/users' ('' = root of container).
- **page** (integer) - Optional - Pagination parameter. Default: 1.
- **page_size** (integer) - Optional - Pagination parameter. Default: 200.

### Responses
#### Success Response (200)
Entries listed successfully.

#### Error Responses
- **401**: Authentication required.
- **422**: Validation Error.
- **500**: Search query failed.
```

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

### Download Raw File

Source: https://docs.leakradar.io/

Generates a pre-signed URL for downloading a raw file. Requires either sha256_original or a combination of container_id and entry_path. An optional expires_in parameter can set the URL's validity period.

```APIDOC
## POST /raw/download

### Description
Generates a pre-signed URL for downloading a raw file. Requires either sha256_original or a combination of container_id and entry_path. An optional expires_in parameter can set the URL's validity period.

### Method
POST

### Endpoint
https://api.leakradar.io/raw/download

### Query Parameters
- **sha256_original** (string | null) - Sha256 Original
- **container_id** (integer | null) - Container Id
- **entry_path** (string | null) - Entry Path
- **expires_in** (integer) - Expires In [ 60 .. 3600 ] Default: 900

### Request Body schema
application/json
- **PayloadPayload** (any) - additional property

### Request Example
```json
null
```

### Responses
#### Success Response (200)
Pre-signed URL generated successfully.
- **url** (string)
- **expires_in** (integer)
- **file_name** (string)
- **size_bytes** (integer)
- **mime** (string)
- **already_unlocked** (boolean)
- **downloaded_before** (boolean)

#### Response Example (200)
```json
{
  "url": "string",
  "expires_in": 900,
  "file_name": "string",
  "size_bytes": 0,
  "mime": "string",
  "already_unlocked": false,
  "downloaded_before": false
}
```

#### Error Responses
- **400** Missing or invalid identifier.
- **401** Authentication required.
- **402** Insufficient GB quota to unlock the file.
- **404** File not found.
- **422** Validation Error
- **500** Storage or search error.
```

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

### Get Container Subfolders

Source: https://docs.leakradar.io/

Retrieves a list of subfolders within a specified container, with options for pagination and filtering by prefix.

```APIDOC
## GET /container/subfolders

### Description
Retrieves a list of subfolders within a specified container.

### Method
GET

### Endpoint
https://api.leakradar.io/container/subfolders

### Parameters
#### Query Parameters
- **container_id** (integer) - Required - The ID of the container.
- **prefix** (string) - Optional - A folder prefix to filter subfolders. Defaults to "" (root).
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **page_size** (integer) - Optional - The number of items per page. Defaults to 1000. Maximum is 100000.

### Responses
#### Success Response (200)
Subfolders aggregated successfully.
- **items** (array) - List of subfolder names.
- **total** (integer) - Total number of subfolders.
- **page** (integer) - Current page number.
- **page_size** (integer) - Items per page.
- **has_more** (boolean) - Indicates if there are more pages.
- **container_id** (string) - The ID of the container.
- **prefix** (string) - The prefix used for the query.

#### Error Responses
- **401** - Authentication required.
- **422** - Validation Error.
- **500** - Aggregation failed.
```

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

### List Notification Methods

Source: https://docs.leakradar.io/openapi.json

Retrieves all notification methods configured for the current account.

```APIDOC
## GET /notification_methods

### Description
Return all notification methods configured for the current account.

**Method types**
- `email`
- `slack` (Incoming Webhook URL)
- `telegram` (`value` = bot token, `second_value` = chat_id)
- `webhook` (generic HTTP webhook)
- `discord` (Discord Webhook URL)

**Response**
Array of objects with `id`, `type`, `value`, `second_value`, `timestamp`.

### Method
GET

### Endpoint
/notification_methods

### Response
#### Success Response (200)
- **items** (array[NotificationMethodOut]) - List of notification methods.

### Errors
- 401 Authentication required.
```

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

### List Balance History API Response Sample

Source: https://docs.leakradar.io/

This JSON structure represents a paginated list of balance log entries, including points and GB changes for the account. Team members see aggregated logs.

```json
{
  "items": [
    {
      "id": 0,
      "user_id": 0,
      "user_email": "string",
      "kind": "string",
      "delta_total": 0,
      "delta_subscription": 0,
      "delta_extra": 0,
      "reason": "string",
      "metadata": { },
      "created_at": "2019-08-24T14:15:22Z"
}
],
  "total": 0,
  "page": 0,
  "page_size": 0,
  "blacklisted_value": "string"
}
```

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

### Get Container Subfolders

Source: https://docs.leakradar.io/

Retrieves aggregated subfolders for a given container ID and optional prefix. Supports pagination.

```json
{
  "items": [
    "string"
],
  "total": 0,
  "page": 0,
  "page_size": 0,
  "has_more": true,
  "container_id": "string",
  "prefix": "string"
}
```

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

### Download Raw File

Source: https://docs.leakradar.io/

Initiates the download of a specific raw file using its download ID. This endpoint provides a temporary redirect to a presigned URL for the file.

```APIDOC
## POST /profile/raw/downloads/{download_id}/file

### Description
Downloads a raw file via a temporary redirect to a presigned URL.

### Method
POST

### Endpoint
https://api.leakradar.io/profile/raw/downloads/{download_id}/file

### Parameters
#### Path Parameters
- **download_id** (integer) - Required - The ID of the download.

#### Query Parameters
- **token** (string) - Optional - The download token.

### Responses
#### Success Response (307)
Temporary redirect to a presigned URL for the raw file.

#### Error Response (401)
Authentication is required.

#### Error Response (404)
Download not found or raw file unavailable.

#### Error Response (410)
Download expired or previous attempt failed. Unlock the file again to regenerate access.

#### Error Response (422)
Validation Error
```

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

### Get Notification Stats

Source: https://docs.leakradar.io/openapi.json

Retrieves monitored assets usage and limits (plan + extra assets) at the account level.

```APIDOC
## GET /notification_stats

### Description
Return monitored assets usage and limits (plan + extra assets) at account level.

### Method
GET

### Endpoint
/notification_stats

### Response
#### Success Response (200)
- `NotificationStatsResponse` (object) - Stats returned successfully.

#### Error Response (401)
- Authentication required.
```

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

### List Container Subfolders

Source: https://docs.leakradar.io/openapi.json

Aggregates immediate subfolders under a given prefix within a container, with support for deep paging.

```APIDOC
## GET /container/subfolders

### Description
Aggregates the immediate subfolders located under the provided prefix.

Pagination is `page`/`page_size`. The server hides any cursor and handles deep paging internally.

Uniform response: { items, total, page, page_size } + has_more.

### Method
GET

### Endpoint
/container/subfolders

### Parameters
#### Query Parameters
- **container_id** (integer) - Required - Container Id
- **prefix** (string) - Optional - folder prefix ('' for root)
- **page** (integer) - Optional - Page
- **page_size** (integer) - Optional - Page Size

### Response
#### Success Response (200)
- **items** (array) - List of subfolder names.
- **total** (integer) - Total number of subfolders.
- **page** (integer) - Current page number.
- **page_size** (integer) - Number of items per page.
- **has_more** (boolean) - Indicates if there are more subfolders available.
```

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

### Get Statistics

Source: https://docs.leakradar.io/openapi.json

Retrieves the cached snapshot of service statistics. If statistics are not available in the cache, a message indicating this will be returned.

```APIDOC
## GET /stats

### Description
Return the cached service statistics snapshot. If stats are not available in cache, the endpoint returns `{ "message": "Stats not available" }`.

### Method
GET

### Endpoint
/stats

### Responses
#### Success Response (200)
- **Statistics returned successfully.**
  - Schema: `anyOf: [{ "$ref": "#/components/schemas/StatsResponse" }, { "$ref": "#/components/schemas/StatsUnavailableResponse" }]`
```

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

### Create Notification (POST /notifications)

Source: https://docs.leakradar.io/

Creates a new notification. Supports email, domain, and advanced types. For email and domain types, bulk creation is possible by setting `bulk=true` and providing newline-separated values.

```json
{
  "method_id": 0,
  "type": "email",
  "value": "string",
  "filters": { },
  "auto_unlock": true,
  "max_points": 0,
  "second_type": "ALL",
  "bulk": false

}
```

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

### Get a single dark web post by ID

Source: https://docs.leakradar.io/openapi.json

Returns the full content of a dark web post without truncation.

```APIDOC
## GET /search/dark-web/post/{post_id}

### Description
Returns the full content of a dark web post without truncation.

### Method
GET

### Endpoint
/search/dark-web/post/{post_id}

### Parameters
#### Path Parameters
- **post_id** (string) - Required - The post ID (document _id).

### Responses
#### Success Response (200)
- **post** (object) - The full content of the dark web post.
```

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

### List Notification Methods

Source: https://docs.leakradar.io/

Returns all notification methods configured for the current account. Supports Bearer authentication.

```APIDOC
## GET /notification_methods

### Description
Returns all notification methods configured for the current account.

### Method
GET

### Endpoint
https://api.leakradar.io/notification_methods

### Responses
#### Success Response (200)
Notification methods listed successfully.
- **id** (string)
- **type** (string) - Possible values: `email`, `slack`, `telegram`, `webhook`, `discord`.
- **value** (string)
- **second_value** (string) - Used for `telegram` (chat_id).
- **timestamp** (string, date-time) - Format: 2019-08-24T14:15:22Z

#### Error Responses
- **401** Authentication required.

### Response Example (200)
```json
[
  {
    "id": "string",
    "type": "string",
    "value": "string",
    "second_value": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
]
```
```