Feeds

Video Feeds

Server syndication feeds of videos

Comments on videos feeds

GET

https://peertube2.cpy.re/feeds/video-comments.{format}

Comments on videos feeds

curl -X GET 'https://peertube2.cpy.re/feeds/video-comments.xml'

const response = await fetch('https://peertube2.cpy.re/feeds/video-comments.xml', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/feeds/video-comments.xml')
print(response.text)

200

External example: https://peertube2.cpy.re/feeds/video-comments.xml?scope=local

External example: https://peertube2.cpy.re/feeds/video-comments.rss?scope=local

External example: https://peertube2.cpy.re/feeds/video-comments.atom?scope=local

External example: https://peertube2.cpy.re/feeds/video-comments.json?scope=local

Parameters

formatstringxmlrssrss2atomatom1jsonjson1requiredpath

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

videoIdstringquery

limit listing comments to a specific video

accountIdstringquery

limit listing comments to videos of a specific account

accountNamestringquery

limit listing comments to videos of a specific account

videoChannelIdstringquery

limit listing comments to videos of a specific video channel

videoChannelNamestringquery

limit listing comments to videos of a specific video channel

isLocalbooleanquery

PeerTube >= 9.0 Display only comments of local or remote accounts

onLocalVideobooleanquery

PeerTube >= 9.0 Display only comments of local or remote videos

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

linkstring<url>

guidstring

pubDatestring<date-time>

content:encodedstring

dc:creatorstring

Response fields application/json

object

400Bad Request

Arises when:

videoId filter is mixed with a channel filter

404Not Found

video, video channel or account not found

406Not Acceptable

accept header unsupported

Common videos feeds

GET

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

Common videos feeds

curl -X GET 'https://peertube2.cpy.re/feeds/videos.xml'

const response = await fetch('https://peertube2.cpy.re/feeds/videos.xml', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/feeds/videos.xml')
print(response.text)

200

External example: https://peertube2.cpy.re/feeds/videos.xml?scope=local

External example: https://peertube2.cpy.re/feeds/videos.rss?scope=local

External example: https://peertube2.cpy.re/feeds/videos.atom?scope=local

External example: https://peertube2.cpy.re/feeds/videos.json?scope=local

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

Response fields application/xml, application/rss+xml, text/xml, application/atom+xml

Array<object>

Show child attributes

linkstring<url>

video watch page URL

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

Videos of subscriptions feeds

GET

https://peertube2.cpy.re/feeds/subscriptions.{format}

Videos of subscriptions feeds

curl -X GET 'https://peertube2.cpy.re/feeds/subscriptions.xml?accountId=string&token=string'

const response = await fetch('https://peertube2.cpy.re/feeds/subscriptions.xml?accountId=string&token=string', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/feeds/subscriptions.xml?accountId=string&token=string')
print(response.text)

200

[
  {
    "link": "https://example.com",
    "guid": "string",
    "pubDate": "2024-01-15T09:30:00Z",
    "description": "string",
    "content:encoded": "string",
    "dc:creator": "string",
    "media:category": 0,
    "media:community": {
      "media:statistics": {
        "views": 0
      }
    },
    "media:embed": {
      "url": "https://example.com"
    },
    "media:player": {
      "url": "https://example.com"
    },
    "media:thumbnail": {
      "url": "https://example.com",
      "height": 0,
      "width": 0
    },
    "media:title": "string",
    "media:description": "string",
    "media:rating": "nonadult",
    "enclosure": {
      "url": "https://example.com",
      "type": "application/x-bittorrent",
      "length": 0
    },
    "media:group": [
      {
        "href": "string",
        "type": "application/x-bittorrent"
      }
    ]
  }
]

{}

Parameters

formatstringxmlrssrss2atomatom1jsonjson1requiredpath

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

accountIdstringrequiredquery

limit listing to a specific account

tokenstringrequiredquery

private token allowing access

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

Response fields application/xml, application/rss+xml, text/xml, application/atom+xml

Array<object>

Show child attributes

linkstring<url>

video watch page URL

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

406Not Acceptable

accept header unsupported

Videos podcast feed

GET

https://peertube2.cpy.re/feeds/podcast/videos.xml

Videos podcast feed

curl -X GET 'https://peertube2.cpy.re/feeds/podcast/videos.xml'

const response = await fetch('https://peertube2.cpy.re/feeds/podcast/videos.xml', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/feeds/podcast/videos.xml')
print(response.text)

Parameters

videoChannelIdstringquery

Limit listing to a specific video channel

playlistIdstringquery

Limit listing to a specific video playlist

enclosurePreferencestringvideo-onlyaudio-onlyquery

Filter enclosures by type (video-only or audio-only)

Response

200OK

successful operation

Response headers

404Not Found

video channel or playlist not found

Video chapters of podcast feeds

GET

https://peertube2.cpy.re/feeds/podcast/video-chapters.json

PeerTube >= 9.0 Chapters of a video in the Podcasting 2.0 JSON format, referenced by the podcast:chapters tag of podcast feed items. See https://podcasting2.org/docs/podcast-namespace/tags/chapters

Video chapters of podcast feeds

curl -X GET 'https://peertube2.cpy.re/feeds/podcast/video-chapters.json?videoId=string'

const response = await fetch('https://peertube2.cpy.re/feeds/podcast/video-chapters.json?videoId=string', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/feeds/podcast/video-chapters.json?videoId=string')
print(response.text)

200

{
  "version": "1.2.0",
  "chapters": [
    {
      "startTime": 0,
      "title": "string"
    }
  ]
}

Parameters

videoIdstringrequiredquery

The video id, uuid or short uuid

Response

200OKPodcastChapters

successful operation

Response fields application/json+chapters, application/json

Podcasting 2.0 JSON chapters, see https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/examples/chapters/jsonChapters.md

versionstring

Example

1.2.0

chaptersArray<object>

Show child attributes

startTimeinteger

Start of the chapter, in seconds

titlestring

404Not Found

video not found

406Not Acceptable

accept header unsupported

Docs by Sourcey