API для работы с прокси
На этой странице вы найдете всё необходимое для работы с прокси: подробную документацию по всем доступным типам прокси, примеры кода и руководство по интеграции.
Если у вас возникли вопросы, свяжитесь с нами по адресу [email protected] или создайте тикет.
Сервис прокси ruCaptcha предоставляет IP-адреса реальных пользователей из 220+ стран для анонимного браузинга и сбора данных. Резидентские прокси используют настоящие IP-адреса, выданные интернет-провайдерами (ISP), и привязаны к физическим устройствам по всему миру. Благодаря этому их можно использовать с целью имитации поведения реальных пользователей и обхода блокировок.
Прокси легко настраиваются, автоматически меняют IP и готовы к работе сразу после настройки. Все подробности о настройке и управлении — в этой API-документации.
Доступные методы API
API сервиса ruCaptcha предоставляет удобные методы для управления прокси, и получения информации о доступных ресурсах. Ниже представлен список доступных методов:
- Управление аккаунтом:
-
Доступные локации
-
Управление белым списком
- generate_white_list_connections - генерация IP-адресов для безопасного подключения
Получение общей информации об аккаунте
Этот метод позволяет получить основную информацию о вашем аккаунте,
включая текущий статус, объем использованного трафика и список IP-адресов
в белом списке.
Эндпоинт API: https://api.rucaptcha.com/proxy?key=<API_KEY>
Метод: GET
Параметры запроса:
Параметр | Обязателен | Описание |
---|---|---|
key |
Да | Ваш API ключ. |
Пример запроса:
https://api.rucaptcha.com/proxy?key=1abc234de56fab7c89012d34e56fa7b8
Пример ответа:
{
"status": "OK",
"data": {
"username": "u2135p19s84m750n5",
"status": 1,
"total_flow": 1000,
"use_flow": 925.679,
"last_flow": 925.679,
"ip_white": [
"203.0.113.42"
]
}
}
Текущий баланс аккаунта
Этот метод позволяет получить текущий баланс аккаунта.
Эндпоинт API: https://api.rucaptcha.com/proxy/balance?key=<API_KEY>
Метод: GET
Параметры запроса:
Параметр | Обязателен | Описание |
---|---|---|
key |
Да | Ваш API ключ. |
Пример запроса:
https://api.rucaptcha.com/proxy/balance?key=1abc234de56fab7c89012d34e56fa7b8
Пример ответа:
{
"status": "OK",
"balance": 1000
}
Список доступных стран
Этот метод позволяет получить список стран, в которых доступны прокси сервиса ruCaptcha.
Эндпоинт API: https://api.rucaptcha.com/proxy/locations/countries?key=<API_KEY>&page=0
Метод: GET
Параметры запроса:
Параметр | Обязателен | Описание |
---|---|---|
key |
Да | Ваш API ключ. |
page |
Нет | Номер страницы. |
Пример запроса:
https://api.rucaptcha.com/proxy/locations/countries?key=1abc234de56fab7c89012d34e56fa7b8&page=0
Пример ответа:
{
"status": "OK",
"data": [
{
"id": 231,
"code": "ae",
"title": "United Arab Emirates"
},
{
"id": 232,
"code": "gb",
"title": "United Kingdom"
},
{
"id": 233,
"code": "us",
"title": "United States"
},
...
],
"total": 208
}
Список доступных регионов
Этот метод позволяет получить список регионов, в которых доступны прокси сервиса ruCaptcha, а также привязку региона к стране.
Эндпоинт API: https://api.rucaptcha.com/proxy/locations/regions?key=<API_KEY>&page=0
Метод: GET
Параметры запроса:
Параметр | Обязателен | Описание |
---|---|---|
key |
Да | Ваш API ключ. |
page |
Нет | Номер страницы. |
Пример запроса:
https://api.rucaptcha.com/proxy/locations/regions?key=1abc234de56fab7c89012d34e56fa7b8&page=0
Пример ответа:
{
"status": "OK",
"data": [
{
"id": 3391,
"countryId": 231,
"region": "dubai"
},
{
"id": 2336,
"countryId": 232,
"region": "england"
},
{
"id": 1450,
"countryId": 233,
"region": "colorado"
},
...
],
"total": 967
}
Список доступных городов
Этот метод позволяет получить список городов, в которых доступны прокси сервиса ruCaptcha, а также привязку города к региону.
Эндпоинт API: https://api.rucaptcha.com/proxy/locations/cities?key=<API_KEY>&page=0
Метод: GET
Параметры запроса:
Параметр | Обязателен | Описание |
---|---|---|
key |
Да | Ваш API ключ. |
page |
Нет | Номер страницы. |
Пример запроса:
https://api.rucaptcha.com/proxy/locations/cities?key=1abc234de56fab7c89012d34e56fa7b8&page=0
Пример ответа:
{
"status": "OK",
"data": [
{
"id": 39364,
"city": "amiens",
"regionId": 4828
},
{
"id": 63141,
"city": "amman",
"regionId": 965
},
{
"id": 76411,
"city": "ampang",
"regionId": 1944
},
...
],
"total": 3145
}
Список ASN
Этот метод позволяет получить список автономных систем (ASN),
через которые предоставляются прокси сервиса ruCaptcha.
Каждая автономная система принадлежит определенному интернет-провайдеру и имеет уникальный номер ASN.
Эндпоинт API: https://api.rucaptcha.com/proxy/locations/asns?key=<API_KEY>&page=0
Метод: GET
Параметры запроса:
Параметр | Обязателен | Описание |
---|---|---|
key |
Да | Ваш API ключ. |
page |
Нет | Номер страницы. |
Пример запроса:
https://api.rucaptcha.com/proxy/locations/asns?key=1abc234de56fab7c89012d34e56fa7b8&page=0
Пример ответа:
{
"status": "OK",
"data": [
{
"id": 4463,
"title": "Sprint",
"countryCode": "us",
"code": "AS1239"
},
{
"id": 1943,
"title": "KCOM GROUP LIMITED",
"countryCode": "gb",
"code": "AS12390"
},
{
"id": 2749,
"title": "Brutele SC",
"countryCode": "be",
"code": "AS12392"
},
...
],
"total": 9830
}
Генерация IP-адресов для подключения
Этот метод позволяет получить список IP-адресов в формате ip:port
,
которые можно использовать без авторизации, но только с указанного вами IP-адреса.
Вы можете выбрать конкретную страну при генерации списка, чтобы весь ваш трафик проходил через прокси в указанной локации.
Если страна не указана, система автоматически выберет случайные IP-адреса из разных стран (mix).
В этом случае страна подключения может изменяться со временем.
Эндпоинт API: https://api.rucaptcha.com/proxy/generate_white_list_connections?key=<API_KEY>&country=au&protocol=http&connection_count=2000&ip=<WHITE_LIST_IP>
Метод: GET
Параметры запроса:
Параметр | Обязателен | Описание |
---|---|---|
key |
Да | API ключ пользователя. |
ip |
Да | IPv4-адрес, который должен быть предварительно добавлен в белый список. |
protocol |
Да | Протокол подключения. Поддерживаемые протоколы: http , https , socks5 |
country |
Нет | Код страны. Важно: Список стран для white list connections отличается от общего списка стран. Актуальный список доступных стран отображается на странице ip-whitelist в генераторе подключения. По умолчанию: случайная страна (mix), которая будет автоматически меняться со временем. |
connection_count |
Нет | Количество генерируемых подключений (от 1 до 2000 ).По умолчанию: 1 |
Пример запроса:
https://api.rucaptcha.com/proxy/generate_white_list_connections?key=1abc234de56fab7c89012d34e56fa7b8&country=au&protocol=http&connection_count=5&ip=203.0.113.42
Пример ответа:
{
"status": "OK",
"data": [
"192.0.2.103:24008",
"198.51.100.179:16679",
"203.0.113.95:30507",
"192.0.2.96:37614",
"198.51.100.163:25494"
]
}