Proxy Configuration
How to pass a proxy for tasks that require IP matching.
Some tasks need to be solved from your IP. For those, include a proxy in the task field (string or object).
{
"clientKey": "YOUR_API_KEY",
"task": {
"type": "ReCaptchaV2Token",
"websiteURL": "https://example.com",
"websiteKey": "6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI",
"proxy": "http://user:[email protected]:8080"
}
}String formats
Schemes: http, https, socks4, socks5. No scheme defaults to http. Most providers only support http.
| Format | Example |
|---|---|
scheme://user:pass@host:port | http://admin:[email protected]:8080 |
scheme://user:pass:host:port | http://admin:secret:1.2.3.4:8080 |
scheme://host:port | socks5://1.2.3.4:1080 |
user:pass@host:port | admin:[email protected]:8080 |
user:pass:host:port | admin:secret:1.2.3.4:8080 |
host:port | 1.2.3.4:8080 |
| IPv6 | http://user:pass@[2001:db8::1]:8080 |
If your password contains :, use user:pass@host:port or a full URL. The colon-separated user:pass:host:port form can't tell the difference.
Object format
| Field | Type | Description |
|---|---|---|
type* | Proxy protocol: http, https, socks4, or socks5. Example: | |
host* | string | Proxy server hostname or IP address. Example: |
port* | unknown | Port the proxy listens on (1 - 65535). Example: |
username | string | Username for proxy authentication (if required). Example: proxy-user. Example: |
password | string | Password for proxy authentication (if required). Example: proxy-pass. Example: |
Example Proxy Object
{ "type": "http", "host": "192.168.1.1", "port": 8080, "username": "proxy-user", "password": "proxy-pass"}socks4 auth behavior
socks4 itself does not support username / password auth like http or socks5. We still accept those fields
for consistency, but many providers ignore them. If you need authenticated SOCKS, use socks5.