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 Domain Search API

Verify and search domains you control.

HaveIBeenPwned Domain Search 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 Domain Search. 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 5 operations across 5 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.

5 operations 5 paths 4 schemas 2 GET3 POST

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 Domain Search 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 5

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

Domain Search 5

Verify and search domains you control.

GET
/breacheddomain/{domain}
Get Breached Email Addresses For A Domain
getBreachedDomain 1 param → 200401403404
GET
/subscribeddomains
List Subscribed Domains
listSubscribedDomains → 200401
POST
/domainverification/generateDnsToken
Generate A DNS Verification Token
generateDnsToken body → 200
POST
/domainverification/verifyDnsToken
Verify A DNS Verification Token
verifyDnsToken body → 200
POST
/domainverification/sendEmail
Send A Domain Verification Email
sendDomainVerificationEmail body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SubscribedDomain (5 properties), Error (2 properties), DomainEmailVerificationRequest (2 properties), DomainVerificationRequest (1 property). Each schema is shown below with its type and property counts.

DomainEmailVerificationRequest
object
2 properties 2 required
SubscribedDomain
object
A domain monitored by the calling subscription.
5 properties 1 required
Error
object
Standard HIBP error payload.
2 properties 2 required
DomainVerificationRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haveibeenpwned-domain-search-api-openapi.yml Raw ↑

Other APIs HaveIBeenPwned publishes across the network.

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