Перейти к содержимому

Residential-таргетинг

Четыре отдельных справочника доступны по базовому адресу https://api.ltesocks.io/v2/proxies/residential/locations. Для каждого запроса нужен bearer-токен с соответствующим правом proxy.residential.locations.{entity} или токен со всеми правами.

GET endpointФильтры
/countriesНеобязательный search по названию или коду страны; необязательный точный country_code
/regionsОбязательный country_code; необязательный search по названию или коду региона
/citiesОбязательный country_code; необязательные region_code и search
/asnНеобязательный country_code; необязательный search по номеру ASN или названию оператора

Регистр кода страны не имеет значения. Коды регионов и городов передавайте в том виде, в котором их вернул API. Чтобы получить города во всех регионах страны, не передавайте region_code. В ответе каждый город содержит коды страны и региона: города с одинаковыми кодами в разных регионах остаются отдельными записями.

Окно терминала
curl --get 'https://api.ltesocks.io/v2/proxies/residential/locations/cities' \
--header "Authorization: Bearer $LTESOCKS_API_TOKEN" \
--data-urlencode 'country_code=us' \
--data-urlencode 'search=Springfield' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=25'
{
"success": true,
"code": 200,
"data": [
{ "code": "springfield", "name": "Springfield", "country_code": "us", "region_code": "illinois" }
],
"page_info": { "page": 1, "page_size": 25, "total_count": 1 }
}

Все справочники поддерживают page (по умолчанию 1) и page_size (по умолчанию 25, максимум 100). Фильтры применяются до пагинации; total_count содержит полное количество совпадений. Неизвестная страна, регион или страница за пределами списка дают пустой массив data. Некорректные параметры возвращают 422 с ошибками по полям.

Записи ASN содержат code, name и country_codes. Один ASN возвращается один раз, даже если доступен в нескольких странах. Для чтения полного справочника перебирайте страницы: ограничения первыми 100 ASN нет. Доступность определяется активным residential-провайдером и его настроенным пакетом; данные могут быть закэшированы.

В GET /v2/user добавлено поле residentialProxy.availableData — остаток residential-трафика в байтах. Поле находится в существующем объекте пользователя. Например, 1073741824 байта равны 1 GiB.

Фильтрация ASN также поддерживает region_code и city_code; каждый из этих фильтров требует country_code. Покупка пакетов, credentials sub-users и управление квотами описаны на странице Residential: sub-users и трафик.