API reference
Base URL https://api.noptcha.com (HTTPS only). This reference is generated from our OpenAPI 3.1 description, which is checked against the implementation by contract tests. The 2captcha legacy endpoints (/in.php,/res.php) are not part of it; see 2captcha legacy API.
OpenAPI
- openapi.json and openapi.yaml: OpenAPI 3.1.0, API version 1.0.0.
- All schemas.
- Task parameter schemas also have their own URLs, for example /schemas/recaptcha.v2.params.json (JSON Schema 2020-12).
Compatibility
The anti-captcha compatible JSON protocol.
| Endpoint | Summary |
|---|---|
POST /createTask | Create a task |
POST /getBalance | Get the balance |
POST /getTaskResult | Get a task's result |
POST /reportCorrectRecaptcha | Report a correct token |
POST /reportIncorrectImageCaptcha | Report a wrong image answer |
POST /reportIncorrectRecaptcha | Report a wrong token |
Tasks
Create and poll tasks, report wrong answers (native API).
| Endpoint | Summary |
|---|---|
POST /v1/tasks | Create a task |
GET /v1/tasks/{id} | Get a task |
POST /v1/tasks/{id}/feedback | Report whether an answer worked |
Account
Balance, task types and prices, the key itself, usage, the public catalog (native API).
| Endpoint | Summary |
|---|---|
GET /v1/balance | Get the balance |
GET /v1/catalog | Get the public catalog and list prices |
GET /v1/me | Describe the current key |
GET /v1/types | List task types and prices |
GET /v1/usage | Get usage |