Довідник API StarProxy: акаунт, замовлення та логіни

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

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

Автентифікація

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

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

HTTP header

Authorization: Bearer spk_your_api_key

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

Базова URL-адреса: https://starproxy.shop/api/v1
Тіло запиту та відповіді: application/json
Суми: USD числом, наприклад 1047.70
Позначки часу: 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/accountПотрібен API-ключ

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

Запит

curl https://starproxy.shop/api/v1/account \
  -H "Authorization: Bearer spk_your_api_key"

Відповідь

{
  "username": "star_user01",
  "balance_usd": 1300,
  "proxy": {
    "host": "gate.starproxy.shop",
    "http_port": 6100,
    "socks5_port": 6200,
    "username": "spexample1",
    "password": "your_password"
  },
  "allowed_ips": [
    "203.0.113.10"
  ]
}

Отримати продукти та ціни

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

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

Запит

curl https://starproxy.shop/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Ключ не потрібен

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

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

Запит

curl "https://starproxy.shop/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://starproxy.shop/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.41,
  "unit": "day",
  "total_usd": 252.3
}

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

POST/api/v1/ordersПотрібен API-ключ

Списує суму з балансу та створює замовлення. Спершу статус 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://starproxy.shop/api/v1/orders \
  -H "Authorization: Bearer spk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"product":"unlimited","quantity":30,"concurrency":1000,"bandwidth":200}'

Відповідь

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

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

GET/api/v1/ordersПотрібен API-ключ

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

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

Запит

curl "https://starproxy.shop/api/v1/orders?status=pending" \
  -H "Authorization: Bearer spk_your_api_key"

Відповідь

{
  "orders": [
    {
      "id": "SP-7KQ2M-X4HTD",
      "product": "unlimited",
      "quantity": 30,
      "months": null,
      "concurrency": 1000,
      "bandwidth_mbps": 200,
      "country": null,
      "unit_price_usd": 8.41,
      "total_usd": 252.3,
      "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 замовлення, наприклад SP-7KQ2M-X4HTD.

Запит

curl https://starproxy.shop/api/v1/orders/SP-7KQ2M-X4HTD \
  -H "Authorization: Bearer spk_your_api_key"

Відповідь

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

Створити логін проксі

GET/api/v1/proxy-userПотрібен API-ключ

Повертає логін проксі з вашими параметрами, а також готові для вставлення 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://starproxy.shop/api/v1/proxy-user?product=residential&country=jp&city=tokyo&session=job42&ttl=30" \
  -H "Authorization: Bearer spk_your_api_key"

Відповідь

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

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

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

Python (requests)

import requests

API = "https://starproxy.shop/api/v1"
HEAD = {"Authorization": "Bearer spk_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://starproxy.shop/api/v1";
const HEAD = { Authorization: "Bearer spk_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 обробляються так само, як замовлення з кабінету, і з'являються на вкладці «Історія». Замініть spk_your_api_key у прикладах на свій ключ.

API StarProxy

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

Автентифікація

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

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

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

Отримати акаунт

Отримати продукти та ціни

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

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

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

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

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

Створити логін проксі

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

Користуйтеся StarProxy прямо з коду