StreamVi
HomeDocumentation
HomeDocumentation
  1. Channel
  • Method v1
    • User
      • Get user profile
      • Update profile
      • SiteUserController_testCode[1]
      • SiteUserController_testCodeException[1]
    • PlanRestream
      • Get tariff for project
      • Remove after tariff
      • Buy restream tariff
      • Get list of restream tariffs
      • Get list of restream tariffs for project
      • Get discount restream
      • Load data for show card the tariffs v2
    • MoneyFlow
      • Transaction list for frontend
    • UserProject
      • Select user for project
      • Get project by number id
      • Get user by number id
      • List of user in project
      • Remove user from project
      • Change access user from project
      • List of project for current user
      • Get project full info
    • Project
      • Get live status
    • ProjectHistory
      • Get project history of actions
    • NotifyUser
      • Delete mobile token from user
      • Get user notify settings
      • Set user notify settings
      • Get user screen notify
      • Remove user screen notify
    • Centrifuge
      • Auth centrifuge
      • Auth token for project
      • Auth token for broadcast
    • Stream key
      • Get stream credentials
      • Update record
    • PlanTranscoding
      • Get tariff for project
      • Remove after tariff
      • Buy transcoder tariff
      • Get list of transcoding tariffs
      • Get discount transcoding
      • Check transcoding tariff before buy
    • PlanStorage
      • Get tariff for project
      • Remove next tariff
      • Buy storage tariff
      • Get info for storage tariff
      • Get discount of storage
      • Check storage tariff before buy
    • 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
      • Search channel list
        GET
      • Minimal channel list
        GET
      • Get live status
        POST
    • Transcoders
      • List of transcoder
      • Transcoder create
      • Transcoder update
      • Transcoder delete
      • Transcoder stop
    • Platforms
      • Get url for start oauth
      • Get category from the platform
      • Get category from the platform
      • Supported platforms
    • Auth
      • Connect telegram in account
      • Auth telegram
      • Get basic data for auth user
      • Get url for start oauth
      • Connected social account
      • Update access token
      • Internal request of auth
      • Internal request of auth
      • Guest request of auth
      • Disconnected social account
      • Logout
      • CallBack for connect social
      • Get code for auth
      • Code exchange
    • Socials
      • Social list for user
    • Transactions
      • Transaction list for frontend
    • BlogPage
      • Get list of blog pages
      • Get blog page
    • HelpPage
      • Get list of help pages
      • Get help page
      • Get structure of help pages
    • NotifyHistory
      • Get my NotifyHistory item by id
      • Get list of my notifications
      • Get my status unread message for user
      • Set all notification in cabinet as read
      • Run action in my notify item
      • Set notification in cabinet as read
    • 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
      • Project channel list
      • Remove access for project in channel
      • Change access for project in channel
      • Transfer owner for project in channel
    • BlogPageTag
      • Get list of blog pages
    • RtmpServer
      • Rtmp locations server list example for unauthorized
      • List rtmp servers
      • State of rtmp servers
      • State of rtmp servers
      • Graph of rtmp servers
    • Pay system
      • Load available pay systems
      • PaySystemController_createChallenge[1]
      • PaySystemController_createUnitpay[1]
    • Payment
      • Create payment item for pay system
      • PaymentController_getStatus[1]
      • PaymentController_list[1]
    • Pay setting
      • Get pay settings for profile v3
      • Set pay settings for profile
      • Check country after update user
    • Stream pull keys
      • Check key
      • List keys
      • Create key
      • Update key
      • Delete key
    • Payout
      • Create payout
      • Get payout data for create
    • Chat gateway
      • List history message
      • Send message
      • Get one message
      • Remove message
    • Broadcast
      • Connect channel, long polling
      • Get restreams
    • Release
      • Get current version app
    • Live
      • View live info
    • Analytics
      • Bitrate for stream
      • Viewers for stream
      • Events for stream
    • Promo
      • Check code
      • Apply code
    • PolicyPage
      • Get policy page
    • Referrals
      • Total info
    • Pull servers
      • Get pull servers
  1. Channel

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
Version
Allowed values:
123
Example:
3
language
enum<string> 
required
Current language
Allowed values:
ruencn
Default:
en
Example:
en
project_id
number 
required
Project id
type
enum<string> 
optional
Allowed values:
allmyavailableactive
Example:
all
platform
string 
optional
platform type
<= 255 characters
Example:
youtube,vk,twitch
Match pattern:
/^(?!,)[a-z]+(,[a-z]+)*(?!,)$/
name
string 
optional
name
<= 10 characters
Example:
name
limit
number 
optional
Number of results
>= 1<= 100
Default:
30
offset
number 
optional
Page offset number
>= 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
Array of items
name
string 
required
name
id
string 
required
name
transcoderId
number 
optional
Transcoder id
group_id
number 
required
group_id
type
string 
required
type
photo_default
string 
required
photo_default
sell
boolean 
required
sell
price
number 
required
price
live
boolean 
required
live
status
enum<string> 
required
status
Allowed values:
initpendingerrorliveofflinebusy
Example:
offline
user_id
number 
required
user_id
active
boolean 
required
active
guestsNum
number 
required
guestsNum
guestRights
number  | null 
required
guestRights
usageType
number 
required
usageType
companyRole
number  | null 
required
companyRole
threads
number 
required
threads
streamInfo
required
streamInfo
rtmp
null  | allOf {1} 
required
rtmp
credentials
array[object (SiteSearchChannelCredentialsDto) {6}]  | null 
required
credentials
tokens
object 
required
Tokens
live_users
array[object (SiteSearchChannelLiveUserDto) {5}] 
optional
live_users
platform
object 
required
Platform
platforms
array[object (SiteSearchChannelPlatformsDto) {4}] 
required
id
number 
required
Id
type
string 
required
Type
title
string 
required
Title
edit_name
number 
required
Is edit name
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
Previous
Disconnect telegram chat
Next
Minimal channel list
Built with