API Documentation

PATH:
https://proxyma.io/api/create/proxy

Method:
POST
Header:
api-key
Body:
"package_key"
Key of the active package - mandatory
From the "Get package key" method
"list_name"
Proxy list name - mandatory
Provided by you
"list_login"
Proxy list login - mandatory
Provided by you
"country_code"
Country code in ISO format - mandatory
From the "Get list of countries" method
"region_name"
Region name - mandatory
From the "Get list of regions" method
"city"
City name - mandatory
From the "Get list of cities" method
"rotation_period"
0[default] - no rotation
1 - rotation each request
custom in seconds
"format"
1[default] - login:password@host:port
2 - host,port,login,password
3 - http://login:password@host:port
4 - socks5://login:password@host:port
Responses:
"200"
data: "list_id = sheet id, login - list login, password - list password, proxy_list - proxy list"
"400"
message: "Parameter error description"
"401"
message: "Authorization error description"
PHP example: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/create/proxy',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"package_key" : "PACKAGE KEY",
"list_name" : "LIST NAME",
"list_login" : "LIST LOGIN",
"country_code":"UA",
"region_name":"Cherkasy Oblast",
"city" : "Cherkasy",
"rotation_period" : 300,
"format": 4
}',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


PATH:
https://proxyma.io/api/get/packages

Method:
GET
Header:
api-key
Body:
Empty body
Responses:
"200"
message: "A list of your active packages"
"400"
message: "Parameter error description"
"401"
message: "Authorization error description"
PHP example: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/get/packages',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


PATH:
https://proxyma.io/api/get/countries

Method:
GET
Header:
api-key
Body:
Empty body
Responses:
"200"
data:"List of available countries in the format - ISO CODE => COUNTRY NAME"
"400"
message: "Parameter error description"
"401"
message: "Authorization error description"
PHP example: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/get/countries',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


PATH:
https://proxyma.io/api/get/regions

Method:
GET
Header:
api-key
Body:
"country_code"
Country code in ISO format - mandatory
From the "Get list of countries" method
Responses:
"200"
data: "List of available regions"
"400"
message: "Parameter error description"
"401"
message: "Authorization error description"
PHP example: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/get/regions',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_POSTFIELDS =>'{
"country_code":"UA"
}',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


PATH:
https://proxyma.io/api/get/cities

Method:
GET
Header:
api-key
Body:
"country_code"
Country code in ISO format - mandatory
From the "Get list of countries" method
"region_name"
Region name - mandatory
From the "Get list of regions" method
Responses:
"200"
data: "List of available cities"
"400"
message: "Parameter error description"
"401"
message: "Authorization error description"
PHP example: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/get/cities',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_POSTFIELDS =>'{
"country_code":"UA",
"region_name":"Odessa"
}',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


PATH:
https://proxyma.io/api/get/lists

Method:
GET
Header:
api-key
Body:
"packagekey"
Package key
From the "Get Package Key" method
Responses:
"200"
data: "List of your lists"
"400"
message: "Parameter error description"
"401"
message: "Authorization error description"
PHP example: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/get/lists',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_POSTFIELDS =>'{
"packagekey":"PACKAGE KEY" }',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


PATH:
https://proxyma.io/api/get/proxy

Method:
GET
Header:
api-key
Body:
"list_name"
List name
From the "Get List of Lists" method
"list_id"
List ID
From the "Get List of Lists" method
"packagekey"
Package key
From the "Get Package Key" method
Responses:
"200"
data: "List of your proxies
"400"
message: "Parameter error description"
"401"
message: "Authorization error description"
PHP example: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/get/proxy',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_POSTFIELDS =>'{
"list_name": "LIST NAME",
"list_id": "LIST ID",
"packagekey":"PACKAGE KEY"
}',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


PATH:
https://proxyma.io/api/buy/packages/list

Method:
GET
Header:
api-key
Body:
Empty body
Responses:
"200"
data: "List of available packages"
"400"
message: "Parameter error description"
"401"
message: "Authorization error description"
PHP example: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/buy/packages/list',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


PATH:
https://proxyma.io/api/buy/package

Method:
POST
Header:
api-key
Body:
"package_id"
Tariff ID
From method "Get available packages for purchase"
Responses:
"200"
package_key: "Package key of purchased package"
"400"
message: "Parameter error description"
"401"
message: "Authorization error description"
PHP example: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/buy/package',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"package_id": "PACKAGE ID",
}',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


PATH:
https://proxyma.io/api/info/package/YOUR_PACKAGE_KEY

Method:
GET
Header:
api-key
Body:
Empty body
Responses:
"200"
data: "Information about your package"
"400"
message: "Parameter error description"
"401"
message: "Authorization error description"
PHP example: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/info/package/YOUR_PACKAGE_KEY',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


PATH:
https://proxyma.io/api/get/api_tools/YOUR_PACKAGE_KEY

Method:
GET
Header:
api-key
Body:
Empty body
Responses:
"200"
data: "URL addresses of API TOOLS"
"400"
message: "Parameter error description"
"401"
message: "Authorization error description"
PHP example: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/get/api_tools/YOUR_PACKAGE_KEY',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Remarks: Each new connection to the received address (without parameters) will change the final IP address in the style of World Mix!!!

The obtained URL addresses undergo modification, and the final IP address can be changed by specifying the country or city in the received addresses.

To change the final IP address to a specific country, a prefix is added to the login _c_US - where US is the country code in the format ISO 3166-1 alpha-2.

Example:
DsuFAajqw7d1hx_c_US:DDShjryq@proxy.proxyma.io:10000
The user's final IP address will be - United States of America

To change the final IP address to a specific city, a prefix is added to the login _city_Milan - where Milan is the city name in international format. If the city name contains spaces, replace them with a hyphen "-", New York = New-York

Example:
DsuFAajqw7d1hx_city_Milan:DDShjryq@proxy.proxyma.io:10000
The user's final IP address will be - Milan, Italy

To remember the IP address and switch between them, sessions can be used - a prefix to the login _s_MySes1 - where MySes1 is an alphanumeric value. The obtained address will be associated with the session name MySes1. By disabling the use of the session or changing it, returning to the session named MySes1 will retrieve the saved IP address provided the address is still active.

Example:
DsuFAajqw7d1hx_s_MySes1:DDShjryq@proxy.proxyma.io:10000
The obtained IP address will be saved in the session named MySes1

All the above parameters can be used in combination

Example:
DsuFAajqw7d1hx_c_Italy_city_Milan_s_MySes1:DDShjryq@proxy.proxyma.io:10000


PATH:
https://proxyma.io/api/get/balance

Метод:
GET
Header:
api-key
Тело:
Пустое тело
Ответы:
"200"
data: "баланс в $"
"400"
message: "Описание ошибки параметров"
"401"
message: "Описание ошибки авторизации"
Пример на PHP: $curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://proxyma.io/api/get/balance',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'api-key: API KEY',
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;