proxy-lists

Node.js module for getting proxies from publicly available proxy lists. Support for more than two dozen different proxy lists. You can see the full list of proxy sources here.
Missing a proxy list that you think should be supported? Open an issue to suggest it be added as a source. Or you can add a new source and create a pull request to have it added to this module.

• Installation
  • Update GeoIp Database
• Command-line interface
• API
  • getProxies
    • Options
    • Proxy Object

    <li>
      <a rel="nofollow noopener" target="_blank" href="#getproxiesfromsource">getProxiesFromSource</a></p> <ul dir="auto">
        <li>
          <a rel="nofollow noopener" target="_blank" href="#options-for-getproxiesfromsource-method">Options</a>
        </li>
      </ul>
    </li>
    
    <li>
      <a rel="nofollow noopener" target="_blank" href="#addsource">addSource</a>
    </li>
    <li>
      <a rel="nofollow noopener" target="_blank" href="#listsources">listSources</a></p> <ul dir="auto">
        <li>
          <a rel="nofollow noopener" target="_blank" href="#options-for-listsources-method">Options</a>
        </li>
      </ul>
    </li>
  </ul>
  

  • Usage with Proxy
  • Contributing
    • Configure Local Environment
    • Tests
  • Changelog
  • License
  • Funding

  Installation

  If you wish to use this module as a CLI tool, install it globally via npm:

  npm install -g proxy-lists
  

  Otherwise, you can add it to your existing node application like this:

  npm install proxy-lists --save
  

  This will install proxy-lists and add it to your application’s package.json file.

  Update GeoIp Database

  This module uses geoip-lite to perform geoip-country lookups on IP addresses of proxies. The geoip-lite module ships with the free version of MaxMind’s geoip database. This database stopped being directly included in the module due to a change on MaxMind’s side – specifically with their end-user licensing agreements. So it is necessary for each end-user (that’s you!) to create their own MaxMind account and then generate a license key.
  If you are using this module inside another project (via the API), use the following command to update the geoip database:

  npm run update:geoip-database license_key=YOUR_LICENSE_KEY

  If you are using the CLI:

  proxy-lists updateGeoIpData --license-key YOUR_LICENSE_KEY

  Command-line interface

  This section assumes that you have proxy-lists installed globally and that it is available on your current user’s PATH.
  To view the help screen for the CLI tool:

  proxy-lists --help
  

  To view the help screen for the getProxies command:

  proxy-lists getProxies --help
  

  To output the proxies in .txt format:

  proxy-lists getProxies --output-format="txt"
  

  To output proxies to STDOUT:

  proxy-lists getProxies --stdout
  

  To output proxies to a different file than proxies.txt:

  proxy-lists getProxies --output-file="somefile.txt"
  

  To get proxies from specific sources:

  proxy-lists getProxies --sources-white-list="gatherproxy,sockslist"
  

  To get proxies from specific countries:

  proxy-lists getProxies --countries="us,ca"
  

  To get proxies with specific protocols:

  proxy-lists getProxies --protocols="http,https"
  

  To get only anonymous and elite proxies:

  proxy-lists getProxies --anonymity-levels="anonymous,elite"
  

  The output of the getProxies command is written to a new file (proxies.txt) in your current working directory.

  API

  These are the public methods of the ProxyLists module that allow you to get proxies, add custom proxy sources, and list existing sources.

  getProxies

  getProxies([options])
  Gets proxies from all available proxy lists.
  Usage:

  var ProxyLists = require('proxy-lists');
  
  // `getProxies` returns an event emitter.
  ProxyLists.getProxies({
  	// options
  	countries: ['us', 'ca']
  })
  	.on('data', function(proxies) {
  		// Received some proxies.
  		console.log('got some proxies');
  		console.log(proxies);
  	})
  	.on('error', function(error) {
  		// Some error has occurred.
  		console.log('error!', error);
  	})
  	.once('end', function() {
  		// Done getting proxies.
  		console.log('end!');
  	});

  Sample proxies:

  [
  	{
  		ipAddress: '123.123.2.42',
  		port: 8080,
  		country: 'us',
  		source: 'superproxies'
  	},
  	{
  		ipAddress: '234.221.233.142',
  		port: 3128,
  		country: 'cz',
  		protocols: ['https'],
  		source: 'someproxysource'
  	},
  	{
  		ipAddress: '234.221.233.142',
  		port: 3128,
  		country: 'cz',
  		anonymityLevel: 'elite',
  		protocols: ['https'],
  		source: 'anotherproxysource'
  	}
  ]

  Options for getProxies Method

  var options = {
  	/*
  		The filter mode determines how some options will be used to exclude proxies.
  
  		For example if using this option `anonymityLevels: ['elite']`:
  			'strict' mode will only allow proxies that have the 'anonymityLevel' property equal to 'elite'; ie. proxies that are missing the 'anonymityLevel' property will be excluded.
  			'loose' mode will allow proxies that have the 'anonymityLevel' property of 'elite' as well as those that are missing the 'anonymityLevel' property.
  	*/
  	filterMode: 'strict',
  
  	/*
  		Whether or not to emit only unique proxies (HOST:PORT).
  	*/
  	unique: true,
  
  	/*
  		Get proxies for the specified countries.
  
  		To get all proxies, regardless of country, set this option to NULL.
  
  		See:
  		https://en.wikipedia.org/wiki/ISO_3166-1
  
  		Only USA and Canada:
  		['us', 'ca']
  	*/
  	countries: null,
  
  	/*
  		Exclude proxies from the specified countries.
  
  		To exclude Germany and Great Britain:
  		['de', 'gb']
  	*/
  	countriesBlackList: null,
  
  	/*
  		Get proxies that use the specified protocols.
  
  		To get all proxies, regardless of protocol, set this option to NULL.
  
  		To get proxies with specified protocols:
  		['socks4', 'socks5']
  	*/
  	protocols: null,
  
  	/*
  		Anonymity level.
  
  		To get all proxies, regardless of anonymity level, set this option to NULL.
  
  		To get proxies with specified anonymity-levels:
  		['elite', 'anonymous']
  	*/
  	anonymityLevels: null,
  
  	/*
  		Include proxy sources by name.
  
  		Only 'freeproxylists':
  		['freeproxylists']
  	*/
  	sourcesWhiteList: null,
  
  	/*
  		Exclude proxy sources by name.
  
  		All proxy sources except 'freeproxylists':
  		['freeproxylists']
  	*/
  	sourcesBlackList: null,
  
  	/*
  		Full path to the sources directory.
  	*/
  	sourcesDir: path.join(__dirname, 'sources'),
  
  	/*
  		Set to TRUE to have all asynchronous operations run in series.
  	*/
  	series: false,
  
  	/*
  		Options to pass to puppeteer when creating a new browser instance.
  	*/
  	browser: {
  		headless: true,
  		slowMo: 0,
  		timeout: 10000,
  	},
  
  	/*
  		Default request module options. For example you could pass the 'proxy' option in this way.
  
  		See for more info:
  		https://github.com/request/request#requestdefaultsoptions
  	*/
  	defaultRequestOptions: null,
  
  	/*
  		Use a queue to limit the number of simultaneous HTTP requests.
  	*/
  	requestQueue: {
  		/*
  			The maximum number of simultaneous requests.
  		*/
  		concurrency: 1,
  		/*
  			The time (in milliseconds) between each request. Set to 0 for no delay.
  		*/
  		delay: 0,
  	},
  };

  Proxy Object

  The proxy object has the following properties:

  • ipAddress – string The IP address of the proxy.
  • port – integer The port number of the proxy.
  • country – string Alpha-2 country code of the country in which the proxy is geo-located.
  • source – string The name of the proxy list from which the proxy was gathered.
  • protocols – optional array An array of protocols that the proxy supports. May contain one or more of the following:
    • http – The proxy uses HTTP.
    • https – The proxy uses HTTPS.
    • socks5 – The proxy server uses the socks5 protocol.
    • socks4 – The proxy server uses the socks4 protocol.
  • anonymityLevel – optional string The anonymity level of the proxy. Can be any one of the following:
    • transparent – The proxy does not hide the requester’s IP address.
    • anonymous – The proxy hides the requester’s IP address, but adds headers to the forwarded request that make it clear that the request was made using a proxy.
    • elite – The proxy hides the requester’s IP address and does not add any proxy-related headers to the request.

  The attributes marked as optional above might not be given for all proxies. Some proxy lists are missing this information.
  It’s important to note that this module does NOT verify all of the information provided by the proxy lists from which the proxies are gathered. If you need to check that proxies work, verify their anonymity level, whether or not they support tunneling; use proxy-verifier.

  getProxiesFromSource

  getProxiesFromSource(name, [options])
  Gets proxies from a specific proxy list.
  Usage:

  var ProxyLists = require('proxy-lists');
  
  // `getProxiesFromSource` returns an event emitter.
  ProxyLists.getProxiesFromSource('freeproxylists', {
  	anonymityLevels: ['elite']
  })
  	.on('data', function(proxies) {
  		// Received some proxies.
  		console.log('got some proxies');
  		console.log(proxies);
  	})
  	.on('error', function(error) {
  		// Some error has occurred.
  		console.log('error!', error);
  	})
  	.once('end', function() {
  		// Done getting proxies.
  		console.log('end!');
  	});

  Options for getProxiesFromSource Method

  See Options for getProxies Method.

  addSource

  addSource(name, source)
  Add a custom proxy source to the list of available proxies. The new proxy source will be used in addition to the existing sources, when calling getProxies().
  Usage:

  var ProxyLists = require('proxy-lists');
  
  ProxyLists.addSource('my-custom-source', {
  	homeUrl: 'https://somewhere.com',
  	getProxies: function(options) {
  
  		var emitter = options.newEventEmitter();
  
  		_.defer(function() {
  			// When an error occurs, use the 'error' event.
  			// The 'error' event can be emitted more than once.
  			emitter.emit('error', new Error('Something bad happened!'));
  
  			// When proxies are ready, use the 'data' event.
  			// The 'data' event can be emitted more than once.
  			emitter.emit('data', proxies);
  
  			// When done getting proxies, emit the 'end' event.
  			// The 'end' event should be emitted once.
  			emitter.emit('end');
  		});
  
  		// Must return an event emitter.
  		return emitter;
  	}
  });

  Your proxy source is required to return the following for each proxy: ipAddress, port. See Proxy Object above for more information.
  Please consider sharing your custom proxy sources by creating a pull request to have them added to this module so that others can use them too.

  Important Options to Note

  Please note that there are a couple options that you should respect in your custom proxy source:

  • sample – boolean If options.sample is true then you should do your best to make the fewest number of HTTP requests to the proxy source but still get at least some real proxies. The purpose of this option is to reduce the strain caused by this module’s unit tests on each proxy sources’…