Skip to main content
POST
Starts a breach search across every source, including the deep search, which Breach Lookup leaves out because it can take a minute or longer. The answer comes at once with a job id; poll GET /api/breach/search/{id} until status is completed. Records appear while the sources answer.
Records for the same query may come from a cache for up to 72 hours. Every search is counted and charged; polling a job is free.

Body

string
required
What to search for: an e-mail address, username, domain, IP address, name, phone number, hash or password.
string
What query is: email, username, password, name, domain, ip, hash or phone. Detected from the query when left out.
boolean
default:"true"
false leaves the deep search out (then a phone search has no source and is refused).

Headers

string
required
Your API key.

Usage

Available on paid plans and pay as you go. Counts as one lookup against your plan’s daily allowance (Max: unlimited). When the allowance is used up, the search can continue at a per-lookup price charged to your balance. The price applies even when the search finds nothing; a search where every source fails is not charged.
The answer, HTTP 202:
string
The job id.
string
running.
string
The type the query is searched as.
array
The ids of the sources searching (b1, b2, …).
string
The path to poll, /api/breach/search/{id}.
object
Your usage after this request (plan, lookups_left), as on Breach Lookup.
GET https://www.osintcat.net/api/breach/search/{id} with the same X-API-KEY. Only the key that started a job can read it; a job is kept for 30 minutes. Polling is free; a few seconds between polls is plenty.
string
The job id.
string
running while sources are still searching, then completed.
string
The type the query is searched as.
number
Number of records in breach_data so far.
array
Matching records from every source that has answered; source_db names the breach when it is known.
number
Only for type=password: how often the password appears in known breaches.
object
One entry per source by id: status (pending, completed or error), count, and for an error a short error message.

Errors

403 with upgrade_required on the free plan; 400 with invalid_query or invalid_type for a missing query or an unknown type; 404 for a job that doesn’t exist, expired, or was started by another key. See Errors for the responses every endpoint can return.