Skip to main content

A human friendly Python API wrapper for haveibeenpwned.com

Project description

Build Status Python 3.7 License: LGPL v3 PyPI version Downloads Coverage Status Language grade: Python 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:

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

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.2.2.tar.gz (7.5 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: hibpwned-1.2.2.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.6.7

File hashes

Hashes for hibpwned-1.2.2.tar.gz
Algorithm Hash digest
SHA256 06b2673ce43dd54b6976bdb23ae5a82a4c873527df14a207141629f46477900d
MD5 c06a8a43f4b29c682d9c3405919dbcb5
BLAKE2b-256 aec4e6afc893fb5e8ec647f291375bd9352ba50921865f751910286b669d553a

See more details on using hashes here.

Supported by

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