Access
Get Entry Nodes
GET
/access/entry-nodes
Different entry nodes help to determine the faster route from the country you are situated in.
Example request:
curl -X GET https://resi-api.iproyal.com/v1/access/entry-nodes \
-H "Authorization: Bearer <your_api_token>"
Example response:
[
{
"dns": "proxy.iproyal.com",
"ips": ["91.239.130.34"],
"ports": [
{
"name": "http|https",
"port": 12321,
"alternative_ports": [
11200,
...
]
},
{
"name": "socks5",
"port": 32325,
"alternative_ports": [
51200,
...
]
}
]
},
{
"dns": "us.proxy.iproyal.com",
"ips": ["23.146.144.102", "23.146.144.102"],
"ports": [
{
"name": "http|https",
"port": 12321,
"alternative_ports": [
11246,
...
]
},
{
"name": "socks5",
"port": 32325,
"alternative_ports": [
51200,
...
]
}
]
},
...
]
Get Countries
GET
/access/countries
Returns a list of countries, cities, states, and ISPs (Internet Service Providers) that could be used to target a specific proxy. It also returns prefixes to use for each. For more information on how to build a proxy string, refer to our 'Proxy' subsection.
Example request:
curl -X GET https://resi-api.iproyal.com/v1/access/countries \
-H "Authorization: Bearer <your_api_token>"
Example response:
{
"prefix": "_country-",
"countries": [
{
"code": "am",
"name": "Armenia",
"cities": {
"prefix": "_city-",
"options": [
{
"code": "armavir",
"name": "Armavir",
"isps": {
"prefix": "_isp-",
"options": [
{
"code": "prostieresheniallc",
"name": "Prostie Reshenia LLC"
}
]
}
}
]
},
"states": {
"prefix": "_state-",
"options": [
{
"code": "armavir",
"name": "Armavir",
"cities": {
"prefix": "_city-",
"options": [
{
"code": "armavir",
"name": "Armavir",
"isps": {
"prefix": "_isp-",
"options": []
}
}
]
},
"isps": {
"prefix": "_isp-",
"options": [
{
"code": "prostieresheniallc",
"name": "Prostie Reshenia LLC"
}
]
}
}
]
}
}
]
}
Get Regions
Similarly to Access, it returns available regions for use when targeting a proxy.
GET
/access/regions
Example request:
curl -X GET https://resi-api.iproyal.com/v1/access/regions \
-H "Authorization: Bearer <your_api_token>"
Example response:
{
"prefix": "_region-",
"regions": [
{
"code": "africa",
"name": "Africa"
},
{
"code": "arabstates",
"name": "Arab States"
},
{
"code": "asiapacific",
"name": "Asia & Pacific"
},
{
"code": "europe",
"name": "Europe"
},
{
"code": "middleeast",
"name": "Middle east"
},
{
"code": "northamerica",
"name": "North America"
},
{
"code": "southlatinamerica",
"name": "South/Latin America"
}
]
}
Get Country Sets
GET
/access/country-sets
Similarly to Access, it returns available country sets to use when targeting a proxy.
Example request:
curl -X GET https://resi-api.iproyal.com/v1/access/country-sets \
-H "Authorization: Bearer <your_api_token>"
Example response:
{
"prefix": "_set-",
"countrySets": [
{
"code": "courir",
"name": "COURIR"
},
{
"code": "mesh1",
"name": "MESH 1"
},
{
"code": "mesh2",
"name": "MESH 2"
},
{
"code": "nikeas",
"name": "NIKE ASIA"
},
{
"code": "nikeeu",
"name": "NIKE EU"
},
{
"code": "nikena",
"name": "NIKE US"
},
{
"code": "zalando",
"name": "ZALANDO"
}
]
}
Generate Proxy List
POST
/access/generate-proxy-list
Body Parameters
format
String
Format in which proxy strings will be returned
{hostname}:{port}:{username}:{password}
{hostname}:{port}@{username}:{password}
{username}:{password}:{hostname}:{port}
port
String
Port as protocol type
http|https
socks5
rotation
String
Rotation that will be used
sticky
random
subuser_hash
String
Subuser that will be used
proxy_count
Integer
Proxy count that will be returned
username
String
Username that will be used
password
String
Password that will be used
lifetime
String
For sticky sessions this will tell how long this session will last
5s
10m
20h
Example request:
curl -X POST https://resi-api.iproyal.com/v1/access/generate-proxy-list \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your_api_token>" \
-d '{
"format": "{hostname}:{port}:{username}:{password}",
"hostname": "example.hostname.com",
"port": "http|https",
"rotation": "sticky",
"location": "_country-sg",
"proxy_count": 10,
"subuser_hash": "example_subuser_hash",
"lifetime": "2h"
}'
Example response:
[
"geo.iproyal.com:0:[email protected]:royal123_session-abc123_lifetime-24h",
"geo.iproyal.com:0:[email protected]:royal123_session-cba321_lifetime-24h",
]
Last updated