CAPTCHAs.IO API Documentation
Welcome to CAPTCHAs.IO API Document
CAPTCHAs.IO is the most stable and fastest captcha solving API web service provider in the Internet at present. This document covers all methods to automate captcha solving through a RESTFul Webservice API. Supported CAPTCHA types: Image CAPTCHAs, reCAPTCHAs, hCAPTCHAs, and Audio CAPTCHAs.
API Endpoint URL
https://api.captchas.io/in.php
AND https://api.captchas.io/res.php
API Key
API Parameters
Endpoint: https://api.captchas.io/in.php
Paramaters | Possible Values / Description |
key | api_key - Your API key found in the console dashboard. |
method |
post - defines that you're sending an image with multipart formbase64 - defines that you're sending a base64 encoded imageuserrecaptcha - defines that you're sending a Google reCAPTCHA requesthcaptcha - defines that you're sending an hCAPTCHA requestfuncaptcha - defines that you're sending an FunCAPTCHA requestaudio - defines that you're sending an audio captcha in MP3 format. |
file | Used when you're sending a post API request... |
body |
Used when sending base64 requests...
|
googlekey | data-sitekey - The Google reCAPTCHA data-sitekey value. Used when in userrecaptcha and hcaptcha mode. |
sitekey | data-sitekey - The hCAPTCHA data-sitekey value. Used when in hcaptcha mode. |
publickey | publickey - The FunCAPTCHA publickey value. Used when in funcaptcha mode. |
surl | Service URL - The FunCAPTCHA service URL value. Used when in funcaptcha mode. |
pageurl | pageurl - The Google reCAPTCHA page URL. Used when in userrecaptcha , funcaptcha , and hcaptcha mode. |
invisible |
0 - DEFAULT; normal reCAPTCHA type.1 - means that reCAPTCHA is invisible type.Used when in
userrecaptcha mode. |
min_score |
Used when you are solving reCAPTCHA v3 only. The score needed for resolution. Currently it's is only possible to get a response with min. score 0.5
0.5 - DEFAULT, 0.1 ... 0.3 ... 0.5 ... 0.9 |
action | verify - Used when you are solving reCAPTCHA v3 only. The value of action parameter you found on page... |
version |
v2 - DEFAULT; defines that you're sending a reCAPTCHA V2.v3 - defines that you're sending a reCAPTCHA V3.Used when in
userrecaptcha mode. |
json |
0 - server will send the response as plain text1 - tells the server to send the response as JSON |
regsense |
0 - server will send the response as case-insensitive.1 - server will send the response as case-sensitive. |
header_acao |
0 - server will send the response as plain text / json headers1 - tells the server to send the response with header "Access-Control-Allow-Origin: *". |
proxy [optional] | <proxy_ip>:<proxy_port> |
proxytype [optional] | HTTP, HTTPS, SOCKS4, SOCKS5 |
Endpoint: https://api.captchas.io/res.php
Paramaters | Possible Values / Description |
key | api_key - Your API key found in the console dashboard. |
action |
getbalance — Get your account subscribed plan threads limit.get — Get answer for captcha. |
id | The ID returned by the in.php endpoint. ex: 12345678 |
json |
0 - server will send the response as plain text1 - tells the server to send the response as JSON |
header_acao |
0 - server will send the response as plain text / json headers1 - tells the server to send the response with header "Access-Control-Allow-Origin: *". |
Image CAPTCHAs
API Parameters for solving Image CAPTCHAs.
Paramaters | Possible Values / Description |
key | api_key - Your API key found in the console dashboard. |
method |
post - defines that you're sending an image with multipart formbase64 - defines that you're sending a base64 encoded image |
file | Used when you're sending a post API request... |
body |
Used when sending base64 requests...
|
json |
0 - server will send the response as plain text1 - tells the server to send the response as JSON |
regsense |
0 - server will send the response as case-insensitive.1 - server will send the response as case-sensitive. |
header_acao |
0 - server will send the response as plain text / json headers1 - tells the server to send the response with header "Access-Control-Allow-Origin: *". |
Audio CAPTCHAs
API Parameters for solving Audio CAPTCHAs.
Paramaters | Possible Values / Description |
key | api_key - Your API key found in the console dashboard. |
method |
audio - defines that you're sending an audio captcha in MP3 format. |
file | Used when you're sending a audio API request... |
json |
0 - server will send the response as plain text1 - tells the server to send the response as JSON |
regsense |
0 - server will send the response as case-insensitive.1 - server will send the response as case-sensitive. |
header_acao |
0 - server will send the response as plain text / json headers1 - tells the server to send the response with header "Access-Control-Allow-Origin: *". |
reCAPTCHA V2
API Parameters for solving reCAPTCHA v2.
Paramaters | Possible Values / Description |
key | api_key - Your API key found in the console dashboard. |
method |
userrecaptcha - defines that you're sending a Google reCAPTCHA request. |
googlekey | data-sitekey - The Google reCAPTCHA data-sitekey value. Used when in userrecaptcha and hcaptcha mode. |
pageurl | pageurl - The Google reCAPTCHA page URL. Used when in userrecaptcha , funcaptcha , and hcaptcha mode. |
version |
v2 - DEFAULT; defines that you're sending a reCAPTCHA V2. |
json |
0 - server will send the response as plain text1 - tells the server to send the response as JSON |
header_acao |
0 - server will send the response as plain text / json headers1 - tells the server to send the response with header "Access-Control-Allow-Origin: *". |
reCAPTCHA V3
API Parameters for solving reCAPTCHA v3.
Paramaters | Possible Values / Description |
key | api_key - Your API key found in the console dashboard. |
method |
userrecaptcha - defines that you're sending a Google reCAPTCHA request. |
googlekey | data-sitekey - The Google reCAPTCHA data-sitekey value. Used when in userrecaptcha and hcaptcha mode. |
pageurl | pageurl - The Google reCAPTCHA page URL. Used when in userrecaptcha , funcaptcha , and hcaptcha mode. |
version |
v3 - defines that you're sending a reCAPTCHA V3. |
invisible |
0 - DEFAULT; normal reCAPTCHA type.1 - means that reCAPTCHA is invisible type.Used when in
userrecaptcha mode. |
min_score |
Used when you are solving reCAPTCHA v3 only. The score needed for resolution. Currently it's is only possible to get a response with min. score 0.5
0.5 - DEFAULT, 0.1 ... 0.3 ... 0.5 ... 0.9 |
action | verify - Used when you are solving reCAPTCHA v3 only. The value of action parameter you found on page... |
json |
0 - server will send the response as plain text1 - tells the server to send the response as JSON |
header_acao |
0 - server will send the response as plain text / json headers1 - tells the server to send the response with header "Access-Control-Allow-Origin: *". |
hCAPTCHA
API Parameters for solving hCAPTCHA.
Paramaters | Possible Values / Description |
key | api_key - Your API key found in the console dashboard. |
method |
hcaptcha - defines that you're sending an hCAPTCHA request. |
sitekey | data-sitekey - The hCAPTCHA data-sitekey value. Used when in hcaptcha mode. |
pageurl | pageurl - The Google reCAPTCHA page URL. Used when in userrecaptcha , funcaptcha , and hcaptcha mode. |
json |
0 - server will send the response as plain text1 - tells the server to send the response as JSON |
header_acao |
0 - server will send the response as plain text / json headers1 - tells the server to send the response with header "Access-Control-Allow-Origin: *". |
Error Responses
These are set of program error code responses for easy coding.
Code | Description |
ERROR_DAILY_SOLVES_LIMIT_REACHED | You have reached your account's allowable daily solves limit. You can wait or you can upgrade your package plan in the console panel https://app.captchas.io/clients/v2/upgrades. |
ERROR_NO_AVAILABLE_THREADS | You have no more available threads in your account's subscribed plan, you can wait for the next thread to be free or you can upgrade your package plan in the console panel https://app.captchas.io/clients/v2/upgrades. |
ERROR_CAPTCHA_UNSOLVABLE | The CAPTCHA or reCAPTCHA is found to be unsolvable by our OCR system. |
ERROR_API_KEY_NOT_FOUND | The API key passed is not found in our database. |
ERROR_ACCESS_DENIED | Access to the API is denied, contact administrator at admin@CAPTCHAs.IO. |
Emulator
Emulation from 2captcha.com
Please follow this step-by-step tutorial to migrate or use CAPTCHAs.IO API from the providers listed above.
These instructions applies only to Windows operated computers.
- Open and edit C:\Windows\System32\drivers\etc\hosts file.
-
Write or encode:
- 217.23.12.189 2captcha.com
- Open your software or application.
- Use your CAPTCHAs.IO API Key as Key.
- Re-run your application and check.
- Done.
Codes and Libraries
Examples
HTML and Curl Examples
<form method="post" action="https://api.captchas.io/in.php"> Method: <input type="text" name="method" value="post"> Key: <input type="text" name="key" value="YOUR_APIKEY"> Captcha: <input type="file" name="file"> <input type="submit" value="Upload and get the ID"> </form>
curl -X POST -F "method=post" -F "key={YOUR_APIKEY}" -F "file=@/path/captcha.png" https://api.captchas.io/in.php
<form method="post" action="https://api.captchas.io/in.php""> Method: <input type="text" name="method" value="base64"> Key: <input type="text" name="key" value="YOUR_APIKEY"> Captcha: <textarea name="body">%BASE64_STRING%</textarea> <input type="submit" value="Upload and get the ID"> </form>
curl -X POST -F "method=base64" -F "key={YOUR_APIKEY}" -F "body={BASE64_STRING}" https://api.captchas.io/in.php
<form method="post" action="https://api.captchas.io/in.php""> Method: <input type="text" name="method" value="userrecaptcha"> Key: <input type="text" name="key" value="YOUR_APIKEY"> GoogleKEY: <input type="text" name="googlekey" value="GOOGLE_SITE_KEY"> PageURL: <input type="text" name="pageurl" value="PAGE_URL"> <input type="submit" value="Upload and get the ID"> </form>
curl -X POST -F "method=userrecaptcha" -F "key={YOUR_APIKEY}" -F "googlekey={GOOGLE_SITE_KEY}" -F "pageurl={PAGE_URL}" https://api.captchas.io/in.php
<form method="post" action="https://api.captchas.io/in.php""> Method: <input type="text" name="method" value="userrecaptcha"> Key: <input type="text" name="key" value="YOUR_APIKEY"> GoogleKEY: <input type="text" name="googlekey" value="GOOGLE_SITE_KEY"> PageURL: <input type="text" name="pageurl" value="PAGE_URL"> Version: <input type="text" name="version" value="v3"> Action: <input type="text" name="action" value="verify"> min_score: <input type="text" name="min_score" value="0.3"> <input type="submit" value="Upload and get the ID"> </form>
curl -X POST -F "method=userrecaptcha" -F "key={YOUR_APIKEY}" -F "action=verify" -F "min_score=0.3" -F "googlekey={GOOGLE_SITE_KEY}" -F "pageurl={PAGE_URL}" -F "version=v3" https://api.captchas.io/in.php
<form method="post" action="https://api.captchas.io/in.php""> Method: <input type="text" name="method" value="userrecaptcha"> Key: <input type="text" name="key" value="YOUR_APIKEY"> GoogleKEY: <input type="text" name="googlekey" value="GOOGLE_SITE_KEY"> PageURL: <input type="text" name="pageurl" value="PAGE_URL"> Invisible: <input type="text" name="invisible" value="1"> <input type="submit" value="Upload and get the ID"> </form>
curl -X POST -F "method=userrecaptcha" -F "key={YOUR_APIKEY}" -F "googlekey={GOOGLE_SITE_KEY}" -F "pageurl={PAGE_URL}" -F "invisible=1" https://api.captchas.io/in.php
<form method="post" action="https://api.captchas.io/in.php"> Method: <input type="text" name="method" value="audio"> Key: <input type="text" name="key" value="YOUR_APIKEY"> Captcha: <input type="file" name="file"> <input type="submit" value="Upload and get the ID"> </form>
curl -X POST -F "method=audio" -F "key={YOUR_APIKEY}" -F "file=@/path/to/audio.mp3" https://api.captchas.io/in.php
Get CAPTCHA Request Response Example
https://api.captchas.io/res.php?key=z1337ce5-5c7518e745b927.58015102&action=get&json=1&id=14636988729
Copyright © 2019 ~ CAPTCHAs.IO ~ All rights reserved world-wide
Server: 185.177.127.250