Справка по FlashProxy API
Проверяйте баланс и планы, читайте статистику использования, генерируйте прокси и продлевайте планы из собственных скриптов. Каждый эндпоинт возвращает JSON и читает данные только вашего аккаунта.
Базовый URL: https://www.flashproxy.com
Создайте ключ API в панели управления по адресу https://www.flashproxy.com/dashboard/api. Полный ключ показывается только один раз, поэтому сохраните его в безопасном месте.
Используете AI-агент? Передайте ему всю эту справку как один файл Markdown: https://www.flashproxy.com/api-reference.md. Спецификация OpenAPI 3,1 находится по адресу https://www.flashproxy.com/openapi.json.
Быстрый старт
Выведите список ваших планов, затем используйте plan_id из ответа в других эндпоинтах.
cURL
curl "https://www.flashproxy.com/api/v1/plans?status=active&limit=10" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Python
import requests
response = requests.get(
"https://www.flashproxy.com/api/v1/plans?status=active&limit=10",
headers={
"Authorization": "Bearer fpk_live_YOUR_KEY",
},
timeout=30,
)
print(response.json())Node.js
const response = await fetch("https://www.flashproxy.com/api/v1/plans?status=active&limit=10", {
headers: {
"Authorization": "Bearer fpk_live_YOUR_KEY",
},
});
console.log(await response.json());Аутентификация
Отправляйте ключ в заголовке Authorization как Bearer fpk_live_… или в заголовке X-API-Key.
Каждый ключ может читать данные использования. Для генерации прокси и расширения планов требуются отдельные разрешения, которые вы выбираете при создании ключа. Обращайтесь с ключом как с паролем и отзывайте его при утечке.
Разрешения ключа
| Разрешение | Разрешает |
|---|---|
| использование | Читать данные об использованном трафике, оставшихся данных и текущей скорости. Каждый ключ это содержит. |
| прокси | Генерировать списки прокси. Ответы содержат ваше имя пользователя и пароль прокси. |
| расширение | Расширение планов. Каждый вызов оплачивается со счета вашего аккаунта. |
Аккаунт
Текущий ключ
GET /api/v1/key
Возвращает ключ, который вы используете: его имя, префикс и разрешения. Полезно, когда вызов возвращает 403 FORBIDDEN.
Разрешение: usage
Запрос
curl "https://www.flashproxy.com/api/v1/key" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"key_id": "7d1c2b4e-…",
"name": "Monitoring server",
"key_prefix": "fpk_live_k3x9q2ma",
"permissions": [
"usage",
"proxies",
"extend"
],
"created_at": "2026-09-29T12:00:00.000Z",
"last_used_at": "2026-10-13T12:00:00.000Z"
}
}Баланс аккаунта
GET /api/v1/balance
Возвращает ваш доступный баланс аккаунта, из которого оплачиваются расширения.
Разрешение: usage
Запрос
curl "https://www.flashproxy.com/api/v1/balance" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"balance_usd": 42.18,
"balance_cents": 4218,
"currency": "USD"
}
}Список планов
GET /api/v1/plans
Возвращает ваши планы (новые в начале) с их статусом, сроком действия, лимитом данных и информацией, расширяются ли они по ГБ или дням. Никогда не возвращает учетные данные прокси.
Разрешение: usage
Параметры
| Имя | В | Обязательно | Описание |
|---|---|---|---|
| status | query | all (по умолчанию), active или expired. | |
| limit | query | Количество планов для возврата, до 100. По умолчанию 50. | |
| offset | query | Количество планов для пропуска (для постраничной навигации). По умолчанию 0. |
Запрос
curl "https://www.flashproxy.com/api/v1/plans?status=active&limit=10" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"plans": [
{
"plan_id": "YOUR_PLAN_ID",
"product": "residential",
"name": "Residential Proxies",
"status": "active",
"billed_by": "data",
"created_at": "2026-09-13T12:00:00.000Z",
"expires_at": "2027-03-12T12:00:00.000Z",
"max_bytes": 10737418240,
"bytes_used": 4294967296,
"speed_mbps": null,
"extend_with": "gb"
}
],
"total": 1,
"limit": 10,
"offset": 0
}
}Список транзакций
GET /api/v1/transactions
Возвращает ваши платежи, пополнения и покупки баланса (новые в начале) для ведения бухгалтерии.
Разрешение: usage
Параметры
| Имя | В | Обязательно | Описание |
|---|---|---|---|
| limit | query | Количество транзакций для возврата, до 100. По умолчанию 50. | |
| offset | query | Количество транзакций для пропуска (для постраничной навигации). По умолчанию 0. |
Запрос
curl "https://www.flashproxy.com/api/v1/transactions?limit=10" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"transactions": [
{
"transaction_id": "FP-1791900000000-a1b2c3d4e",
"type": "PURCHASE",
"status": "COMPLETED",
"amount_usd": 29.8,
"payment_method": "BALANCE",
"description": "Purchase of 1 item",
"created_at": "2026-10-11T12:00:00.000Z",
"completed_at": "2026-10-11T12:00:00.000Z"
}
],
"total": 1,
"limit": 10,
"offset": 0,
"currency": "USD"
}
}
```,## Использование
### Использование всех активных планов
`GET /api/v1/usage`
Возвращает запись использования для каждого активного плана вашего аккаунта.
Разрешение: `usage`
**Запрос**
```bash
curl "https://www.flashproxy.com/api/v1/usage" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"plans": [
{
"plan_id": "YOUR_PLAN_ID",
"product": "ipv6-datacenter",
"name": "IPv6 Datacenter Proxies",
"status": "active",
"expires_at": "2026-11-01T12:00:00.000Z",
"usage": {
"bytes_used": 2639963,
"max_bytes": null,
"remaining_bytes": null,
"percentage_used": null
},
"throughput_status": "ok",
"throughput": {
"source": "per_minute",
"current_mbps": 412.5,
"avg_mbps_5m": 380.1,
"peak_mbps_1h": 955,
"sampled_at": "2026-10-13T11:59:15.000Z",
"data_delay_seconds": 45,
"limit_mbps": 1000,
"utilization_pct": 41.25
},
"generated_at": "2026-10-13T12:00:00.000Z"
}
]
}
}Использование одного плана
GET /api/v1/plans/{plan_id}/usage
Возвращает запись использования одного из ваших планов независимо от его статуса.
Разрешение: usage
Параметры
| Имя | В | Обязательно | Описание |
|---|---|---|---|
| plan_id | path | обязательно | ID плана, возвращаемый в plan_id функцией List plans. |
Запрос
curl "https://www.flashproxy.com/api/v1/plans/YOUR_PLAN_ID/usage" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"plan_id": "YOUR_PLAN_ID",
"product": "ipv6-datacenter",
"name": "IPv6 Datacenter Proxies",
"status": "active",
"expires_at": "2026-11-01T12:00:00.000Z",
"usage": {
"bytes_used": 2639963,
"max_bytes": null,
"remaining_bytes": null,
"percentage_used": null
},
"throughput_status": "ok",
"throughput": {
"source": "per_minute",
"current_mbps": 412.5,
"avg_mbps_5m": 380.1,
"peak_mbps_1h": 955,
"sampled_at": "2026-10-13T11:59:15.000Z",
"data_delay_seconds": 45,
"limit_mbps": 1000,
"utilization_pct": 41.25
},
"generated_at": "2026-10-13T12:00:00.000Z"
}
}История использования
GET /api/v1/plans/{plan_id}/usage/history
Возвращает трафик и скорость плана за время в фиксированных интервалах (1 минута за 1 ч, до 4 часов за 30 дней) с итогами, процентом успеха и пиками. Метки времени в UTC. Доступно для планов ISP, ISP EU, Datacenter, IPv6 и Premium Unlimited.
Разрешение: usage
Параметры
| Имя | В | Обязательно | Описание |
|---|---|---|---|
| plan_id | path | обязательно | ID плана, возвращаемый в plan_id функцией List plans. |
| range | query | Временной интервал: 1h, 24h, 7d, 30d. По умолчанию 24h. |
Запрос
curl "https://www.flashproxy.com/api/v1/plans/YOUR_PLAN_ID/usage/history?range=24h" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"plan_id": "YOUR_PLAN_ID",
"range": "24h",
"bucket_seconds": 900,
"generated_at": "2026-10-13T12:00:00.000Z",
"totals": {
"bytes": 3221225472,
"bytes_up": 214748364.8,
"bytes_down": 3006477107.2,
"connections": 48210,
"success_pct": 99.2,
"peak_mbps": 412.5,
"peak_concurrent": 37
},
"series": [
{
"t": "2026-10-13T11:30:00.000Z",
"bytes": 41943040,
"bytes_up": 2097152,
"bytes_down": 39845888,
"mbps": 0.37,
"connections_per_sec": 0.62,
"concurrent": 12
},
{
"t": "2026-10-13T11:45:00.000Z",
"bytes": 52428800,
"bytes_up": 3145728,
"bytes_down": 49283072,
"mbps": 0.47,
"connections_per_sec": 0.71,
"concurrent": 15
}
]
}
}Основные направления
GET /api/v1/plans/{plan_id}/destinations
Возвращает сайты, к которым план подключался чаще всего за период времени, с трафиком, подключениями и процентом успеха на хост (топ 100).
Разрешение: usage
Параметры
| Имя | В | Обязательно | Описание |
|---|---|---|---|
| plan_id | path | обязательно | ID плана, возвращаемый в plan_id функцией List plans. |
| range | query | Временной интервал: 1h, 24h, 7d, 30d. По умолчанию 24h. |
Запрос
curl "https://www.flashproxy.com/api/v1/plans/YOUR_PLAN_ID/destinations?range=24h" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"plan_id": "YOUR_PLAN_ID",
"range": "24h",
"generated_at": "2026-10-13T12:00:00.000Z",
"destinations": [
{
"host": "example.com",
"bytes_down": 1288490188.8,
"bytes_up": 107374182.4,
"connections": 18240,
"failed": 96,
"success_pct": 99.5
}
]
}
}Разбор ошибок
GET /api/v1/plans/{plan_id}/errors
Возвращает то, что пошло не так за период времени, сгруппированное по категориям, каждая с читаемым названием и подсказкой, что проверить.
Разрешение: usage
Параметры
| Имя | В | Обязательно | Описание |
|---|---|---|---|
| plan_id | path | обязательно | ID плана, возвращаемый в plan_id функцией List plans. |
| range | query | Временной интервал: 1h, 24h, 7d, 30d. По умолчанию 24h. |
Запрос
curl "https://www.flashproxy.com/api/v1/plans/YOUR_PLAN_ID/errors?range=24h" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"plan_id": "YOUR_PLAN_ID",
"range": "24h",
"generated_at": "2026-10-13T12:00:00.000Z",
"errors": [
{
"category": "timeout",
"label": "Connection timed out",
"hint": "The destination did not answer in time. Usually a slow or overloaded target site; retry with a longer client timeout, and check whether one destination dominates.",
"count": 214
}
]
}
}
```,## Прокси
### Локации плана
`GET /api/v1/plans/{plan_id}/locations`
Возвращает страны, которые может выбрать план через поле country при генерации прокси. Когда any_country равно true, принимается любой двухбуквенный код и списка нет.
Разрешение: `usage`
**Параметры**
| Имя | В | Обязательно | Описание |
| --- | --- | --- | --- |
| `plan_id` | path | обязательно | ID плана, возвращаемый в plan_id функцией List plans. |
**Запрос**
```bash
curl "https://www.flashproxy.com/api/v1/plans/YOUR_PLAN_ID/locations" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"plan_id": "YOUR_PLAN_ID",
"product": "ipv6-datacenter",
"any_country": false,
"countries": [
{
"code": "CA",
"name": "Canada"
},
{
"code": "FR",
"name": "France"
},
{
"code": "US",
"name": "United States"
}
]
}
}Генерировать прокси
POST /api/v1/plans/{plan_id}/proxies
Создает готовые к использованию строки прокси для одного из ваших активных планов так же, как генератор в панели управления.
Разрешение: proxies
Параметры
| Имя | В | Обязательно | Описание |
|---|---|---|---|
| plan_id | path | обязательно | ID плана, возвращаемый в plan_id функцией List plans. |
| count | body | Количество строк для возврата, 1 до 1000. По умолчанию 10. | |
| country | body | Двухбуквенный код страны, например US. Оставьте пусто для любой страны. | |
| session | body | ротационные сессии для нового IP при каждом запросе (по умолчанию) или sticky-сессии для сохранения одного IP. | |
| sticky_minutes | body | Как долго сохраняется sticky IP, 1 до 1000 минут. Резидентные и мобильные прокси ограничивают до 120. По умолчанию 30. | |
| protocol | body | http (по умолчанию) или socks5. | |
| format | body | hostport для host:port:user:pass (по умолчанию) или url для scheme://user:pass@host:port. |
Запрос
curl -X POST "https://www.flashproxy.com/api/v1/plans/YOUR_PLAN_ID/proxies" \
-H "Authorization: Bearer fpk_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"count":2,"country":"US","session":"sticky","sticky_minutes":30,"protocol":"http","format":"hostport"}'Ответ · 200
{
"success": true,
"data": {
"plan_id": "YOUR_PLAN_ID",
"count": 2,
"protocol": "http",
"format": "hostport",
"proxies": [
"adam.flashproxy.io:8080:USERNAME-country-US-session-k3x9q2ma-time-30:PASSWORD",
"adam.flashproxy.io:8080:USERNAME-country-US-session-p7d1v8tc-time-30:PASSWORD"
]
}
}Список выделенных IP
GET /api/v1/plans/{plan_id}/ips
Возвращает выделенные IP плана с его логином: актуальные выходные IP для планов дата-центров или арендованные IP для планов Dedicated ISP. Планы с ротационными шлюзами используют Generate proxies вместо этого.
Разрешение: proxies
Параметры
| Имя | В | Обязательно | Описание |
|---|---|---|---|
| plan_id | path | обязательно | ID плана, возвращаемый в plan_id функцией List plans. |
| protocol | query | http (по умолчанию) или socks5. Планы Dedicated ISP v2 поддерживают только http. | |
| format | query | hostport для host:port:user:pass (по умолчанию) или url для scheme://user:pass@host:port. | |
| limit | query | Количество IP для возврата, до 10000. По умолчанию 1000. total всегда показывает полный счёт. |
Запрос
curl "https://www.flashproxy.com/api/v1/plans/YOUR_PLAN_ID/ips?protocol=http&limit=2" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"plan_id": "YOUR_PLAN_ID",
"product": "datacenter",
"source": "live",
"protocol": "http",
"format": "hostport",
"total": 2048,
"count": 2,
"proxies": [
"203.0.113.10:777:USERNAME:PASSWORD",
"203.0.113.11:777:USERNAME:PASSWORD"
]
}
}
```,## Расширения
### Цена расширения
`GET /api/v1/plans/{plan_id}/extend/quote`
Возвращает стоимость расширения, выполняя те же проверки, что и Extend a plan, без покупки.
Разрешение: `usage`
**Параметры**
| Имя | В | Обязательно | Описание |
| --- | --- | --- | --- |
| `plan_id` | path | обязательно | ID плана, возвращаемый в plan_id функцией List plans. |
| `gb` | query | | ГБ для расчёта, для планов, которые оплачиваются по объёму данных. |
| `days` | query | | Дни для расчёта, для планов, которые оплачиваются по времени. Отправьте gb или days, но не оба. |
**Запрос**
```bash
curl "https://www.flashproxy.com/api/v1/plans/YOUR_PLAN_ID/extend/quote?gb=10" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"plan_id": "YOUR_PLAN_ID",
"added": {
"gb": 10
},
"price_usd": 35,
"currency": "USD"
}
}Расширить план
POST /api/v1/plans/{plan_id}/extend
Добавляет данные (ГБ) или время (дни) к одному из ваших планов и оплачивает с баланса аккаунта по той же цене, что на панели управления.
Разрешение: extend
Параметры
| Имя | В | Обязательно | Описание |
|---|---|---|---|
| plan_id | path | обязательно | ID плана, возвращаемый в plan_id функцией List plans. |
| Idempotency-Key | header | обязательно | Уникальная строка для этого расширения. См. Idempotency ниже. |
| gb | body | ГБ для добавления к планам, которые оплачиваются по объёму данных. Целое число от 1 до 2 000 000. | |
| days | body | Дни для добавления к планам, которые оплачиваются по времени: 1 до 365 или 1, 7, 30, 60 для Premium Unlimited Residential. Отправьте gb или days, но не оба. |
Запрос
curl -X POST "https://www.flashproxy.com/api/v1/plans/YOUR_PLAN_ID/extend" \
-H "Authorization: Bearer fpk_live_YOUR_KEY" \
-H "Idempotency-Key: extend-2026-10-13-001" \
-H "Content-Type: application/json" \
-d '{"gb":10}'Ответ · 200
{
"success": true,
"data": {
"plan_id": "YOUR_PLAN_ID",
"charged_usd": 35,
"added": {
"gb": 10
},
"plan": {
"status": "active",
"expires_at": "2027-04-11T12:00:00.000Z",
"max_bytes": 21474836480
},
"replayed": false
}
}
```,## Продукты и цены
### Продукты и цены
`GET /api/v1/products`
Возвращает каждый продукт с его тарифами за ГБ (вся сумма выставляется по ставке уровня, в который она попадает) и цены за скорость и дни. Используйте Quote an extension для точной цены конкретного плана.
Разрешение: `usage`
**Запрос**
```bash
curl "https://www.flashproxy.com/api/v1/products" \
-H "Authorization: Bearer fpk_live_YOUR_KEY"Ответ · 200
{
"success": true,
"data": {
"products": [
{
"product": "datacenter",
"name": "Datacenter Proxies",
"billed_by": [
"data",
"time"
],
"data_pricing": [
{
"up_to_gb": 1,
"per_gb_usd": 0.7
},
{
"up_to_gb": 5,
"per_gb_usd": 0.65
}
],
"time_pricing": [
{
"mbps": 10,
"days": 1,
"price_usd": 1
},
{
"mbps": 10,
"days": 30,
"price_usd": 18
}
]
}
],
"currency": "USD"
}
}Идемпотентность
Расширение плана расходует ваш баланс, поэтому каждый вызов расширения требует заголовок Idempotency-Key.
- Используйте новый ключ для каждого расширения плана, которое вы хотите купить: от 8 до 128 букв, цифр, - или _.
- Если вызов истечет по времени или вернет ошибку 5xx, отправьте его еще раз с тем же ключом. Вам будет выставлен счет максимум один раз, и завершенное расширение плана вернется с replayed: true.
- Один и тот же ключ с другим планом или суммой возвращает 409 IDEMPOTENCY_KEY_REUSED.
- Пока первый вызов еще выполняется, второй вызов с тем же ключом возвращает 409 REQUEST_IN_PROGRESS.
Поля ответа
Каждый план в ответе использования содержит одну и ту же запись.
| Поле | Значение |
|---|---|
| usage.* | bytes_used, max_bytes, remaining_bytes и percentage_used. max_bytes и remaining_bytes имеют значение null для планов без ограничения по объёму данных. bytes_used имеет значение null для Unlimited Residential, который оплачивается по времени и скорости. |
| throughput.current_mbps | Последний замер скорости: последняя полная минута для большинства продуктов, 0 при отсутствии недавнего трафика. |
| throughput.avg_mbps_5m / peak_mbps_1h | Среднее значение за 5 минут и пиковая скорость за 1 час. |
| throughput.limit_mbps | Ограничение скорости вашего плана. utilization_pct — текущая скорость, разделённая на это ограничение. |
| throughput.sampled_at | Время последнего измерения. data_delay_seconds показывает, насколько оно старо. |
Значения throughput_status
| Значение | Значение |
|---|---|
| ok | пропускная способность заполнена. |
| pending | Скорость ещё собирается. Для Unlimited Residential первое значение может быть доступно до 10 минут; продолжайте опрашивать обычным образом. |
| unavailable | Скорость временно недоступна. Повторите попытку позже. |
| not_supported | Для этого продукта метрики скорости недоступны. Счётчики использования работают. |
Ограничения
- 60 запросов в минуту на ключ
- Все ключи одного аккаунта делят лимит 120 запросов в минуту.
- При превышении лимита вы получите 429 с заголовком Retry-After: 60.
- Вызовы расширения также учитываются в лимите 6 покупок баланса в минуту на аккаунт, общем с панелью управления.
- Скорость измеряется в минуту, поэтому опроса каждые 15–30 секунд вполне достаточно.
- Ответы об использовании могут быть устаревшими на 15 секунд, а цены на продукты — на 5 минут.
Ошибки
Ошибки имеют одну структуру: success — false и error содержит код и читаемое сообщение.
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}| Статус | Код | Значение |
|---|---|---|
| 400 | INVALID_REQUEST | Тело или параметр недействительны. Сообщение указывает, какой именно. |
| 400 | IDEMPOTENCY_KEY_REQUIRED | Вызов расширения без действительного заголовка Idempotency-Key. |
| 400 | PAYMENT_REFUSED | Платёж баланса отклонен. Свяжитесь со службой поддержки. |
| 401 | UNAUTHORIZED | Ключ отсутствует, недействителен или отозван. |
| 402 | INSUFFICIENT_BALANCE | Баланса недостаточно для этого расширения. Пополните и повторите попытку. |
| 403 | FORBIDDEN | Ключ не имеет разрешения, требуемого для этой точки. |
| 404 | NOT_FOUND | На вашем аккаунте такого плана нет. |
| 409 | PLAN_NOT_ACTIVE | Прокси можно генерировать только для активного плана. |
| 409 | PLAN_NOT_READY | План ещё не имеет учётных данных прокси. Повторите попытку вскоре. |
| 409 | IDEMPOTENCY_KEY_REUSED | Этот Idempotency-Key уже был использован для другого расширения. |
| 409 | REQUEST_IN_PROGRESS | Расширение с этим Idempotency-Key всё ещё выполняется. Повторите попытку через момент. |
| 409 | PRICE_MISMATCH | Цена изменилась во время обработки. Повторите с новым Idempotency-Key. |
| 422 | EXTENSION_NOT_SUPPORTED | Этот план невозможно расширить через API. Расширьте его в панели управления. |
| 422 | PROXIES_NOT_SUPPORTED | Выделенные планы имеют фиксированный список IP. Загрузите его из панели управления. |
| 422 | USAGE_HISTORY_NOT_SUPPORTED | Для этого продукта нет истории использования. Используйте точки использования для его счётчиков. |
| 422 | IPS_NOT_SUPPORTED | Этот план использует ротационный шлюз, а не фиксированный список IP. Используйте Generate proxies. |
| 422 | CUSTOM_PLAN_EXTEND_VIA_SUPPORT | Пользовательские планы расширяются только службой поддержки. |
| 429 | RATE_LIMITED | Слишком много запросов. Дождитесь Retry-After, затем повторите попытку. |
| 500 | INTERNAL_ERROR | Временная ошибка. Попробуйте снова. |
| 502 | EXTENSION_FAILED | Расширение не завершилось. Повторите с тем же Idempotency-Key, только если в сообщении сказано, что списания не было; иначе обратитесь в поддержку. |
| 503 | IPS_UNAVAILABLE | Список IP не удалось загрузить прямо сейчас. Повторите через минуту. |