HaveIBeenPwned Breached Accounts API
Lookup breaches affecting an email address.
HaveIBeenPwned Breached Accounts API is one of 8 APIs that HaveIBeenPwned publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 9 JSON Schema definitions.
Tagged areas include Breached Accounts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and 9 JSON Schemas.
This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.
Requests are made against a single base URL, https://haveibeenpwned.com/api/v3.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HaveIBeenPwned Breached Accounts API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as hibp-api-key (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— 32-character hexadecimal API key issued at https://haveibeenpwned.com/API/Key. Required for all account, paste, stealer log, domain search, and subscription en…
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Lookup breaches affecting an email address.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Breach (19 properties), BreachedAccountRangeEntry (2 properties), Error (2 properties), BreachName (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HaveIBeenPwned 7
Other APIs HaveIBeenPwned publishes across the network.