Video Feeds

Common videos feeds

GET
https://peertube2.cpy.re/feeds/videos.{format}

Parameters

formatstringxmlrssrss2atomatom1jsonjson1requiredpath

format expected (we focus on making rss the most feature-rich ; it serves Media RSS)

accountIdstringquery

limit listing to a specific account

accountNamestringquery

limit listing to a specific account

videoChannelIdstringquery

limit listing to a specific video channel

videoChannelNamestringquery

limit listing to a specific video channel

sortstringquery

Sort column

nsfwstringtruefalsequery

whether to include nsfw videos, if any

isLocalbooleanquery

PeerTube >= 4.0 Display only local or remote objects

includeinteger012481632query

Only administrators and moderators can use this parameter

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
  • 16 CAPTIONS
  • 32 VIDEO SOURCE
privacyOneOfVideoPrivacySet12345query

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

hasHLSFilesbooleanquery

PeerTube >= 4.0 Display only videos that have HLS files

hasWebVideoFilesbooleanquery

PeerTube >= 6.0 Display only videos that have Web Video files

Response

200OKArray<object>

successful operation

Response headers
Cache-Controlstringmax-age=900header
Response fields application/xml, application/rss+xml, text/xml, application/atom+xml
Array<object>
Show child attributes
guidstring

video canonical URL

pubDatestring<date-time>

video publication date

descriptionstring

video description

content:encodedstring

video description

dc:creatorstring

publisher user name

media:categoryinteger

video category (MRSS)

media:communityobject

see media:community (MRSS)

Show child attributes
media:statisticsobject
Show child attributes
viewsinteger
media:embedobject
Show child attributes
urlstring<url>

video embed path, relative to the canonical URL domain (MRSS)

media:playerobject
Show child attributes
urlstring<url>

video watch path, relative to the canonical URL domain (MRSS)

media:thumbnailobject
Show child attributes
urlstring<url>
heightinteger
widthinteger
media:titlestring

see media:title (MRSS). We only use plain titles.

media:descriptionstring
media:ratingstringnonadultadult

see media:rating (MRSS)

enclosureobject

main streamable file for the video

Show child attributes
urlstring<url>
typestringapplication/x-bittorrent
lengthinteger
media:groupArray<MRSSPeerLink | MRSSGroupContent>

list of streamable files for the video. see media:peerLink and media:content or (MRSS)

Show child attributes
Any of
hrefstring
typestringapplication/x-bittorrent
urlstring<url>
fileSizeinteger
typestring
framerateinteger
durationinteger
heightinteger
langstring
Response fields application/json
object
404Not Found

video channel or account not found

406Not Acceptable

accept header unsupported

Docs by Sourcey
↑↓ navigate↵ selectesc close