Skip to main content

Phish.AI API wrapper

Project description

https://img.shields.io/badge/License-MIT-blue.svg https://img.shields.io/badge/python-2.7%2B%203.5%2B-blue.svg

Summary

Official python API for Phish.AI public and private API to detect zero-day phishing websites

How it Works (TLDR)

Essentially we have a very big computer vision database of known websites and their legitimate domains. The API surf to a given website takes a screenshots of the website and then compare it with our database and if we detect that it is similar to a known website but hosted we classify it as malicious and classify the targeted brand (which website this site tries to mimic).

The Engine is in beta and doesn’t protect all brands yet. we make the database bigger every day, if you believe your brand is not in our database and you want us to crawl it, just drop me a line at yp@phish.ai

Privacy Policy

The full privacy policy is at: https://www.phish.ai/phish-ai-privacy-policy/. By using the Public API you agree to our Privacy Policy and allow us to share your submission with the security community. If you want a Private API Key please contact us at info@phish.ai.

Useful resources

Installation

$ pip install phish-ai-api

Usage

from __future__ import print_function
from phish_ai_api import API

ph = API(api_key='None or private api key you can request at info@phish.ai')
res = ph.scan_url('https://google.com')
print(res)
print(ph.get_report(res['scan_id']))

Output

{"scan_id": "pQz7bGMwxgzGboNyX8cy"}
{"domain": "google.com",
 "ip_address": "74.125.124.113",
 "iso_code": "US",
 "status": "completed",
 "target": "Google",
 "time": "2018-04-15T07:27:37.860Z",
 "title": "google",
 "tld": "com",
 "url": "http://google.com",
 "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/67.0.3391.0 Safari/537.36",
 "user_email": "api",
 "verdict": "clean"}

Issues & Contributing

Found a Bug/Have a feature request feel free to open an Issue and we will look into it. Cheers.

Project details


Release history Release notifications | RSS feed

This version

1.7

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

phish-ai-api-1.7.tar.gz (2.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

phish_ai_api-1.7-py2.py3-none-any.whl (2.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file phish-ai-api-1.7.tar.gz.

File metadata

  • Download URL: phish-ai-api-1.7.tar.gz
  • Upload date:
  • Size: 2.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for phish-ai-api-1.7.tar.gz
Algorithm Hash digest
SHA256 e690ab5b5a5bcbfeab7ad4e4f6ec48478f1f269e388d528ba365bf50afb6b9f6
MD5 5dc33aae9d2b85f6359900210a551195
BLAKE2b-256 dcc8a69dd2b1459ebef54c9b203a47d867b2507b080adaded3890f5384a932ef

See more details on using hashes here.

File details

Details for the file phish_ai_api-1.7-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for phish_ai_api-1.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 777e198a0e57dd8ebc3b4d53781c9fffe59e78cbc9c753f0e6b93f3ff58e7064
MD5 fef03f544662d7fba1ae3d15421cb57d
BLAKE2b-256 7c1c5e841ef7774c8aed5b5dbb50cb92024374a8430e6a2b384219039615f628

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