Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lenconda/free-proxy
Fetch free proxies from https://www.free-proxy-list.com
https://github.com/lenconda/free-proxy
Last synced: 3 months ago
JSON representation
Fetch free proxies from https://www.free-proxy-list.com
- Host: GitHub
- URL: https://github.com/lenconda/free-proxy
- Owner: lenconda
- License: mit
- Created: 2018-12-28T16:11:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-09-15T03:48:45.000Z (almost 2 years ago)
- Last Synced: 2024-03-18T21:19:50.002Z (3 months ago)
- Language: JavaScript
- Size: 27.3 KB
- Stars: 16
- Watchers: 3
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - free-proxy - Fetch free proxies from https://www.free-proxy-list.com (JavaScript)
README
# Free Proxy
[](https://badge.fury.io/js/free-proxy)
[](https://github.com/lenconda/free-proxy/blob/master/LICENSE)
[](https://github.com/dwyl/esta/issues)
Fetch free proxies from https://www.free-proxy-list.com
## Features
- Fetch HTTP/HTTPS proxies
- Promise and async/await support
- ES6 class support
- Get proxies in medium and high speed
- Non-Chinese proxies
- Typescript Typings
## Requirements
| Item | Details |
| ----------- | ------------------------------------------------------------ |
| System | GNU/Linux (>=2.6.x), macOS (>=10.10.x), Windows (later than XP) |
| Environment | Node.js >= 8.2.0 |
## Installation
```bash
# under product mode
$ npm install free-proxy --save
$ yarn add free-proxy
# under development mode
$ npm install free-proxy --save-dev
$ yarn add -D free-proxy
```
## Quick Start
After you finished the installation above, you will have a package `free-proxy` in your `./node_modules` directory.
### Import
Default module exports in CommonJS style
```javascript
const ProxyList = require('free-proxy');
const proxyList = new ProxyList();
```
or
```javascript
import ProxyList from 'free-proxy';
const proxyList = new ProxyList();
```
### Usages
###### proxyList.get()
Get proxy list. This function will craw the website and returns an array of proxy list, and some information (e.g. IP address, port, country, etc.) wrapped in a Promise object.
Recommended usage:
```javascript
let proxies;
try {
proxies = await proxyList.get();
} catch (error) {
throw new Error(error);
}
```
or alternatively:
```javascript
proxyList.get()
.then(function (proxies) {
// get proxies here
})
.catch(function (error) {
throw new Error(error);
});
```
###### proxyList.getByProtocol()
Get list of proxies using a specific protocol. This function will use `proxyList.get` and filter the result by protocaol
Recommended usage:
```javascript
let proxies;
try {
proxies = await proxyList.getByProtocol('https');
} catch (error) {
throw new Error(error);
}
```
or alternatively:
```javascript
proxyList.getByProtocol('http')
.then(function (proxies) {
// get proxies here
})
.catch(function (error) {
throw new Error(error);
});
```
###### proxyList.getByCountryCode()
Get proxy list from a specific country. This function will use `proxyList.get` and filter the result by countryCode
Recommended usage:
```javascript
let proxies;
try {
proxies = await proxyList.getByCountryCode('FR');
} catch (error) {
throw new Error(error);
}
```
or alternatively:
```javascript
proxyList.getByCountryCode('FR')
.then(function (proxies) {
// get proxies here
})
.catch(function (error) {
throw new Error(error);
});
```
###### proxyList.random()
Get a proxy randomly. Based on `proxyList.get()`, this function will get a random item from the results of `proxyList.get()`
Recommended usage:
```javascript
let data;
try {
data = await proxyList.random();
} catch (error) {
throw new Error(error);
}
```
or alternatively:
```javascript
proxyList.random()
.then(function (data) {
// get data here
})
.catch(function (error) {
throw new Error(error);
});
```
###### proxyList.randomByProtocol()
Get a proxy randomly. Based on `proxyList.getByProtocol()`, this function will get a random item from the results of `proxyList.get()`
Recommended usage:
```javascript
let data;
try {
data = await proxyList.randomByProtocol('https');
} catch (error) {
throw new Error(error);
}
```
or alternatively:
```javascript
proxyList.randomByProtocol('http')
.then(function (data) {
// get data here
})
.catch(function (error) {
throw new Error(error);
});
```
###### proxyList.randomByCountryCode()
Get a proxy randomly. Based on `proxyList.getByCountryCode()`, this function will get a random item from the results of `proxyList.get()`
Recommended usage:
```javascript
let data;
try {
data = await proxyList.randomByCountryCode('FR');
} catch (error) {
throw new Error(error);
}
```
or alternatively:
```javascript
proxyList.randomByCountryCode('FR')
.then(function (data) {
// get data here
})
.catch(function (error) {
throw new Error(error);
});
```
###### proxyList.randomFromCache()
Get a proxy randomly. Based on `proxyList.get()`, this function will get a random item from the results of `proxyList.get()`. The list is cached the first time the method is invoked and only updated once the cached list runs out of proxies.
Recommended usage:
```javascript
let data;
try {
data = await proxyList.randomFromCache();
} catch (error) {
throw new Error(error);
}
```
or alternatively:
```javascript
proxyList.randomFromCache()
.then(function (data) {
// get data here
})
.catch(function (error) {
throw new Error(error);
});
```
## Tests
To run the test suite, go to the root directory of this package, and install dependencies, and then run `npm test` or `npm run test`:
```bash
$ cd /path/to/free-proxy
$ npm install
$ npm test
# or
$ npm run test
```
# License
[MIT](License)