Skip to main content

Overview

Discovery utilities help users build safer searches before spending lookups on a large query. They are most useful when the user does not know the exact breach source name, supported field, or common value spelling. The current helper surface is centered around V2 breach autocomplete. These helpers return raw JSON, not the standard {success, data} envelope.

Value Autocomplete

Value autocomplete suggests likely values across supported breach fields. Use it for typeahead, field-specific suggestions, and “did you mean” UI before running a search.

DB Name Discovery

DB name discovery helps users choose the right source filter. It returns source suggestions plus the fields available in each source, which is useful before building strict filters or scanner query_config.

Field Coverage

Field coverage answers the inverse question: “which sources contain this field?” Use it when a workflow needs a field such as password_hash, phone, or username, but the user does not know which db names are relevant.

Original Helper

GET /service/dbname-autocomplete returns a plain string array. Prefer the V2 db-name autocomplete endpoint for new work because it includes counts and field coverage.

Breach Search

Use discovered fields and db names in actual searches

Structured Filters

Turn discovered values into reusable filter logic

Scanners

Use stable discovered filters for recurring monitoring

API Reference

Use OpenAPI for exact parameters, schemas, and playground requests