{"id":20398641,"url":"https://github.com/bsnext/iproyal.com-wrapper","last_synced_at":"2026-06-01T02:31:35.889Z","repository":{"id":90607676,"uuid":"507530990","full_name":"bsnext/IPRoyal.com-Wrapper","owner":"bsnext","description":"JavaScript Async/Await API for proxy service IPRoyal.com","archived":false,"fork":false,"pushed_at":"2022-06-27T09:56:22.000Z","size":4,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-07T09:18:05.641Z","etag":null,"topics":["iproyal","js","proxy","wrapper"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bsnext.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-26T09:30:22.000Z","updated_at":"2024-07-06T14:39:47.000Z","dependencies_parsed_at":"2023-03-13T17:55:12.683Z","dependency_job_id":null,"html_url":"https://github.com/bsnext/IPRoyal.com-Wrapper","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/bsnext/IPRoyal.com-Wrapper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bsnext%2FIPRoyal.com-Wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bsnext%2FIPRoyal.com-Wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bsnext%2FIPRoyal.com-Wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bsnext%2FIPRoyal.com-Wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bsnext","download_url":"https://codeload.github.com/bsnext/IPRoyal.com-Wrapper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bsnext%2FIPRoyal.com-Wrapper/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33757790,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-01T02:00:06.963Z","response_time":115,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["iproyal","js","proxy","wrapper"],"created_at":"2024-11-15T04:23:04.836Z","updated_at":"2026-06-01T02:31:35.870Z","avatar_url":"https://github.com/bsnext.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![](https://iproyal.com/wp-content/uploads/2018/11/Logo-1.png)\n## IPRoyal Residential API Wrapper\n\nJavaScript Async/Await API for proxy service [IPRoyal.com](https://iproyal.com/)\n\n## API\n\nTo work with the API, you must have an account token. \nYou can get it in your personal account on the portal.\n\n## Starting\n\nConnect the IPRoyal module to Node.JS and create a new instance of the class.\n\n```javascript\nlet iproyal = require(`iproyal-wrapper`);\nlet token = `abc`; // IPRoyal account token\n\nlet account = new iproyal(token);\n```\n\n## Methods\n* new IPRoyal();\n* account.getInfo();\n* account.getSubUsers();\n* account.createSubUser();\n* account.getSubUserInfo();\n* account.updateSubUserInfo();\n* account.addSubUserTraffic();\n* account.takeSubUserTraffic();\n* account.getAvailableCountries();\n* account.getAvailableCountrySets();\n* account.getAvailableRegions();\n* account.getProxyHostNames();\n* account.generateUserProxyList();\n\n## Examples\n\n```javascript\nlet account = new iproyal(`abc`);\nlet subusersList = await account.getSubUsers(10);\nconsole.log(subusersList);\nconsole.log(await subusersList.next());\nconsole.log(await subusersList.next());\n```\n\n```javascript\nlet account = new iproyal(`abc`);\nlet newSubUser = await account.creteSubUser(`login`, `password`, traffic);\nconsole.log(anewSubUser);\n```\n\n```javascript\nlet newSubUser = await account.creteSubUser(`login`, `password`, traffic);\nconsole.log(await account.addSubUserTraffic(newSubUser.id, 4));\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbsnext%2Fiproyal.com-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbsnext%2Fiproyal.com-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbsnext%2Fiproyal.com-wrapper/lists"}