syapi-node

1.0.7 • Public • Published

syapi-node

npm dependents install size Downloads NPM Version run on repl.it

syapi-node is a Node.js package for detecting phishing websites. It uses a combination of machine learning algorithms and blacklist checks to determine if a given URL is likely to be a phishing website.

Installation

To install syapi-node, simply use npm:

npm install syapi-node

Usage

To use syapi-node, first import the Client class:

const { Client } = require('syapi-node');

Then, create a new instance of the Client class:

const api = new Client();

To check if a URL is a phishing website, use the fetchDomain method:

api.fetchDomain("https://example.com").then(function (response) {
console.log(response);
});

The fetchDomain method returns a Promise that resolves with an object containing the following properties:

  • isPhishing: A boolean value indicating whether or not the URL is a phishing website.
  • confidence: A number between 0 and 1 indicating the confidence level that the URL is a phishing website. Higher values indicate higher confidence.
  • blacklist: An array of strings containing the names of any blacklists that the URL appears on. If the URL does not appear on any blacklists, this property will be an empty array.

License

syapi-node is licensed under the MIT License. See the LICENSE file for more information.

Package Sidebar

Install

npm i syapi-node

Weekly Downloads

0

Version

1.0.7

License

MIT

Unpacked Size

3.9 kB

Total Files

3

Last publish

Collaborators

  • tyler09456