Search Email

Search leaks by email or username

Search for leaks associated with a specific email or username. Provide the search payload in the JSON body.

Pagination

  • page starts at 1.
  • page_size is 1 to 100 (default 100).

Access and visibility

  • If your plan includes email_search, full URLs and item IDs are returned.
  • Otherwise URLs are redacted except for the first 10 items per page and IDs are omitted.
  • Credentials are returned only when unlocked=true and your plan includes email_search.

Auto-unlock Pass auto_unlock=true to automatically unlock locked items on the current page. Points are consumed per newly unlocked item. If insufficient points, partial unlock is performed. The response field auto_unlock_points_consumed indicates how many points were used.

Response EmailSearchResponse with items, total, total_unlocked, page, page_size.

Special case: if email is a full SHA-1 (40 hex chars, no '@'), search is done on username_hash exactly.

post/search/email

Request

Query parameters

pageinteger

Page number (starts at 1).

page_sizeinteger

Items per page (1–100, default 100).

auto_unlockboolean

Automatically unlock locked items on the current page using your points.

Request body

emailstring required

Email or username to search.

searchstring nullable

Optional free-text filter.

is_emailboolean nullable

Identifier type filter: true=email only, false=username only, null=both.

Example request

{
  "email": "john.doe@example.com",
  "is_email": true
}

Response

Search results successfully returned.

totalinteger required

Total number of matching leak records.

total_unlockedinteger required

Number of already-unlocked records in the total results.

pageinteger required

Current page number.

page_sizeinteger required

Number of items per page.

blacklisted_valuestring nullable

If a filter value matched a blacklist entry, this field contains the matched value.

auto_unlock_points_consumedinteger nullable

Number of points consumed by auto-unlock on this request.

Example response

{
  "items": [
    {
      "added_at": "2025-01-15T10:30:00Z",
      "id": "3f1a9c2b7e",
      "is_email": true,
      "password": "P@ssw0rd123",
      "password_strength": 6,
      "status": "new",
      "unlocked": true,
      "url": "https://example.com/login",
      "username": "john.doe@example.com"
    }
  ],
  "page": 1,
  "page_size": 10,
  "total": 1,
  "total_unlocked": 1
}

Changes

No recorded changes to this operation across all 13 revisions of this API.