Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HaveIBeenPwned Breaches API

Browse breach metadata in the HIBP corpus.

HaveIBeenPwned Breaches 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 Breaches. 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 3 operations across 3 paths, and defines 1 schema. 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.

3 operations 3 paths 1 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://haveibeenpwned.com/api/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

HaveIBeenPwned Breaches 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 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Breaches 3

Browse breach metadata in the HIBP corpus.

GET
/breaches
Get All Breaches In The System
listBreaches 2 params → 200
GET
/breach/{name}
Get A Single Breach By Name
getBreachByName 1 param → 200404
GET
/latestbreach
Get The Most Recently Added Breach
getLatestBreach → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Breach (19 properties). Each schema is shown below with its type and property counts.

Breach
object
Full metadata record describing a breach in HIBP.
19 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haveibeenpwned-breaches-api-openapi.yml Raw ↑

Other APIs HaveIBeenPwned publishes across the network.

HaveIBeenPwned Breached Accounts API
HaveIBeenPwned Data Classes API
HaveIBeenPwned Domain Search API
HaveIBeenPwned Pastes API
HaveIBeenPwned Range Search API
HaveIBeenPwned Stealer Logs API
HaveIBeenPwned Subscription API