Аутентификация

Все запросы к API требуют аутентификации с помощью API-ключа. Ваш ключ можно найти в разделе Профиль.

Способы передачи ключа

  • Query-параметр: ?key=YOUR_API_KEY
  • Тело запроса (POST): key=YOUR_API_KEY
  • Cookie: key=YOUR_API_KEY
! Никогда не делитесь своим API-ключом. Если ключ был скомпрометирован, сгенерируйте новый в профиле.

Пример запроса

GET /api/getOrders?key=YOUR_API_KEY

POST /perfectPanel
Content-Type: application/json

{
  "key": "YOUR_API_KEY",
  "action": "services"
}

PerfectPanel API

Совместимый со стандартом PerfectPanel API. Все запросы выполняются через один эндпоинт методом POST.

HTTP-методPOST
URL APIhttps://streamrise.ru/perfectPanel
Формат ответаJSON
POSThttps://streamrise.ru/perfectPanel

Получение списка доступных услуг с ценами.

ПараметрТипОписание
key*stringВаш API-ключ
action*string"services"
! Список услуг и цены зависят от вашего аккаунта и скидки.

Пример ответа

Пример запроса

POST https://streamrise.ru/perfectPanel
Content-Type: application/json

{
  "key": "YOUR_API_KEY",
  "action": "services"
}

Пример ответа

[
  {
    "service": 1,
    "name": "Twitch Viewers",
    "type": "Default",
    "category": "Twitch",
    "rate": "0.90",
    "min": "10",
    "max": "10000",
    "cancel": true
  },
  {
    "service": 2,
    "name": "Twitch Chatbots",
    "type": "Custom Comments",
    "category": "Twitch",
    "rate": "8.00",
    "min": "10",
    "max": "1500",
    "cancel": false
  }
]
POSThttps://streamrise.ru/perfectPanel

Получение текущего баланса аккаунта.

ПараметрТипОписание
key*stringВаш API-ключ
action*string"balance"

Пример ответа

Пример запроса

POST https://streamrise.ru/perfectPanel
Content-Type: application/json

{
  "key": "YOUR_API_KEY",
  "action": "balance"
}

Пример ответа

{
  "balance": "100.84",
  "currency": "USD"
}
POSThttps://streamrise.ru/perfectPanel

Проверка статуса одного или нескольких заказов.

ПараметрТипОписание
key*stringВаш API-ключ
action*string"status"
order*stringID заказа

Пример ответа

Пример запроса

POST https://streamrise.ru/perfectPanel
Content-Type: application/json

{
  "key": "YOUR_API_KEY",
  "action": "status",
  "order": 12345
}

Пример ответа

{
  "charge": "0.27",
  "start_count": "3572",
  "status": "In progress",
  "remains": "157",
  "currency": "USD"
}

Пример ошибки

{
  "error": "Incorrect order ID"
}
POSThttps://streamrise.ru/perfectPanel

Проверка статуса нескольких заказов одновременно (до 100 ID через запятую).

ПараметрТипОписание
key*stringВаш API-ключ
action*string"status"
orders*stringID заказов (через запятую, до 100)

Пример ответа

Пример запроса

POST https://streamrise.ru/perfectPanel
Content-Type: application/json

{
  "key": "YOUR_API_KEY",
  "action": "status",
  "orders": "12345,12346,99999"
}

Пример ответа

{
  "12345": {
    "charge": "0.27",
    "start_count": "3572",
    "status": "Partial",
    "remains": "157",
    "currency": "USD"
  },
  "12346": {
    "charge": "1.44",
    "start_count": "234",
    "status": "In progress",
    "remains": "10",
    "currency": "USD"
  },
  "99999": {
    "error": "Incorrect order ID"
  }
}
POSThttps://streamrise.ru/perfectPanel

Создание нового заказа на выбранную услугу.

ПараметрТипОписание
key*stringВаш API-ключ
action*string"add"
service*stringID услуги
link*stringСсылка на канал/страницу
quantity*stringНеобходимое количество
intervalstringИнтервал в минутах Необязательный
runsstringКоличество запусков Необязательный
commentsstringСписок комментариев (разделённых \n) Необязательный
periodAmountstringПериод (количество) Необязательный

Пример ответа

Пример запроса

POST https://streamrise.ru/perfectPanel
Content-Type: application/json

{
  "key": "YOUR_API_KEY",
  "action": "add",
  "service": 1,
  "link": "https://twitch.tv/username",
  "quantity": 100
}

Пример ответа

{
  "order": 23501
}
POSThttps://streamrise.ru/perfectPanel

Отмена активных заказов.

ПараметрТипОписание
key*stringВаш API-ключ
action*string"cancel"
orders*stringID заказов (через запятую, до 100)
! Отмена доступна только для услуг, поддерживающих эту функцию.

Пример ответа

Пример запроса

POST https://streamrise.ru/perfectPanel
Content-Type: application/json

{
  "key": "YOUR_API_KEY",
  "action": "cancel",
  "orders": "23501,23502"
}

Пример ответа

[
  {
    "order": 23501,
    "cancel": 1
  },
  {
    "order": 23502,
    "cancel": {
      "error": "Incorrect order ID"
    }
  }
]

Нативный API

Нативный API предоставляет расширенный набор операций с заказами. Все эндпоинты требуют аутентификации.

GEThttps://streamrise.ru/api/getFamilyServices

Получение списка семейств услуг (верхнеуровневые категории: twitch, kick и т.д.).

ПараметрТипОписание
keystringВаш API-ключ Необязательный

Пример ответа

Пример запроса

GET https://streamrise.ru/api/getFamilyServices

Пример ответа

[
  { "service": "twitch", "order": 1 },
  { "service": "kick", "order": 2 },
  { "service": "youtube", "order": 3 },
  { "service": "tiktok", "order": 4 }
]
GEThttps://streamrise.ru/api/getServices

Полный каталог услуг с конфигурацией. Возвращает ключи услуг (например twitchViewersPeriod), их семейства, типы и доступные параметры. Без ключа — публичные данные, с ключом — персонализированные.

ПараметрТипОписание
keystringВаш API-ключ Необязательный

Пример ответа

Пример запроса

GET https://streamrise.ru/api/getServices?key=YOUR_API_KEY

Пример ответа

{
  "services": {
    "twitch": {
      "twitchViewers": {
        "service": "twitchViewers",
        "serviceFamily": "twitch",
        "serviceType": "viewers",
        "enabled": true,
        "fieldsData": { ... }
      },
      "twitchViewersPeriod": {
        "service": "twitchViewersPeriod",
        "serviceFamily": "twitch",
        "serviceType": "viewers",
        "enabled": true,
        "fieldsData": { ... }
      },
      "twitchChatBots": {
        "service": "twitchChatBots",
        "serviceFamily": "twitch",
        "serviceType": "chatbots",
        "enabled": true,
        "fieldsData": { ... }
      }
    },
    "kick": { ... }
  },
  "types": { ... }
}

Доступные услуги

Интерактивная таблица ваших доступных услуг. Нажмите на семейство чтобы раскрыть список.

Загрузка...
GEThttps://streamrise.ru/api/getPrices

Таблица цен для всех или конкретной услуги. Цены зависят от вашего аккаунта и скидки.

ПараметрТипОписание
keystringВаш API-ключ Необязательный
servicestringФильтр по ключу услуги (необязательный) Необязательный
! Список услуг и цены зависят от вашего аккаунта и скидки.

Пример ответа

Пример запроса

GET https://streamrise.ru/api/getPrices?key=YOUR_API_KEY&service=twitchViewers

Пример ответа

{
  "twitchViewers": {
    "1": {
      "10": 0.90,
      "50": 4.20,
      "100": 7.80
    }
  }
}
GEThttps://streamrise.ru/api/availableToSend

Какие параметры возвращаются при чтении заказов (whitelist полей).

ПараметрТипОписание
key*stringВаш API-ключ

Пример ответа

Пример запроса

GET https://streamrise.ru/api/availableToSend?key=YOUR_API_KEY

Пример ответа

{
  "twitchViewers": ["channel", "amount", "interval"],
  "twitchChatBots": ["channel", "amount", "comments"],
  "types": {
    "viewers": ["channel", "amount"],
    "chatbots": ["channel", "amount", "comments"]
  }
}
GEThttps://streamrise.ru/api/availableToChange

Какие параметры можно изменить у существующего заказа.

ПараметрТипОписание
key*stringВаш API-ключ

Пример ответа

Пример запроса

GET https://streamrise.ru/api/availableToChange?key=YOUR_API_KEY

Пример ответа

{
  "twitchViewers": ["channel", "amount"],
  "twitchChatBots": ["channel", "comments"],
  "types": {
    "viewers": ["channel", "amount"],
    "chatbots": ["channel", "comments"]
  }
}
GEThttps://streamrise.ru/api/availableToUpgrade

Какие параметры можно изменить при апгрейде заказа.

ПараметрТипОписание
key*stringВаш API-ключ

Пример ответа

Пример запроса

GET https://streamrise.ru/api/availableToUpgrade?key=YOUR_API_KEY

Пример ответа

{
  "twitchViewers": ["amount"],
  "twitchViewersPeriod": ["amount", "period"],
  "types": {
    "viewers": ["amount"]
  }
}
GEThttps://streamrise.ru/api/newOrder

Создание нового заказа.

ПараметрТипОписание
key*stringВаш API-ключ
service*stringID услуги
channel*stringКанал (ссылка или имя)
amount*stringКоличество
periodstringПериод подписки Необязательный
periodAmountstringПериод (количество) Необязательный
intervalstringИнтервал в минутах Необязательный
commentsstringСписок комментариев (разделённых \n) Необязательный

Пример ответа

Пример запроса

GET https://streamrise.ru/api/newOrder?key=YOUR_API_KEY&service=twitchViewers&channel=username&amount=100

Пример ответа

{
  "orderId": 12345,
  "order": {
    "id": 12345,
    "service": "twitchViewers",
    "channel": "username",
    "amount": 100,
    "status": "active"
  }
}

Пример ошибки

{
  "error": {
    "channel": "channelEmpty"
  }
}
GEThttps://streamrise.ru/api/getOrders

Получение списка активных заказов.

ПараметрТипОписание
key*stringВаш API-ключ
idsstringID заказов (через запятую) Необязательный

Пример ответа

Пример запроса

GET https://streamrise.ru/api/getOrders?key=YOUR_API_KEY

Пример ответа

{
  "12345": {
    "id": 12345,
    "service": "twitchViewers",
    "channel": "username",
    "amount": 100,
    "pause": false
  },
  "12346": {
    "id": 12346,
    "service": "twitchChatBots",
    "channel": "username2",
    "amount": 50,
    "pause": true
  }
}
GEThttps://streamrise.ru/api/getOrdersPage

Получение заказов с постраничной навигацией, сортировкой и поиском.

ПараметрТипОписание
key*stringВаш API-ключ
startnumberСмещение (начало, для пагинации) Необязательный
endnumberСмещение (конец, для пагинации) Необязательный
totalbooleanЗапросить общее количество Необязательный
sortKeystringПоле сортировки Необязательный
sortDirectionstringНаправление сортировки (asc/desc) Необязательный
searchValuestringПоисковый запрос Необязательный
serviceTypestringТип услуги Необязательный
idsstringID заказов (через запятую) Необязательный

Пример ответа

Пример запроса

GET https://streamrise.ru/api/getOrdersPage?key=YOUR_API_KEY&start=0&end=15&total=true&sortKey=orderTime&sortDirection=desc

Пример ответа

{
  "history": [
    {
      "id": 12345,
      "service": "twitchViewers",
      "channel": "username",
      "amount": 100,
      "orderTime": 1711500000000,
      "pause": false
    }
  ],
  "total": "42"
}
GEThttps://streamrise.ru/api/pauseOrder

Приостановка активного заказа.

ПараметрТипОписание
key*stringВаш API-ключ
id*stringID заказа

Пример ответа

Пример запроса

GET https://streamrise.ru/api/pauseOrder?key=YOUR_API_KEY&id=12345

Пример ответа

200 OK
GEThttps://streamrise.ru/api/resumeOrder

Возобновление приостановленного заказа.

ПараметрТипОписание
key*stringВаш API-ключ
id*stringID заказа

Пример ответа

Пример запроса

GET https://streamrise.ru/api/resumeOrder?key=YOUR_API_KEY&id=12345

Пример ответа

200 OK
GEThttps://streamrise.ru/api/deleteOrder

Удаление заказа с возвратом неиспользованных средств.

ПараметрТипОписание
key*stringВаш API-ключ
id*stringID заказа

Пример ответа

Пример запроса

GET https://streamrise.ru/api/deleteOrder?key=YOUR_API_KEY&id=12345

Пример ответа

200 OK
POSThttps://streamrise.ru/api/calculateUpgradePrice

Расчёт стоимости изменения параметров заказа перед применением.

ПараметрТипОписание
key*stringВаш API-ключ
id*stringID заказа
order*objectИзменение параметров существующего заказа (количество, период и т.д.).

Пример ответа

Пример запроса

POST https://streamrise.ru/api/calculateUpgradePrice?key=YOUR_API_KEY
Content-Type: application/json

{
  "id": 12345,
  "order": {
    "amount": 200
  }
}

Пример ответа

{
  "price": 5.50,
  "totalDiscount": 0.55
}
POSThttps://streamrise.ru/api/upgradeOrder

Изменение параметров существующего заказа (количество, период и т.д.).

ПараметрТипОписание
key*stringВаш API-ключ
id*stringID заказа
order*objectИзменение параметров существующего заказа (количество, период и т.д.).

Пример ответа

Пример запроса

POST https://streamrise.ru/api/upgradeOrder?key=YOUR_API_KEY
Content-Type: application/json

{
  "id": 12345,
  "order": {
    "amount": 200
  }
}

Пример ответа

200 OK
POSThttps://streamrise.ru/api/changeOrder

Изменение параметров заказа (канал, настройки чата и т.д.).

ПараметрТипОписание
key*stringВаш API-ключ
id*stringID заказа
order*objectИзменение параметров заказа (канал, настройки чата и т.д.).

Пример ответа

Пример запроса

POST https://streamrise.ru/api/changeOrder?key=YOUR_API_KEY
Content-Type: application/json

{
  "id": 12345,
  "order": {
    "channel": "new_channel_name"
  }
}

Пример ответа

200 OK

Пример ошибки

{
  "error": {
    "channel": "Invalid channel name"
  }
}
GEThttps://streamrise.ru/api/getParamsLimits

Получение допустимых диапазонов значений параметров для услуг.

ПараметрТипОписание
key*stringВаш API-ключ
servicestringID услуги Необязательный

Пример ответа

Пример запроса

GET https://streamrise.ru/api/getParamsLimits?key=YOUR_API_KEY&service=twitchViewers

Пример ответа

{
  "amount": {
    "min": 10,
    "max": 10000
  },
  "interval": {
    "min": 1,
    "max": 60
  }
}
GEThttps://streamrise.ru/api/validateOrderProperty

Проверка значения конкретного параметра заказа перед созданием.

ПараметрТипОписание
service*stringID услуги
field*stringНазвание поля
value*stringЗначение для проверки

Пример ответа

Пример запроса

GET https://streamrise.ru/api/validateOrderProperty?service=twitchViewers&field=channel&value=username

Пример ответа (OK)

200 OK

Пример ошибки

{
  "error": {
    "channel": "Channel not found"
  }
}