# ubiquiti-unifi

> Library for accessing the unifi network equipment

Latest version **1.0.0** (published 2016-12-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install ubiquiti-unifi
pnpm add ubiquiti-unifi
yarn add ubiquiti-unifi
bun add ubiquiti-unifi
```

## 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.0 |
| Published | 2016-12-15 |
| First published | 2016-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^6.3.1 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Daniel H Moran |
| Maintainers | danielheth |
| Keywords | unifi, network |

## Links

- npm: https://www.npmjs.com/package/ubiquiti-unifi
- Repository: https://github.com/danielheth/ubiquiti-unifi
- Homepage: https://github.com/danielheth/ubiquiti-unifi#readme
- Issues: https://github.com/danielheth/ubiquiti-unifi/issues
- npm.io page: https://npm.io/package/ubiquiti-unifi

## Dependencies (1)

- [got](https://npm.io/package/got.md) ^6.3.0

## Recent versions

- 1.0.0 (latest) — 2016-12-15
- 0.1.2 — 2016-12-15

## README

# ubiquiti-unifi
[![CircleCI](https://circleci.com/gh/danielheth/ubiquiti-unifi.svg?style=svg)](https://circleci.com/gh/danielheth/ubiquiti-unifi) [![Coverage Status](https://coveralls.io/repos/github/danielheth/ubiquiti-unifi/badge.svg)](https://coveralls.io/github/danielheth/ubiquiti-unifi)

> Library for accessing the unifi network equipment


## Install

Currently, the module is written on Node 6, without any transpilers, using the
ES2015+ features.

``` sh
npm install --save ubiquiti-unifi
```

## Usage

``` javascript
const ubiquitiUnifi = require('ubiquiti-unifi')
const options = {
  username: '',
  password: '',
  port: 8443,
  url: 'https://127.0.0.1',
  site: 'default',
  ignoreSsl: false
}

ubiquitiUnifi(options)
  .then(router =>
    Promise.all([router.getAccessPoints(), router.getClients()])
  .then(([accessPoints, clients]) => {
    console.log(accessPoints, clients)
  })
```

## API

### ubiquitiUnifi(options)

Returns a `Promise` with the Router API

#### options

##### username

Type: `string`

Username for the Router API

##### password

Type: `string`

Password for the Router API


##### port (default:`8443`)

Type: `number`

Port for the Router API


##### url (default:`https://127.0.0.1`)

Type: `string`

URL for the Router API

##### site (default:`default`)

Type: `string`

The site setting for the Router API

##### ignoreSsl (default:`false`)

Type: `boolean`

Ignore SSL warnings, for instance when accessing router API that uses a self signed certificate.

## License

MIT © Daniel H Moran

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