ephemeral-proxies

Javascript client library for Ephemeral proxies API

⚠️ This library requires a valid Rapid API key to access Ephemeral Proxies API. A Rapid API key can easily be obtained on https://rapidapi.com/.

ℹ️ More information about Ephemeral Proxies API can be found here

Example:

$ npm install -s ephemeral-proxies

main.js:

const ep = require('ephemeral-proxies');

(async function main() {
    try {
        let proxy = await ep.getProxy(ep.ProxyType.datacenter)
        console.log(proxy)
    } catch (e) {
        console.warn(e)
    }
})()

The Rapid API key can be set by EP_RAPIDAPI_KEY environment variable.

$ EP_RAPIDAPI_KEY=YOUR_API_KEY_HERE node main.js

{
    "success": true,
    "proxy": {
        "id": "bcdedb1e958400a7a213250a0d877777",
        "host": "l9de0.ep-proxy.net",
        "port": 33357,
        "expires_at": "2022-08-02T21:16:12.000Z",
        "whitelisted_ips": [
            "91.267.2.90"
        ],
        "visibility": {
            "ip": "84.54.58.127",
            "country": "United Kingdom",
            "country_iso": "GB",
            "country_eu": true,
            "latitude": 51.5088,
            "longitude": -0.126,
            "timezone": "Europe/London",
            "asn": "AS174",
            "asn_org": "Cogent Communications",
            "zip_code": "WC1N",
            "region_name": "England",
            "region_code": "ENG",
            "city": "London"
        },
        "features": {
            "static": true,
            "supported_protocols": {
                "socks4": false,
                "socks5": false,
                "http": true,
                "https": true
            }
        }
    }
}

Library functions

• getProxy(proxyType, countries, whitelistIp, rapidApiKey) - Returns a new proxy.

  proxyType is required. Set to ep.ProxyType.datacenter or ep.ProxyType.residential to select the proxy type.

  countries argument is optional. A string array of country codes, that you would like the proxies to be located. If null or empty, country will be randomly selected.

  whitelistIp argument is optional. The proxy will allow connections from the source ip that is making this API call. Additionally, you can allow an extra ip to connect to the proxy by using whitelistIp argument.

  rapidApiKey argument is optional. If null or unset, EP_RAPIDAPI_KEY environment variable is required.

  Example:

  let proxy = ep.getProxy(ep.ProxyType.datacenter, rapidApiKey)
  console.log(proxy)
  

• getServiceStatus(proxyType, rapidApiKey) - Retrieves API service status.

  proxyType is required. Set to ep.ProxyType.datacenter or ep.ProxyType.residential to select the proxy service.

  rapidApiKey argument is optional. If null or unset, EP_RAPIDAPI_KEY environment variable is required.

  Example:

  let service = ep.getServiceStatus(ep.ProxyType.residential, rapidApiKey)
  console.log(service)
  

• extendProxy(proxyId, rapidApiKey) - Extends expiration time of Datacenter Proxy by 30 minutes.

  proxyId argument is required. Id of proxy to extend.

  rapidApiKey argument is optional. If null or unset, EP_RAPIDAPI_KEY environment variable is required.

  Example:

  let proxy = ep.getProxy(rapidApiKey)
  let proxyExtended = ep.extendProxy(proxy.id, rapidApiKey)
  console.log(proxyExtended)
  

• getUserBalance(rapidApiKey) - Get information about Residential traffic's usage.

  Example:

  let balance = ep.getUserBalance(rapidApiKey)
  console.log(balance)