# nudity-filter

> Realtime nudity detection API. Moderate and filter user-generated images. This is the official client for the Sightengine API.

Latest version **0.1.2** (published 2014-12-01) · 0 weekly downloads

## Install

```sh
npm install nudity-filter
pnpm add nudity-filter
yarn add nudity-filter
bun add nudity-filter
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2014-12-01 |
| First published | 2014-12-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Sightengine |
| Maintainers | davidlis |
| Keywords | moderation, image, nudity, filter, photo |

## Links

- npm: https://www.npmjs.com/package/nudity-filter
- npm.io page: https://npm.io/package/nudity-filter

## Dependencies (2)

- [node-fs](https://npm.io/package/node-fs.md) 0.x
- [request](https://npm.io/package/request.md) 2.x

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2014-12-01
- 0.1.1 — 2014-12-01
- 0.1.0 — 2014-12-01

## README

# Sightengine nudity detection - Nudity filter for images

Use the [Sightengine nudity API](http://sightengine.com) to instantly moderate adult content in user-submitted photos.



## Installation

    npm install nudity-filter


## Instructions

1. Create an account on http://sightengine.com, you will get your own `API_USER` and `API_SECRET` values
2. Import the Sightengine package

    var SightengineClient = require ('./sightengine');

3. Initialize the Client with your `API_USER` and `API_SECRET` values

    var Sightengine = new SightengineClient(API_USER, API_SECRET);

4. Moderate your images using either `Sightengine.checkNudityForURL` or `Sightengine.checkNudityForFile`. See the example below.



## Example


### Initialize

    // Set your API_USER and API_SECRET values here. See http://sightengine.com to create your account
    var API_USER = "";
    var API_SECRET = "";

    var SightengineClient = require ('./sightengine');
    var Sightengine = new SightengineClient(API_USER, API_SECRET);


### Moderate an image available over HTTP

    var imageurl = "http://url.to/image.jpg";
    Sightengine.checkNudityForURL(imageurl, function(error, result) {
      if(error) console.dir(error);
      else console.log(result);
    });


### Moderate an image available on the local filesystem

    var imagepath = "/path/to/image.jpg";
    Sightengine.checkNudityForFile(imagepath, function(error, result) {
      if(error) console.dir(error);
      else console.log(result);
    });



## More information

See [Sightengine's website](http://sightengine.com)

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