# proxyshop

> nodejs client for https://proxy.shop

Latest version **1.0.0** (published 2020-11-25) · MIT license · 0 weekly downloads

## Install

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

## 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 | 2020-11-25 |
| First published | 2020-11-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 9.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Nico Kokonas |
| Maintainers | nicomee |
| Keywords | bots, automation, confirmation, activation, authentication, auth, code, pin, otp, login, security |

## Links

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

## Dependencies (3)

- [got](https://npm.io/package/got.md) ^11.8.0
- [uuid](https://npm.io/package/uuid.md) ^8.3.1
- [assert](https://npm.io/package/assert.md) ^2.0.0

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-11-25

## README

# proxyshop

> Allows you to easily work with a huge number of high-quality, residential proxies using [proxy.shop](https://proxy.shop/)

- These proxies can be very useful when you require clean, residential ips for your application.
- perfect fit for automation, bots, crawlers, credential stuffers (wait, what?)

Refer to the [API Docs](https://proxy.shop/proxy/apidoc) for full API documentation. Some of the abstractions they use, like sub-accounts, I find to be clunky and hard to manage out of the box. This package provides some useful functions to work with your proxies in a more intuitive fashion.


[![NPM](https://img.shields.io/npm/v/proxyshop.svg)](https://www.npmjs.com/package/proxyshop) [![Build Status](https://travis-ci.com/nicoandmee/proxyshop.svg?branch=master)](https://travis-ci.com/nicoandmee//proxyshop) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)


## Install

```bash
npm install --save proxyshop
```


```js
const proxyshop = require('proxyshop');

const client = new proxyshop({
  key: '...', // Your API Key goes here
});

// get a new proxy from TX
const proxy = await client.getProxy('TX');

// provide http proxy URI to your bot
const bot = new PlayBot({ proxy });
await bot.init();
await bot.goto('http://whoer.net');


// add a new sub-account (which represents a distinct proxy handle)
const sid = await client.addProxy('username', 'password');

// you can persist the sid somewhere if you want
await redis.set('sid:', sid);

// then later, you can update/refresh the proxy
await client.updateProxy(sid, 'CA');


```
## TODO
- Add tests


## References

Please see API documentation for full usage details: [API](https://github.com/nicoandmee/proxyshop/blob/master/api.md).

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