GDPR Cookie Consent by FreePrivacyPolicy API Documentation for Obtaining Proxies: Request Parameters, Response Formats and Usage Limits
API documentation for getting proxy servers with filter settings. Convenient tool for accessing proxy list with selection of type, anonymity, ping, country, city and output format (TXT, JSON). Support for authorization, usage limits and data download. Learn how to integrate API for working with proxies.
Home Knowledge Base API Documentation Free Proxies FAQ Terms of Use
API Documentation for Obtaining Proxies

API Documentation for Obtaining Proxies

Description

This API provides access to a list of proxy servers with the ability to configure filters. To work with the API, a valid access key is required, which is checked 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 file for download. The API is available at https://api.good-proxies.com/api.

Main request parameters

Parameter Description Required Example value
key Access key required to authenticate the request. Yes abc123
type Proxy server types (http, https, socks4, socks5). You can specify multiple types separated by commas. No http,https
anon Proxy anonymity level (transparent, anonymous, elite). No elite
ping Maximum allowable proxy response time in milliseconds. No 500
time Maximum time (in seconds) since the last proxy check. No 600
works The number of successful proxy tests out of the total number of attempts as a percentage. Available values: from 0 to 100. Example of use: works=50 - this means that proxies will be issued that have at least 50% successful checks out of the total number of tests for performance. The value is displayed if the json format is selected. No 50
country Proxy country code (ISO Alpha-2). You can specify multiple codes separated by commas. No us,ca
city Proxy city name. You can specify multiple cities separated by commas. Names can be in Russian or English. No Paris,Moscow
count Number of requested proxies. No 10
get Data output format. By default, the value txt is used, which means output as text in the browser. To output in JSON format, use get=json. To download a file, use get=txt.file or get=json.file. No txt, json, txt.file, json.file
timecheck The time of the last successful proxy performance check. Displayed only if the json format is selected. Time is specified in the GMT+2 time zone. No Cannot be specified
ip_out The outgoing resulting IP address of the proxy. 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 HTTP proxies with "elite" anonymity in JSON format

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

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

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

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

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

Response Format

Successful response in JSON format

When a successful request is made 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 the GMT+2 time zone. The ip_out parameter indicates the resulting IP address of the proxy, 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": "Medellin",
        "works": "66"
    }
]

Successful response in TXT format

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

192.168.1.1:8080
192.168.1.2:8080
192.168.1.3:8080

Successful response in TXT format for download

If the get=txt.file parameter, the 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 response in JSON format for download

If the get=json.file parameter, the 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 with an error description.

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 get=txt.file or get=json.file parameter, the data will be offered for download as a file.
  • The time in the timecheck field, returned in JSON format, is specified in the GMT+2 time zone.

PHP Usage Example

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

$url = "https://api.good-proxies.com/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 getting proxies.";
}

Conclusion

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

0.001 сек