Access
Get Entry Nodes
GET
/access/entry-nodes
Different entry nodes help to determine the faster route from the country you are situated in.
In almost all cases, you should use geo.iproyal.com
which will automatically determine the best server for your location.
Example response:
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.
Depending on some settings set for you as a user, it will return different results.
Identity verification - provides a larger selection of options.
Skip ISP Static (Admin activatable) - on top of verified identity, includes a parameter that will reflect the availability of proxies, skipping static proxies.
ISPs enabled (Admin activatable) - includes ISPs in every location.
Show IP availability (Admin activatable) - adds a parameter that shows the availability of proxies in that location.
Example response
Get Regions
Similarly to #countries, it returns available regions for use when targeting a proxy.
GET
/access/regions
Get Country Sets
GET
/access/country-sets
Similarly to #countries, it returns available country sets to use when targeting a proxy.
Generate Proxy List
POST
/access/generate-proxy-list
If subuser_hash
is supplied, username
and password
are not needed, and vice versa - if username
and password
are supplied - subuser_hash
is not needed.
The location you wish to use needs to be prefixed with a "prefix" that is described in the Get Countries, for example if you want to target Singapore - "_country-sg"
Body Parameters
Name | Type | Description | Available options |
---|---|---|---|
format | String | Format in which proxy strings will be returned | |
hostname | String | Hostname that will be used | |
port | Integer | Port that will be used | |
rotation | String | Rotation that will be used | |
subuser_hash | String | Subuser that will be used | |
location | String | Location 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 |
Last updated