Proxy List API Documentation

Example PHP

PHP library for working with our API we can download here.

List of proxies


Method
GET
Route
https://proxy-spider.com/api/proxies.json
Response
JSON

Parameters

Name Type Value Def. Req.
api_key string Listed at the top of this page - Yes
Your API key.
limit integer 1..1000 1 No
The number of proxies to retrieve.
order string best, random or new best No
The sort order. "best" will return the most reliable proxies first in the list.
page integer 1.. 1 No
The page number, for queries matching more than limit number of results. Start with page 1, then if has_next_page is true, increase the page number on your next query with the same parameters.
country_code string ex: US All No
Add this to retrieve only proxies at this location. Comma-separate multiple values to search with OR condition.
exclude_country_code string ex: MX All No
Add this to exclude proxies at this location. Comma-separate multiple values to search with OR condition.
response_time string slow, medium or fast All No
Add this to retrieve only proxies with a specific response time. Comma-separate multiple values to search with OR condition.
type string anonymous, elite or transparent All No
Add this to retrieve only proxies with a type. Comma-separate multiple values to search with OR condition.
protocols string http, https, socks4 or socks5 All No
Add this to retrieve only proxies with a specific protocol. Comma-separate multiple values to search with AND condition.
supports string referer, cookie, get, post or useragent All No
Add this to retrieve only proxies that support these capabilities. Comma-separate multiple values to search with AND condition.
test integer 0..1 0 No
Set this to true to make a test API call. All proxies will be 0.0.0.0 and the call will not count against your daily allowance.

Response example

https://proxy-spider.com/api/proxies.json?limit=2&country_code=US&supports=referer,get&test=1
{
    "status": "ok",
    "data": {
        "proxies": [{
            "ip": "0.0.0.0",
            "port": "3128",
            "country_code": "US",
            "response_time": "fast",
            "type":"elite",
            "supports": ["get", "cookie", "referer"],
            "protocols": ["http", "https"]
        }, {
            "ip": "0.0.0.0",
            "port": "8080",
            "country_code": "US",
            "response_time": "fast",
            "type":"transparent",
            "supports": ["get", "cookie", "referer"],
            "protocols": ["http", "https"]
        }],
        "filters": {
            "order": "best",
            "country_code": "US",
            "response_time": "",
            "type": "",
            "protocols": "",
            "supports": "",
            "test": 0
        },
        "quota_remaining": 0,
        "limit": 2,
        "page": 1,
        "has_next_page": true
    },
    "message": "",
    "request_id": "45"
}

Response object

Name Type Description
status string ok on successful API call, else error
data object Requested data
request_id string Unique string, identifying the request
message string Error message, displayed when status is error

Data object

Name Type Description
proxies array Proxies matching requested filter conditions
filters object Parameters that are common to all proxies
quota_remaining integer Number of remaining proxy requests allowed by your subscription plan for today. Will be negative if you are over your limit.
limit integer The number of proxies the request was limited to.
page integer The page number of paginated results.
has_next_page boolean True if there are more proxies matching the requested filter conditions, but the request exceeded the limit. If true, you can make the call again, but increase the page number by one to get the next page of results.

Proxy object

Name Type Description
ip string IP address
port integer Port
country_code string Country code
response_time string Response time
type string Type
protocols array List of protocols this proxy supports
supports array List of capabilities this proxy supports

Ping


Method
GET
Route
https://proxy-spider.com/api/ping.json
Response
JSON

Response example

https://proxy-spider.com/api/ping.json
{
    "status": "ok",
    "data": {
        "response": "pong"
    },
    "message": "",
    "request_id": ""
}

Error


Method
GET
Route
https://proxy-spider.com/api/error.json
Response
JSON

Response example

https://proxy-spider.com/api/error.json
{
    "status": "error",
    "data": [],
    "message": "Error message",
    "request_id": ""
}

List of proxies


Method
GET
Route
https://proxy-spider.com/api/proxies.csv
Response
CSV

Parameters

Name Type Value Def. Req.
api_key string Listed at the top of this page - Yes
Your API key.
limit integer 1..1000 1 No
The number of proxies to retrieve.
order string best, random or new best No
The sort order. "best" will return the most reliable proxies first in the list.
page integer 1.. 1 No
The page number, for queries matching more than limit number of results. Start with page 1, then if has_next_page is true, increase the page number on your next query with the same parameters.
country_code string ex: US All No
Add this to retrieve only proxies at this location. Comma-separate multiple values to search with OR condition.
exclude_country_code string ex: MX All No
Add this to exclude proxies at this location. Comma-separate multiple values to search with OR condition.
response_time string slow, medium or fast All No
Add this to retrieve only proxies with a specific response time. Comma-separate multiple values to search with OR condition.
type string anonymous, elite or transparent All No
Add this to retrieve only proxies with a type. Comma-separate multiple values to search with OR condition.
protocols string http, https, socks4 or socks5 All No
Add this to retrieve only proxies with a specific protocol. Comma-separate multiple values to search with OR condition.
supports string referer, cookie, get, post or useragent All No
Add this to retrieve only proxies that support these capabilities. Comma-separate multiple values to search with OR condition.
test integer 0..1 0 No
Set this to true to make a test API call. All proxies will be 0.0.0.0 and the call will not count against your daily allowance.

Response example

https://proxy-spider.com/api/proxies.csv?limit=2&country_code=US&supports=referer,get&test=1
ip,port,country_code,response_time,type,protocols,supports
0.0.0.0,3128,US,fast,elite,"http,https","get,cookie,referer,useragent"
0.0.0.0,8080,US,fast,transparent,"http,https","get,cookie,referer,useragent"

Response columns

Name Type Description
ip string IP address
port integer Port
country_code string Country code
response_time string Response time
type string Type
protocols string List of protocols this proxy supports, comma separated
supports string List of capabilities this proxy supports, comma separated

List of proxies


Method
GET
Route
https://proxy-spider.com/api/proxies.xml
Response
XML

Parameters

Name Type Value Def. Req.
api_key string Listed at the top of this page - Yes
Your API key.
limit integer 1..1000 1 No
The number of proxies to retrieve.
order string best, random or new best No
The sort order. "best" will return the most reliable proxies first in the list.
page integer 1.. 1 No
The page number, for queries matching more than limit number of results. Start with page 1, then if has_next_page is true, increase the page number on your next query with the same parameters.
country_code string ex: US All No
Add this to retrieve only proxies at this location. Comma-separate multiple values to search with OR condition.
exclude_country_code string ex: MX All No
Add this to exclude proxies at this location. Comma-separate multiple values to search with OR condition.
response_time string slow, medium or fast All No
Add this to retrieve only proxies with a specific response time. Comma-separate multiple values to search with OR condition.
type string anonymous, elite or transparent All No
Add this to retrieve only proxies with a type. Comma-separate multiple values to search with OR condition.
protocols string http, https, socks4 or socks5 All No
Add this to retrieve only proxies with a specific protocol. Comma-separate multiple values to search with OR condition.
supports string referer, cookie, get, post or useragent All No
Add this to retrieve only proxies that support these capabilities. Comma-separate multiple values to search with OR condition.
test integer 0..1 0 No
Set this to true to make a test API call. All proxies will be 0.0.0.0 and the call will not count against your daily allowance.

Response example

https://proxy-spider.com/api/proxies.xml?limit=2&country_code=US&supports=referer,get&test=1
<?xml version="1.0"?>
<response>
  <status>ok</status>
  <data>
    <proxies>
      <item>
        <ip>0.0.0.0</ip>
        <port>3128</port>
        <country_code>US</country_code>
        <response_time>fast</response_time>
        <type>elite</type>
        <supports>
          <item>get</item>
          <item>cookie</item>
          <item>referer</item>
          <item>useragent</item>
        </supports>
        <protocols>
          <item>http</item>
          <item>https</item>
        </protocols>
      </item>
      <item>
        <ip>0.0.0.0</ip>
        <port>8080</port>
        <country_code>US</country_code>
        <response_time>fast</response_time>
        <type>transparent</type>
        <supports>
          <item>get</item>
          <item>cookie</item>
          <item>referer</item>
          <item>useragent</item>
        </supports>
        <protocols>
          <item>http</item>
          <item>https</item>
        </protocols>
      </item>
    </proxies>
    <filters>
      <order>best</order>
      <country_code>US</country_code>
      <response_time></response_time>
      <type></type>
      <protocols></protocols>
      <supports></supports>
      <test>0</test>
    </filters>
    <quota_remaining>0</quota_remaining>
    <limit>2</limit>
    <page>1</page>
    <has_next_page>1</has_next_page>
  </data>
<message></message>
<request_id>94</request_id>
</response>

Response object

Name Type Description
status string ok on successful API call, else error
data object Requested data
request_id string Unique string, identifying the request
message string Error message, displayed when status is error

Data object

Name Type Description
proxies array Proxies matching requested filter conditions
filters object Parameters that are common to all proxies
quota_remaining integer Number of remaining proxy requests allowed by your subscription plan for today. Will be negative if you are over your limit.
limit integer The number of proxies the request was limited to.
page integer The page number of paginated results.
has_next_page boolean True if there are more proxies matching the requested filter conditions, but the request exceeded the limit. If true, you can make the call again, but increase the page number by one to get the next page of results.

Proxy object

Name Type Description
ip string IP address
port integer Port
country_code string Country code
response_time string Response time
type string Type
protocols array List of protocols this proxy supports
supports array List of capabilities this proxy supports

List of proxies


Method
GET
Route
https://proxy-spider.com/api/proxies.txt
Response
TXT

Parameters

Name Type Value Def. Req.
api_key string Listed at the top of this page - Yes
Your API key.
limit integer 1..1000 1 No
The number of proxies to retrieve.
order string best, random or new best No
The sort order. "best" will return the most reliable proxies first in the list.
page integer 1.. 1 No
The page number, for queries matching more than limit number of results. Start with page 1, then if has_next_page is true, increase the page number on your next query with the same parameters.
country_code string ex: US All No
Add this to retrieve only proxies at this location. Comma-separate multiple values to search with OR condition.
exclude_country_code string ex: MX All No
Add this to exclude proxies at this location. Comma-separate multiple values to search with OR condition.
response_time string slow, medium or fast All No
Add this to retrieve only proxies with a specific response time. Comma-separate multiple values to search with OR condition.
type string anonymous, elite or transparent All No
Add this to retrieve only proxies with a type. Comma-separate multiple values to search with OR condition.
protocols string http, https, socks4 or socks5 All No
Add this to retrieve only proxies with a specific protocol. Comma-separate multiple values to search with OR condition.
supports string referer, cookie, get, post or useragent All No
Add this to retrieve only proxies that support these capabilities. Comma-separate multiple values to search with OR condition.
test integer 0..1 0 No
Set this to true to make a test API call. All proxies will be 0.0.0.0 and the call will not count against your daily allowance.

Response example

https://proxy-spider.com/api/proxies.txt?limit=2&country_code=US&supports=referer,get&test=1
  0.0.0.0:3128
  0.0.0.0:8080

Response object

Each line contains the proxy and port number, separated by a colon.