2.0.1 β€’ Published 7 months ago

@sapphire/phisherman v2.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

Sapphire Logo

@sapphire/phisherman

Wrapper around Phisherman to easily check and report domains

GitHub codecov npm bundle size npm

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.

Donate WithAddress
Open CollectiveClick Here
Ko-fiClick Here
PatreonClick Here
PayPalClick Here

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

2.0.2-next.ff2c792d

12 months ago

2.0.2-next.5d7bdbbc

11 months ago

2.0.2-next.6f485e71

11 months ago

2.0.2-next.15bf4d53

12 months ago

2.0.2-next.5da72061

12 months ago

2.0.2-next.548200f1

11 months ago

2.0.2-next.156b9b1c

11 months ago

2.0.2-next.c73fb3fc

12 months ago

2.0.2-next.0f753b92

12 months ago

2.0.2-next.42db0795

11 months ago

2.0.2-next.61eebdff

11 months ago

2.0.2-next.318b047f

11 months ago

2.0.2-next.ab1708e3

11 months ago

2.0.2-next.bc2f01ce

10 months ago

2.0.2-next.a0809c46

11 months ago

2.0.2-next.014a7928

11 months ago

2.0.2-next.9f0e31f6

11 months ago

2.0.2-next.598c24a3

11 months ago

2.0.2-next.87bbf48f

10 months ago

2.0.2-next.246fc0d6

11 months ago

2.0.2-next.ec05fe56

12 months ago

2.0.2-next.51415597

11 months ago

2.0.2-next.8a922c42

11 months ago

2.0.1

2 years ago

2.0.0

2 years ago

1.4.2

2 years ago

1.4.1

4 years ago

1.4.0

4 years ago

1.3.1

4 years ago

1.3.0

4 years ago

1.2.0

4 years ago

1.1.0

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago