# poparazzi-private-api
> An open source implementation of the Poparazzi private Web API.
Latest version **0.2.3** (published 2022-06-21) · Apache-2.0 license · 0 weekly downloads
## Install
```sh
npm install poparazzi-private-api
pnpm add poparazzi-private-api
yarn add poparazzi-private-api
bun add poparazzi-private-api
```
## Health
**Score 20/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities.
Warnings: low downloads; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.2.3 |
| Published | 2022-06-21 |
| First published | 2022-05-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 117.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Max Rodriguez |
| Maintainers | max-rodriguez |
| Keywords | poparazzi, client, api, implementation, sdk |
## Links
- npm: https://www.npmjs.com/package/poparazzi-private-api
- Repository: https://github.com/Max-Rodriguez/poparazzi-private-api
- Issues: https://github.com/Max-Rodriguez/poparazzi-private-api/issues
- npm.io page: https://npm.io/package/poparazzi-private-api
## Dependencies (2)
- [ws](https://npm.io/package/ws.md) ^8.8.0
- [node-fetch](https://npm.io/package/node-fetch.md) 2.6.7
## Alternatives
- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads
## Recent versions
- 0.2.3 (latest) — 2022-06-21
- 0.2.2 — 2022-06-02
- 0.2.1 — 2022-05-31
- 0.2.0 — 2022-05-29
- 0.1.1 — 2022-05-28
## README
# poparazzi-private-api
   
### An open source implementation of the Poparazzi Web API, written in TypeScript.
#### Join our Discord community server via this [invite link](https://discord.gg/ywvvGuBKxT).
# Installation
Installing using _NPM_
```
npm install poparazzi-private-api
```
Installing using _Yarn_
```
yarn add poparazzi-private-api
```
# Getting Started
Take a look at examples for using the package [here.](examples/)
Below is the simplest and fastest way to authenticate to Poparazzi using the package.
```typescript
import * as Poparazzi from 'poparazzi-private-api';
;(async () => {
// Run the built-in terminal login prompt
const client = new Poparazzi.Client({ interactive_login: true });
client.set_event({ login_success: async () => {
console.log(`Logged into Poparazzi!`);
await client.end_session(); // Logout from Poparazzi
}});
client.set_event({ logout: async () => {
console.log("Logged out of Poparazzi.");
}});
})();
```
# Documentation
For more detailed information on all the package features, please see the package [docs](docs/README.md).
Every single enum, interface, class object and methods are fully documented there.
# Contributing
If you would like to implement a new feature or fix a bug, feel free to create a pull request!
API and SDK documentation also make very useful contributions, so if you are good at - please do so!
Before starting on your own contribution, please read the [contributor guidelines](CONTRIBUTING.md)!
```
Released under the Apache-2.0 license. Copyright (c) 2022 Max Rodriguez
```
---
_Source: https://npm.io/package/poparazzi-private-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._