{"info":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","description":"

WARNING: This API is deprecated and will be permanently shut down on July 14, 2025. Transition to the new API to avoid service disruptions.

IPRoyal Royal Residential API for Resellers.

You can get you X-Access-Token in https://dashboard.iproyal.com/settings.

IMPORTANT: you won't be able to use Residential API while IPRoyal manager didn't gave you access.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10917935","collectionId":"d883d5e9-7aec-48de-85a2-0670165d49f1","publishedId":"Uz5KjZ8k","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3c4b64"},"publishDate":"2022-06-07T10:03:12.000Z"},"item":[{"name":"Reseller account","item":[{"name":"Show your reseller account info","id":"ea272dd1-24ac-4047-9f8b-b51954f3eb17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/my-info","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","my-info"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"681260c9-f7ce-4506-8cb9-55b2957d76d8","name":"Show your reseller account info","originalRequest":{"method":"GET","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/my-info"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"availableTraffic\": 1032.80,\n \"subUsersCount\": 27\n}"}],"_postman_id":"ea272dd1-24ac-4047-9f8b-b51954f3eb17"},{"name":"Rotate user sessions","id":"6a8d200b-416e-40e0-b064-b60c653a112d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sessions","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sessions"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6a8d200b-416e-40e0-b064-b60c653a112d"},{"name":"Rotate user sessions by id","id":"be174464-3d4b-4586-af8f-db28556ed64a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/rotate-sessions-by-ids","description":"

ids - array required

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","rotate-sessions-by-ids"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"2960db4d-7688-41b6-b251-dca792932c3c","name":"Rotate user sessions by id","originalRequest":{"method":"POST","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [1]\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/rotate-sessions-by-ids"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"be174464-3d4b-4586-af8f-db28556ed64a"}],"id":"624a86a5-901e-4e9d-8152-4ca624d6b36a","_postman_id":"624a86a5-901e-4e9d-8152-4ca624d6b36a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}}},{"name":"Sub Users","item":[{"name":"Whitelist","item":[{"name":"Get whitelist entries","id":"2fc7abcf-2f30-4d60-8860-d19ae3758ee8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/{sub-user-id}/whitelist-entry","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sub-users","{sub-user-id}","whitelist-entry"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2fc7abcf-2f30-4d60-8860-d19ae3758ee8"},{"name":"Create whitelist entry","id":"83e98947-b641-4df0-9234-0f7c49fc9a44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/{sub-user-id}/whitelist-entry","description":"

To create an entry you need specify:

ip - IP that will be connecting

port - numeric port value, available ports are returned in this endpoint: https://dashboard.iproyal.com/api/residential/royal/reseller/access/ports

configuration - a string that will define the proxie's location, session type and time, etc. More information on this in \"Access\" section

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sub-users","{sub-user-id}","whitelist-entry"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"83e98947-b641-4df0-9234-0f7c49fc9a44"},{"name":"Update whitelist entry","id":"a527b9d1-89c8-4e3d-9510-72c3832f3d2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/{sub-user-id}/whitelist-entry/{whitelist-entry-hash}","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sub-users","{sub-user-id}","whitelist-entry","{whitelist-entry-hash}"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a527b9d1-89c8-4e3d-9510-72c3832f3d2c"},{"name":"Delete whitelist entry","id":"5ede3335-4345-452f-afba-3064381ecf55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/{sub-user-id}/whitelist-entry/{whitelist-entry-hash}","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sub-users","{sub-user-id}","whitelist-entry","{whitelist-entry-hash}"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ede3335-4345-452f-afba-3064381ecf55"}],"id":"5063cfb4-80e4-4c32-ade5-f79156b58ff1","_postman_id":"5063cfb4-80e4-4c32-ade5-f79156b58ff1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}}},{"name":"Show","id":"cc76d62d-79c1-4141-9e99-85eab796dcdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Access-Token","type":"text","value":"Bearer API-ACCESS-TOKEN"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/{sub-user-id}","description":"

Returns information about a single sub-user owned by your IPRoyal Royal Residential Reseller account.

Available trafic is listed in GB.

\n","urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sub-users","{sub-user-id}"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"0b44ff66-9bcf-4e12-bbbd-ebfd2663113f","name":"Show","originalRequest":{"method":"GET","header":[{"key":"X-Access-Token","type":"text","value":"Bearer API-ACCESS-TOKEN"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/2"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"username\": \"user111\",\n \"password\": \"password111\",\n \"availableTraffic\": 2,\n \"usedTraffic\": 1.65\n}"}],"_postman_id":"cc76d62d-79c1-4141-9e99-85eab796dcdc"},{"name":"Create","id":"dd727f45-3fa3-4b8c-b1d4-e0a8dee5c29c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Access-Token","type":"text","value":"Bearer API-ACCESS-TOKEN"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"newuser\",\n \"password\": \"newuserpass\",\n \"traffic\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users","description":"

Creates a sub-user under your IPRoyal Royal Residential Reseller account.

Username: Must be from 3 to 30 characters long. Only letters, numbers, and underscore (_) are allowed.

Password: Must be from 6 to 16 characters long. Only letters and numbers allowed.

Traffic: This will be added from your main User.

\n","urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sub-users"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"6e3d89f7-fa06-4aa0-a67b-c3c037ef52b9","name":"Create","originalRequest":{"method":"POST","header":[{"key":"X-Access-Token","type":"text","value":"Bearer API-ACCESS-TOKEN"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"newuser\",\n \"password\": \"newuserpassword\",\n \"traffic\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 55,\n \"username\": \"newuser\",\n \"password\": \"newuserpassword\",\n \"availableTraffic\": 2,\n \"usedTraffic\": 0\n}"}],"_postman_id":"dd727f45-3fa3-4b8c-b1d4-e0a8dee5c29c"},{"name":"Update","id":"ff75d8ee-0caa-4ce3-b033-6e78b930c17f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Access-Token","type":"text","value":"Bearer API-ACCESS-TOKEN"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"newusername\",\n \"password\": \"newpassword\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/{sub-user-id}","description":"

Change password of a sub-user.

Password must be from 6 to 16 characters long. Only letters and numbers allowed.

The sub-user's new password is returned as part of the response body.

\n","urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sub-users","{sub-user-id}"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"16fac9ff-81c9-44ba-8edc-9fb645f57c28","name":"Update","originalRequest":{"method":"PATCH","header":[{"key":"X-Access-Token","type":"text","value":"Bearer API-ACCESS-TOKEN"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"newusername\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/2"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"username\": \"newusername\",\n \"password\": \"password111\",\n \"availableTraffic\": 2,\n \"usedTraffic\": 1.65\n}"}],"_postman_id":"ff75d8ee-0caa-4ce3-b033-6e78b930c17f"},{"name":"Delete","id":"87772592-46e2-479c-bebd-148b4941bd1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Access-Token","type":"text","value":"Bearer API-ACCESS-TOKEN"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/{sub-user-id}","description":"

Deletes sub-user, traffic left will be transfered back to main user.

\n","urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sub-users","{sub-user-id}"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"87772592-46e2-479c-bebd-148b4941bd1d"},{"name":"List","id":"fcbd46e7-a039-4b29-a04d-ae1f54b16118","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users","description":"

Returns a list of sub-users owned by your IPRoyal Residential Reseller account.

Pagination is possible by adding \"page\" and \"pageSize\" query parameters.

Additionally, you can add the \"search\" query parameter, which will return sub-users by usernames.

Traffic is listed in GB.

\n","urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sub-users"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"886ebb2a-9d8b-4640-b617-91cbd1598db8","name":"List","originalRequest":{"method":"GET","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"page\": 1,\n \"pageSize\": 20,\n \"totalCount\": 3,\n \"filteredCount\": 3,\n \"data\": [\n {\n \"id\": 2156,\n \"username\": \"user111\",\n \"password\": \"password111\",\n \"availableTraffic\": 2,\n \"usedTraffic\": 1.12\n },\n {\n \"id\": 2157,\n \"username\": \"user222\",\n \"password\": \"password222\",\n \"availableTraffic\": 1,\n \"usedTraffic\": 0\n },\n {\n \"id\": 2158,\n \"username\": \"user333\",\n \"password\": \"password333\",\n \"availableTraffic\": 0.77,\n \"usedTraffic\": 1.23\n }\n ]\n}"}],"_postman_id":"fcbd46e7-a039-4b29-a04d-ae1f54b16118"},{"name":"Give traffic","id":"fc9bc083-bacc-4b22-86c7-f46b6b00813f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Access-Token","type":"text","value":"Bearer API-ACCESS-TOKEN"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/{sub-user-id}/give-traffic","description":"

Gives traffic to a sub-user.

Traffic amount must be numeric, can not be negative and have 2 decimal places.

The traffic amount given to the sub-user is subtracted from your IPRoyal Royal Residential Reseller account balance.

The 'traffic_available' value in the response body indicates the sub-user's new available traffic value.

\n","urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sub-users","{sub-user-id}","give-traffic"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"11f64f15-6ea8-4c3a-a353-97d827eba798","name":"Give traffic","originalRequest":{"method":"POST","header":[{"key":"X-Access-Token","type":"text","value":"Bearer API-ACCESS-TOKEN"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/2/give-traffic"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"username\": \"user111\",\n \"password\": \"password111\",\n \"availableTraffic\": 2,\n \"usedTraffic\": 1.65\n}"}],"_postman_id":"fc9bc083-bacc-4b22-86c7-f46b6b00813f"},{"name":"Take traffic","id":"a737a780-f30f-498a-8a56-ee0f1a775404","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Access-Token","type":"text","value":"Bearer API-ACCESS-TOKEN"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/{sub-user-id}/take-traffic","description":"

Takes traffic from a sub-user.

Traffic amount must be numeric, can not be negative and have 2 decimal places.

The traffic amount taken from the sub-user is added to your IPRoyal Royal Residential Reseller account balance.

The 'availableTraffic' value in the response body indicates the sub-user's new available traffic value.

\n","urlObject":{"protocol":"https","path":["api","residential","royal","reseller","sub-users","{sub-user-id}","take-traffic"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"a327bfd8-1cf0-4053-bbe7-3afa486f5a93","name":"Take traffic","originalRequest":{"method":"POST","header":[{"key":"X-Access-Token","type":"text","value":"Bearer API-ACCESS-TOKEN"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/sub-users/2/take-traffic"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"username\": \"user111\",\n \"password\": \"password111\",\n \"availableTraffic\": 1,\n \"usedTraffic\": 1.65\n}"}],"_postman_id":"a737a780-f30f-498a-8a56-ee0f1a775404"}],"id":"a309cfdb-7fa8-4bb6-9dd4-f507f29d3860","_postman_id":"a309cfdb-7fa8-4bb6-9dd4-f507f29d3860","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}}},{"name":"Access","item":[{"name":"List available countries","id":"eee6b3ff-a19c-4a50-aead-684fbea676dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/access/countries","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","access","countries"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"0bf0e08d-9fb8-4c06-adb1-59b12a1ce698","name":"List available countries","originalRequest":{"method":"GET","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/access/countries"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"prefix\": \"_country-\",\n \"countries\": [\n {\n \"code\": \"dz\",\n \"name\": \"Algeria\",\n \"cities\": {\n \"prefix\": \"_city-\",\n \"options\": [\n {\n \"code\": \"algiers\"\n },\n {\n \"code\": \"oran\"\n }\n ]\n }\n },\n {\n \"code\": \"ao\",\n \"name\": \"Angola\",\n \"cities\": {\n \"prefix\": \"_city-\",\n \"options\": [\n {\n \"code\": \"luanda\"\n }\n ]\n }\n }\n ...\n ]\n]"}],"_postman_id":"eee6b3ff-a19c-4a50-aead-684fbea676dd"},{"name":"List available country sets","id":"71f072ae-9eee-4ee1-9745-b81e13f9d800","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/access/country-sets","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","access","country-sets"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"429de207-b554-4803-b2d1-84f532ef258e","name":"List available country sets","originalRequest":{"method":"GET","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/access/country-sets"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"prefix\": \"_set-\",\n \"countrySets\": [\n {\n \"code\": \"ftl\",\n \"name\": \"FTL\"\n },\n {\n \"code\": \"mesh1\",\n \"name\": \"MESH 1\"\n },\n {\n \"code\": \"mesh2\",\n \"name\": \"MESH 2\"\n },\n ...\n ]\n}"}],"_postman_id":"71f072ae-9eee-4ee1-9745-b81e13f9d800"},{"name":"List available regions","id":"9adfaae1-2e14-4f34-9fa3-7bad92aed352","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/access/regions","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","access","regions"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"9fe13fec-ab8d-4dc8-bd10-bfb883cb50be","name":"List available regions","originalRequest":{"method":"GET","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/access/regions"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"prefix\": \"_region-\",\n \"regions\": [\n {\n \"code\": \"africa\",\n \"name\": \"Africa\"\n },\n {\n \"code\": \"arabstates\",\n \"name\": \"Arab States\"\n },\n ...\n ]\n}"}],"_postman_id":"9adfaae1-2e14-4f34-9fa3-7bad92aed352"},{"name":"List proxy hostnames","id":"9bbe1b76-05d1-48ab-be1d-2d3cefa61aa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/access/hostnames","description":"

Different hostnames helps to determine the faster route from the country you are situated in, keep in mind that almost in all cases you should use geo.iproyal.com

us.proxy.iproyal.com is used for these country codes - us, mx, cu, pr, gt, ni, nikena
sg.proxy.iproyal.com is used for these country codes - sg, my, id, ph, vn, th, nikeas
au.proxy.iproyal.com is used for these country codes - au, nz, pg
proxy.iproyal.com for all other countries.

How to make your custom domain? (CNAME Record For Your Domain)

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","access","hostnames"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"b82d7cc4-d9eb-4495-918b-89690d30e5cf","name":"List proxy hostnames","originalRequest":{"method":"GET","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/access/hostnames"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"dns\": \"proxy.iproyal.com\",\n \"ip\": \"91.239.130.17\",\n \"ports\": [\n {\n \"name\": \"https|https\",\n \"port\": 22323\n },\n {\n \"name\": \"socks5\",\n \"port\": 52325\n }\n ]\n },\n {...}\n]"}],"_postman_id":"9bbe1b76-05d1-48ab-be1d-2d3cefa61aa7"},{"name":"List available ports","id":"edbd38fa-c53d-4312-af4a-ea14a2a0ab1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/access/ports","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","residential","royal","reseller","access","ports"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"4dc02ebb-c65e-4a60-adf1-b3a4b5e5a46e","name":"List available ports","originalRequest":{"method":"GET","header":[{"key":"X-Access-Token","value":"Bearer API-ACCESS-TOKEN","type":"text"}],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/access/ports"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"http|https\",\n \"port\": 22323\n },\n {\n \"name\": \"socks5\",\n \"port\": 52327\n }\n]"}],"_postman_id":"edbd38fa-c53d-4312-af4a-ea14a2a0ab1a"},{"name":"Generate proxy list","id":"dbfd0580-cf9a-4648-9ae5-f133507c613f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.iproyal.com/api/residential/royal/reseller/access/generate-proxy-list","description":"

Request parameters:

format

Determines which format to use to generate proxies.

type: string

default: {hostname}:{port}:{username}:{password}

possible values:

{hostname}:{port}:{username}:{password}
{hostname}:{port}@{username}:{password}
{username}:{password}:{hostname}:{port}
{username}:{password}@{hostname}:{port}

hostname

Determines which hostname to use, keep in mind that almost in all cases default value should be used.

type: string

default: geo.iproyal.com

possible values: see \"List proxy hostname\"

port

Determines which format to use to generate proxies.

type: string

default: http|https

possible values:

http|https
socks5

rotation

Determines type of connection

type: string

default: random

possible values:

random
sticky

subUserId

If provided system will find this sub-user's username and password and fill them in proxies, if not - username and password parameters are mandatory

type: integer

username

Not needed if subUserId is provided

type: string

password

Not needed if subUserId is provided

type: string

location

If rotation type is sticky this will determine what location to use, this needs to be a fully chained location, ex:
_country-us_state-texas

type: string

lifetime

If rotation type is sticky, you can provide a timeframe

type: string

default: 24h

possible values:

1-59s
1-59m
1-24h

proxyCount

Count of proxies to return

type: integer

default: 10

possible values: 1-5000

highEndPool

After activating this option, you will exclusively get only faster and more stable proxies from our pool. However, keep in mind that the pool size gets smaller than normal when using this option. Please contact the support to get access.

type: bool

skipIspStatic

After activating this option, static ISPs will be skipped. Please contact the support to get access.

type: bool

Proxy connection

There are 4 available formats to connect to a proxy:

* {hostname}:{port}:{username}:{password}
* {hostname}:{port}@{username}:{password}
* {username}:{password}:{hostname}:{port}
* {username}:{password}@{hostname}:{port}

{hostname} and {port}

Use Access/List proxy hostnames endpoint to fetch available options. Keep in mind that you should use geo.iproyal.com (it will automatically redirect to use appropriate server by your location)

{username} and {password}

This is your Sub User's credentials, use Sub Users/Show or Sub Users/List endpoint to fetch them.

proxy configuration

All available configuration options are being set by appending them to password.

Proxy location

There are 3 options - countries, country-sets and regions

countries - use Access/List available countries endpoint to fetch them.
country-sets - use Access/List available country sets endpoint to fetch them.
regions - use Access/List available regions endpoint to fetch them.

country-sets and regions have only one level, on the other hand countries has 2 more levels inside, every country has cities and every city has ISPS

Each of the above mentioned endpoints returns a list of locations and a prefix needed to set that location.

Examples:

* {hostname}:{port}:{username}:{password}_country-de
* {hostname}:{port}:{username}:{password}_country-de_city-spesenroth
* {hostname}:{port}:{username}:{password}_country-de_city-spesenroth_isp-westenergiebreitbandgmbh
* {hostname}:{port}:{username}:{password}_set-ftl
* {hostname}:{port}:{username}:{password}_region-africa

Now countries and only countries can be chained, like so

* {hostname}:{port}:{username}:{password}_country-de,al,dk

If no location is set this will give you a random location.

Notice that every country will return cities array with it, if you choose to use a city then you need to chain it with the country ex: _countries-uk_city-london

Proxy rotation

There are 2 types of rotation

Random - IP changes on every request. Only allows a selection of location and is a default connection.
Sticky - IP stays the same as long as possible/configured. Additionally allows you to set a TTL (time to live) option.

To select Sticky rotation you need to append a string to password, like so _session-ixzg2jxp, there are 2 parts in this:

_session- this is static and will not change.
ixzg2jxp this is a 8 character long alphanumeric string, which will be generated by you and should be different for every connection.

Example:
{hostname}:{port}:{username}:{password}_country-de_session-3dybqczs

As said before, Sticky rotation also allows you to set a TTL option, which looks like this _lifetime-10m, again, there are 2 parts in this:

_lifetime- this is static and will not change.
10m this is a timeframe, you can select one of these s - seconds, m - minutes, h - hours, amount of time is restricted, for s and m you can only select in a range - 1-59, for h - 1-24.

If lifetime is not set then it will default to 24h.

Additional examples

Random country with Random rotation

* {hostname}:{port}:{username}:{password}

Location set to countries (Albania) with Random rotation

* {hostname}:{port}:{username}:{password}_country-al

Location set to city Luanda (Angola) with Random rotation

* {hostname}:{port}:{username}:{password}_country-ao_city-luanda

Location set to Spesenroth (Germany) with ISP Westenergie Breitband GmbH

* {hostname}:{port}:{username}:{password}_country-de_city-spesenroth_isp-westenergiebreitbandgmbh

Location set to countries (Albania, Cuba, Angola) with Random rotation

* {hostname}:{port}:{username}:{password}_country-al,cu,ao

Location set to regions (Europe) with Random rotation

* {hostname}:{port}:{username}:{password}_region-europe

Random country with Sticky rotation and 40 seconds lifetime

* {hostname}:{port}:{username}:{password}_session-gw55vwsh_lifetime-40s

Location set to countries (Germany) with Sticky rotation and 10 minutes lifetime

* {hostname}:{port}:{username}:{password}_country-de_session-oga2v9m2_lifetime-10m

Location set to countries (Germany, Spain) with Sticky rotation and 2 hour lifetime

* {hostname}:{port}:{username}:{password}_country-de,es_session-oga2v9m2_lifetime-2h

Location set to sets (FTL) with Sticky rotation and 1 hour lifetime

* {hostname}:{port}:{username}:{password}_set-ftl_session-oga2v9m2_lifetime-1h

\n","_postman_id":"3aa89074-83af-4b1e-930e-dfc1c0e8a59e","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}}},{"name":"Get balance","id":"fa4b3dbe-8e6c-42e3-b8b7-8781d9cea2d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.iproyal.com/api/user/balance","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d883d5e9-7aec-48de-85a2-0670165d49f1","id":"d883d5e9-7aec-48de-85a2-0670165d49f1","name":"IPRoyal Royal Residential Proxies Reseller API (ISP ENABLED)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","user","balance"],"host":["dashboard","iproyal","com"],"query":[],"variable":[]}},"response":[{"id":"b253802b-e4c6-407f-8f7d-d9a781b8f467","name":"Get balance","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.iproyal.com/api/user/balance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"balance\": 100\n}"}],"_postman_id":"fa4b3dbe-8e6c-42e3-b8b7-8781d9cea2d7"}],"auth":{"type":"bearer","bearer":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"259868d1-a7ef-4557-8fe6-5a29c00a2a6f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e2008588-6a31-48a1-9a82-56fb7134dcd8","type":"text/javascript","exec":[""]}}]}