API Documentation

Access your live proxies through our simple API with JSON and XML response formats available.

Making requests

With the GhostProxies API, you can retrieve your proxies in multiple formats (JSON and XML). Below are some examples of making requests and configuration.

Requests are made using GET parameters in the samples below:

JSON

Request
http://ghostproxies.com/proxies/api.json?key=YOUR_API_KEY
Response
{
  "data": [
    {
      "Proxy": {
        "ip": "67.205.112.132",
        "portNum": "10000",
        "countryCode": "CA",
        "countryName": "Canada",
        "regionName": "Quebec",
        "cityName": "Montreal",
        "status": "online"
      }
    },
    // More proxy results
  ]
}

XML

Request
http://ghostproxies.com/proxies/api.xml?key=YOUR_API_KEY
Response
<response>
  <data>
    <Proxy>
      <ip>67.205.112.132</ip>
      <portNum>10000</portNum>
      <countryCode>CA</countryCode>
      <countryName>Canada</countryName>
      <regionName>Quebec</regionName>
      <cityName>Montreal</cityName>
      <status>online</status>
    </Proxy>
  </data>
  // More proxy results
</response>

Configuration Options

Available API configuration options are listed below.

Parameters Type Example Notes
key string http://ghostproxies.com/proxies/api.json?key=YOUR_API_KEY Your key is YOUR_API_KEY. You must provide a valid key as a parameter to retrieve your proxies in the response.
limit integer http://ghostproxies.com/proxies/api.json?key=YOUR_API_KEY&limit=5 Define limit for amount of proxies to return. Default will return all proxies with no limit.
authorize null http://ghostproxies.com/proxies/api.json?key=YOUR_API_KEY&authorize Set the "authorize" key to authorize your current IP with your proxies. This will overwrite all existing IP authorizations and may take 1-2 minutes to propagate.

Create your account and try a FREE private proxy!