[](https://github.com/plasticuproject/hibpwned/actions/workflows/tests.yml)
[](https://www.python.org/downloads/release/python-380/)
[](https://www.gnu.org/licenses/lgpl-3.0)
[](https://badge.fury.io/py/hibpwned)
[](https://pepy.tech/project/hibpwned)
[](https://coveralls.io/github/plasticuproject/hibpwned?branch=master)
[](https://github.com/plasticuproject/hibpwned/actions/workflows/codeql.yml)
[](https://sonarcloud.io/dashboard?id=plasticuproject_hibpwned)
[](https://sonarcloud.io/dashboard?id=plasticuproject_hibpwned)
# hibpwned
A friendly, low-level, fully functional, Python API wrapper for haveibeenpwned.com <br/>
All data sourced from https://haveibeenpwned.com <br/>
Visit https://haveibeenpwned.com/API/v3 to read the Acceptable Use Policy <br/>
for rules regarding acceptable usage of this API. <br/>
## Installation
```
pip install hibpwned
```
Making calls to the HIBP API requires a key. You can purchase an HIBP-API-Key at <br/>
https://haveibeenpwned.com/API/Key
## Usage
This module contains the class Pwned with functions: <br/>
search_all_breaches <br/>
all_breaches <br/>
single_breach <br/>
data_classes <br/>
search_pastes <br/>
search_password <br/>
search_hashes <br/>
All functions return a list of JSON objects containing relevent data, with the exception <br/>
of search_password and search_hashes, which returns an integer and a string object, <br/>
respectively. <br/>
See module DocStrings for function descriptions and parameters <br/>
## Examples
```python
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")
```
Raw data
{
"_id": null,
"home_page": "https://github.com/plasticuproject/hibpwned",
"name": "hibpwned",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "hibp,haveibeenpwned,api,wrapper",
"author": "plasticuproject",
"author_email": "plasticuproject@pm.me",
"download_url": "https://files.pythonhosted.org/packages/99/8b/ec09898251983daff9cedc5659064b9a2d89fe0d6e7f54d310e391d884d3/hibpwned-1.3.7.tar.gz",
"platform": null,
"description": "[](https://github.com/plasticuproject/hibpwned/actions/workflows/tests.yml)\n[](https://www.python.org/downloads/release/python-380/)\n[](https://www.gnu.org/licenses/lgpl-3.0)\n[](https://badge.fury.io/py/hibpwned)\n[](https://pepy.tech/project/hibpwned)\n[](https://coveralls.io/github/plasticuproject/hibpwned?branch=master)\n[](https://github.com/plasticuproject/hibpwned/actions/workflows/codeql.yml)\n[](https://sonarcloud.io/dashboard?id=plasticuproject_hibpwned)\n[](https://sonarcloud.io/dashboard?id=plasticuproject_hibpwned)\n# hibpwned\nA friendly, low-level, fully functional, Python API wrapper for haveibeenpwned.com <br/>\nAll data sourced from https://haveibeenpwned.com <br/>\nVisit https://haveibeenpwned.com/API/v3 to read the Acceptable Use Policy <br/>\nfor rules regarding acceptable usage of this API. <br/>\n\n\n## Installation\n```\npip install hibpwned\n```\nMaking calls to the HIBP API requires a key. You can purchase an HIBP-API-Key at <br/>\nhttps://haveibeenpwned.com/API/Key\n\n\n## Usage\nThis module contains the class Pwned with functions: <br/>\n\nsearch_all_breaches <br/>\nall_breaches <br/>\nsingle_breach <br/>\ndata_classes <br/>\nsearch_pastes <br/>\nsearch_password <br/>\nsearch_hashes <br/>\n\nAll functions return a list of JSON objects containing relevent data, with the exception <br/>\nof search_password and search_hashes, which returns an integer and a string object, <br/>\nrespectively. <br/>\n\nSee module DocStrings for function descriptions and parameters <br/>\n\n\n## Examples\n```python\nimport hibpwned\n\nmy_app = hibpwned.Pwned(\"test@example.com\", \"My_App\", \"My_API_Key\")\n\nmy_breaches = my_app.search_all_breaches()\nbreaches = my_app.all_breaches()\nadobe = my_app.single_breach(\"adobe\")\ndata = my_app.data_classes()\nmy_pastes = my_app.search_pastes()\npassword = my_app.search_password(\"BadPassword\")\nmy_hashes = my_app.search_hashes(\"21BD1\")\n```",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A human friendly Python API wrapper for haveibeenpwned.com",
"version": "1.3.7",
"project_urls": {
"Download": "https://github.com/plasticuproject/hibpwned/archive/v1.3.7.tar.gz",
"Homepage": "https://github.com/plasticuproject/hibpwned"
},
"split_keywords": [
"hibp",
"haveibeenpwned",
"api",
"wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "998bec09898251983daff9cedc5659064b9a2d89fe0d6e7f54d310e391d884d3",
"md5": "c844334c8c96dfc2cc126fb3db72d717",
"sha256": "f1a9f10281cf001349b74000cf0f37096bb8709012255fa5427b1b24a729b867"
},
"downloads": -1,
"filename": "hibpwned-1.3.7.tar.gz",
"has_sig": false,
"md5_digest": "c844334c8c96dfc2cc126fb3db72d717",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11216,
"upload_time": "2023-05-23T23:44:18",
"upload_time_iso_8601": "2023-05-23T23:44:18.244804Z",
"url": "https://files.pythonhosted.org/packages/99/8b/ec09898251983daff9cedc5659064b9a2d89fe0d6e7f54d310e391d884d3/hibpwned-1.3.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-23 23:44:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "plasticuproject",
"github_project": "hibpwned",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "hibpwned"
}
JSON
