API Documentation

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:


Example Request
GET https://ghostproxies.com/proxies/api.json?key=YOUR_API_KEY
Example Response
   "data": [
         "Proxy": {
            "ip": "",
            "portNum": "80",
            "countryCode": "US",
            "countryName": "United States",
            "regionName": "California",
            "cityName": "San Francisco",
            "status": "Online"
            "panel_user": "ProxyUsername"
            "panel_pass": "ProxyPassword"
      // More proxy results


Example Request
GET https://ghostproxies.com/proxies/api.xml?key=YOUR_API_KEY
Example Response
         <countryName>United States</countryName>
         <cityName>San Francisco</cityName>
   // More proxy results

Configuration Options

Available API configuration options are listed below.

Parameters Type Example Notes
key string https://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 https://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.