Table of Contents

1. About The Project
2. Getting Started
3. Contributing
4. License
5. Contact

About The Project

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.

Phisherman.js was written as a utility package for my private bots, because I wanted a simple way to interface with the Phisherman API through a package, so I didn't have to worry about managing API routes, error handling, etc.

(back to top)

Getting Started

To get started, you'll need to install the package:

    npm install phisherman.js

You can obtain your API key by going to the Phisherman website and following the steps there to request a token.

Then, simply initalize the Phisherman client with your API key:

import {Client} from "phisherman.js";
const client = new Client('your-api-key-here');

To check a domain, you can use the checkDomain method:

client.checkDomain('unknown.test.phisherman.gg')
.then(result => {
    console.log(result);
})

See the documentation for more information about the methods available.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License. See LICENSE for more information.

(back to top)

Contact

Shadow - will@willshadow.com

Project Link: https://github.com/thewilloftheshadow/phisherman.js

(back to top)