Authentication

All API requests require authentication using an API key. Your key can be found in the Profile section.

Authentication methods

  • Query parameter: ?key=YOUR_API_KEY
  • Request body (POST): key=YOUR_API_KEY
  • Cookie: key=YOUR_API_KEY
! Never share your API key. If your key has been compromised, generate a new one in your profile.

Request example

GET /api/getOrders?key=YOUR_API_KEY

POST /perfectPanel
Content-Type: application/json

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

PerfectPanel API

Compatible with the PerfectPanel API standard. All requests are made via a single POST endpoint.

HTTP MethodPOST
API URLhttps://stream-rise.com/perfectPanel
Response formatJSON
POSThttps://stream-rise.com/perfectPanel

Get a list of available services with pricing.

ParameterTypeDescription
key*stringYour API key
action*string"services"
! Service list and pricing depend on your account and discount level.

Response example

Request example

POST https://stream-rise.com/perfectPanel
Content-Type: application/json

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

Response example

[
  {
    "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://stream-rise.com/perfectPanel

Get current account balance.

ParameterTypeDescription
key*stringYour API key
action*string"balance"

Response example

Request example

POST https://stream-rise.com/perfectPanel
Content-Type: application/json

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

Response example

{
  "balance": "100.84",
  "currency": "USD"
}
POSThttps://stream-rise.com/perfectPanel

Check the status of a single order.

ParameterTypeDescription
key*stringYour API key
action*string"status"
order*stringOrder ID

Response example

Request example

POST https://stream-rise.com/perfectPanel
Content-Type: application/json

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

Response example

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

Error example

{
  "error": "Incorrect order ID"
}
POSThttps://stream-rise.com/perfectPanel

Check the status of multiple orders at once (up to 100 IDs, comma-separated).

ParameterTypeDescription
key*stringYour API key
action*string"status"
orders*stringOrder IDs (comma-separated, up to 100)

Response example

Request example

POST https://stream-rise.com/perfectPanel
Content-Type: application/json

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

Response example

{
  "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://stream-rise.com/perfectPanel

Create a new order for a selected service.

ParameterTypeDescription
key*stringYour API key
action*string"add"
service*stringService ID
link*stringLink to channel/page
quantity*stringDesired quantity
intervalstringInterval in minutes Optional
runsstringNumber of runs Optional
commentsstringComments list (separated by \n) Optional
periodAmountstringPeriod amount Optional

Response example

Request example

POST https://stream-rise.com/perfectPanel
Content-Type: application/json

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

Response example

{
  "order": 23501
}
POSThttps://stream-rise.com/perfectPanel

Cancel active orders.

ParameterTypeDescription
key*stringYour API key
action*string"cancel"
orders*stringOrder IDs (comma-separated, up to 100)
! Cancellation is only available for services that support this feature.

Response example

Request example

POST https://stream-rise.com/perfectPanel
Content-Type: application/json

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

Response example

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

Native API

The native API provides an extended set of order operations. All endpoints require authentication.

GEThttps://stream-rise.com/api/getFamilyServices

Get the list of service families (top-level categories: twitch, kick, etc.).

ParameterTypeDescription
keystringYour API key Optional

Response example

Request example

GET https://stream-rise.com/api/getFamilyServices

Response example

[
  { "service": "twitch", "order": 1 },
  { "service": "kick", "order": 2 },
  { "service": "youtube", "order": 3 },
  { "service": "tiktok", "order": 4 }
]
GEThttps://stream-rise.com/api/getServices

Full service catalog with configuration. Returns service keys (e.g. twitchViewersPeriod), families, types, and available parameters. Without a key -- public data; with a key -- personalized.

ParameterTypeDescription
keystringYour API key Optional

Response example

Request example

GET https://stream-rise.com/api/getServices?key=YOUR_API_KEY

Response example

{
  "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": { ... }
}

Available Services

Interactive table of your available services. Click a family to expand the list.

Loading...
GEThttps://stream-rise.com/api/getPrices

Pricing table for all or a specific service. Prices depend on your account and discount level.

ParameterTypeDescription
keystringYour API key Optional
servicestringFilter by service key (optional) Optional
! Service list and pricing depend on your account and discount level.

Response example

Request example

GET https://stream-rise.com/api/getPrices?key=YOUR_API_KEY&service=twitchViewers

Response example

{
  "twitchViewers": {
    "1": {
      "10": 0.90,
      "50": 4.20,
      "100": 7.80
    }
  }
}
GEThttps://stream-rise.com/api/availableToSend

Which parameters are returned when reading orders (field whitelist).

ParameterTypeDescription
key*stringYour API key

Response example

Request example

GET https://stream-rise.com/api/availableToSend?key=YOUR_API_KEY

Response example

{
  "twitchViewers": ["channel", "amount", "interval"],
  "twitchChatBots": ["channel", "amount", "comments"],
  "types": {
    "viewers": ["channel", "amount"],
    "chatbots": ["channel", "amount", "comments"]
  }
}
GEThttps://stream-rise.com/api/availableToChange

Which parameters can be changed on an existing order.

ParameterTypeDescription
key*stringYour API key

Response example

Request example

GET https://stream-rise.com/api/availableToChange?key=YOUR_API_KEY

Response example

{
  "twitchViewers": ["channel", "amount"],
  "twitchChatBots": ["channel", "comments"],
  "types": {
    "viewers": ["channel", "amount"],
    "chatbots": ["channel", "comments"]
  }
}
GEThttps://stream-rise.com/api/availableToUpgrade

Which parameters can be changed when upgrading an order.

ParameterTypeDescription
key*stringYour API key

Response example

Request example

GET https://stream-rise.com/api/availableToUpgrade?key=YOUR_API_KEY

Response example

{
  "twitchViewers": ["amount"],
  "twitchViewersPeriod": ["amount", "period"],
  "types": {
    "viewers": ["amount"]
  }
}
GEThttps://stream-rise.com/api/newOrder

Create a new order.

ParameterTypeDescription
key*stringYour API key
service*stringService ID
channel*stringChannel (link or name)
amount*stringQuantity
periodstringSubscription period Optional
periodAmountstringPeriod amount Optional
intervalstringInterval in minutes Optional
commentsstringComments list (separated by \n) Optional

Response example

Request example

GET https://stream-rise.com/api/newOrder?key=YOUR_API_KEY&service=twitchViewers&channel=username&amount=100

Response example

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

Error example

{
  "error": {
    "channel": "channelEmpty"
  }
}
GEThttps://stream-rise.com/api/getOrders

Get a list of active orders.

ParameterTypeDescription
key*stringYour API key
idsstringOrder IDs (comma-separated) Optional

Response example

Request example

GET https://stream-rise.com/api/getOrders?key=YOUR_API_KEY

Response example

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

Get orders with pagination, sorting, and search.

ParameterTypeDescription
key*stringYour API key
startnumberOffset (start, for pagination) Optional
endnumberOffset (end, for pagination) Optional
totalbooleanRequest total count Optional
sortKeystringSort field Optional
sortDirectionstringSort direction (asc/desc) Optional
searchValuestringSearch query Optional
serviceTypestringService type Optional
idsstringOrder IDs (comma-separated) Optional

Response example

Request example

GET https://stream-rise.com/api/getOrdersPage?key=YOUR_API_KEY&start=0&end=15&total=true&sortKey=orderTime&sortDirection=desc

Response example

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

Pause an active order.

ParameterTypeDescription
key*stringYour API key
id*stringOrder ID

Response example

Request example

GET https://stream-rise.com/api/pauseOrder?key=YOUR_API_KEY&id=12345

Response example

200 OK
GEThttps://stream-rise.com/api/resumeOrder

Resume a paused order.

ParameterTypeDescription
key*stringYour API key
id*stringOrder ID

Response example

Request example

GET https://stream-rise.com/api/resumeOrder?key=YOUR_API_KEY&id=12345

Response example

200 OK
GEThttps://stream-rise.com/api/deleteOrder

Delete an order with refund of unused funds.

ParameterTypeDescription
key*stringYour API key
id*stringOrder ID

Response example

Request example

GET https://stream-rise.com/api/deleteOrder?key=YOUR_API_KEY&id=12345

Response example

200 OK
POSThttps://stream-rise.com/api/calculateUpgradePrice

Calculate the cost of changing order parameters before applying.

ParameterTypeDescription
key*stringYour API key
id*stringOrder ID
order*objectChange parameters of an existing order (quantity, period, etc.).

Response example

Request example

POST https://stream-rise.com/api/calculateUpgradePrice?key=YOUR_API_KEY
Content-Type: application/json

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

Response example

{
  "price": 5.50,
  "totalDiscount": 0.55
}
POSThttps://stream-rise.com/api/upgradeOrder

Change parameters of an existing order (quantity, period, etc.).

ParameterTypeDescription
key*stringYour API key
id*stringOrder ID
order*objectChange parameters of an existing order (quantity, period, etc.).

Response example

Request example

POST https://stream-rise.com/api/upgradeOrder?key=YOUR_API_KEY
Content-Type: application/json

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

Response example

200 OK
POSThttps://stream-rise.com/api/changeOrder

Change order parameters (channel, chat settings, etc.).

ParameterTypeDescription
key*stringYour API key
id*stringOrder ID
order*objectChange order parameters (channel, chat settings, etc.).

Response example

Request example

POST https://stream-rise.com/api/changeOrder?key=YOUR_API_KEY
Content-Type: application/json

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

Response example

200 OK

Error example

{
  "error": {
    "channel": "Invalid channel name"
  }
}
GEThttps://stream-rise.com/api/getParamsLimits

Get allowed value ranges for service parameters.

ParameterTypeDescription
key*stringYour API key
servicestringService ID Optional

Response example

Request example

GET https://stream-rise.com/api/getParamsLimits?key=YOUR_API_KEY&service=twitchViewers

Response example

{
  "amount": {
    "min": 10,
    "max": 10000
  },
  "interval": {
    "min": 1,
    "max": 60
  }
}
GEThttps://stream-rise.com/api/validateOrderProperty

Validate a specific order parameter value before creating an order.

ParameterTypeDescription
service*stringService ID
field*stringField name
value*stringValue to validate

Response example

Request example

GET https://stream-rise.com/api/validateOrderProperty?service=twitchViewers&field=channel&value=username

Response example (OK)

200 OK

Error example

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