Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icanhasfay/PyPwned
A Python client for the HaveIBeenPwned REST API
https://github.com/icanhasfay/PyPwned
Last synced: 21 days ago
JSON representation
A Python client for the HaveIBeenPwned REST API
- Host: GitHub
- URL: https://github.com/icanhasfay/PyPwned
- Owner: icanhasfay
- License: mit
- Created: 2015-02-03T05:17:48.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-10-21T11:22:31.000Z (about 3 years ago)
- Last Synced: 2024-09-18T02:57:32.907Z (3 months ago)
- Language: Python
- Size: 13.7 KB
- Stars: 45
- Watchers: 4
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.rst
- License: LICENSE.rst
Awesome Lists containing this project
- awesome-hacking-lists - icanhasfay/PyPwned - A Python client for the HaveIBeenPwned REST API (Python)
README
PyPwned
======
[](https://travis-ci.org/icanhasfay/PyPwned)
A Python client for the HaveIBeenPwned REST API. https://haveibeenpwned.com/
Installation
-----
```pip install pypwned```
Requires
-----
* requests
* pyOpenSSL
* ndg-httpsclient
* pyasn1
Usage
-----
> Note: The below examples assume you have loaded the envrionment variable HIBP_API_KEY with your appropriate Have I Been Pwned API key.
More details here, https://haveibeenpwned.com/API/Key.
### Breaches
#### Getting all breaches for an account
##### Get all breaches for an account across all domains.
```
import pypwned, os
your_hibp_key = os.environ.get("HIBP_API_KEY")
pwny = pypwned.pwned(your_hibp_key)
pwny.getAllBreachesForAccount(email="[email protected]")
```
##### Get all breaches for an account across a specific domain.
```
import pypwned, os
your_hibp_key = os.environ.get("HIBP_API_KEY")
pwny = pypwned.pwned(your_hibp_key)
pwny.getAllBreachesForAccount(email="[email protected]",domain="adobe.com")
```
#### Getting all breached sites in the system
##### Return the details of each breach in the system.
```
import pypwned, os
your_hibp_key = os.environ.get("HIBP_API_KEY")
pwny = pypwned.pwned(your_hibp_key)
pwny.getAllBreaches()
```
##### Return the details of each breach associated with a specific domain.
```
import pypwned, os
your_hibp_key = os.environ.get("HIBP_API_KEY")
pwny = pypwned.pwned(your_hibp_key)
pwny.getAllBreaches(domain="adobe.com")
```
#### Getting a single breached site
Return the details of a single breach, by breach name.
```
import pypwned, os
your_hibp_key = os.environ.get("HIBP_API_KEY")
pwny = pypwned.pwned(your_hibp_key)
pwny.getSingleBreachedSite(name="adobe")
```
#### Getting all data classes in the system
Return the different types of data classes that are associated with a record in a breach. E.G, Email addresses and passwords
```
import pypwned, os
your_hibp_key = os.environ.get("HIBP_API_KEY")
pwny = pypwned.pwned(your_hibp_key)
pwny.getAllDataClasses()
```
### Pastes
#### Getting all pastes for an account
Return any pastes that contain the given email address
```
import pypwned, os
your_hibp_key = os.environ.get("HIBP_API_KEY")
pwny = pypwned.pwned(your_hibp_key)
pwny.getAllPastesForAccount(account="[email protected]")
```