API для работы с прокси

Доступные методы API

API сервиса 2Captcha предоставляет удобные методы для управления прокси, и получения информации о доступных ресурсах. Ниже представлен список доступных методов:

1. Управление аккаунтом:
   • proxy - получение общей информации об аккаунте
   • balance - проверка текущего баланса аккаунта

2. Доступные локации

   • countries - получение списка доступных стран
   • regions - получение списка доступных регионов
   • cities - получение списка доступных городов
   • asns - получение списка ASN

3. Управление белым списком

   • get_white_list_ips - получение списка IP-адресов в белом списке
   • add_white_list_ip - добавление IP-адресов в белый список
   • delete_white_list_ip - удаление IP-адреса из белого списка
   • create_white_list_connections - создание подключений белого списка
   • get_white_list_connections - получение списка подключений белого списка
   • white_list_connections_count - получение количества портов белого списка
   • delete_white_list_connection - удаление подключения белого списка
   • delete_all_white_list_connections - удаление всех подключений белого списка
   • white_list_errors - коды ошибок белого списка

Получение общей информации об аккаунте

Этот метод позволяет получить основную информацию о вашем аккаунте,
включая текущий статус, объем использованного трафика и список IP-адресов
в белом списке.

Эндпоинт API: https://api.2captcha.com/proxy?key=<API_KEY>
Метод: GET

Параметры запроса:

Пример запроса:

https://api.2captcha.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.2captcha.com/proxy/balance?key=<API_KEY>
Метод: GET

Параметры запроса:

Пример запроса:

https://api.2captcha.com/proxy/balance?key=1abc234de56fab7c89012d34e56fa7b8

Пример ответа:

{
    "status": "OK",
    "balance": 1000
}

Список доступных стран

Этот метод позволяет получить список стран, в которых доступны прокси сервиса 2Captcha.

Эндпоинт API: https://api.2captcha.com/proxy/locations/countries?key=<API_KEY>&page=0
Метод: GET

Параметры запроса:

Пример запроса:

https://api.2captcha.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
}

Список доступных регионов

Этот метод позволяет получить список регионов, в которых доступны прокси сервиса 2Captcha, а также привязку региона к стране.

Эндпоинт API: https://api.2captcha.com/proxy/locations/regions?key=<API_KEY>&page=0
Метод: GET

Параметры запроса:

Пример запроса:

https://api.2captcha.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
}

Список доступных городов

Этот метод позволяет получить список городов, в которых доступны прокси сервиса 2Captcha, а также информацию о регионе и коде страны.

Эндпоинт API: https://api.2captcha.com/proxy/locations/cities?key=<API_KEY>&page=0
Метод: GET

Параметры запроса:

Пример запроса:

https://api.2captcha.com/proxy/locations/cities?key=1abc234de56fab7c89012d34e56fa7b8&page=0

Пример ответа:

{
    "status": "OK",
    "data": [
        {
            "id": 39364,
            "city": "amiens",
            "regionId": 4828,
            "region": "hautsdefrance",
            "countryCode": "fr"
        },
        {
            "id": 63141,
            "city": "amman",
            "regionId": 965,
            "region": "amman",
            "countryCode": "jo"
        },
        {
            "id": 76411,
            "city": "ampang",
            "regionId": 1944,
            "region": "selangor",
            "countryCode": "my"
        },
        ...
    ],
    "total": 3145
}

Список ASN

Этот метод позволяет получить список автономных систем (ASN),
через которые предоставляются прокси сервиса 2Captcha.
Каждая автономная система принадлежит определенному интернет-провайдеру и имеет уникальный номер ASN.

Эндпоинт API: https://api.2captcha.com/proxy/locations/asns?key=<API_KEY>&page=0
Метод: GET

Параметры запроса:

Пример запроса:

https://api.2captcha.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-адресов в белом списке

Этот метод позволяет получить список IPv4-адресов, добавленных в ваш белый список. Прокси из подключений белого списка можно использовать без авторизации, но только с этих IP-адресов.

Эндпоинт API: https://api.2captcha.com/proxy/white_lists/ips?key=<API_KEY>
Метод: GET

Параметры запроса:

Пример запроса:

https://api.2captcha.com/proxy/white_lists/ips?key=1abc234de56fab7c89012d34e56fa7b8

Пример ответа:

{
    "status": "OK",
    "data": [
        "203.0.113.42",
        "198.51.100.10"
    ]
}

Добавление IP-адреса в белый список

Этот метод позволяет добавить один или несколько IPv4-адресов в белый список.

Ограничения:

• поддерживаются только IPv4-адреса;
• не более 5 IP-адресов на аккаунт;
• один и тот же IP-адрес нельзя передать дважды в одном запросе;
• один IP-адрес нельзя добавить в белый список нескольких аккаунтов.

Эндпоинт API: https://api.2captcha.com/proxy/white_lists/ips?key=<API_KEY>
Метод: POST
Content-Type: application/json

Параметры строки запроса:

Тело запроса:

Пример запроса:

curl -X POST "https://api.2captcha.com/proxy/white_lists/ips?key=1abc234de56fab7c89012d34e56fa7b8" \
  -H "Content-Type: application/json" \
  -d '{
    "ips": ["203.0.113.42"]
  }'

Пример ответа:

{
    "status": "OK"
}

Удаление IP-адреса из белого списка

Этот метод позволяет удалить IP-адрес из белого списка.

Эндпоинт API: https://api.2captcha.com/proxy/white_lists/ips?key=<API_KEY>&ip=<IP>
Метод: DELETE

Параметры запроса:

Пример запроса:

curl -X DELETE "https://api.2captcha.com/proxy/white_lists/ips?key=1abc234de56fab7c89012d34e56fa7b8&ip=203.0.113.42"

Пример ответа:

{
    "status": "OK"
}

Создание подключений белого списка

Этот метод создаёт постоянную группу прокси-портов (подключение) для вашего основного прокси-аккаунта. Подключение можно использовать без авторизации с IP-адресов из вашего белого списка. Каждому подключению присваивается id, по которому его можно получить или удалить.

Вы можете выбрать страну, регион или город, чтобы весь трафик подключения проходил через прокси в указанной локации. Доступные значения можно получить методами countries, regions и cities.

Эндпоинт API: https://api.2captcha.com/proxy/white_lists/connections?key=<API_KEY>
Метод: POST
Content-Type: application/json

Параметры строки запроса:

Тело запроса:

Обязателен только count, поэтому минимальное тело запроса — {"count": 5}.
Для совместимости с устаревшим методом также принимаются алиасы connection_count, country, region_id и city_id.

Пример запроса:

curl -X POST "https://api.2captcha.com/proxy/white_lists/connections?key=1abc234de56fab7c89012d34e56fa7b8" \
  -H "Content-Type: application/json" \
  -d '{
    "count": 5,
    "countryCode": "de",
    "regionId": 3016,
    "cityId": 25866,
    "description": "Germany"
  }'

Пример ответа:

{
    "status": "OK",
    "data": {
        "id": 61957,
        "portsCount": 5,
        "connections": [
            "proxy-host:10001",
            "proxy-host:10002"
        ],
        "countryCode": "de",
        "regionId": null,
        "cityId": null,
        "description": "Germany",
        "subAccount": "proxy-login",
        "masterAccount": "master-login",
        "trafficType": "traffic-type"
    }
}

Набор полей объекта подключения может меняться. После создания подключения получите актуальный список подключений методом get_white_list_connections.

Список подключений белого списка

Этот метод позволяет получить список ваших подключений белого списка с постраничной навигацией.

Эндпоинт API: https://api.2captcha.com/proxy/white_lists/connections?key=<API_KEY>&page=1&limit=10
Метод: GET

Параметры запроса:

Пример запроса:

https://api.2captcha.com/proxy/white_lists/connections?key=1abc234de56fab7c89012d34e56fa7b8&page=1&limit=10

Пример ответа:

{
    "status": "OK",
    "data": {
        "data": [],
        "meta": {
            "total": 0,
            "perPage": 10,
            "currentPage": 1,
            "lastPage": 1
        }
    }
}

Количество портов белого списка

Этот метод возвращает общее количество портов в ваших подключениях белого списка. Значение возвращается в поле data.

Эндпоинт API: https://api.2captcha.com/proxy/white_lists/connections/count?key=<API_KEY>
Метод: GET

Параметры запроса:

Пример запроса:

https://api.2captcha.com/proxy/white_lists/connections/count?key=1abc234de56fab7c89012d34e56fa7b8

Удаление подключения белого списка

Этот метод удаляет подключение белого списка по его id.

Эндпоинт API: https://api.2captcha.com/proxy/white_lists/connections/<ID>?key=<API_KEY>
Метод: DELETE

Параметры запроса:

Пример запроса:

curl -X DELETE "https://api.2captcha.com/proxy/white_lists/connections/61957?key=1abc234de56fab7c89012d34e56fa7b8"

Пример ответа:

{
    "status": "OK"
}

Удаление всех подключений белого списка

Этот метод удаляет все подключения белого списка вашего основного прокси-аккаунта.

Эндпоинт API: https://api.2captcha.com/proxy/white_lists/connections?key=<API_KEY>
Метод: DELETE

Параметры запроса:

Пример запроса:

curl -X DELETE "https://api.2captcha.com/proxy/white_lists/connections?key=1abc234de56fab7c89012d34e56fa7b8"

Пример ответа:

{
    "status": "OK"
}

Коды ошибок белого списка

В случае ошибки поле status содержит код ошибки, а поле message — её описание:

{
    "status": "ERROR_INVALID_CONNECTION_COUNT",
    "message": "Connection count is missing, invalid, or out of range (1-2000)"
}

Переход с устаревших методов

Прежние методы управления белым списком заменены новыми:

Новый метод создания подключений работает иначе, чем generate_white_list_connections:

• параметр ip больше не передаётся: IP-адреса белого списка управляются методами /proxy/white_lists/ips;
• параметр protocol больше не передаётся;
• результатом становится постоянное подключение с id, которое можно получить или удалить позже.

Метод generate_white_list_connections больше не генерирует подключения и возвращает HTTP-статус 410 Gone:

{
    "status": "ERROR_METHOD_DEPRECATED",
    "message": "Method is deprecated. Use POST /proxy/white_lists/connections"
}