Phish-Scanner

For security information on this package, please refer to the SECURITY.md file.

---

This package supports both ESM and CommonJS.

To use this package with ESM, please refer to the snippet below:

import { scan } from "phish-scanner";

const keys {}

const phishScanner = PhishScanner(link, keys);

// this returns a promise, so you can use async/await or .then()

if (phishscanner) {
  // this is a phish link, do something
}

To use this package with CommonJS, please refer to the snippet below:

const { scan } = require("phish-scanner");

const keys {}

const phishScanner = PhishScanner(link, keys);

// this returns a promise, so you can use async/await or .then()

if (phishscanner) {
  // this is a phish link, do something
}

---

This is the bare minimum with this package, and will call several APIs that have open endpoints. However, for the most accurate results, you should use your own API keys for some services we use.

We use the following services as our bare minimum:

• 1st Party It's Phishy API
• Walshy
• SinkingYahts
• More being discovered every day!

You can get these keys from the following services:

• Phisherman
• Google Safe Browsing
• urlscan.io
• VirusTotal
• CheckPhish
• IpQualityScore
• More to come soon!

To provide your own keys, add them to the keys object like so:

const keys = {
  googleSafeBrowsing: "Your Google Safe Browsing key here",
  phisherman: "Your Phisherman key here",
  urlScan: "Your urlscan.io key here",
  virusTotal: "Your VirusTotal key here",
  checkPhish: "Your CheckPhish key here",
  ipQualityScore: "Your IpQualityScore key here",
};

this will then automaticaly enable these services during the scan.

---