API для проксі: замовлення, баланс і логіни

З чого почати?

1Зареєструйтеся й увійдіть у кабінет.
2Відкрийте розділ Connect і створіть API-ключ. Повний ключ показується лише один раз, тож скопіюйте його в надійне місце.
3Надсилайте ключ у заголовку Authorization з кожним запитом, якому він потрібен.
4Викличте /account, щоб перевірити, що ключ працює, потім оформлюйте замовлення через /orders.

Як працює автентифікація?

Запити до вашого власного акаунта (account, orders, proxy-user) потребують API-ключа. Надсилайте його як Bearer-токен у заголовку Authorization. Ціни, країни й розрахунки вартості публічні й не потребують ключа.

Ми зберігаємо лише хеш ключа. Якщо ви його загубили, створіть новий у кабінеті, і старий ключ одразу перестане працювати. Не вставляйте ключ у код для браузера й у публічні репозиторії.

HTTP header

Authorization: Bearer rpk_your_api_key

Базова URL-адреса та формат

Базова URL-адреса: https://royalproxy.online/api/v1
Тіло запиту та відповіді: application/json
Гроші: Числа в USD, наприклад 807.90
Час: ISO 8601 (UTC)

Чи є обмеження частоти запитів?

З кожного API-ключа можна надсилати до 60 запитів на хвилину. Публічні ендпоінти дозволяють 60 запитів на хвилину з одного IP. Понад ліміт ви отримаєте HTTP 429, тож зачекайте хвилину й спробуйте знову.

Як виглядають помилки?

Помилки повертаються з HTTP-кодом статусу та JSON-тілом з коротким кодом і повідомленням.

Приклад

{
  "error": {
    "code": "insufficient_balance",
    "message": "Your balance is too low for this order. Top up in the dashboard."
  }
}

HTTP	code	Значення
400	bad_requestHTTP 400Значення відсутнє або не допускається для цього продукту.	Значення відсутнє або не допускається для цього продукту.
401	unauthorizedHTTP 401API-ключ відсутній або недійсний.	API-ключ відсутній або недійсний.
402	insufficient_balanceHTTP 402Баланс менший за суму замовлення. Нічого не списано.	Баланс менший за суму замовлення. Нічого не списано.
404	not_foundHTTP 404На вашому акаунті немає замовлення з таким id.	На вашому акаунті немає замовлення з таким id.
429	rate_limitedHTTP 429Забагато запитів за одну хвилину.	Забагато запитів за одну хвилину.
500	server_errorHTTP 500Запит не вдалося виконати. Нічого не списано.	Запит не вдалося виконати. Нічого не списано.

Ендпоінти

Дані акаунта

GET/api/v1/accountAPI-ключ

Повертає баланс, хост і порти проксі, логін і пароль, а також дозволені IP.

Запит

curl https://royalproxy.online/api/v1/account \
  -H "Authorization: Bearer rpk_your_api_key"

Відповідь

{
  "username": "royal_user",
  "balance_usd": 1300,
  "proxy": {
    "host": "gate.royalproxy.online",
    "http_port": 6100,
    "socks5_port": 6200,
    "username": "rpexample1",
    "password": "your_password"
  },
  "allowed_ips": [
    "203.0.113.10"
  ]
}

Список продуктів і цін

GET/api/v1/productsКлюч не потрібен

Повертає всі продукти з обмеженнями, ціновими порогами та знижками. Ціни беруться з тієї самої таблиці, що й на сторінці цін.

Запит

curl https://royalproxy.online/api/v1/products

Відповідь

{
  "currency": "USD",
  "prices_as_of": "2026-10-31",
  "products": [
    {
      "id": "unlimited",
      "unit": "day",
      "quantity": {
        "meaning": "days",
        "min": 1,
        "max": 365
      },
      "...": "..."
    },
    {
      "id": "residential",
      "unit": "gb",
      "...": "..."
    }
  ]
}

Список країн і міст

GET/api/v1/countriesКлюч не потрібен

Повертає країни, доступні для продукту, разом зі значеннями міст, які можна вказати в логіні проксі.

Поле	Тип	Значення
`product`Необов'язковий	string	unlimited, residential, isp або datacenter. За замовчуванням residential.

Запит

curl "https://royalproxy.online/api/v1/countries?product=datacenter"

Відповідь

{
  "product": "datacenter",
  "countries": [
    {
      "code": "us",
      "name": "United States",
      "region": "americas",
      "datacenter": true,
      "cities": [
        {
          "name": "New York",
          "value": "new_york"
        },
        {
          "name": "Los Angeles",
          "value": "los_angeles"
        }
      ]
    }
  ]
}

Розрахунок вартості

POST/api/v1/quoteКлюч не потрібен

Розраховує суму замовлення, нічого не списуючи. Використовуйте те саме тіло запиту, що й для оформлення замовлення.

Поле	Тип	Значення
`product`Обов'язковий	string	unlimited, residential, isp або datacenter.
`quantity`Обов'язковий	integer	Дні для unlimited (1~365), GB для residential (5~5,000), IP для isp (1~1,000) або datacenter (5~5,000).
`concurrency`Необов'язковий	integer	Лише для unlimited: 200, 500, 1000 або 2000.
`bandwidth`Необов'язковий	integer	Лише для unlimited, у Mbps: 100, 200, 500 або 1000.
`months`Необов'язковий	integer	Лише для isp і datacenter: 1, 3, 6 або 12.
`country`Необов'язковий	string	Лише для isp і datacenter: двобуквений код країни, наприклад jp. Див. /countries.

Запит

curl -X POST https://royalproxy.online/api/v1/quote \
  -H "Content-Type: application/json" \
  -d '{"product":"unlimited","quantity":30,"concurrency":1000,"bandwidth":200}'

Відповідь

{
  "product": "unlimited",
  "quantity": 30,
  "unit_price_usd": 8.97,
  "unit": "day",
  "total_usd": 269.1
}

Оформити замовлення

POST/api/v1/ordersAPI-ключ

Списує суму з балансу й створює замовлення. Нові замовлення мають статус pending (активується) і переходять в active, коли готові. Якщо замовлення не вдається активувати, воно отримує статус refunded, і вся сума повертається на баланс. Повертає 402, якщо балансу недостатньо.

Поле	Тип	Значення
`product`Обов'язковий	string	unlimited, residential, isp або datacenter.
`quantity`Обов'язковий	integer	Дні для unlimited (1~365), GB для residential (5~5,000), IP для isp (1~1,000) або datacenter (5~5,000).
`concurrency`Необов'язковий	integer	Лише для unlimited: 200, 500, 1000 або 2000.
`bandwidth`Необов'язковий	integer	Лише для unlimited, у Mbps: 100, 200, 500 або 1000.
`months`Необов'язковий	integer	Лише для isp і datacenter: 1, 3, 6 або 12.
`country`Необов'язковий	string	Лише для isp і datacenter: двобуквений код країни, наприклад jp. Див. /countries.

Запит

curl -X POST https://royalproxy.online/api/v1/orders \
  -H "Authorization: Bearer rpk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"product":"unlimited","quantity":30,"concurrency":1000,"bandwidth":200}'

Відповідь

{
  "order": {
    "id": "RP-7KQ2M-X4HTD",
    "product": "unlimited",
    "quantity": 30,
    "months": null,
    "concurrency": 1000,
    "bandwidth_mbps": 200,
    "country": null,
    "unit_price_usd": 8.97,
    "total_usd": 269.1,
    "status": "pending",
    "created_at": "2026-10-31T09:12:44.120Z",
    "updated_at": "2026-10-31T09:12:44.120Z"
  },
  "balance_usd": 1030.9
}

Список ваших замовлень

GET/api/v1/ordersAPI-ключ

Повертає ваші останні 100 замовлень, спершу нові.

Поле	Тип	Значення
`status`Необов'язковий	string	pending, active або refunded. Не вказуйте, щоб отримати всі.

Запит

curl "https://royalproxy.online/api/v1/orders?status=pending" \
  -H "Authorization: Bearer rpk_your_api_key"

Відповідь

{
  "orders": [
    {
      "id": "RP-7KQ2M-X4HTD",
      "product": "unlimited",
      "quantity": 30,
      "months": null,
      "concurrency": 1000,
      "bandwidth_mbps": 200,
      "country": null,
      "unit_price_usd": 8.97,
      "total_usd": 269.1,
      "status": "pending",
      "created_at": "2026-10-31T09:12:44.120Z",
      "updated_at": "2026-10-31T09:12:44.120Z"
    }
  ]
}

Одне замовлення

GET/api/v1/orders/{id}API-ключ

Повертає одне замовлення за його id, наприклад, щоб перевірити, чи воно активне.

Поле	Тип	Значення
`id`Обов'язковий	string	Id замовлення, наприклад RP-7KQ2M-X4HTD.

Запит

curl https://royalproxy.online/api/v1/orders/RP-7KQ2M-X4HTD \
  -H "Authorization: Bearer rpk_your_api_key"

Відповідь

{
  "order": {
    "id": "RP-7KQ2M-X4HTD",
    "product": "unlimited",
    "quantity": 30,
    "months": null,
    "concurrency": 1000,
    "bandwidth_mbps": 200,
    "country": null,
    "unit_price_usd": 8.97,
    "total_usd": 269.1,
    "status": "active",
    "created_at": "2026-10-31T09:12:44.120Z",
    "updated_at": "2026-10-31T09:40:02.511Z"
  }
}

Зібрати логін проксі

GET/api/v1/proxy-userAPI-ключ

Повертає логін проксі з вашими параметрами та готові URL проксі для HTTP і SOCKS5. Без session IP змінюється на кожен запит.

Поле	Тип	Значення
`product`Необов'язковий	string	unlimited, residential, isp або datacenter. За замовчуванням unlimited.
`country`Необов'язковий	string	Двобуквений код країни, наприклад jp.
`city`Необов'язковий	string	Значення міста з /countries, наприклад tokyo. Потребує country.
`session`Необов'язковий	string	Будь-які 1~32 літери або цифри. Запити з однаковим session зберігають той самий IP.
`ttl`Необов'язковий	integer	Скільки хвилин утримувати IP сесії, 1~60. За замовчуванням 30.

Запит

curl "https://royalproxy.online/api/v1/proxy-user?product=residential&country=jp&city=tokyo&session=job42&ttl=30" \
  -H "Authorization: Bearer rpk_your_api_key"

Відповідь

{
  "username": "rpexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30",
  "password": "your_password",
  "http": "http://rpexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30:your_password@gate.royalproxy.online:6100",
  "socks5": "socks5h://rpexample1-zone-res-cc-jp-city-tokyo-sid-job42-ttl-30:your_password@gate.royalproxy.online:6200"
}

Повні приклади

Ці приклади перевіряють ціну, оформлюють замовлення з балансу й підключаються через японський IP.

Python (requests)

import requests

API = "https://royalproxy.online/api/v1"
HEAD = {"Authorization": "Bearer rpk_your_api_key"}

# 1) Check the price first
plan = {"product": "residential", "quantity": 100}
print(requests.post(f"{API}/quote", json=plan).json())

# 2) Order from your balance
r = requests.post(f"{API}/orders", json=plan, headers=HEAD)
order = r.json()["order"]
print(order["id"], order["status"])

# 3) Get a username for Japanese IPs
u = requests.get(f"{API}/proxy-user", headers=HEAD,
                 params={"product": "residential", "country": "jp"}).json()
proxies = {"http": u["http"], "https": u["http"]}
print(requests.get("https://ipinfo.io/json", proxies=proxies, timeout=30).json())

Node.js 18+

const API = "https://royalproxy.online/api/v1";
const HEAD = { Authorization: "Bearer rpk_your_api_key", "Content-Type": "application/json" };

// Check the balance
const acc = await fetch(`${API}/account`, { headers: HEAD }).then((r) => r.json());
console.log(acc.balance_usd);

// Order 7 days of unlimited
const res = await fetch(`${API}/orders`, {
  method: "POST",
  headers: HEAD,
  body: JSON.stringify({ product: "unlimited", quantity: 7, concurrency: 500, bandwidth: 100 }),
});
if (res.status === 402) console.log("Top up first");
else console.log((await res.json()).order.id);

Замовлення, оформлені через API, нічим не відрізняються від замовлень з кабінету й відображаються в History. Замініть rpk_your_api_key на свій ключ.

Документація API для проксі

З чого почати?

Як працює автентифікація?

Базова URL-адреса та формат

Чи є обмеження частоти запитів?

Як виглядають помилки?

Дані акаунта

Список продуктів і цін

Список країн і міст

Розрахунок вартості

Оформити замовлення

Список ваших замовлень

Одне замовлення

Зібрати логін проксі

Повні приклади

Підключіть RoyalProxy до власної системи