- Method v1
- User
- PlanRestream
- MoneyFlow
- UserProject
- Project
- ProjectHistory
- NotifyUser
- Centrifuge
- Stream key
- PlanTranscoding
- PlanStorage
- Channel settings
- Optional settings for vk. Depends on the tariff.
- Optional settings for youtube. Depends on the tariff.
- Optional settings for trovo. Depends on the tariff.
- Optional settings for twitch. Depends on the tariff.
- Optional settings for ok. Depends on the tariff.
- Optional settings for vk video live. Depends on the tariff.
- Set planned id. Depends on the tariff.
- Get playlists from the platform
- Get planned list
- Set name from custom channel. Global settings.
- Set rtmp url from channel. Global settings.
- Set transcoder from channel. Personal settings.
- Get status platform
- Get status platform
- Optional settings for telegram
- Get telegram post by filter
- Get telegram post list
- Get telegram settings
- Set telegram settings
- Get code for connected chat
- Disconnect telegram chat
- Channel
- Transcoders
- Platforms
- Auth
- Socials
- Transactions
- BlogPage
- HelpPage
- NotifyHistory
- ProjectChannelInvite
- List of invites for channel in project
- Get invitation for channel
- Accept channel invitation for selected project
- Decline channel invitation for selected project
- Get channel invitation using a secret link
- Accept channel invitation using a secret link
- Decline channel invitation using a secret link
- Get channel invite item for my channel for another user
- Add channel invite item for another user by id
- Add channel invite item for another user by email
- Del channel invite item for my channel for another user
- ProjectChannel
- BlogPageTag
- RtmpServer
- Pay system
- Payment
- Pay setting
- Stream pull keys
- Payout
- Chat gateway
- Broadcast
- Release
- Live
- Analytics
- Promo
- PolicyPage
- Referrals
- Pull servers
Search channel list
GET
/method/channel/search
Channel
Request
Authorization
Add the parameter
Authorization
to Headers,whose value is to concatenate the Token after the oauth.Example:
Authorization: oauth ********************
Query Params
v
enum<string>Â
required
Allowed values:
123
Example:
3
language
enum<string>Â
required
Allowed values:
ruencn
Default:
en
Example:
en
project_id
numberÂ
required
type
enum<string>Â
optional
Allowed values:
allmyavailableactive
Example:
all
platform
stringÂ
optional
<= 255 characters
Example:
youtube,vk,twitch
Match pattern:
/^(?!,)[a-z]+(,[a-z]+)*(?!,)$/
name
stringÂ
optional
<= 10 characters
Example:
name
limit
numberÂ
optional
>= 1<= 100
Default:
30
offset
numberÂ
optional
>= 0
Default:
0
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-v2.streamvi.io/method/channel/search?v&language&project_id'
Responses
🟢200OK
application/json
Body
results
array[object (SiteSearchChannelItem) {23}]Â
required
name
stringÂ
required
id
stringÂ
required
transcoderId
numberÂ
optional
group_id
numberÂ
required
type
stringÂ
required
photo_default
stringÂ
required
sell
booleanÂ
required
price
numberÂ
required
live
booleanÂ
required
status
enum<string>Â
required
Allowed values:
initpendingerrorliveofflinebusy
Example:
offline
user_id
numberÂ
required
active
booleanÂ
required
guestsNum
numberÂ
required
guestRights
number  | nullÂ
required
usageType
numberÂ
required
companyRole
number  | nullÂ
required
threads
numberÂ
required
streamInfo
required
rtmp
null  | allOf {1}Â
required
credentials
array[object (SiteSearchChannelCredentialsDto) {6}]  | nullÂ
required
tokens
objectÂ
required
live_users
array[object (SiteSearchChannelLiveUserDto) {5}]Â
optional
platform
objectÂ
required
platforms
array[object (SiteSearchChannelPlatformsDto) {4}]Â
required
id
numberÂ
required
type
stringÂ
required
title
stringÂ
required
edit_name
numberÂ
required
limit
numberÂ
required
offset
numberÂ
required
total
numberÂ
required
Example
{
"results": [
{
"name": "string",
"id": "string",
"transcoderId": 0,
"group_id": 0,
"type": "string",
"photo_default": "string",
"sell": true,
"price": 0,
"live": true,
"status": "init",
"user_id": 0,
"active": true,
"guestsNum": 0,
"guestRights": 0,
"usageType": 0,
"companyRole": 0,
"threads": 0,
"streamInfo": {
"title": "string",
"description": "string",
"lang": "ru",
"tags": [
"string"
],
"category": {
"id": "string",
"name": "string"
},
"playlist": {
"id": "string"
},
"privacyVideo": "private",
"latency": "normal",
"audience": "mark_for_kids",
"image": "string"
},
"rtmp": {
"name": "string",
"path": "string",
"port": 0,
"query": "string",
"domain": "string",
"protocol": "string"
},
"credentials": [
{
"cid": 0,
"id": "string",
"status": 0,
"role": 0,
"personal": true,
"update": true
}
],
"tokens": {
"account": {
"status": "unused"
},
"group": {
"status": "unused"
}
},
"live_users": [
{
"restreamId": 0,
"userId": 0,
"video": "string",
"name": "string",
"photo": "string"
}
],
"platform": {
"title": "Youtube",
"type": "youtube",
"url": "https://vk.com",
"extension": "png",
"edit_name": 0
}
}
],
"platforms": [
{
"id": 0,
"type": "string",
"title": "string",
"edit_name": 0
}
],
"limit": 0,
"offset": 0,
"total": 0
}
🟠400Bad Request
Modified at 2025-05-05 15:10:46