GET api/v1/videos

cpy.re:peertube

Summary: List videos
Operation ID: getVideos
Auth: unknown

Parameters (17)

categoryOneOf (?, query, optional)

category id of the video (see [/videos/categories](#operation/getCategories))

count (integer, query, optional, default: 15)

Number of items to return

Constraints: {'minimum': 1, 'maximum': 100}

excludeAlreadyWatched (boolean, query, optional)

Whether or not to exclude videos that are in the user's video history

hasHLSFiles (boolean, query, optional)

**PeerTube >= 4.0** Display only videos that have HLS files

hasWebtorrentFiles (boolean, query, optional)

**PeerTube >= 4.0** Display only videos that have WebTorrent files

include (integer, query, optional)

**PeerTube >= 4.0** Include additional videos in results (can be combined using bitwise or operator) - `0` NONE - `1` NOT_PUBLISHED_STATE - `2` BLACKLISTED - `4` BLOCKED_OWNER - `8` FILES

Constraints: {'enum': [0, 1, 2, 4, 8]}

isLive (boolean, query, optional)

whether or not the video is a live

isLocal (boolean, query, optional)

**PeerTube >= 4.0** Display only local or remote videos

languageOneOf (?, query, optional)

language id of the video (see [/videos/languages](#operation/getLanguages)). Use `_unknown` to filter on videos that don't have a video language

licenceOneOf (?, query, optional)

licence id of the video (see [/videos/licences](#operation/getLicences))

nsfw (string, query, optional)

whether to include nsfw videos, if any

Constraints: {'enum': ['true', 'false']}

privacyOneOf (?, query, optional)

**PeerTube >= 4.0** Display only videos in this specific privacy/privacies

skipCount (string, query, optional, default: false)

if you don't need the `total` in the response

Constraints: {'enum': ['true', 'false']}

sort (string, query, optional)

Constraints: {'enum': ['name', '-duration', '-createdAt', '-publishedAt', '-views', '-likes', '-trending', '-hot', '-best']}

start (integer, query, optional)

Offset used to paginate results

Constraints: {'minimum': 0}

tagsAllOf (?, query, optional)

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

tagsOneOf (?, query, optional)

tag(s) of the video

No probe data for this endpoint yet.