/haveibeenpwned/breaches

POST /api/haveibeenpwned/breaches

Price: 1 credit

Get a data breach record by its name

How to use it

Get the full Have I Been Pwned record for a single data breach by its name (e.g. 'Adobe', 'LinkedIn'). Returns the breach title, affected domain, breach date, dates it was added to and last modified in HIBP, the number of compromised accounts, a description, logo image, source attribution, disclosure url, the list of compromised data classes (e.g. email addresses, passwords), and status flags (verified, fabricated, sensitive, retired, spam list, malware, subscription-free, stealer log).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• name string required — Breach name (also accepts a haveibeenpwned.com/breach/{Name} URL) (examples: "Adobe", "LinkedIn"; minLength: 1)

Response

• @type string (default: "HaveibeenpwnedBreach")
• name string required
• breach_title string nullable
• domain string nullable
• breach_date string nullable
• added_at string nullable
• modified_at string nullable
• pwn_count integer nullable
• description string nullable
• image string nullable
• attribution string nullable
• disclosure_url string nullable
• data_classes array (default: [])
• is_verified boolean (default: false)
• is_fabricated boolean (default: false)
• is_sensitive boolean (default: false)
• is_retired boolean (default: false)
• is_spam_list boolean (default: false)
• is_malware boolean (default: false)
• is_subscription_free boolean (default: false)
• is_stealer_log boolean (default: false)
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Breach not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.