IPRoyal
This page will guide you on how to generate sticky and rotating proxies, Supported countries, other optional features, White labeling and FAQs regarding IPRoyal APIs.
How to generate sticky proxies:
const randomString = (length) => {
let result = '';
const characters = 'abcdefghijklmnopqrstuvwxyz1234567890';
const charactersLength = characters.length;
for (let i = 0; i < length; i++) {
result += characters.charAt(Math.floor(Math.random() * charactersLength));
}
return result;
};
function proxyGenerationSticky(amount, country, username, password) {
proxy = [];
for (var i = 0; i < parseInt(amount); i++) {
proxy.push(
`iproyal.x.proxiess.com:12321:${username}:${password}-country-${country.toLowerCase()}_session-${randomString(8
)}\n`,
);
}
return proxy.join('');
}Sessionid ( add this under sticky proxy generation )
The _session- key instructs our routing system to either create or resolve a unique session for the connection. The value assigned to this key must be a random alphanumeric string, precisely 8 characters in length. This ensures the uniqueness and integrity of the session.
Streaming
_streaming-1
When activated, the 'Streaming' option grants you access to the swiftest and most reliable proxies in our selection. Please be aware, however, that the trade-off for this enhanced quality is a smaller pool of available proxies than what is typically accessible.
To enable this feature, you will need to add the _streaming- key with value 1.
lifetime ( add this under sticky proxy generation )
The _lifetime- key directs the router regarding the duration for which the session remains valid. The minimum duration is set at 1 second, and the maximum extends to 7 days. It is crucial to note the format here: only one unit of time can be specified. This parameter plays a pivotal role in defining the operational span of a sticky session, balancing between session stability and security needs.
Example
General Proxy format for IPRoyal Sticky:
Follow the below table for generate HTTP/HTTPS and SOCKS5.
IPRoyal
HTTP/HTTPS
iproyal.x.proxiess.com
12321
IPRoyal EU
HTTP/HTTPS
iproyaleu.x.proxiess.com
12323
IPRoyal Asia
HTTP/HTTPS
iproyalasia.x.proxiess.com
12322
IPRoyal
SOCKS5
socksiproyal.x.proxiess.com
12324
IPRoyal EU
SOCKS5
socksiproyaleu.x.proxiess.com
12326
IPRoyal Asia
SOCKS5
socksiproyalasia.x.proxiess.com
12325
How to generate rotating proxies:
General Proxy format of IPRoyal Rotating:
IPRoyal
HTTP/HTTPS
iproyal.x.proxiess.com
12321
IPRoyal EU
HTTP/HTTPS
iproyaleu.x.proxiess.com
12323
IPRoyal Asia
HTTP/HTTPS
iproyalasia.x.proxiess.com
12322
IPRoyal
SOCKS5
socksiproyal.x.proxiess.com
12324
IPRoyal EU
SOCKS5
socksiproyaleu.x.proxiess.com
12326
IPRoyal Asia
SOCKS5
socksiproyalasia.x.proxiess.com
12325
City
-country-<country-code>_city-<city-name> is the key to targeting a city. The value should be a name of the city.
Additionally, it's essential to specify the country when targeting a specific city, as multiple countries may have cities with the same name.
Example:
state
_state-<state-name> is the key to target a state. The value should be the name of the state.
This is used to target a state in the US
Example:
Supported countries:
Other Optional Features:
Generate proxy list using endpoint
White labeling:
Use this method to brand your proxies with your own domain/company name
To brand the proxies under your domain follow these steps:
Open the DNS configuration for your domain.
Create a CNAME Record pointing to the domain.
IPRoyal
HTTP/HTTPS
CNAME
iproyal.x.proxiess.com
12321
IPRoyal EU
HTTP/HTTPS
CNAME
iproyaleu.x.proxiess.com
12323
IPRoyal Asia
HTTP/HTTPS
CNAME
iproyalasia.x.proxiess.com
12322
IPRoyal
SOCKS5
CNAME
socksiproyal.x.proxiess.com
12324
IPRoyal EU
SOCKS5
CNAME
socksiproyaleu.x.proxiess.com
12326
IPRoyal Asia
SOCKS5
CNAME
socksiproyalasia.x.proxiess.com
12325
Whatever you enter in the name/host will decide the domain which points to our API IP.
Thus if your domain is API.com and you enter the host premium or whatever you want to call it pointing to the IPRoyal domain, your proxies will be formatted premium.yourdomain.com:port:user:pass
An example on Godaddy is linked below:
FAQ
What is Authorization?
This is a header value you provide with every request. We are using the Bearer token so send in the header like this: "Authorization: Bearer <your API token>"
Im getting this error:
{"message":"username cannot be null or undefined.","timestamp":1634146255996}how do I fix it?
Make sure you have this "Content-Type": "application/json" header present in your requests.
Headers
Please check on how to send requests with headers in whichever languages you are using.
POST Request:
GET Request:
Last updated