GDPR Cookie Consent by FreePrivacyPolicy API Documentation: how to retrieve and filter proxy lists (TXT / JSON)
Документация API для получения прокси-серверов с настройкой фильтров. Удобный инструмент для доступа к списку прокси с выбором типа, анонимности, пинга, страны, города и формата вывода (TXT, JSON). Поддержка авторизации, лимитов использования и скачивания данных. Узнайте, как интегрировать API для работы с прокси.
RU EN
Home Knowledge Base API Documentation Free Proxies Frequently Asked Questions Terms of Use
Документация API для получения прокси

API Documentation for Retrieving Proxies

Description

This API provides access to a list of proxy servers with customizable filters. Working with the API requires a valid access key, which is verified for authenticity and compliance with usage limits. In response to a request, the user receives data depending on the get parameter in the form of text, JSON, or a downloadable file. The API is available at https://api.good-proxies.ru/api.

Main Request Parameters

Parameter Description Required Example Value
key Access key required for request authentication. Yes abc123
type Type of proxy servers (http, https, socks4, socks5). Multiple types can be specified separated by commas. No http,https
anon Proxy anonymity level (transparent, anonymous, elite). No elite
ping Maximum allowed proxy response time in milliseconds. No 500
time Maximum time (in seconds) since the last proxy check. No 600
works Percentage of successful proxy tests out of total attempts. Available values: from 0 to 100. Example usage: works=50 — this means that proxies with at least 50% successful checks out of the total number of tests will be returned. The value is displayed if the json format is selected. No 50
country Proxy country code (ISO Alpha-2). Multiple codes can be specified separated by commas. No us,ca
city Proxy city name. Multiple cities can be specified separated by commas. Names can be in Russian or English. No Paris,Moscow
count Number of proxies requested. No 10
get Data output format. By default, txt is used, which means output as text in the browser. For JSON format output use get=json. To download a file use get=txt.file or get=json.file. No txt, json, txt.file, json.file
timecheck Time of the last successful proxy functionality check. Displayed only if json format is selected. Time is indicated in GMT+2 timezone. No Cannot be specified
ip_out Outgoing resulting proxy IP address. May differ from the main proxy IP address. This parameter is displayed only in JSON format. No Cannot be specified

Request Examples

Example 1: 5 proxies with HTTP type and "elite" anonymity in JSON format

GET https://api.good-proxies.ru/api?key=abc123&type=http&anon=elite&count=5&get=json

Example 2: 10 proxies with HTTPS type and maximum ping 500 ms in TXT file format for download

GET https://api.good-proxies.ru/api?key=abc123&type=https&ping=500&count=10&get=txt.file

Example 3: 2 proxies from USA and Canada in list format (displayed as text in browser)

GET https://api.good-proxies.ru/api?key=abc123&country=us,ca&count=2

Response Format

Successful JSON Response

Upon a successful request with the get=json parameter, the API returns a list of proxy servers in structured JSON format. Includes the timecheck parameter, which shows the time of the last successful check in GMT+2 timezone. The ip_out parameter indicates the resulting proxy IP address, which may differ from the main one.

[
    {
        "ip": "15.162.126.1:919",
        "ip_out": "15.162.126.1:919",
        "type": "http",
        "anon": "transparent",
        "ping": 5.07786,
        "timecheck": "2024-11-25 20:09:25",
        "country": "CO",
        "city": "Медельин",
        "works": "66"
    }
]

Successful TXT Response

If the parameter get=txt (default), data is returned as a plain text file displayed in the browser:

192.168.1.1:8080
192.168.1.2:8080
192.168.1.3:8080

Successful TXT Response for Download

If the parameter get=txt.file, data will be offered for download in text format:

192.168.1.1:8080
192.168.1.2:8080
192.168.1.3:8080

Successful JSON Response for Download

If the parameter get=json.file, data will be offered for download in JSON format:

[
    {
        "ip": "112.63.11.8:180",
        "ip_out": "122.63.41.1:380",
        "type": "http",
        "anon": "elite",
        "ping": 3.83659,
        "timecheck": "2024-11-25 20:09:26",
        "country": "SN",
        "city": "",
        "works": "100"
    }
]

Errors

If the request fails, the API returns a text message describing the error.

Error: Access key not provided

Limits

Notes

  • All parameters except key are optional.
  • If the count parameter is not specified, the API returns the maximum number of available proxies.
  • When using the parameter get=txt.file or get=json.file, data will be offered for download as a file.
  • The time in the timecheck field, returned in JSON format, is specified in GMT+2 timezone.

PHP Usage Example

$key = 'abc123';
$type = 'http';
$anon = 'elite';
$count = 5;
$get = 'json';

$url = "https://api.good-proxies.ru/api?key=$key&type=$type&anon=$anon&count=$count&get=$get";

$response = file_get_contents($url);

if ($response) {
    $proxies = json_decode($response, true);
    print_r($proxies);
} else {
    echo "Error retrieving proxies.";
}

Conclusion

The API provides a convenient tool for retrieving proxy servers with extensive filtering capabilities. Make sure you have a valid access key and observe the limits for uninterrupted service operation.

0.001 сек