2captcha-node/README.md

A NodeJS wrapper to solve image captchas with 2captcha

<h1 align="center">Welcome to 2captcha-node 👋</h1>

<p align="center">
  <a href="https://www.npmjs.com/package/2captcha-node"><img alt="NPM version" src="https://img.shields.io/npm/v/2captcha-node"></a>
  <a href="https://bundlephobia.com/result?p=2captcha-node"><img alt="Bundle size" src="https://img.shields.io/bundlephobia/minzip/2captcha-node"></a>
  <img alt="MIT" src="https://img.shields.io/github/license/pedroapfilho/2captcha-node">
</p>

> A NodeJS wrapper to solve image captchas with 2captcha

## Prerequisites:

You will need a `2Captcha API key`

## Install

```sh
npm install 2captcha-node

or

yarn add 2captcha-node
```

## Usage

Set up your api key:

```js
import captchaSolver from '2captcha-node';

const captcha = captchaSolver('your-api-key');
```

It'll return an object with the `solve` function, and you'll be able to use it inside of your script

```js
const options = {
  image: 'base64-image',
  maxAttempts: 60, // Optional
};

const { id, text } = await captcha.solve(options);
```

And this solvedCaptcha will return object, with captcha id and captcha text

You can use the `balance` function too, to see your balance at 2Captcha

```js
const balance = await captcha.balance();
```

You can use the Report Captcha is valid or not.

```js
await captcha.report(id, isValid);
```

## Author

👤 **Pedro Filho <pedro@filho.me>**

- Twitter: [@pedrofilhome](https://twitter.com/pedrofilhome)
- Github: [@pedroapfilho](https://github.com/pedroapfilho)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/pedroapfilho/2captcha-node/issues).

## Show your support

Give a ⭐️ if this project helped you!

<a href="https://www.buymeacoffee.com/khcUAVF" target="_blank"><img src="https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>