API Documentation

TXT
JSON
CSV
XML
  • Get a list of proxies


    Method
    GET
    Route
    https://kingproxies.com/api/v2/proxies.txt
    Response
    TXT

    Parameters
    NameTypeValueDescription
    keystringRegister to get your free API keyREQUIRED
    Your API key.
    typestringelite, anonymous, or transparentAdd this to retrieve only proxies with a type. Comma-separate multiple values to search with OR condition.
    DEFAULT: All types
    protocolsstringhttp, socks4, or socks5Add this to retrieve only proxies with a specific protocol. Comma-separate multiple values to search with OR condition.
    DEFAULT: All protocols
    alivebooleantrue/false, 1/0, yes/noOnly retrieve proxies that were tested to be working within the last 5 minutes.
    DEFAULT: true
    newbooleantrue/false, 1/0, yes/noOnly retrieve proxies that were added to the list in the past 24 hours.
    DEFAULT: false
    country_codestringAdd this to retrieve only proxies at this location. Comma-separate multiple values to search with OR condition.
    DEFAULT: All countries

    Response example
    https://kingproxies.com/api/v2/proxies.txt?country_code=US
    0.0.0.0:6390
    0.0.0.0:8938
    
    Response

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

  • Get a list of proxies


    Method
    GET
    Route
    https://kingproxies.com/api/v2/proxies.json
    Response
    JSON

    Parameters
    NameTypeValueDescription
    keystringRegister to get your free API keyREQUIRED
    Your API key.
    typestringelite, anonymous, or transparentAdd this to retrieve only proxies with a type. Comma-separate multiple values to search with OR condition.
    DEFAULT: All types
    protocolsstringhttp, socks4, or socks5Add this to retrieve only proxies with a specific protocol. Comma-separate multiple values to search with OR condition.
    DEFAULT: All protocols
    alivebooleantrue/false, 1/0, yes/noOnly retrieve proxies that were tested to be working within the last 5 minutes.
    DEFAULT: true
    newbooleantrue/false, 1/0, yes/noOnly retrieve proxies that were added to the list in the past 24 hours.
    DEFAULT: false
    country_codestringAdd this to retrieve only proxies at this location. Comma-separate multiple values to search with OR condition.
    DEFAULT: All countries

    Response example
    https://kingproxies.com/api/v2/proxies.json?country_code=US
    {
      "data":{
        "proxies":[
          {
            "ip":"0.0.0.0",
            "port":1499,
            "region":"Georgia",
            "city":"Atlanta",
            "type":"elite",
            "protocols":["socks4","socks5"],
            "alive":true
          },
          {
            "ip":"0.0.0.0",
            "port":8938,
            "region":"Georgia",
            "city":"Duluth",
            "type":"elite",
            "protocols":["socks5"],
            "alive":true
          }
        ],
        "filters":{
          "country_code":"US"
        }
      },
      "request_id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
    
    Response object
    NameTypeDescription
    dataobjectRequested data
    request_idstringUnique 36-character string, identifying the request
    messagestringError or informational message
    data object
    NameTypeDescription
    proxiesarrayProxies matching requested filter conditions
    filtersobjectParameters that are common to all proxies
    Proxy object
    NameTypeDescription
    ipstringIP address
    portintegerPort
    country_codestringCountry code
    regionstringRegion
    citystringCity
    typestringType
    protocolsarrayList of protocols this proxy supports
    alivebooleanTrue if the proxy was working when last tested
  • Get a list of proxies


    Method
    GET
    Route
    https://kingproxies.com/api/v2/proxies.csv
    Response
    CSV

    Parameters
    NameTypeValueDescription
    keystringRegister to get your free API keyREQUIRED
    Your API key.
    typestringelite, anonymous, or transparentAdd this to retrieve only proxies with a type. Comma-separate multiple values to search with OR condition.
    DEFAULT: All types
    protocolsstringhttp, socks4, or socks5Add this to retrieve only proxies with a specific protocol. Comma-separate multiple values to search with OR condition.
    DEFAULT: All protocols
    alivebooleantrue/false, 1/0, yes/noOnly retrieve proxies that were tested to be working within the last 5 minutes.
    DEFAULT: true
    newbooleantrue/false, 1/0, yes/noOnly retrieve proxies that were added to the list in the past 24 hours.
    DEFAULT: false
    country_codestringAdd this to retrieve only proxies at this location. Comma-separate multiple values to search with OR condition.
    DEFAULT: All countries

    Response example
    https://kingproxies.com/api/v2/proxies.csv?country_code=US
    ip,port,region,city,type,protocols,alive
    0.0.0.0,6390,Georgia,West_Point,elite,http,true
    0.0.0.0,8938,Georgia,Duluth,elite,socks5,true
    
    Response columns
    NameTypeDescription
    ipstringIP address
    portintegerPort
    country_codestringCountry code
    regionstringRegion
    citystringCity
    typestringType
    protocolsstringList of protocols this proxy supports, comma separated
    alivebooleanTrue if the proxy was working when last tested
  • Get a list of proxies


    Method
    GET
    Route
    https://kingproxies.com/api/v2/proxies.xml
    Response
    XML

    Parameters
    NameTypeValueDescription
    keystringRegister to get your free API keyREQUIRED
    Your API key.
    typestringelite, anonymous, or transparentAdd this to retrieve only proxies with a type. Comma-separate multiple values to search with OR condition.
    DEFAULT: All types
    protocolsstringhttp, socks4, or socks5Add this to retrieve only proxies with a specific protocol. Comma-separate multiple values to search with OR condition.
    DEFAULT: All protocols
    alivebooleantrue/false, 1/0, yes/noOnly retrieve proxies that were tested to be working within the last 5 minutes.
    DEFAULT: true
    newbooleantrue/false, 1/0, yes/noOnly retrieve proxies that were added to the list in the past 24 hours.
    DEFAULT: false
    country_codestringAdd this to retrieve only proxies at this location. Comma-separate multiple values to search with OR condition.
    DEFAULT: All countries

    Response example
    https://kingproxies.com/api/v2/proxies.xml?country_code=US
    <?xml version="1.0" encoding="UTF-8"?>
    <response>
      <data>
        <proxies>
          <ip>0.0.0.0</ip>
          <port>1499</port>
          <region>Georgia</region>
          <city>Atlanta</city>
          <type>elite</type>
          <protocols>socks4</protocols>
          <protocols>socks5</protocols>
          <alive>true</alive>
        </proxies>
        <proxies>
          <ip>0.0.0.0</ip>
          <port>8938</port>
          <region>Georgia</region>
          <city>Duluth</city>
          <type>elite</type>
          <protocols>socks5</protocols>
          <alive>true</alive>
        </proxies>
        <filters>
          <country_code>US</country_code>
        </filters>
      </data>
      <request_id>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</request_id>
    </response>
    Response object
    NameTypeDescription
    dataobjectRequested data
    request_idstringUnique 36-character string, identifying the request
    messagestringError or informational message
    data object
    NameTypeDescription
    proxiesarrayProxies matching requested filter conditions
    filtersobjectParameters that are common to all proxies
    Proxy object
    NameTypeDescription
    ipstringIP address
    portintegerPort
    country_codestringCountry code
    regionstringRegion
    citystringCity
    typestringType
    protocolsarrayList of protocols this proxy supports
    alivebooleanTrue if the proxy was working when last tested