Перейти к содержанию
royalproxy
Начать

Документация API прокси

Через REST API RoyalProxy можно из своего кода получать баланс и данные подключения, проверять цены, оформлять заказы с баланса и собирать логины прокси.

Создать API-ключСмотреть эндпоинты

С чего начать?

  1. 1Зарегистрируйтесь и войдите в личный кабинет.
  2. 2Откройте раздел Connect и создайте API-ключ. Полный ключ показывается только один раз, поэтому сохраните его в надежном месте.
  3. 3Передавайте ключ в заголовке Authorization в каждом запросе, где он нужен.
  4. 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."
  }
}
code
bad_requestHTTP 400Значение отсутствует или недопустимо для этого продукта.
unauthorizedHTTP 401API-ключ отсутствует или недействителен.
insufficient_balanceHTTP 402Баланс меньше суммы заказа. Ничего не списано.
not_foundHTTP 404На вашем аккаунте нет заказа с таким id.
rate_limitedHTTP 429Слишком много запросов за одну минуту.
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Необязательный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Обязательныйunlimited, residential, isp или datacenter.
quantityОбязательныйДни для unlimited (1~365), GB для residential (5~5,000), IP для isp (1~1,000) или datacenter (5~5,000).
concurrencyНеобязательныйТолько для unlimited: 200, 500, 1000 или 2000.
bandwidthНеобязательныйТолько для unlimited, в Mbps: 100, 200, 500 или 1000.
monthsНеобязательныйТолько для isp и datacenter: 1, 3, 6 или 12.
countryНеобязательныйТолько для 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Обязательныйunlimited, residential, isp или datacenter.
quantityОбязательныйДни для unlimited (1~365), GB для residential (5~5,000), IP для isp (1~1,000) или datacenter (5~5,000).
concurrencyНеобязательныйТолько для unlimited: 200, 500, 1000 или 2000.
bandwidthНеобязательныйТолько для unlimited, в Mbps: 100, 200, 500 или 1000.
monthsНеобязательныйТолько для isp и datacenter: 1, 3, 6 или 12.
countryНеобязательныйТолько для 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Необязательный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Обязательный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Необязательныйunlimited, residential, isp или datacenter. По умолчанию unlimited.
countryНеобязательныйДвухбуквенный код страны, например jp.
cityНеобязательныйЗначение города из /countries, например tokyo. Требует country.
sessionНеобязательныйЛюбые 1~32 буквы или цифры. Запросы с одинаковым session сохраняют один IP.
ttlНеобязательныйСколько минут держать 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 ничем не отличаются от заказов из личного кабинета и видны в истории. Замените rpk_your_api_key на свой ключ.

Подключите RoyalProxy к своей системе

Создайте аккаунт, затем выпустите API-ключ в личном кабинете.

Создание аккаунтаИнструкция по настройке