2.0.1 β€’ Published 10 months ago

@sapphire/phisherman v2.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
10 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.8490b4d9

10 months ago

2.0.2-next.ba915f93

10 months ago

2.0.2-next.78b93032

10 months ago

2.0.2-next.79db3048

10 months ago

2.0.2-next.d8701971

10 months ago

2.0.2-next.624d18f9

10 months ago

2.0.2-next.24be195f

10 months ago

2.0.2-next.4b7c3e6c

10 months ago

2.0.2-next.bb6c8891

10 months ago

2.0.2-next.09afdaab

10 months ago

2.0.2-next.c419bda5

10 months ago

2.0.2-next.9b2d985c

10 months ago

2.0.2-next.143375f7

10 months ago

2.0.2-next.0cb1b7f1

10 months ago

2.0.2-next.5ac3f246

10 months ago

2.0.2-next.72e50e85

10 months ago

2.0.2-next.78c5a5bb

10 months ago

2.0.2-next.0dce7d63

10 months ago

2.0.2-next.a6c8ccda

10 months ago

2.0.2-next.d8c5d05d

10 months ago

2.0.2-next.403a3afe

11 months ago

2.0.2-next.1e7d2dec

11 months ago

2.0.2-next.809c41ce

11 months ago

2.0.2-next.74c9ef24

11 months ago

2.0.2-next.acf54294

11 months ago

2.0.2-next.caddeb87

11 months ago

2.0.2-next.70feaf69

11 months ago

2.0.2-next.574c09c3

12 months ago

2.0.2-next.19790b8e

12 months ago

2.0.2-next.8627eb32

12 months ago

2.0.2-next.a133f01a

12 months ago

2.0.2-next.b913810f

12 months ago

2.0.2-next.b97b30cd

12 months ago

2.0.2-next.fc35dd86

12 months ago

2.0.2-next.86dab688

12 months ago

2.0.2-next.63feeab8

12 months ago

2.0.2-next.855b323f

12 months ago

2.0.2-next.6100b95e

12 months ago

2.0.1

2 years ago

2.0.0

2 years ago

1.4.2

2 years ago

1.4.1

3 years ago

1.4.0

3 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