Search Advanced

Search leaks with advanced filters (JSON body)

Search leaked credentials using any combination of fields defined in LeakSearchFilters.

Pagination: page ≥ 1, page_size in [1, 1 000] (default 100).

Access: If your plan includes advanced_search, full URLs and item IDs are returned; otherwise redacted.

Rate limit: 5 requests per second per user.

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.


Filter limits:

ConstraintValue
Max values per filter field50
Min characters per value (default)3
Min characters for url_scheme, url_tld, email_tld2
Min characters for username_hash, password_hash4
Max characters per string value100
Max characters for url_scheme20
Max characters for url_tld, email_tld10
post/search/advanced

Query parameters

pageinteger

Page number (starts at 1).

Page number (starts at 1).

page_sizeinteger

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

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

auto_unlockboolean

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

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

Request body

usernamestring[] nullable

Username values to match.

username_notstring[] nullable

Username values to exclude.

username_match_type'contains' | 'starts_with' | 'ends_with'
username_not_match_type'contains' | 'starts_with' | 'ends_with'
passwordstring[] nullable

Password values to match.

password_notstring[] nullable

Password values to exclude.

password_match_type'contains' | 'starts_with' | 'ends_with'
password_not_match_type'contains' | 'starts_with' | 'ends_with'
urlstring[] nullable

URL values to match.

url_notstring[] nullable

URL values to exclude.

url_match_type'contains' | 'starts_with' | 'ends_with'
url_not_match_type'contains' | 'starts_with' | 'ends_with'
url_domainstring[] nullable

URL domain values to match.

url_domain_notstring[] nullable

URL domain values to exclude.

url_domain_match_type'contains' | 'starts_with' | 'ends_with'
url_domain_not_match_type'contains' | 'starts_with' | 'ends_with'
url_hoststring[] nullable

URL host values to match.

url_host_notstring[] nullable

URL host values to exclude.

url_host_match_type'contains' | 'starts_with' | 'ends_with'
url_host_not_match_type'contains' | 'starts_with' | 'ends_with'
username_hashstring[] nullable

Username SHA-1 hash prefix (hex).

password_hashstring[] nullable

Password SHA-1 hash prefix (hex).

url_schemestring[] nullable

URL scheme(s) to include (multi).

url_scheme_notstring[] nullable

URL scheme(s) to exclude (multi).

url_portinteger[] nullable

URL port(s) to include (multi).

url_port_notinteger[] nullable

URL port(s) to exclude (multi).

url_tldstring[] nullable

URL TLD(s) to include (multi).

url_tld_notstring[] nullable

URL TLD(s) to exclude (multi).

is_emailboolean nullable

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

email_domainstring[] nullable

Email domain values to match.

email_domain_notstring[] nullable

Email domain values to exclude.

email_domain_match_type'contains' | 'starts_with' | 'ends_with'
email_domain_not_match_type'contains' | 'starts_with' | 'ends_with'
email_hoststring[] nullable

Email host values to match.

email_host_notstring[] nullable

Email host values to exclude.

email_host_match_type'contains' | 'starts_with' | 'ends_with'
email_host_not_match_type'contains' | 'starts_with' | 'ends_with'
email_tldstring[] nullable

Email TLD(s) to include (multi).

email_tld_notstring[] nullable

Email TLD(s) to exclude (multi).

password_strength'too_weak' | 'weak' | 'medium' | 'strong'
added_fromstring date-time nullable

Only include leaks indexed on/after this UTC datetime.

added_tostring date-time nullable

Only include leaks indexed on/before this UTC datetime.

force_andboolean nullable

When true, require all values within each field (AND within field).

Example request

{
  "password": [
    "123456"
  ],
  "url_domain": [
    "example.com"
  ]
}

Response

Search results returned successfully.

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"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.