Getting Started

Our Proxy API is very a simple service to use.
To get started, you will firstly need to sign up with our service in order to acquire an API Access Token.
This token can be easily found on your Dashboard Home Page.

Basic Usage

Your API token is used to authenticate you with our API, and can be provided as a token URL parameter.

                            #Utilize authentication token in URL parameter
                                $ curl https://api.proxykingdom.com/proxy?token=TOKEN
                        

Sample Response

Our Proxy API is fully RESTful responding in JSON format, and it will return a different proxy on each request.
The simplest way to get a working proxy is to call our Proxy API by only including the required Access Token in the URL parameter.

                            #Get a random proxy without any filtering
                                $ curl https://api.proxykingdom.com/proxy?token=TOKEN
                                
{ "address": "86.125.112.230", "port": 30897, "protocol": "Socks4", "accessType": "Elite", "isSsl": true, "uptime": 0.88, "lastTested": 2022-09-28T12:01:59Z, "timings": { "connectTime": 0.506, "firstByteTime": 0.607, "responseTime": 1.092 }, "isp": { "id": 10232, "name": "Comcast" }, "location": { "cityName": "Timișoara", "postalCode": "300011", "latitude": 45.7537, "longitude": 21.7537, "accuracyRadius": 1, "timezone": "Europe/Bucharest", "country": { "code": "RO", "name": "Romania" }, "continent": { "code": "EU", "name": "Europe" }, "subdivisions": [{ "code": "TM", "name": "Timis" }] } }

Filtering

Our Proxy API offers a wide range of powerful filters, allowing consumers to limit the result to a specific set of proxies.

Filter Parameters

Query ParameterDescriptionTypeExample
addressProxy address string/proxy?address=86.125.112.230
portProxy port integer/proxy?port=30897
protocolProxy protocol http, socks4, or socks5/proxy?protocol=socks4
accessTypeHow much of your info is hidden transparent, anonymous or elite/proxy?accessType=elite
responseTimeProxy response time in seconds decimal/proxy?responseTime=1.235
isSslIf the proxy uses SSL bool/proxy?isSsl=true
uptimeWhat percentage uptime the proxy has decimal/proxy?uptime=0.88
countryProxy country string / ISO 3166-1/proxy?country=RO
continentProxy continent string/proxy?continent=EU
timezoneProxy timezone string / TZ Database/proxy?timezone=Europe/Bucharest
lastTestedThe proxy last tested timestamp string / ISO 8601 (UTC) /proxy?lastTested=2022-09-28T12:01:59Z

Filter Concatenation

You can even go further and use multiple concatenated filters in a single request.

                            #Get a proxy with port 8080 and protocol socks4
                                $ curl https://api.proxykingdom.com/proxy?token=TOKEN&port=8080&protocol=socks4
                        
                            #Get a proxy with port 8080, protocol as socks4, country as United States, and response time <= 1.3s
                                $ curl https://api.proxykingdom.com/proxy?token=TOKEN&port=8080&protocol=socks4&country=US&responseTime=1.300
                            
                        

Data Types

PropertyDescriptionType
Proxy Data Type
addressThe proxy address string
portThe proxy port integer
protocolThe proxy protocol Http, Socks4 or Socks5
accessTypeHow much of your info is hidden Transparent, Anonymous or Elite
isSslIf the proxy uses SSL boolean
uptimeThe proxy uptime from 0 to 1 ratio decimal
lastTestedThe proxy last tested timestamp string / ISO 8601 (UTC)
Timings Data Type
connectTimeThe proxy connect time decimal
firstByteTimeTime to first byte decimal
responseTimeThe proxy response time decimal
Isp Data Type
idThe Autonomous System Identifier integer
nameThe Autonomous System Name string
Location Data Type
cityNameThe proxy city name string
postalCodeThe proxy postal code string
latitudeThe location latitude co-ordinate decimal
longitudeThe location longitude co-ordinate decimal
accuracyRadiusThe radius in km around the specified location integer
timezoneThe proxy timezone string / TZ Database
Country Data Type
codeThe proxy country ISO 3166 code string / ISO 3166-1
nameThe proxy country name string
Continent Data Type
codeThe proxy continent code string
nameThe proxy continent name string
Subdivision Data Type
codeThe proxy subdivision code string
nameThe proxy subdivision name string

Proxy Data Type

The Proxy data type is the full response you will get when you request a proxy from our Proxy API.
This will contain all the below data types in itself, including geolocation data, ASN data and proxy statistics.

                            {
    "address": "86.125.112.230",
    "port": 30897,
    "protocol": "Socks4",
    "accessType": "Elite",
    "isSsl": true,
    "uptime": 0.88,
    "lastTested": 2022-09-28T12:01:59Z,
    "timings": {
       "connectTime": 0.506,
       "firstByteTime": 0.607,
       "responseTime": 1.092
    },
    "isp": {
       "id": 10232,
       "name": "Comcast"
    },
    "location": {
       "cityName": "Timișoara",
       "postalCode": "300011",
       "latitude": 45.7537,
       "longitude": 21.7537,
       "accuracyRadius": 1,
       "timezone": "Europe/Bucharest",
       "country": {
          "code": "RO",
          "name": "Romania"
       },
       "continent": {
          "code": "EU",
          "name": "Europe"
       },
       "subdivisions": 
       [{
          "code": "TM",
          "name": "Timis" 
       }]
    }
 }
                        

Timings Data Type

This data type is all about the proxy request times.
The connectTime denotes the time taken to establish the TCP connection between the client and the proxy server using the TCP Handshake. The firstByteTime is the time taken for the client to receive the first byte from the proxy server. Lastly, the responseTime is the full time taken to receive the whole response from the proxy server to the client.

                            {
  ...
  "timings": {
     "connectTime": 0.506,
     "firstByteTime": 0.607,
     "responseTime": 1.092
  }
  ...
 }
                        

Isp Data Type

This data type provides data on the proxy Internet Service Provider, specifically the Autonomous System Number and the Autonomous System Name.

                            {
  ...
  "isp": {
     "id": 10232,
     "name": "Comcast"
  }
  ...
}
                        

Location Data Type

This data type contains all of the proxy geolocation details all in one place.
The geolocation data ranges from the proxy country details, the continent details, city details, and extends down to a list of subdivision details.

                            {
  ...
  "location": {
     "cityName": "Timișoara",
     "postalCode": "300011",
     "latitude": 45.7537,
     "longitude": 21.7537,
     "accuracyRadius": 1,
     "timezone": "Europe/Bucharest",
     "country": {
        "code": "RO",
        "name": "Romania"
     },
     "continent": {
        "code": "EU",
        "name": "Europe"
     },
     "subdivisions": 
     [{
        "code": "TM",
        "name": "Timis" 
     }]
  }
  ...
}
                        

Country Data Type

The Country data type will hold the country details of the chosen proxy.
The details entail the Country Name and its respective ISO Country Code.

                            {
  ...
  "country": {
     "code": "RO",
     "name": "Romania"
   }
  ...
}
                        

Continent Data Type

The Continent data type will hold the continent details of the chosen proxy.
The details entail the Continent Name and its respective Continent Code.

                            {
  ...
  "continent": {
     "code": "EU",
     "name": "Europe"
   }
  ...
}
                        

Subdivisions Data Type

This data type consists of a list of proxy subdivisions.
The subdivision details consist of the Subdisivion Code and the Subdisivion Name.

                            {
   ...
   "subdivisions": 
     [{
        "code": "TM",
        "name": "Timis" 
     }]
   ...
}
                        

Responses

Status CodeDescription
Successful Requests
200 OKProxy retrieved successfully
Failed Requests
400 BadRequestProxy request provided was invalid
404 NotFoundNo proxies found for the parameters provided
429 TooManyRequestsSubscription limit reached
500 InternalServerErrorServer is experiencing technical difficulties
We use cookies to give you the best experience on our site. If you want to know more please refer to our Cookie Policy. You can change these settings in the Cookie Settings.