Search videos - PeerTube

{ "data": [ { "account": { "avatar": { "createdAt": "2019-08-24T14:15:22Z", "path": "string", "updatedAt": "2019-08-24T14:15:22Z" }, "displayName": "string", "host": "example.com", "id": 0, "name": "string", "url": "string" }, "blacklisted": true, "blacklistedReason": "string", "category": { "id": 15, "label": "Science & Technology" }, "channel": { "avatar": { "createdAt": "2019-08-24T14:15:22Z", "path": "string", "updatedAt": "2019-08-24T14:15:22Z" }, "displayName": "string", "host": "example.com", "id": 42, "name": "string", "url": "string" }, "createdAt": "2017-10-01T10:52:46.396Z", "description": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n", "dislikes": 7, "duration": 1419, "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee", "id": 42, "isLive": true, "isLocal": true, "language": { "id": "en", "label": "English" }, "licence": { "id": 2, "label": "Attribution - Share Alike" }, "likes": 42, "name": "What is PeerTube?", "nsfw": true, "originallyPublishedAt": "2010-10-01T10:52:46.396Z", "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg", "privacy": { "id": 1, "label": "string" }, "publishedAt": "2018-10-01T10:52:46.396Z", "scheduledUpdate": { "privacy": 1, "updateAt": "2019-08-24" }, "shortUUID": "2y84q2MQUMWPbiEcxNXMgC", "state": { "id": 1, "label": "string" }, "thumbnailPath": "/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg", "updatedAt": "2021-05-04T08:01:01.502Z", "userHistory": { "currentTime": 0 }, "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d", "views": 1337, "waitTranscoding": true } ], "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 video information and interact with it.

categoryOneOf

string

optional

category id of the video (see /videos/categories)

isLive

string

optional

whether or not the video is a live

tagsOneOf

string

optional

tag(s) of the video

tagsAllOf

string

optional

tag(s) of the video, where all should be present in the video

licenceOneOf

string

optional

licence id of the video (see /videos/licences)

languageOneOf

string

optional

language id of the video (see /videos/languages). Use _unknown to filter on videos that don't have a video language

nsfw

string

optional

whether to include nsfw videos, if any

filter

string

optional

Special filters which might require special rights:

local - only videos local to the instance

all-local - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)

all - all videos, showing private and unlisted videos (requires Admin privileges)

skipCount

string

optional

if you don't need the total in the response

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 videos by criteria

startDate

string

optional

Get videos that are published after this date

endDate

string

optional

Get videos that are published before this date

originallyPublishedStartDate

string

optional

Get videos that are originally published after this date

originallyPublishedEndDate

string

optional

Get videos that are originally published before this date

durationMin

integer

optional

Get videos that have this minimum duration

durationMax

integer

optional

Get videos that have this maximum duration

Responses

🟢200successful operation

application/json

Body

data

array[object (Video) {31}]

optional

<= 100 items

account

object (AccountSummary)

optional

blacklisted

boolean | null

optional

blacklistedReason

string | null

optional