Piped

https://docs.piped.video/docs
Admin
Piped is a video platform or service that offers an API, configuration options, and self-hosting...
Tokens:13,428
Snippets:60
Trust Score:9.4
Update:10 months ago
Show doc for...
Tokens:
Raw
### Docker Compose: Configure Piped with Caddy

Source: https://docs.piped.video/docs/self-hosting

This script automates the setup of Piped using Docker Compose and Caddy as the reverse proxy. It handles hostname configuration and TLS certificate management. Ensure you have git, docker, and the compose plugin installed, and then create DNS records pointing to your server's IP.

```bash
git clone https://github.com/TeamPiped/Piped-Docker
cd Piped-Docker
./configure-instance.sh
# Fill in hostnames when asked, choose 'caddy' as the reverse proxy
# Create A (and AAAA) records to your server’s public IP with the hostnames
docker compose up -d
```

--------------------------------

### Apache Reverse Proxy Configuration for Piped

Source: https://docs.piped.video/docs/self-hosting

Example Apache VirtualHost configuration for proxying requests to a Piped instance. This setup requires manual TLS configuration and forwards traffic to localhost:8080, preserving the Host header.

```apache
<VirtualHost *:443>
    ServerName hostname # For all 3 hostnames

    ProxyPass /  http://127.0.0.1:8080/  nocanon
    ProxyPassReverse /  http://127.0.0.1:8080/

    ProxyPreserveHost On

    AllowEncodedSlashes On

    # TLS configuration here
</VirtualHost>
```

--------------------------------

### GET /suggestions

Source: https://docs.piped.video/docs/api-documentation

Retrieves a list of search suggestions based on the provided query string.

```APIDOC
## GET /suggestions

### Description
Retrieves a list of search suggestions based on the provided query string.

### Method
GET

### Endpoint
/suggestions

### Parameters
#### Query Parameters
- **query** (string) - Required - The query string to get search suggestions for.

### Response
#### Success Response (200)
- An array of strings, where each string is a search suggestion.

#### Response Example
```json
[
	"",
	""
]
```
```

--------------------------------

### Run Piped Backend with Docker Compose

Source: https://docs.piped.video/docs/self-hosting

Starts the Piped backend services in detached mode using Docker Compose. Assumes `docker-compose.yml` has been downloaded and configured.

```bash
docker compose up -d
```

--------------------------------

### Run Watchtower for Automatic Updates

Source: https://docs.piped.video/docs/self-hosting

Starts the Watchtower container, which automatically updates other Docker containers. This is an optional step for maintaining the Piped instance.

```bash
docker run -d \
    --name watchtower \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower
```

--------------------------------

### GET /user/:name

Source: https://docs.piped.video/docs/api-documentation

Retrieves information about a specific YouTube user's channel, including their avatar, banner, description, and a list of related videos.

```APIDOC
## GET /user/:name

### Description
Retrieves information about a specific YouTube channel using the user's name.

### Method
GET

### Endpoint
/user/:name

#### Path Parameters
- **name** (string) - Required - The name of the user’s channel you want to get information about.

### Response
#### Success Response (200)
- **avatarUrl** (string) - The avatar of the channel
- **bannerUrl** (string) - The banner of the channel
- **description** (string) - The description of the channel
- **id** (string) - The ID of the channel
- **name** (string) - The name of the channel
- **nextpage** (string) - A JSON encoded page, which is used for the nextpage endpoint.
- **relatedStreams** (array) - A list of videos from the channel
  - **duration** (integer) - The duration of the channel's video in seconds
  - **thumbnail** (string) - The thumbnail of the channel's video
  - **title** (string) - The title of the channel's video
  - **uploadedDate** (string) - The date the channel's video was uploaded
  - **uploaderAvatar** (string) - The avatar of the channel of the channel's video
  - **uploaderUrl** (string) - The URL of the channel
  - **uploaderVerified** (boolean) - Whether or not the channel is verified
  - **url** (string) - The URL of the channel's video
  - **views** (integer) - The number of views the channel's video has
- **subscriberCount** (integer) - The number of subscribers the channel has
- **verified** (boolean) - Whether or not the channel is verified

#### Response Example
```json
{
    "avatarUrl": "https://pipedproxy-bom.kavin.rocks/...",
    "bannerUrl": "https://pipedproxy-bom.kavin.rocks/...",
    "description": "",
    "id": "",
    "name": "",
    "nextpage": "",
    "relatedStreams": [
        {
            "duration": 0,
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/vi/...",
            "title": "",
            "uploadedDate": "3 months ago",
            "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/...",
            "uploaderUrl": "/channel/...",
            "uploaderVerified": true,
            "url": "/watch?v=...",
            "views": 0
        }
    ],
    "subscriberCount": 0,
    "verified": false
}
```
```

--------------------------------

### Get Search Suggestions

Source: https://docs.piped.video/docs/api-documentation

Provides search suggestions based on a given query string. The response is a JSON array of strings, where each string is a potential search suggestion.

```json
[
	"", 
	""
]
```

--------------------------------

### GET /trending

Source: https://docs.piped.video/docs/api-documentation

Retrieves a list of trending YouTube videos for a specified region.

```APIDOC
## GET /trending

### Description
Retrieves a list of trending YouTube videos for a specified region.

### Method
GET

### Endpoint
/trending

#### Query Parameters
- **region** (string) - Optional - The region you want to get trending YouTube videos from. Example: `US`.

### Response
#### Success Response (200)
- **trendingVideos** (array) - A list of trending videos.
  - **duration** (integer) - The duration of the trending video in seconds.
  - **thumbnail** (string) - The thumbnail of the trending video.
  - **title** (string) - The title of the trending video.
  - **uploadedDate** (string) - The date the trending video was uploaded.
  - **uploaderAvatar** (string) - The avatar of the channel of the trending video.
  - **uploaderUrl** (string) - The URL of the channel of the trending video.
  - **uploaderVerified** (boolean) - Whether or not the channel of the trending video is verified.
  - **url** (string) - The URL of the trending video.
  - **views** (integer) - The number of views the trending video has.

#### Response Example
```json
[
    {
        "duration": 0, 
        "thumbnail": "https://pipedproxy-bom.kavin.rocks/vi/...", 
        "title": "", 
        "uploadedDate": "12 hours ago", 
        "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/...", 
        "uploaderUrl": "/channel/...", 
        "uploaderVerified": true, 
        "url": "/watch?v=...",
        "views": 0 
    }
]
```
```

--------------------------------

### Caddy Reverse Proxy Configuration for Piped

Source: https://docs.piped.video/docs/self-hosting

Example Caddy configuration to set up Piped with Caddy as the reverse proxy. This configuration automatically handles TLS certificates and proxies requests to the Piped backend running on port 8080.

```caddy
hostname, hostname2, hostname3 {
    reverse_proxy http://127.0.0.1:8080
}
```

--------------------------------

### Nginx Reverse Proxy Configuration for Piped

Source: https://docs.piped.video/docs/self-hosting

Example Nginx configuration to proxy requests to a Piped instance running on port 8080. This setup requires manual TLS configuration and assumes Piped is accessible via HTTP on localhost:8080.

```nginx
server {
    listen 80;
    server_name hostname; # For all 3 hostnames

    location / {
       proxy_pass http://127.0.0.1:8080;
       proxy_set_header Host $host;
    }
}
```

--------------------------------

### Traefik Labels for Piped Nginx Container

Source: https://docs.piped.video/docs/self-hosting

Example Docker labels for configuring Traefik as a reverse proxy for Piped. These labels should be applied to the Nginx container and define the routing rules based on hostnames.

```yaml
labels:
  - "traefik.enable=true"
  - "traefik.http.routers.piped.rule=Host(`hostname`,`hostname2`,`hostname3`)"
  - "traefik.http.routers.piped.entrypoints=web"
```

--------------------------------

### GET /comments/:videoId

Source: https://docs.piped.video/docs/api-documentation

Retrieves comments for a specific YouTube video.

```APIDOC
## GET /comments/:videoId

### Description
Retrieves comments for a specific YouTube video.

### Method
GET

### Endpoint
/comments/:videoId

#### Path Parameters
- **videoId** (string) - Required - The video ID of the YouTube video you want to get comments for.

### Response
#### Success Response (200)
- **comments** (array) - A list of comments.
  - **author** (string) - The name of the author of the comment.
  - **commentId** (string) - The comment ID.
  - **commentText** (string) - The text of the comment.
  - **commentedTime** (string) - The time the comment was made.
  - **commentorUrl** (string) - The URL of the channel of the comment.
  - **hearted** (boolean) - Whether or not the comment has been hearted.
  - **likeCount** (integer) - The number of likes the comment has.
  - **pinned** (boolean) - Whether or not the comment is pinned.
  - **thumbnail** (string) - The thumbnail of the comment.
  - **verified** (boolean) - Whether or not the author of the comment is verified.
  - **creatorReplied** (boolean) - Whether the creator has replied to the comment.
- **disabled** (boolean) - Whether or not the comments are disabled.
- **nextpage** (string) - A JSON encoded page, which is used for the nextpage endpoint.

#### Response Example
```json
{
    "comments": [
        {
            "author": "", 
            "commentId": "", 
            "commentText": "", 
            "commentedTime": "14 hours ago", 
            "commentorUrl": "/channel/...", 
            "hearted": false, 
            "likeCount": 0, 
            "pinned": false, 
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/...", 
            "verified": false, 
            "creatorReplied": false 
        }
    ], 
    "disabled": false, 
    "nextpage": ""
}
```
```

--------------------------------

### GET /nextpage/channel/:channelId

Source: https://docs.piped.video/docs/api-documentation

Retrieves the next page of related streams for a given channel ID, used for pagination.

```APIDOC
## GET /nextpage/channel/:channelId

### Description
Retrieves the next page of related streams for a given channel ID, used for pagination.

### Method
GET

### Endpoint
/nextpage/channel/:channelId

#### Path Parameters
- **channelId** (string) - Required - The channel ID of the YouTube channel you want to get information about.

#### Query Parameters
- **nextpage** (string) - Required - The JSON encoded nextpage variable, to be sent as a query string.

### Response
#### Success Response (200)
- **nextpage** (string) - A JSON encoded page, which is used for the nextpage endpoint.
- **relatedStreams** (array) - A list of videos from the channel
  - **duration** (integer) - The duration of the channel's video in seconds
  - **thumbnail** (string) - The thumbnail of the channel's video
  - **title** (string) - The title of the channel's video
  - **uploadedDate** (string) - The date the channel's video was uploaded
  - **uploaderAvatar** (string) - The avatar of the channel of the channel's video
  - **uploaderUrl** (string) - The URL of the channel
  - **uploaderVerified** (boolean) - Whether or not the channel is verified
  - **url** (string) - The URL of the channel's video
  - **views** (integer) - The number of views the channel's video has

#### Response Example
```json
{
    "nextpage": "",
    "relatedStreams": [
        {
            "duration": 0,
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/vi/...",
            "title": "",
            "uploadedDate": "3 months ago",
            "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/...",
            "uploaderUrl": "/channel/...",
            "uploaderVerified": true,
            "url": "/watch?v=...",
            "views": 0
        }
    ]
}
```
```

--------------------------------

### Get User Channel Information

Source: https://docs.piped.video/docs/api-documentation

Retrieves detailed information about a YouTube channel, including its avatar, banner, description, and a list of related videos. It requires the user's channel name as a parameter and returns a JSON object with channel metadata and video stream information.

```json
{
    "avatarUrl": "https://pipedproxy-bom.kavin.rocks/வதற்காக/...". // The avatar of the channel
    "bannerUrl": "https://pipedproxy-bom.kavin.rocks/வதற்காக/...". // The banner of the channel
    "description": "", // The description of the channel
    "id": "", // The ID of the channel
    "name": "", // The name of the channel
    "nextpage": "", // A JSON encoded page, which is used for the nextpage endpoint.
    "relatedStreams": [
        {
            "duration": 0, // The duration of the channel's video in seconds
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/vi/...". // The thumbnail of the channel's video
            "title": "", // The title of the channel's video
            "uploadedDate": "3 months ago", // The date the channel's video was uploaded
            "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/வதற்காக/...". // The avatar of the channel of the channel's video
            "uploaderUrl": "/channel/...". // The URL of the channel
            "uploaderVerified": true, // Whether or not the channel is verified
            "url": "/watch?v=...". // The URL of the channel's video
            "views": 0 // The number of views the channel's video has
        }
    ], // A list of videos from the channel
    "subscriberCount": 0, // The number of subscribers the channel has
    "verified": false // Whether or not the channel is verified
}
```

--------------------------------

### GET /nextpage/comments/:videoId

Source: https://docs.piped.video/docs/api-documentation

Retrieves the next page of comments for a specific YouTube video.

```APIDOC
## GET /nextpage/comments/:videoId

### Description
Retrieves the next page of comments for a specific YouTube video using the `nextpage` parameter.

### Method
GET

### Endpoint
/nextpage/comments/:videoId

#### Path Parameters
- **videoId** (string) - Required - The video ID of the YouTube video you want to get comments for.

#### Query Parameters
- **nextpage** (string) - Required - The JSON encoded nextpage variable, to be sent as a query string.

### Response
#### Success Response (200)
- **comments** (array) - A list of comments.
  - **author** (string) - The name of the author of the comment.
  - **commentId** (string) - The comment ID.
  - **commentText** (string) - The text of the comment.
  - **commentedTime** (string) - The time the comment was made.
  - **commentorUrl** (string) - The URL of the channel of the comment.
  - **hearted** (boolean) - Whether or not the comment has been hearted.
  - **likeCount** (integer) - The number of likes the comment has.
  - **pinned** (boolean) - Whether or not the comment is pinned.
  - **thumbnail** (string) - The thumbnail of the comment.
  - **verified** (boolean) - Whether or not the author of the comment is verified.
  - **creatorReplied** (boolean) - Whether the creator has replied to the comment.
- **disabled** (boolean) - Whether or not the comments are disabled.
- **nextpage** (string) - A JSON encoded page, which is used for the nextpage endpoint.

#### Response Example
```json
{
    "comments": [
        {
            "author": "", 
            "commentId": "", 
            "commentText": "", 
            "commentedTime": "14 hours ago", 
            "commentorUrl": "/channel/...", 
            "hearted": false, 
            "likeCount": 0, 
            "pinned": false, 
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/...", 
            "verified": false, 
            "creatorReplied": false
        }
    ], 
    "disabled": false, 
    "nextpage": ""
}
```
```

--------------------------------

### Get Next Page of Channel Videos

Source: https://docs.piped.video/docs/api-documentation

Fetches the subsequent page of videos for a given YouTube channel. This endpoint is used for pagination and requires both the channel ID and a JSON encoded 'nextpage' token as query parameters. It returns a JSON object containing the next page token and a list of related video streams.

```json
{
    "nextpage": "", // A JSON encoded page, which is used for the nextpage endpoint.
    "relatedStreams": [
        {
            "duration": 0, // The duration of the channel's video in seconds
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/vi/...". // The thumbnail of the channel's video
            "title": "", // The title of the channel's video
            "uploadedDate": "3 months ago", // The date the channel's video was uploaded
            "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/வதற்காக/...". // The avatar of the channel of the channel's video
            "uploaderUrl": "/channel/...". // The URL of the channel
            "uploaderVerified": true, // Whether or not the channel is verified
            "url": "/watch?v=...". // The URL of the channel's video
            "views": 0 // The number of views the channel's video has
        }
    ] // A list of videos from the channel
}
```

--------------------------------

### GET /sponsors/:videoId

Source: https://docs.piped.video/docs/api-documentation

Retrieves sponsor segments for a given YouTube video, allowing users to skip sponsored content.

```APIDOC
## GET /sponsors/:videoId

### Description
Retrieves sponsor segments for a given YouTube video, allowing users to skip sponsored content.

### Method
GET

### Endpoint
/sponsors/:videoId

### Parameters
#### Path Parameters
- **videoId** (string) - Required - The video ID of the YouTube video you want to get information about.

#### Query Parameters
- **category** (array) - Optional - The category of sponsors you would like to skip. Example: `["sponsor"]`. See the SponsorBlock Wiki for more information.

### Response
#### Success Response (200)
- **hash** (string) - The hash of the videoId.
- **segments** (array) - A list of sponsor segments. Each object contains:
    - **UUID** (string) - The UUID of the segment.
    - **actionType** (string) - The action type of the segment.
    - **category** (string) - The category of the segment.
    - **segment** (array) - The start and end time of the segment (e.g., `[0, 10]` for 0 to 10 seconds).
    - **videoDuration** (number) - The duration of the video.
- **videoID** (string) - The video ID of the segment.

#### Response Example
```json
{
    "hash": "",
    "segments": [
        {
            "UUID": "",
            "actionType": "skip",
            "category": "sponsor",
            "segment": [0, 10],
            "videoDuration": 0
        }
    ],
    "videoID": ""
}
```
```

--------------------------------

### GET /nextpage/playlists/:playlistId

Source: https://docs.piped.video/docs/api-documentation

Retrieves information about a specific YouTube playlist, including related videos. Supports pagination using the `nextpage` query parameter.

```APIDOC
## GET /nextpage/playlists/:playlistId

### Description
Retrieves information about a specific YouTube playlist, including related videos. Supports pagination using the `nextpage` query parameter.

### Method
GET

### Endpoint
/nextpage/playlists/:playlistId

### Parameters
#### Path Parameters
- **playlistId** (string) - Required - The playlist ID of the YouTube playlist you want to get information about.

#### Query Parameters
- **nextpage** (string) - Optional - The JSON encoded nextpage variable, to be sent as a query string.

### Response
#### Success Response (200)
- **nextpage** (string) - A JSON encoded page, which is used for the nextpage endpoint.
- **relatedStreams** (array) - A list of videos from the playlist. Each object contains:
    - **duration** (number) - The duration of the playlist's video in seconds
    - **thumbnail** (string) - The thumbnail of the playlist's video
    - **title** (string) - The title of the playlist's video
    - **uploadedDate** (string) - The date the playlist's video was uploaded
    - **uploaderAvatar** (string) - The avatar of the channel of the playlist's video
    - **uploaderUrl** (string) - The URL of the channel of the playlist's video
    - **uploaderVerified** (boolean) - Whether or not the playlist is verified
    - **url** (string) - The URL of the playlist's video
    - **views** (number) - The number of views the playlist's video has

#### Response Example
```json
{
    "nextpage": "",
    "relatedStreams": [
        {
            "duration": 0,
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/vi/வுகளை",
            "title": "",
            "uploadedDate": "3 months ago",
            "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/...",
            "uploaderUrl": "/channel/வுகளை",
            "uploaderVerified": true,
            "url": "/watch?v=வுகளை",
            "views": 0
        }
    ]
}
```
```

--------------------------------

### Get Playlist Information - Next Page

Source: https://docs.piped.video/docs/api-documentation

Retrieves information about a YouTube playlist using its ID and a pagination token. The response includes video details like duration, thumbnail, title, upload date, uploader information, and URL. It requires a `playlistId` and an optional `nextpage` JSON encoded variable for pagination.

```json
{
    "nextpage": "", 
    "relatedStreams": [
        {
            "duration": 0, 
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/vi/...", 
            "title": "", 
            "uploadedDate": "3 months ago", 
            "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/...", 
            "uploaderUrl": "/channel/...", 
            "uploaderVerified": true, 
            "url": "/watch?v=...",
            "views": 0
        }
    ]
}
```

--------------------------------

### GET /streams/:videoId

Source: https://docs.piped.video/docs/api-documentation

Retrieves detailed information about a specific YouTube video, including audio and video streams, metadata, and related content.

```APIDOC
## GET /streams/:videoId

### Description
This endpoint retrieves detailed information about a specific YouTube video. It provides access to various audio and video streams, video metadata such as title, description, likes, dislikes, upload date, and a list of related videos.

### Method
GET

### Endpoint
`/streams/:videoId`

### Parameters
#### Path Parameters
- **videoId** (string) - Required - The unique identifier of the YouTube video.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **audioStreams** (array) - The audio streams of the video.
  - **bitrate** (integer) - The bitrate of the audio stream in bytes.
  - **codec** (string) - The codec of the audio stream.
  - **format** (string) - The format of the audio stream.
  - **indexEnd** (integer) - Useful for creating dash streams.
  - **indexStart** (integer) - Useful for creating dash streams.
  - **initStart** (integer) - Useful for creating dash streams.
  - **initEnd** (integer) - Useful for creating dash streams.
  - **mimeType** (string) - The mime type of the audio stream.
  - **quality** (string) - The quality of the audio stream.
  - **url** (string) - The stream's URL.
  - **videoOnly** (boolean) - Whether or not the stream is video only.
- **dash** (string | null) - The dash manifest URL, to be used if not null (for OTF streams).
- **description** (string) - The description of the video.
- **dislikes** (integer) - The number of dislikes the video has.
- **duration** (integer) - The duration of the video in seconds.
- **hls** (string | null) - The hls manifest URL, to be used for Livestreams.
- **lbryId** (string) - The lbry id of the video, if available.
- **likes** (integer) - The number of likes the video has.
- **livestream** (boolean) - Whether or not the video is a livestream.
- **proxyUrl** (string) - The proxy url to be used for rewrites.
- **relatedStreams** (array) - A list of related streams.
  - **duration** (integer) - The duration of the related video in seconds.
  - **thumbnail** (string) - The thumbnail of the related video.
  - **title** (string) - The title of the related video.
  - **uploadedDate** (string) - The date the related video was uploaded.
  - **uploaderAvatar** (string) - The avatar of the channel of the related video.
  - **uploaderUrl** (string) - The URL of the channel of the related video.
  - **uploaderVerified** (boolean) - Whether or not the channel of the related video is verified.
  - **url** (string) - The URL of the related video.
  - **views** (integer) - The number of views the related video has.
- **subtitles** (array) - A list of subtitles.
  - **autoGenerated** (boolean) - Whether or not the subtitle was auto-generated.
  - **code** (string) - The language code of the subtitle.
  - **mimeType** (string) - The mime type of the subtitle.
  - **name** (string) - The name of the subtitle.
  - **url** (string) - The URL of the subtitle.
- **thumbnailUrl** (string) - The thumbnail of the video.
- **title** (string) - The title of the video.
- **uploadDate** (string) - The date the video was uploaded.
- **uploader** (string) - The name of the channel of the video.
- **uploaderUrl** (string) - The URL of the channel of the video.
- **uploaderVerified** (boolean) - Whether or not the channel of the video is verified.
- **videoStreams** (array) - The video streams of the video.
  - **bitrate** (integer) - The bitrate of the video stream in bytes.
  - **codec** (string) - The codec of the video stream.
  - **format** (string) - The format of the video stream.
  - **fps** (integer) - The frames per second of the video stream.
  - **height** (integer) - The height of the video stream.
  - **indexEnd** (integer) - Useful for creating dash streams.
  - **indexStart** (integer) - Useful for creating dash streams.
  - **initStart** (integer) - Useful for creating dash streams.
  - **initEnd** (integer) - Useful for creating dash streams.
  - **mimeType** (string) - The mime type of the video stream.
  - **quality** (string) - The quality of the video stream.
  - **url** (string) - The stream's URL.
  - **videoOnly** (boolean) - Whether or not the stream is video only.
  - **width** (integer) - The width of the video stream.
- **views** (integer) - The number of views the video has.

#### Response Example
```json
{
    "audioStreams": [
        {
            "bitrate": 128000,
            "codec": "mp4a.40.5",
            "format": "M4A",
            "indexEnd": 0,
            "indexStart": 0,
            "initStart": 0,
            "initEnd": 0,
            "mimeType": "audio/mp4",
            "quality": "128 kbps",
            "url": "https://pipedproxy-bom.kavin.rocks/videoplayback?...",
            "videoOnly": false
        }
    ],
    "dash": null,
    "description": "This is a sample video description.",
    "dislikes": 100,
    "duration": 300,
    "hls": null,
    "lbryId": "",
    "likes": 1000,
    "livestream": false,
    "proxyUrl": "https://pipedproxy-bom.kavin.rocks",
    "relatedStreams": [
        {
            "duration": 240,
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/vi/...".
            "title": "Related Video Title",
            "uploadedDate": "1 week ago",
            "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/...".
            "uploaderUrl": "/channel/...".
            "uploaderVerified": true,
            "url": "/watch?v=..."
            "views": 50000
        }
    ],
    "subtitles": [
        {
            "autoGenerated": false,
            "code": "en",
            "mimeType": "application/ttml+xml",
            "name": "English",
            "url": "https://pipedproxy-bom.kavin.rocks/api/timedtext?..."
        }
    ],
    "thumbnailUrl": "https://pipedproxy-bom.kavin.rocks/vi/...".
    "title": "Sample Video Title",
    "uploadDate": "2021-01-01",
    "uploader": "Sample Channel",
    "uploaderUrl": "/channel/..."
    "uploaderVerified": true,
    "videoStreams": [
        {
            "bitrate": 2000000,
            "codec": "avc1.64002a",
            "format": "MPEG_4",
            "fps": 30,
            "height": 720,
            "indexEnd": 0,
            "indexStart": 0,
            "initStart": 0,
            "initEnd": 0,
            "mimeType": "video/mp4",
            "quality": "720p",
            "url": "https://pipedproxy-bom.kavin.rocks/videoplayback?...".
            "videoOnly": false,
            "width": 1280
        }
    ],
    "views": 1000000
}
```
```

--------------------------------

### Get Playlist Information

Source: https://docs.piped.video/docs/api-documentation

Retrieves details about a YouTube playlist, including its banner, name, creator information, and a list of videos within it. It requires the playlist ID as a parameter and returns a JSON object with playlist metadata and associated video streams.

```json
{
    "bannerUrl": "https://pipedproxy-bom.kavin.rocks/வதற்காக/...". // The banner of the playlist
    "name": "", // The name of the playlist
    "nextpage": "", // A JSON encoded page, which is used for the nextpage endpoint.
    "relatedStreams": [
        {
            "duration": 0, // The duration of the playlist's video in seconds
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/vi/...". // The thumbnail of the playlist's video
            "title": "", // The title of the playlist's video
            "uploadedDate": "3 months ago", // The date the playlist's video was uploaded
            "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/வதற்காக/...". // The avatar of the channel of the playlist's video
            "uploaderUrl": "/channel/...". // The URL of the channel of the playlist's video
            "uploaderVerified": true, // Whether or not the playlist is verified
            "url": "/watch?v=...". // The URL of the playlist's video
            "views": 0 // The number of views the playlist's video has
        }
    ], // A list of videos from the playlist
    "thumbnailUrl": "https://pipedproxy-bom.kavin.rocks/வதற்காக/...". // The thumbnail of the playlist
    "uploader": "", // The name of the creator of the playlist
    "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/வதற்காக/...". // The avatar of the creator of the playlist
    "uploaderUrl": "/channel/...". // The URL of the creator of the playlist
    "videos": 0 // The number of videos in the playlist
}
```

--------------------------------

### Get Nginx User and Group IDs

Source: https://docs.piped.video/docs/self-hosting

Retrieves the user and group IDs for the Nginx web server, typically 'www-data'. These IDs are needed for correctly running the ytproxy Docker container.

```bash
cat /etc/passwd
```

--------------------------------

### GET /playlists/:playlistId

Source: https://docs.piped.video/docs/api-documentation

Retrieves details about a specific YouTube playlist, including its banner, name, thumbnail, uploader information, and a list of videos within the playlist.

```APIDOC
## GET /playlists/:playlistId

### Description
Retrieves details about a specific YouTube playlist, including its banner, name, thumbnail, uploader information, and a list of videos within the playlist.

### Method
GET

### Endpoint
/playlists/:playlistId

#### Path Parameters
- **playlistId** (string) - Required - The playlist ID of the YouTube playlist you want to get information about.

### Response
#### Success Response (200)
- **bannerUrl** (string) - The banner of the playlist
- **name** (string) - The name of the playlist
- **nextpage** (string) - A JSON encoded page, which is used for the nextpage endpoint.
- **relatedStreams** (array) - A list of videos from the playlist
  - **duration** (integer) - The duration of the playlist's video in seconds
  - **thumbnail** (string) - The thumbnail of the playlist's video
  - **title** (string) - The title of the playlist's video
  - **uploadedDate** (string) - The date the playlist's video was uploaded
  - **uploaderAvatar** (string) - The avatar of the channel of the playlist's video
  - **uploaderUrl** (string) - The URL of the channel of the playlist's video
  - **uploaderVerified** (boolean) - Whether or not the playlist is verified
  - **url** (string) - The URL of the playlist's video
  - **views** (integer) - The number of views the playlist's video has
- **thumbnailUrl** (string) - The thumbnail of the playlist
- **uploader** (string) - The name of the creator of the playlist
- **uploaderAvatar** (string) - The avatar of the creator of the playlist
- **uploaderUrl** (string) - The URL of the creator of the playlist
- **videos** (integer) - The number of videos in the playlist

#### Response Example
```json
{
    "bannerUrl": "https://pipedproxy-bom.kavin.rocks/...",
    "name": "",
    "nextpage": "",
    "relatedStreams": [
        {
            "duration": 0,
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/vi/...",
            "title": "",
            "uploadedDate": "3 months ago",
            "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/...",
            "uploaderUrl": "/channel/...",
            "uploaderVerified": true,
            "url": "/watch?v=...",
            "views": 0
        }
    ],
    "thumbnailUrl": "https://pipedproxy-bom.kavin.rocks/...",
    "uploader": "",
    "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/...",
    "uploaderUrl": "/channel/...",
    "videos": 0
}
```
```

--------------------------------

### Get Sponsor Segments for Video

Source: https://docs.piped.video/docs/api-documentation

Retrieves sponsor skip segments for a given YouTube video ID. It allows filtering by sponsor category and returns a list of segments with their UUID, action type, category, time range, and video duration. Requires `videoId` and an optional `category` parameter.

```json
{
    "hash": "", 
    "segments": [
        {
            "UUID": "", 
            "actionType": "skip", 
            "category": "sponsor", 
            "segment": [0, 10], 
            "videoDuration": 0
        }
    ],
    "videoID": ""
}
```

--------------------------------

### Get YouTube Video Information - JSON Response

Source: https://docs.piped.video/docs/api-documentation

This JSON object represents the response from the '/streams/:videoId' endpoint, providing comprehensive details about a YouTube video. It includes information on audio and video streams, video metadata, related content, and subtitle availability. The response structure is crucial for applications that process or display YouTube video data through the Piped API.

```json
{
    "audioStreams": [
        {
            "bitrate": 0, 
            "codec": "mp4a.40.5", 
            "format": "M4A", 
            "indexEnd": 0, 
            "indexStart": 0, 
            "initStart": 0, 
            "initEnd": 0, 
            "mimeType": "audio/mp4", 
            "quality": "48 kbps", 
            "url": "https://pipedproxy-bom.kavin.rocks/videoplayback?வுகளில்", 
            "videoOnly": false 
        }
    ], 
    "dash": null, 
    "description": "", 
    "dislikes": 0, 
    "duration": 0, 
    "hls": null, 
    "lbryId": "", 
    "likes": 0, 
    "livestream": false, 
    "proxyUrl": "https://pipedproxy-bom.kavin.rocks", 
    "relatedStreams": [
        {
            "duration": 0, 
            "thumbnail": "https://pipedproxy-bom.kavin.rocks/vi/வுகளில்", 
            "title": "", 
            "uploadedDate": "3 months ago", 
            "uploaderAvatar": "https://pipedproxy-bom.kavin.rocks/வுகளில்", 
            "uploaderUrl": "/channel/வுகளில்", 
            "uploaderVerified": true, 
            "url": "/watch?v=வுகளில்",
            "views": 0 
        }
    ], 
    "subtitles": [
        {
            "autoGenerated": false, 
            "code": "en", 
            "mimeType": "application/ttml+xml", 
            "name": "English", 
            "url": "https://pipedproxy-bom.kavin.rocks/api/timedtext?வுகளில்" 
        }
    ], 
    "thumbnailUrl": "https://pipedproxy-bom.kavin.rocks/vi/வுகளில்", 
    "title": "", 
    "uploadDate": "2021-01-01", 
    "uploader": "", 
    "uploaderUrl": "/channel/வுகளில்", 
    "uploaderVerified": true, 
    "videoStreams": [
        {
            "bitrate": 0, 
            "codec": "avc1.64002a", 
            "format": "MPEG_4", 
            "fps": 30, 
            "height": 720, 
            "indexEnd": 0, 
            "indexStart": 0, 
            "initStart": 0, 
            "initEnd": 0, 
            "mimeType": "video/mp4", 
            "quality": "720p", 
            "url": "https://pipedproxy-bom.kavin.rocks/videoplayback?வுகளில்", 
            "videoOnly": false,
            "width": 1280 
        }
    ], 
    "views": 0 
}
```

--------------------------------

### Download Piped Backend Files

Source: https://docs.piped.video/docs/self-hosting

Downloads the necessary configuration and Docker Compose files for the Piped backend. This is the first step in setting up a Piped instance.

```bash
mkdir piped && cd piped
wget https://raw.githubusercontent.com/TeamPiped/Piped-Backend/master/config.properties
wget https://raw.githubusercontent.com/TeamPiped/Piped-Backend/master/docker-compose.yml
```

--------------------------------

### Run ytproxy Docker Container

Source: https://docs.piped.video/docs/self-hosting

Launches the ytproxy Docker container, which acts as a proxy for video playback. Requires the Nginx user/group IDs and should be run with host networking for socket access.

```bash
docker run -d --network=host -v "/var/run/ytproxy/:/app/socket" --user 33:33 --restart unless-stopped 1337kavin/ytproxy:latest
```

--------------------------------

### Enable IPv6 in Docker Daemon

Source: https://docs.piped.video/docs/self-hosting

Configures the Docker daemon to enable IPv6 networking. This involves modifying `/etc/docker/daemon.json` and restarting the Docker service.

```json
{
  "experimental": true,
  "ip6tables": true
}
```

--------------------------------

### Nginx Piped Site Configuration

Source: https://docs.piped.video/docs/self-hosting

Nginx server block configuration (`piped.conf`) for the Piped instance. It defines two server blocks, one for the API and one for the proxy, handling SSL and routing.

```nginx
server {
    listen 80;
    listen 443 ssl http2;
    ssl_certificate /etc/ssl/certs/kavin.rocks.pem;
    ssl_certificate_key /etc/ssl/private/kavin.rocks.key;
    ssl_early_data on;
    server_name pipedapi.kavin.rocks; # Change this depending on what domain you are using

    location / {
       proxy_pass http://127.0.0.1:8080;
    }
}

server {
    listen 80;
    listen 443 ssl http2;
    ssl_certificate /etc/ssl/certs/kavin.rocks.pem;
    ssl_certificate_key /etc/ssl/private/kavin.rocks.key;
    ssl_early_data on;
    server_name pipedproxy-bom.kavin.rocks; # Change this depending on what domain you are using

    location ~ (/videoplayback|/api/v4/|/api/manifest/) {
       include snippets/ytproxy.conf;
       add_header Cache-Control private always;
       proxy_hide_header Access-Control-Allow-Origin;
    }

    location / {
       include snippets/ytproxy.conf;
       add_header Cache-Control "public, max-age=604800";
       proxy_hide_header Access-Control-Allow-Origin;
    }
}
```

--------------------------------

### Docker Compose: Configure Piped with Nginx

Source: https://docs.piped.video/docs/self-hosting

This script sets up Piped with Docker Compose and Nginx. Note that this requires a separate reverse proxy and manual TLS configuration. After running the script and configuring DNS, you need to forward traffic to 127.0.0.1:8080 with the appropriate 'Host' header.

```bash
git clone https://github.com/TeamPiped/Piped-Docker
cd Piped-Docker
./configure-instance.sh
# Fill in hostnames when asked, choose 'nginx' as the reverse proxy
# Create A (and AAAA) records to your server’s public IP with the hostnames
docker compose up -d
# Forward traffic to 127.0.0.1:8080 with your reverse proxy
```

--------------------------------

### Manually Update Piped Docker Containers

Source: https://docs.piped.video/docs/self-hosting

Command to manually update all running Piped-related Docker containers using Watchtower. This command should be executed with root privileges and ensures all specified services are updated to their latest versions.

```bash
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower --run-once piped-frontend piped-backend piped-proxy varnish nginx caddy postgres watchtower
```
Tokens:
Raw