https://github.com/opsdisk/pyisitphish
A Python API client for interacting with the isitphish API.
https://github.com/opsdisk/pyisitphish
Last synced: 6 months ago
JSON representation
A Python API client for interacting with the isitphish API.
- Host: GitHub
- URL: https://github.com/opsdisk/pyisitphish
- Owner: opsdisk
- License: gpl-3.0
- Created: 2021-03-11T01:47:39.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-06-09T22:11:03.000Z (9 months ago)
- Last Synced: 2025-08-14T13:46:36.908Z (6 months ago)
- Language: Python
- Size: 27.3 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# isitphish API Client
A Python API client for interacting with the isitphish API (). Comments, suggestions, and
improvements are always welcome. Be sure to follow [@opsdisk](https://twitter.com/opsdisk) on Twitter for the latest
updates.
## Installation
```bash
git clone https://github.com/opsdisk/pyisitphish.git
cd pyisitphish
virtualenv -p python3.7 .venv # If using a virtual environment.
source .venv/bin/activate # If using a virtual environment.
pip install -r requirements.txt
```
## Update Credentials
If using a secrets file, create/update the `secrets.json` file with the host and API key. See the usage section
on how to pass a secrets dictionary.
```bash
cp secrets_empty.json secrets.json
```
```json
{
"isitphish": {
"host": "api.isitphish.com",
"token": "1234...abcd"
}
}
```
## Usage
### Script
```bash
python isitphish.py -u https://phishbarrel.com
```
### Module
```python
import isitphish
# Pass a secrets file.
full_path_to_secrets_file_location="/home/user/secrets.json"
iip_client = isitphish.IsItPhishClient(secrets_file_location=full_path_to_secrets_file_location)
iip_client.retrieve_url_score("https://phishbarrel.com")
# Pass a secrets dictionary.
secrets_dict = {
"isitphish": {
"host": "api.isitphish.com",
"token": "1234...abcd"
}
}
iip_client = isitphish.IsItPhishClient(secrets_dict=secrets_dict)
iip_client.retrieve_url_score("https://phishbarrel.com")
```