Search Advanced

Queue an async mass unlock task for advanced search

Creates an asynchronous unlock Task for the given advanced filters. Returns a task_id you can poll with the task-status endpoint.

Concurrency limit

advanced / raw: max 2 concurrent tasks per user.
email / domain: max 5 concurrent tasks per user.
Returns 429 if limit exceeded.

post/search/advanced/unlock/task

Query parameters

maxinteger nullable

Optional cap of new unlocks.

list_idinteger nullable

Assign this list id to new unlocks.

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

Unlock task queued; returns a task_id to poll.

object required

Changes

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