Introduction

This documentation aims to provide all the information you need to work with our API.

Base URL

https://api.proxy5.net

Authenticating requests

To authenticate requests, include an Authorization header in the form "Basic {credentials}". The value of {credentials} should be your email and your password, joined with a colon (|), and then base64-encoded.

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Endpoints

GET clients list.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/clients" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/clients"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/clients',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/clients'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


[{
"id": numeric (client ID),
"email": string (email),
}] or empty array

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

GET service stats by Service ID. Only for PPR.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/stats/123" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/stats/123"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/stats/123',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/stats/123'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


[{
"date": string (date YYYY-MM-DD),
"rate": numeric (count of requests|used traffic in MB),
}] or empty array

Example response (422):


{
    "error": "Unprocessable Entity "
}

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

GET service rate by Service ID. Only for PPR.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/rate/123" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/rate/123"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/rate/123',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/rate/123'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


[{
"limit": numeric (limit of requests|used traffic in MB),
"rate": numeric (count of requests|used traffic in MB),
}] or empty array

Example response (422):


{
    "error": "Unprocessable Entity "
}

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

GET product by Product ID.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/product/12" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/product/12"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/product/12',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/product/12'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
"productId": numeric (product ID),
"price": numeric (product price in USD),
"groupId": numeric (product group ID),
"groupName": string (group name),
"created_at": string (product date creation YYYY-MM-DD),
"product_hidden": boolean (product hidden or not),
"group_hidden": boolean (group hidden or not),
"product_type": string (fpr - static proxy  or ppr - rotating proxy),
"ip_count": numeric (IP count for fpr only),
"update_time": string (update time YYYY-MM-DD HH:MM:SS for fpr only),
"geo": array (geo list for fpr only),
}

Example response (422):


{
    "error": "Unprocessable Entity "
}

Example response (422):


{
    "error": "Unprocessable Entity or product ID not found"
}

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

POST add new service

requires authentication

Example request:

curl --request POST \
    "https://api.proxy5.net/api/product/12" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"clientid\": 1,
    \"setip\": \"12.34.56.78\"
}"

const url = new URL(
    "https://api.proxy5.net/api/product/12"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "clientid": 1,
    "setip": "12.34.56.78"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.proxy5.net/api/product/12',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'clientid' => 1,
            'setip' => '12.34.56.78',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/product/12'
payload = {
    "clientid": 1,
    "setip": "12.34.56.78"
}
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
'serviceId': numeric,
'orderId': numeric,
'invoiceId': numeric,
'amount': numeric,
"ip": string,
}

Example response (422):


{
    "error": "Unprocessable Entity or product ID not found"
}

Example response (422):


{
    "error": "Unprocessed entity or not enough funds to order"
}

Example response (422):


{
    "error": "Unprocessable Entity. Incorrect posted data"
}

Example response (422):


{
    "error": "Unprocessable Entity. ClientID not found"
}

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

GET products list.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/products" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/products"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/products',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/products'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


[{
"productId": numeric (product ID),
"productName": string (product name),
"price": numeric (product price in USD),
"groupId": numeric (product group ID),
"groupName": string (group name),
"created_at": string (product date creation YYYY-MM-DD),
}] or empty array

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

GET products list order by field.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/products/orderby/productId" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/products/orderby/productId"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/products/orderby/productId',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/products/orderby/productId'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


[{
"productId": numeric (product ID),
"productName": string (product name),
"price": numeric (product price in USD),
"groupId": numeric (product group ID),
"groupName": string (group name),
"created_at": string (product date creation YYYY-MM-DD),
}] or empty array

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

GET network status errors proxy servers list by Service ID.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/networkstatus/errors/123" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/networkstatus/errors/123"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/networkstatus/errors/123',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/networkstatus/errors/123'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


array (IP address list) or empty array

Example response (422):


{
    "error": "Unprocessable Entity "
}

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Example response (400):


{
    "error": "Unprocessable Entity. ClientID not found"
}

Received response:

Request failed with error:

GET network status inactive proxy servers list by Service ID.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/networkstatus/inactive/123" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/networkstatus/inactive/123"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/networkstatus/inactive/123',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/networkstatus/inactive/123'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


array (IP address list) or empty array

Example response (422):


{
    "error": "Unprocessable Entity "
}

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Example response (400):


{
    "error": "Unprocessable Entity. ClientID not found"
}

Received response:

Request failed with error:

GET billing credit.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/billing/credit" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/billing/credit"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/billing/credit',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/billing/credit'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
"credit": numeric (credit in USD),
}

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

GET billing invoices list.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/billing/invoices" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/billing/invoices"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/billing/invoices',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/billing/invoices'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


[{
"id": numeric (invoice ID),
"description": string (invoice description),
"status": string (Unpaid|Paid|Cancelled|Refunded|Collections|Payment Pending|Pending),
"created_at": string (invoice date creation YYYY-MM-DD),
"amount": numeric (invoice amount in USD),
"date_refunded": string (invoice date refunded YYYY-MM-DD),
"date_paid": string (invoice date paid YYYY-MM-DD),
"paymentmethod": string (payment method),
"serviceid": numeric (service ID),
}] or empty array

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

GET billing invoice by Invoice ID.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/billing/invoice/et" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/billing/invoice/et"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/billing/invoice/et',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/billing/invoice/et'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


[{
"id": numeric (invoice ID),
"description": string (invoice description),
"status": string (Unpaid|Paid|Cancelled|Refunded|Collections|Payment Pending|Pending),
"created_at": string (invoice date creation YYYY-MM-DD),
"amount": numeric (invoice amount in USD),
"date_refunded": string (invoice date refunded YYYY-MM-DD),
"date_paid": string (invoice date paid YYYY-MM-DD),
"paymentmethod": string (payment method),
"serviceid": numeric (service ID),
}] or empty array

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

GET service by Service ID.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/service/vel" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/service/vel"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/service/vel',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/service/vel'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
 "service_id": numeric (service ID),
 "orderid": numeric (order ID),
 "product_name": string (product name),
 "regdate": string (date YYYY-MM-DD),",
 "nextduedate": string (date YYYY-MM-DD),
 "status": string (Active|Pending|Suspended|Terminated|Cancelled|Fraud),
 "billingcycle": string (Free|Monthly|Quarterly|Semi-Annually|Annually|Biennially|Triennially),
 "username": string (username),
 "password": string (password),
 "bindedip": string (binded IP address 111.222.233.144 for fpr only),
 "product_type": string (fpr - static proxy  or ppr - rotating proxy),
 "ip_count": numeric (IP count for fpr only),
 "price": numeric (price in USD),
}

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

GET user services list.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/services" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/services"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/services',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/services'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


[{
"service_id": numeric,
"product_name": string (product name),
"nextduedate": string (date),
"orderid": numeric,
"status": string (Active|Pending|Suspended|Terminated|Cancelled|Fraud),
}]

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

PUT update service by Service ID.

requires authentication

Example request:

curl --request PUT \
    "https://api.proxy5.net/api/service/repudiandae" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"setip\": \"12.34.56.78\",
    \"update_list\": \"true\",
    \"password\": \"cGFzc3dvcmQ=\"
}"

const url = new URL(
    "https://api.proxy5.net/api/service/repudiandae"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "setip": "12.34.56.78",
    "update_list": "true",
    "password": "cGFzc3dvcmQ="
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.proxy5.net/api/service/repudiandae',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'setip' => '12.34.56.78',
            'update_list' => 'true',
            'password' => 'cGFzc3dvcmQ=',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/service/repudiandae'
payload = {
    "setip": "12.34.56.78",
    "update_list": "true",
    "password": "cGFzc3dvcmQ="
}
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "setip": {
        "success": "IP address updated successfully"
    },
    "update_list": {
        "success": "IP list updated successfully"
    },
    "password": {
        "success": "Password updated successfully"
    }
}

Example response (422):


{
    "error": "Unprocessable Entity "
}

Example response (422):


{
    "error": "Unprocessable Entity. Incorrect posted data"
}

Example response (429):


{
    "error": "Too Many Attempts (updateList). Next update possible: YYYY-MM-DD HH:MM:SS"
}

Example response (422):


{
    "error": "Unprocessable Entity. Invalid IPv4 format"
}

Example response (422):


{
    "error": "Unprocessable Entity. IP already binded"
}

Example response (422):


{
    "error": "Unprocessable Entity. Invalid IPv4 format"
}

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Example response (400):


{
    "error": "Unprocessable Entity. ClientID not found"
}

Received response:

Request failed with error:

Request

PUT api/service/{id}

URL Parameters

id string

The ID of the service.

Body Parameters

setip string optional

IP address for bind.

update_list string optional

Update IP list.

password string optional

New password base64 encoded.

GET IP list by Service ID.

requires authentication

Example request:

curl --request GET \
    --get "https://api.proxy5.net/api/iplist/http-ip/csv/123" \
    --header "Authorization: Basic {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.proxy5.net/api/iplist/http-ip/csv/123"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.proxy5.net/api/iplist/http-ip/csv/123',
    [
        'headers' => [
            'Authorization' => 'Basic {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.proxy5.net/api/iplist/http-ip/csv/123'
headers = {
  'Authorization': 'Basic {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


ip list in selected format

Example response (422):


{
    "error": "Unprocessable Entity "
}

Example response (401):


Unauthenticated

Example response (400):


Invalid Authorization header

Example response (400):


Invalid credentials format

Received response:

Request failed with error:

Introduction

Authenticating requests

Endpoints

GET clients list.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

GET service stats by Service ID. Only for PPR.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

GET service rate by Service ID. Only for PPR.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

GET product by Product ID.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

POST add new service

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Body Parameters

GET products list.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

GET products list order by field.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

GET network status errors proxy servers list by Service ID.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

GET network status inactive proxy servers list by Service ID.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

GET billing credit.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

GET billing invoices list.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

GET billing invoice by Invoice ID.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

GET service by Service ID.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

GET user services list.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

PUT update service by Service ID.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Body Parameters

GET IP list by Service ID.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request