Skip to main content

A human friendly Python API wrapper for haveibeenpwned.com

Project description

build Python 3.11 License: LGPL v3 PyPI version Downloads Coverage Status CodeQL Quality Gate Status Security Rating

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:

search_all_breaches
all_breaches
single_breach
data_classes
search_pastes
search_password
search_hashes

All functions return a list of JSON objects containing relevent data, with the exception
of search_password and search_hashes, which returns an integer and a string object,
respectively.

See module DocStrings for function descriptions and parameters

Examples

import hibpwned

my_app = hibpwned.Pwned("test@example.com", "My_App", "My_API_Key")

my_breaches = my_app.search_all_breaches()
breaches = my_app.all_breaches()
adobe = my_app.single_breach("adobe")
data = my_app.data_classes()
my_pastes = my_app.search_pastes()
password = my_app.search_password("BadPassword")
my_hashes = my_app.search_hashes("21BD1")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hibpwned-1.3.9.tar.gz (11.6 kB view hashes)

Uploaded Source

Built Distribution

hibpwned-1.3.9-py3-none-any.whl (11.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page