Чотири окремі довідники доступні за базовою адресою 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 і трафік.