Skip to content

About

Independent API documentation sample for the Have I Been Pwned API v3: a Getting Started guide and an endpoint reference, verified against the live API.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

35 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

Have I Been Pwned API v3: Documentation Sample

Independent documentation for the free, key-less endpoints of the Have I Been Pwned API v3, written and verified by Georgia Lainiotis.

This is a portfolio project. It is not affiliated with or endorsed by Have I Been Pwned or Troy Hunt. Breach and data class information comes from Have I Been Pwned and is used under the Creative Commons Attribution 4.0 International License. See Attribution in the Overview.

Start here

Read the pages in this order:

  1. Overview: scope, authentication, the required header, and response codes.
  2. Getting Started: a five-minute walkthrough that gets a new developer to a working request with no account or API key.
  3. Get a Single Breach: full field-by-field reference for the breach-lookup endpoint.
  4. Get All Data Classes: reference for the data-category endpoint.
  5. Check a Password (Pwned Passwords Range API): reference for the k-anonymity password-check endpoint.
  6. Changelog: version history for the documentation itself.

How it was verified

Every example was tested against the live API. Where the vendor's published documentation differs from what the API actually returns, the difference is noted on the relevant page.

About the author

Technical writer for SaaS, cybersecurity, and financial services products: API references, getting-started guides, how-to guides, and SOPs, written docs-as-code in Markdown with Git and GitHub. Writes and reviews documentation in English, Portuguese, Greek, and Spanish.

Portfolio: Georgia Lainiotis — Technical Writer

Other writing samples: a how-to guide, How to Verify a Business Customer's Legal Entity Identifier (LEI), and an SOP, Contributing Documentation Changes Through a GitHub Pull-Request Workflow.

© 2026 Georgia Lainiotis. All rights reserved.

About

Independent API documentation sample for the Have I Been Pwned API v3: a Getting Started guide and an endpoint reference, verified against the live API.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors