Proxy Generation Instructions
  • Reseller APIs
    • Oxylab
    • Geonode
    • Packetstream
    • Bright Data
    • Smart
    • IP Royal
    • Plan X
      • Plan X Special Countries
Powered by GitBook
On this page
  • How to generate sticky proxies:
  • How to generate Rotating Proxies:
  • Supported countries:
  • White labeling:
  • FAQ
  1. Reseller APIs

Plan X

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

PreviousIP RoyalNextPlan X Special Countries

Last updated 4 months ago

API documentation:

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(
      `usax.x.proxiess.com:6000:${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.

How to generate Rotating Proxies:

There are two scenarios of generating rotating proxies.

  • If the host belongs to (geox, geoxeu or geoxasia)

function proxyGenerationRotating(amount, country, username, password) {
  proxy = [];
  for (var i = 0; i < parseInt(amount); i++) {
    proxy.push(
      `geox.x.proxiess.com:6011:${username}:${password}-country-${country.toLowerCase()}\n`,
    );
  }
  return proxy.join('');
}
  • For others

function proxyGenerationRotating(amount, country, username, password) {
  proxy = [];
  for (var i = 0; i < parseInt(amount); i++) {
    proxy.push(
      `usax.x.proxiess.com:6000:${username}:${password}\n`,
    );
  }
  return proxy.join('');
}

Supported countries:

Country Name
Code
Host

Algeria

DZ

geoxasia

Angola

AO

geoxasia

Armenia

AM

geoxasia

Azerbaijan

AZ

geoxasia

Bahrain

BH

geoxasia

Bangladesh

BD

geoxasia

Benin

BJ

geoxasia

Botswana

BW

geoxasia

Brunei Darussalam

BN

geoxasia

Cambodia

KH

geoxasia

Cameroon

CM

geoxasia

China

CN

geoxasia

Cote D'Ivoire

CI

geoxasia

Cyprus

CY

geoxasia

Egypt

EG

geoxasia

Ethiopia

ET

geoxasia

Georgia

GE

geoxasia

Ghana

GH

geoxasia

Hong Kong

HK

geoxasia

India

IN

geoxasia

Indonesia

ID

geoxasia

Iran

IR

geoxasia

Iraq

IQ

geoxasia

Israel

IL

geoxasia

Japan

JP

geoxasia

Jordan

JO

geoxasia

Kazakhstan

KZ

geoxasia

Kenya

KE

geoxasia

Korea

KR

geoxasia

Kuwait

KW

geoxasia

Kyrgyzstan

KG

geoxasia

Lao People's Democratic Republic

LA

geoxasia

Lebanon

LB

geoxasia

Libyan Arab Jamahiriya

LY

geoxasia

Macao

MO

geoxasia

Madagascar

MG

geoxasia

Malaysia

MY

geoxasia

Mali

ML

geoxasia

Mauritius

MU

geoxasia

Mongolia

MN

geoxasia

Morocco

MA

geoxasia

Mozambique

MZ

geoxasia

Myanmar

MM

geoxasia

Namibia

NA

geoxasia

Nepal

NP

geoxasia

Nigeria

NG

geoxasia

Oman

OM

geoxasia

Pakistan

PK

geoxasia

Palestine

PS

geoxasia

Philippines

PH

geoxasia

Qatar

QA

geoxasia

Reunion

RE

geoxasia

Russian Federation

RU

geoxasia

Saudi Arabia

SA

geoxasia

Senegal

SN

geoxasia

Singapore

SG

geoxasia

Somalia

SO

geoxasia

South geoxasia

ZA

geoxasia

Sri Lanka

LK

geoxasia

Sudan

SD

geoxasia

Syrian Arab Republic

SY

geoxasia

Taiwan

TW

geoxasia

Thailand

TH

geoxasia

Togo

TG

geoxasia

Tunisia

TN

geoxasia

Turkey

TR

geoxasia

United Arab Emirates

AE

geoxasia

Uzbekistan

UZ

geoxasia

Viet Nam

VN

geoxasia

Zambia

ZM

geoxasia

Zimbabwe

ZW

geoxasia

Argentina

AR

geox

Barbados

BB

geox

Bolivia

BO

geox

Brazil

BR

geox

Canada

CA

geox

Chile

CL

geox

Colombia

CO

geox

Costa Rica

CR

geox

Cuba

CU

geox

Dominica

DM

geox

Dominican Republic

DO

geox

Ecuador

EC

geox

El Salvador

SV

geox

Guatemala

GT

geox

Guyana

GY

geox

Haiti

HT

geox

Honduras

HN

geox

Jamaica

JM

geox

Mexico

MX

geox

Nicaragua

NI

geox

Panama

PA

geox

Paraguay

PY

geox

Peru

PE

geox

Puerto Rico

PR

geox

Saint Lucia

LC

geox

Suriname

SR

geox

Trinidad and Tobago

TT

geox

United States

USX

usax

Tickets - USA

USX1

usat

Uruguay

UY

geox

Venezuela

VE

geox

Argentina - X

ARX

usax

Barbados - X

BBX

usax

Bolivia - X

BOX

usax

Brazil - X

BRX

usax

Canada - X

CAX

usax

Chile - X

CLX

usax

Colombia - X

COX

usax

Costa Rica - X

CRX

usax

Cuba - X

CUX

usax

Dominica - X

DMX

usax

Dominican Republic - X

DOX

usax

Ecuador - X

ECX

usax

El Salvador - X

SVX

usax

Guatemala - X

GTX

usax

Guyana - X

GYX

usax

Haiti - X

HTX

usax

Honduras - X

HNX

usax

Jamaica - X

JMX

usax

Mexico - X

MXX

usax

Nicaragua - X

NIX

usax

Panama - X

PAX

usax

Paraguay - X

PYX

usax

Peru - X

PEX

usax

Puerto Rico - X

PRX

usax

Saint Lucia - X

LCX

usax

Suriname - X

SRX

usax

Trinidad and Tobago - X

TTX

usax

United States - X

US

geox

Uruguay - X

UYX

usax

Venezuela - X

VEX

usax

Albania

AL

geoxeu

Austria

AT

geoxeu

Belarus

BY

geoxeu

Belgium

BE

geoxeu

Bosnia and Herzegovina

BA

geoxeu

Bulgaria

BG

geoxeu

Croatia

HR

geoxeu

Czech Republic

CZ

geoxeu

Denmark

DK

geoxeu

Estonia

EE

geoxeu

Finland

FI

geoxeu

France

FR

geoxeu

Germany

DEX

dex

Tickets - EU DE

DET

dedx

Greece

GR

geoxeu

Hungary

HU

geoxeu

Ireland

IE

geoxeu

Italy

IT

geoxeu

Latvia

LV

geoxeu

Lithuania

LT

geoxeu

Macedonia

MK

geoxeu

Malta

MT

geoxeu

Moldova

MD

geoxeu

Montenegro

ME

geoxeu

Netherlands

NLX

nlx

Tickets - EU NL

NLT

nlvx

Gaming - EU

NLG

nlvx

DTAG - NL

NLD

nldx

Vodafone - NL

NLV

nlvx

Norway

NO

geoxeu

Poland

PL

geoxeu

Portugal

PT

geoxeu

Romania

RO

geoxeu

Serbia

RS

geoxeu

Slovakia

SK

geoxeu

Slovenia

SI

geoxeu

Spain

ES

geoxeu

Sweden

SE

geoxeu

Switzerland

CH

geoxeu

Ukraine

UA

geoxeu

United Kingdom

GBX

ukx

Colt - United Kingdom

GBC

ukcx

Virgin Media - United Kingdom

GBV

ukvx

Albania - X

ALX

dex

Austria - X

ATX

dex

Belarus - X

BYX

dex

Belgium - X

BEX

nlx

Bosnia and Herzegovina - X

BAX

dex

Bulgaria - X

BGX

dex

Croatia - X

HRX

dex

Czech Republic - X

CZX

dex

Denmark - X

DKX

dex

Estonia - X

EEX

dex

Finland - X

FIX

dex

France - X

FRX

dex

Germany - X

DE

geoxeu

Greece - X

GRX

dex

Hungary - X

HUX

dex

Ireland - X

IEX

ukx

Italy - X

ITX

dex

Latvia - X

LVX

dex

Lithuania - X

LTX

dex

Macedonia - X

MKX

dex

Malta - X

MTX

dex

Moldova - X

MDX

dex

Montenegro - X

MEX

dex

Netherlands - X

NL

geoxeu

Norway - X

NOX

dex

Poland - X

PLX

dex

Portugal - X

PTX

ukx

Romania - X

ROX

dex

Serbia - X

RSX

dex

Slovakia - X

SKX

dex

Slovenia - X

SIX

dex

Spain - X

ESX

ukx

Sweden - X

SEX

dex

Switzerland - X

CHX

dex

Ukraine - X

UAX

dex

United Kingdom - X

GB

geoxeu

Australia

AU

geoxasia

Australia - X (AU)

AUX

aux

New Zealand (NZ)

NZ

geoxasia

New Zealand - X (NZ)

NZX

aux

You can find the JSON file for the available country list.

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.

API
Record Type
Domain
Port

usax

CNAME

usax.x.proxiess.com

6000

usatx

CNAME

usatx.x.proxiess.com

6001

aux

CNAME

aux.x.proxiess.com

6002

ukx

CNAME

ukx.x.proxiess.com

6003

ukcx

CNAME

ukcx.x.proxiess.com

6004

ukvx

CNAME

ukvx.x.proxiess.com

6005

dex

CNAME

dex.x.proxiess.com

6006

dedx

CNAME

dedx.x.proxiess.com

6007

nlx

CNAME

nlx.x.proxiess.com

6008

nldx

CNAME

nldx.x.proxiess.com

6009

nlvx

CNAME

nlvx.x.proxiess.com

6010

geox

CNAME

geox.x.proxiess.com

6011

geoxeu

CNAME

geoxeu.x.proxiess.com

6012

geoxasia

CNAME

geoxasia.x.proxiess.com

6013

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

  2. If your domain is API.com, you are planning to white labeling like premium (or any name) and point it to the Paln X domain, your proxies will then be formatted as:

    premium.yourdomain.com:port:user:pass

  3. 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>"

  • I'm getting this error: {"message":"dataGb 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 how to send requests with headers in whichever languages you use. POST Request:

{
	"Authorization": "Bearer <your api token>",
	"Content-Type": "application/json"
} 
# Sample curl request
curl --location --request POST 'https://core-proxy-service-w34nvoxnwq-uc.a.run.app/proxy_api/v1/planx/users/create' \
  --header "Authorization: Bearer <your api token>" \
  --header "Content-Type: application/json" \
  --data-raw '{
    "data_gb": 1
  }'

GET Request

{
	"Authorization": "Bearer <your api token>",
}
# Sample curl request
curl --location --request GET 'https://core-proxy-service-w34nvoxnwq-uc.a.run.app/proxy_api/v1/planx/users/<userId>' \
         -H "Authorization: Bearer <your api token>"
https://core-proxy-service-w34nvoxnwq-uc.a.run.app/api
15KB
poolx_countries.json