https://github.com/bsnext/iproyal.com-wrapper
JavaScript Async/Await API for proxy service IPRoyal.com
https://github.com/bsnext/iproyal.com-wrapper
iproyal js proxy wrapper
Last synced: 20 days ago
JSON representation
JavaScript Async/Await API for proxy service IPRoyal.com
- Host: GitHub
- URL: https://github.com/bsnext/iproyal.com-wrapper
- Owner: bsnext
- Created: 2022-06-26T09:30:22.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-27T09:56:22.000Z (almost 4 years ago)
- Last Synced: 2025-12-07T09:18:05.641Z (7 months ago)
- Topics: iproyal, js, proxy, wrapper
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## IPRoyal Residential API Wrapper
JavaScript Async/Await API for proxy service [IPRoyal.com](https://iproyal.com/)
## API
To work with the API, you must have an account token.
You can get it in your personal account on the portal.
## Starting
Connect the IPRoyal module to Node.JS and create a new instance of the class.
```javascript
let iproyal = require(`iproyal-wrapper`);
let token = `abc`; // IPRoyal account token
let account = new iproyal(token);
```
## Methods
* new IPRoyal();
* account.getInfo();
* account.getSubUsers();
* account.createSubUser();
* account.getSubUserInfo();
* account.updateSubUserInfo();
* account.addSubUserTraffic();
* account.takeSubUserTraffic();
* account.getAvailableCountries();
* account.getAvailableCountrySets();
* account.getAvailableRegions();
* account.getProxyHostNames();
* account.generateUserProxyList();
## Examples
```javascript
let account = new iproyal(`abc`);
let subusersList = await account.getSubUsers(10);
console.log(subusersList);
console.log(await subusersList.next());
console.log(await subusersList.next());
```
```javascript
let account = new iproyal(`abc`);
let newSubUser = await account.creteSubUser(`login`, `password`, traffic);
console.log(anewSubUser);
```
```javascript
let newSubUser = await account.creteSubUser(`login`, `password`, traffic);
console.log(await account.addSubUserTraffic(newSubUser.id, 4));
```