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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file hibpwned-1.3.9.tar.gz.

File metadata

  • Download URL: hibpwned-1.3.9.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for hibpwned-1.3.9.tar.gz
Algorithm Hash digest
SHA256 60b18d77ee81e47c84e013cd68184b3b420e71dc7a9df371bd7723ae6e8e72a6
MD5 d4c8a938753b4465371b0e3bf3777861
BLAKE2b-256 791db94ec77b1cfd6e4e0ad4a532afe9cd58b049e691efabca382bbab9b017cf

See more details on using hashes here.

File details

Details for the file hibpwned-1.3.9-py3-none-any.whl.

File metadata

  • Download URL: hibpwned-1.3.9-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for hibpwned-1.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 3dee5d1f8a701ae1d8e986a23ec0bdf0c19e196a844079a1adbd1dc714893fe2
MD5 ba7c33d59cd5f87113f1cc79ab77bc7c
BLAKE2b-256 0cd71cd561379d6b65c384b3631bb89a6a6fc8e7fdfaa5530af8a8d19e0fdd8c

See more details on using hashes here.

Supported by

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