Description

With @sapphire/phisherman, you can have an out of the box integration with Phisherman. Phisherman is a centralised database of phishing and scam links. It is designed for use with Discord bots, allowing them to utilise the Phisherman API to cross-check URLs against our known phishing links.

Note: Phisherman is currently in early access. For more information or to request access, please visit their discord server.

Features

• Fully ready for TypeScript!
• Includes ESM ready entrypoint
• Easy to use

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @sapphire/phisherman

Usage

Note: While this section uses import, it maps 1:1 with CommonJS' require syntax. For example, import { checkDomain } from '@sapphire/phisherman' is the same as const { checkDomain } = require('@sapphire/phisherman').

Before you do anything make sure to set the apiKey like this:

import { setApiKey } from '@sapphire/phisherman';

setApiKey('your-api-key');

The main use you will have for phisherman is checking whether an URL is safe or not. You can do so with:

import { checkDomain } from '@sapphire/phisherman';

checkDomain('some-domain');

If you have an URL that didn't pass the check, but you are sure is actually a phishing site, you can use the following to report it to phisherman:

import { reportDomain } from '@sapphire/phisherman';

reportDomain('some-domain');

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Sapphire!