Skip to main content
GET
Searches the breach indexes for a value and returns every matching record in one request. The search is case-insensitive, except for passwords and hashes. This endpoint answers with the fast sources. The deep search, which covers more sources and can take a minute or longer, runs as a job: see Breach Search Job.
Records for the same query may come from a cache for up to 72 hours. Every request is counted and charged, whether or not its records came from the cache.

Parameters

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; set it for a name or a password, which can’t be told apart from a username.

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 lookup can continue at a per-lookup price charged to your balance (the module’s page in the dashboard shows the price). The price applies even when the lookup finds nothing; a lookup that fails because of an error on our side is not charged.

Example request

SDK example

The same request with the official SDKs. Each one reads your key from OSINTCAT_API_KEY.

Response

string
Always OsintCat.
number
Time the search took, in milliseconds.
string
When the search ran (UTC), e.g. Oct 6th 09:41.
string
The type the query was searched as (the type you sent, or the detected one).
number
Number of records in breach_data.
array
Matching records. The fields of a record depend on the breach it comes from (for example email, username, password, hash, ip, name, phone); source_db names the breach the record was found in, when it is known.
number
Only for type=password: how often the password appears in known breaches.
object
One entry per source that searched, by id (b1, b2, …): status (completed or error), count, and for an error a short error message. A source that failed doesn’t fail the request.
The endpoint for the deep search job, /api/breach/search.
object
Your usage after this request.

Errors

See Errors for the responses every endpoint can return.