Skip to main content

A human friendly Python API wrapper for haveibeenpwned.com

Project description

Build Status License: LGPL v3 PyPI version Downloads

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

Uploaded Source

File details

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

File metadata

  • Download URL: hibpwned-1.1.6.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.7

File hashes

Hashes for hibpwned-1.1.6.tar.gz
Algorithm Hash digest
SHA256 7ca5e0bf79a16896ef109303f08be6b18a4981a5ef11238d46efa24c24eed045
MD5 77f8b3f21ae3751752a18de3464c1057
BLAKE2b-256 5ac2a86e86d92c1c783bab6a7c49e1955b74c74d8a8d51aebcc821b52ded3272

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