A human friendly Python API wrapper for haveibeenpwned.com


Keywords
hibp, haveibeenpwned, api, wrapper, api-v3, binding, breach, infosec, python, security
License
GPL-3.0
Install
pip install hibpwned==1.1.9

Documentation

Build Status License: LGPL v3 PyPI version Downloads Coverage Status

hibpwned

A friendly, low-level, fully functional, Python API wrapper for haveibeenpwned.com
All data sourced from https://haveibeenpwned.com
Visit https://haveibeenpwned.com/API/v3 to read the Acceptable Use Policy
for rules regarding acceptable usage of this API.

Installation

pip install hibpwned

Making calls to the HIBP API requires a key. You can purchase an HIBP-API-Key at
https://haveibeenpwned.com/API/Key

Usage

This module contains the class Pwned with functions:

searchAllBreaches
allBreaches
singleBreach
dataClasses
searchPastes
searchPassword
searchHashes

All functions return a JSON object containing relevent data, with the exception
of searchPassword and searchHashes, which returns an integer and a string object,
respectively.

See module DocStrings for function descriptions and parameters

Examples

import hibpwned

myApp = hibpwned.Pwned('test@example.com', 'My_App', 'My_API_Key')

myBreaches = myApp.searchAllBreaches()
Breaches = myApp.allBreaches()
adobe = myApp.singleBreach('adobe')
data = myApp.dataClasses()
myPastes = myApp.searchPastes()
password = myApp.searchPassword('BadPassword')
myHashes = myApp.searchHashes('21BD1')