SuperNova Proxy SuperNova
Войти Регистрация →

Документация API для разработчиков

Используйте наш API для упрощения работы или перепродажи

Документация API для разработчиков

Наш сервис позволяет работать с нами через API. Это полезно, если ваше ПО поддерживает API или вы хотите перепродавать наши прокси под своим брендом. Войдите в аккаунт и создайте API-ключ в форме сверху этой страницы. Данный ключ используется во всех запросах. Разрешен только один активный ключ. Вы можете обновить его в любой момент — старый ключ отключится автоматически.

Рекомендации:

1. Обновляйте страны, регионы и города минимум раз в минуту или перед созданием/обновлением прокси-ссылок

2. Форматы ссылок меняются редко. Обращайтесь в поддержку для запроса кастомного формата

3. Не игнорируйте лимиты субаккаунтов! При перепродаже всегда устанавливайте лимиты во избежание списания средств с вашего баланса

4. Вы можете использовать свой домен для подключений: выполните ping нашего шлюза, получите текущий IP и обновите DNS-записи. Поддерживаются только IPv4-адреса. Обратитесь в поддержку при необходимости.

Общая информация

Добавьте API-ключ в заголовок запроса: 

Content-Type: application/json
Authorization: ApiKey 00000000-0000-0000-0000-000000000000

Ошибки содержат HTTP-код, описание и флаг 'success'=false:

{
  "data": {
    "general": "API key not recognized or user is blocked"
  },
  "success": false
}

На все endpointы API действует лимит запросов для безопасности. При слишком частых запросах вы получите ошибку 429. Обратитесь в поддержку для увеличения лимита. В заголовках ответа указано оставшееся количество запросов до ошибки 429:

< X-Ratelimit-Limit: 5
< X-Ratelimit-Remaining: 4
< X-Ratelimit-Reset: 15

Баланс аккаунта

Запрос для получения текущего баланса:

curl -X GET https://supernovanet.org/api/v1/balance -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000" ### Get Balance
GET https://supernovanet.org/api/v1/balance
Authorization: ApiKey 00000000-0000-0000-0000-000000000000

Успешный ответ на запрос:

HTTP/1.1 200 OK
Date: Thu, 01 Apr 2025 00:00:00 GMT
Content-Type: application/json
Content-Length: 73
X-Ratelimit-Limit: 5
X-Ratelimit-Remaining: 4
X-Ratelimit-Reset: 15
Connection: close

{
  "data": {
    "balance_string": "$14.97",
    "balance_float": 14.97
  },
  "success": true
}

Доступные страны

Запрос списка стран. В списке представлены все страны для всех типов прокси. Фильтрация по типам прокси невозможна.

curl -X GET https://supernovanet.org/api/v1/inventory/countries -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"

Успешный ответ на запрос:

{
    "data": [{
        "name": "France",
        "iso": "FR"
    }, 
    ... // More countries in the list
    {
        "name": "Latvia",
        "iso": "LV"
    }],
    "success": true
}

Доступные регионы и страны

Запрос регионов выбранной страны. Список включает регионы и города для всех типов прокси (Mobile, Residential, Mixed). Фильтрация по типам недоступна. Обязательно укажите страну. Возвращаются все регионы выбранной страны.

curl -X GET "https://supernovanet.org/api/v1/inventory/targeting?country=US" -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"

Фильтрация городов по ID региона:

curl -X GET "https://supernovanet.org/api/v1/inventory/targeting?country=US&state=4361885" -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"

Успешный ответ на запрос:

{
    "data": {
        "states": [{
                "name": "Maryland",
                "id": 4361885
            },
            ... // More states
            {
                "name": "Illinois",
                "id": 4896861
            }
        ],
        "cities": [{
                "name": "Kissimmee",
                "id": 4160983
            },
            ... // More cities
            {
                "name": "Ellsworth",
                "id": 4963692
            }
        ]
    },
    "success": true
}

Форматы прокси-ссылок

Запрос доступных форматов ссылок (потребуется ID формата для генерации ссылок!)

curl -X GET https://supernovanet.org/api/v1/formats -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"

Успешный ответ на запрос:

{
    "data": [{
        "id": 1,
        "name": "login:pass@host:port",
        "description": "No scheme: login:pass@host:port",
        "format": "{login}:{password}@{host}:{port}"
    }, 
    ... // More formats in the list
    {
        "id": 2,
        "name": "login:pass@ip:port",
        "description": "No scheme: login:pass@ip:port",
        "format": "{login}:{password}@{ip}:{port}"
    }],
    "success": true
}

Активные субаккаунты

Субаккаунт — аналог пользователя в вашей системе. Может быть активным или в архиве. Лимитируется по дате, трафику и сумме расходов. Субаккаунт — основная сущность для отслеживания статистики.

Не используйте один субаккаунт для разных пользователей — у них общий пароль и лимиты!

Запрос списка активных субаккаунтов. Доступны параметры пагинации: p (страница) и l (лимит на страницу). Максимальный лимит: 300.

curl -X GET "https://supernovanet.org/api/v1/subaccounts/active?p=1&l=30" -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"

Успешный ответ на запрос:

{
    "data": {
        "limit": 30,
        "page": 1,
        "total_rows": 1,
        "total_pages": 1,
        "rows": [{
            "port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // Main identificator of your Subaccount
            "name": "My List №1",
            "total_traffic": 0, // In Bytes
            "total_spend": 0, // In Dollars
            "status": 1, // See below 
            "amount_limit": 123, // In Dollars
            "traffic_limit": 1, // In Gigabytes
            "date_limit": "2025-04-20T00:00:00+00:00",
            "last_bytes_at": null,
            "created_at": "2025-04-16T17:35:13.313+00:00"
        }]
    },
    "success": true
}

Статусы субаккаунтов:


WORKING = 0
PAUSED = 1
PAUSED DUE TO SUBACCOUNT LIMITS = 2
PAUSED DUE TO NO FUNDS = 3

Архивные субаккаунты

Субаккаунты можно архивировать. Запрос списка архивных субаккаунтов. Доступны параметры пагинации: p (страница) и l (лимит на страницу). Максимальный лимит: 300.

curl -X GET "https://supernovanet.org/api/v1/subaccounts/archived?p=1&l=30" -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"

Успешный ответ на запрос:

{
    "data": {
        "limit": 30,
        "page": 1,
        "total_rows": 1,
        "total_pages": 1,
        "rows": [{
            "port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // Main identificator of your Subaccount
            "name": "My List №1",
            "total_traffic": 0, 
            "total_spend": 0, 
            "status": 1, // Status automatically set to Paused when you archive your subaccount!
            "amount_limit": 123, 
            "traffic_limit": 1,
            "date_limit": "2025-04-20T00:00:00+00:00",
            "last_bytes_at": null,
            "created_at": "2025-04-10T17:35:13.313+00:00",
            "archived_at":"2025-04-16T18:20:44.024+00:00" // Pay attention to new field in archived
        }]
    },
    "success": true
}

Успешный ответ на запрос:

Создание субаккаунта с лимитами и паролем. Если пароль не указан — он сгенерируется автоматически.

Всегда устанавливайте лимиты при перепродаже!

curl -X POST https://supernovanet.org/api/v1/subaccounts/add \
  -H "Content-Type: application/json" \
  -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000" \
  -d '{
    "name": "Test Subaccount",
    "password": "testpassword123",
    "amount_limit": 100.0,
    "traffic_limit": 1024.0,
    "date_limit": "2025-12-31"
  }'
Описание полей запроса:
{
  "name": "Test Subaccount", // Name of your Subaccount (for your convenience)
  "password": "testpassword123", // Password. Leave it blank and we will generate it by our own
  "amount_limit": 100.0, // Amount in US dollars after this subaccount will be stopped
  "traffic_limit": 1024.0, // Amount in Gigabytes after this subaccount will be stopped
  "date_limit": "2025-12-31" // Date after this subaccount will be stopped (last working date)
}'

Успешный ответ на запрос:

{
  "data": {
    "port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // This identificator will be required to edit port later!
    "password": "testpassword123",
    "name": "Test Subaccount",
    "total_traffic": 0,
    "total_spend": 0,
    "status": 0,
    "amount_limit": 100,
    "traffic_limit": 1024,
    "date_limit": "2025-12-31T00:00:00+00:00",
    "last_bytes_at": null,
    "created_at": "2025-04-01T12:00:00.000+00:00"
  },
  "success": true
}

Редактировать субаккаунт (Список или Порт)

Для редактирования укажите идентификатор порта! Запрос аналогичен созданию, но с добавлением поля 'port'.

Если не указать поле 'port' — будет создан новый субаккаунт!

curl -X POST https://supernovanet.org/api/v1/subaccounts/edit \
  -H "Content-Type: application/json" \
  -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000" \
  -d '{
    "port": "YOUR_SUBACCOUNT_IDENTIFICATOR",
    "name": "Test Subaccount",
    "password": "testpassword123",
    "amount_limit": 100.0,
    "traffic_limit": 1024.0,
    "date_limit": "2025-12-31"
  }'
Описание полей запроса:
{
  "port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // Identificator of your Subaccount. Mandatory field for edit subaccount.
  "name": "Test Subaccount", // Name of your Subaccount (for your convenience)
  "password": "testpassword123", // Password. Leave it blank and we will generate it by our own
  "amount_limit": 100.0, // Amount in US dollars after this subaccount will be stopped
  "traffic_limit": 1024.0, // Amount in Gigabytes after this subaccount will be stopped
  "date_limit": "2025-12-31" // Date after this subaccount will be stopped (last working date)
}'

Успешный ответ на запрос:

{
  "data": {
    "port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // This identificator will be required to edit port later!
    "password": "testpassword123",
    "name": "Test Subaccount",
    "total_traffic": 0,
    "total_spend": 0,
    "status": 0,
    "amount_limit": 100,
    "traffic_limit": 1024,
    "date_limit": "2025-12-31T00:00:00+00:00",
    "last_bytes_at": null,
    "created_at": "2025-04-01T12:00:00.000+00:00"
  },
  "success": true
}

Запуск, остановка, архивация и восстановление

Изменение статуса субаккаунта мгновенно активирует/останавливает работу прокси.

curl -X POST https://supernovanet.org/api/v1/subaccounts/command \
  -H "Content-Type: application/json" \
  -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000" \
  -d '{
    "port": "YOUR_SUBACCOUNT_IDENTIFICATOR",
    "command": "start"
  }'
Описание полей запроса:
{
  "port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // Identificator of your Subaccount. Mandatory field for edit subaccount.
  "command": "start" // Possible values of command: 'archive' 'restore' 'pause' 'start'
}'

Успешный ответ на запрос:

{
  "data": "ok",
  "success": true
}

Генерация прокси-ссылок

Для генерации укажите субаккаунт, тип ссылки, количество (до 10000), тип ротации, страну (обязательно), регион и город (опционально).

Обратите внимание на URL запроса: идентификатор субаккаунта ('port') указывается в URL!

curl -X POST https://supernovanet.org/api/v1/subaccounts/YOUR_SUBACCOUNT_IDENTIFICATOR/generate-links \
  -H "Content-Type: application/json" \
  -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000" \
  -d '{
    "link_type": 7,
    "mob": true,
    "res": true,
    "mix": true,
    "country": "US",
    "city": 123,
    "state": 45,
    "session": "rotate",
    "quantity": 1000
}'
Описание полей запроса:
{
  "link_type": 7, // Mandatory. This ID is from Proxy Link Formats
  "mob": true, // Mandatory. If you need Mobile proxies. Please pay attention that one of mob, res or mix fields must be true!
  "res": true, // Mandatory. If you need Residential proxies. Please pay attention that one of mob, res or mix fields must be true!
  "mix": true, // Mandatory. If you need Mixed proxies. Please pay attention that one of mob, res or mix fields must be true!
  "country": "US", // Mandatory! Country from list of available ones
  "city": 123,  // Optional: city id from Available States/Regions and Countries. Ignored if no that City available.
  "state": 45, // Optional: city id from Available States/Regions and Countries. Ignored if no that State available.
  "session": "rotate", // Mandatory. Possible values: "rotate", "keep"
  "quantity": 1000 // Optional. Links quantity. By default is one. Up to 10000, but specify reasonable amount. 
}'

Успешный ответ на запрос:

{
  "data": [
    "http://YOUR_SUBACCOUNT_IDENTIFICATOR-iso-us-t-mrv-st-r-s-1cdvecqqnu:[email protected]:9090",
    "http://YOUR_SUBACCOUNT_IDENTIFICATOR-iso-us-t-mrv-st-r-s-xboz8dc60t:[email protected]:9090"
  ],
  "success": true
}