# phishai

> Use Node to check for phising domains in PhisAI

Latest version **1.0.3** (published 2018-04-21) · ISC license · 0 weekly downloads

## Install

```sh
npm install phishai
pnpm add phishai
yarn add phishai
bun add phishai
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2018-04-21 |
| First published | 2018-04-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Carlos Polop |
| Maintainers | carlospolop |
| Keywords | api, phisai, phising, ai |

## Links

- npm: https://www.npmjs.com/package/phishai
- Repository: https://github.com/carlospolop-node-apis/node-phishai
- Homepage: https://github.com/carlospolop-node-apis/node-phishai#readme
- Issues: https://github.com/carlospolop-node-apis/node-phishai/issues
- npm.io page: https://npm.io/package/phishai

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.85.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2018-04-21
- 1.0.2 — 2018-04-21
- 1.0.1 — 2018-04-21
- 1.0.0 — 2018-04-21

## README

# Node PhisAI

Use Node to check for phising domains in [PhishAI](https://www.phish.ai)

## Install
`npm install phishai`

## How to use

```javascript
const phishai = require('phishai');

phishai.setApiKey("<YOUR API KEY>");

var id = "";

// Use checkDomain(<domain>) to check that domain against PhisAI
// A promise will be returned
var domain = "https://example.com"
phishai.checkDomain(domain).then(function(result){
    id = result.scan_id;
    console.log(result);
}, function(err) {
    console.log(err);
});

/*
Output example
{ scan_id: 'U2sG4AkxdHMlrIcT5O8L' }
*/

// Use checkId(<id>) to get the report of the Id
// A promise will be returned
phishai.checkId(id).then(function(result){ 
    console.log(result);
}, function(err) {
    console.log(err);
});

/*
Output example
{ url: 'https://example.com',
  status: 'in progress',
  time: '2018-04-21T09:40:53.199Z' }

{"url":"https://example.com",
"status":"completed",
"target":"unknown",
"iso_code":"US",
"title":"example_domain",
"user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/67.0.3372.0 Safari/537.36",
"user_email":"api",
"ip_address":"93.184.216.34",
"verdict":"clean",
"domain":"example.com",
"time":"2018-04-12T11:07:36.789Z",
"tld":"com"}
*/
```

---
_Source: https://npm.io/package/phishai · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._