Have I Been Pwned Breach API
The Breach API from Have I Been Pwned — 1 operation(s) for breach.
Have I Been Pwned Breach API is one of 16 APIs that Have I Been Pwned publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Breach. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.
Requests are made against 2 base URLs: https://haveibeenpwned.com/api/v3, https://api.pwnedpasswords.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Have I Been Pwned Breach API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as hibp-api-key (HibpApiKey).
HibpApiKey— HIBP API key passed in the hibp-api-key header. Paid APIs require a 32-character hexadecimal value. On supported test-only endpoints, any 32-character hexadeci…
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Breach (19 properties), Error (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Have I Been Pwned 12
Other APIs Have I Been Pwned publishes across the network.