Search channels - PeerTube

{ "data": [ { "description": "Videos made with <3 by Framasoft", "displayName": "Videos of Framasoft", "id": 42, "isLocal": true, "ownerAccount": { "id": 0, "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d" }, "support": "Please support our work on https://soutenir.framasoft.org/en/ <3", "updatedAt": "2019-08-24T14:15:22Z", "avatar": { "createdAt": "2019-08-24T14:15:22Z", "path": "string", "updatedAt": "2019-08-24T14:15:22Z" }, "createdAt": "2019-08-24T14:15:22Z", "followersCount": 0, "followingCount": 0, "host": "example.com", "hostRedundancyAllowed": true, "name": "chocobozzz", "url": "string" } ], "total": 1 }

Request

Query Params

string

required

String to search. If the user can make a remote URI search, and the string is an URI then the PeerTube instance will fetch the remote object and add it to its database. Then, you can use the REST API to fetch the complete channel information and interact with it.

start

integer

optional

Offset used to paginate results

count

integer

optional

Number of items to return

searchTarget

string

optional

If the administrator enabled search index support, you can override the default search target.

Warning: If you choose to make an index search, PeerTube will get results from a third party service. It means the instance may not yet know the objects you fetched. If you want to load video/channel information:

If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
After that, you can use the classic REST API endpoints to fetch the complete object or interact with it

If the current user doesn't have the ability to make a remote URI search, then redirect the user on the origin instance or fetch
the data from the origin instance API

sort

string

optional

Sort column

Responses

🟢200successful operation

application/json

Body

data

array[object (Actor) {15}]

optional

description

string

optional

>= 3 characters<= 1000 characters

Example:

Videos made with <3 by Framasoft

displayName

string

optional

editable name of the channel, displayed in its representations

>= 1 characters<= 120 characters

Example:

Videos of Framasoft

integer

read-onlyoptional

>= 1

Example:

isLocal

boolean

read-onlyoptional

ownerAccount

object | null

read-onlyoptional

support

string

optional

text shown by default on all videos of this channel, to tell the audience how to support it

>= 3 characters<= 1000 characters

Example:

Please support our work on https://soutenir.framasoft.org/en/ <3

updatedAt

string <date-time>

read-onlyoptional

avatar

object

ActorImage

optional

createdAt

string <date-time>

optional

followersCount

integer

optional

number of followers of this actor, as seen by this instance

>= 0

followingCount

integer

optional

number of actors subscribed to by this actor, as seen by this instance

>= 0

host

string <hostname>

optional

server on which the actor is resident

hostRedundancyAllowed

boolean

optional

whether this actor's host allows redundancy of its videos

name

string

optional

immutable name of the actor, used to find or mention it

>= 1 characters<= 50 characters

Example:

chocobozzz

Match pattern:

/^[a-z0-9._]+$/

url

string <url>

optional

total

integer

optional

Example:

🔴500search index unavailable