search

IPRoyal

This page will guide you on how to generate sticky and rotating proxies, Supported countries, other optional features, White labeling and FAQs regarding IP Royal APIs.

circle-info

API documentation: https://torchlabs.readme.io/arrow-up-right

hashtag
How to generate sticky proxies:

const string = (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-${string(8,
      )}_lifetime-1h\n`,
    );
  }
  return proxy.join('');
}

  • Session ( 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.

  • 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.

Examples:

hashtag
How to generate IPRoyal EU sticky proxies:

hashtag
How to generate IPRoyal Asia sticky proxies:

hashtag
How to generate rotating proxies:

hashtag
How to generate IPRoyal EU rotating proxies:

hashtag
How to generate IPRoyal Asia rotating proxies:

  • High-End Pool

When activated, the 'High-End Pool' 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.

Example:

  • City

_city- is the key to target a city. The value should be the 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

_city- is the key to target a city. The value should be the 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:

hashtag
Supported countries:

hashtag
Other Optional Features:

Generate proxy list using endpoint

LogoIPRoyal Royal Residential Proxies Reseller APIIPRoyal Royal Residential Proxies Reseller APIchevron-right

hashtag
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:

  1. Open the DNS configuration for your domain.

  2. Create a C Name Record pointing to the domain.

IPRoyal (Default)

CNAME

iproyal.x.proxiess.comarrow-up-right

12321

IPRoyalasia

CNAME

iproyalasia.x.proxiess.comarrow-up-right

12322

IPRoyalEU

CNAME

iproyaleu.x.proxiess.comarrow-up-right

12323

  1. Whatever you enter in the name/host will decide the domain which points to our API IP.

  2. Thus if your domain is API.comarrow-up-right 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.comarrow-up-right:port:user:pass

  3. An example on Godaddy is linked below:

hashtag
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.

hashtag
Headers

Please check on how to send requests with headers in whichever languages you are using.

POST Request:

GET Request:

PreviousBright DataNextGeonode

Last updated