Class PipedAPI

Hierarchy

PipedAPI

Index

Constructors

Properties

Methods

_get channel channelByName comments playlist search sponsors streams suggestions trending user

Constructors

constructor

new PipedAPI(host?): PipedAPI
Parameters
- host: string = "https://pipedapi.kavin.rocks"
Returns PipedAPI
- Defined in piped-api.ts:16

Properties

host

host: string

Methods

`Private` _get

_get(url): Promise<any>
Retrieves data from the specified URL.
Parameters
- url: string
  
  The URL from which to retrieve data.
Returns Promise<any>
- A Promise that resolves to the parsed JSON data.
- Defined in piped-api.ts:26

channel

channel(id, nextpage?): Promise<Channel | NextPageChannel>
Retrieves a channel by its ID.
Parameters
- id: string
  
  The ID of the channel to retrieve.
- Optional nextpage: string
  
  The JSON encoded nextpage variable, to be sent as a query string (optional).
Returns Promise<Channel | NextPageChannel>
A Promise that resolves to the retrieved Channel object.
- Defined in piped-api.ts:71

channelByName

channelByName(name): Promise<Channel>
Retrieves a channel by its name.
Parameters
- name: string
  
  The name of the channel.
Returns Promise<Channel>
A promise that resolves to the channel object.
- Defined in piped-api.ts:86

comments

comments(videoId, nextpage?): Promise<Comments>
Retrieves comments for a specific video.
Parameters
- videoId: string
  
  The ID of the video for which to retrieve comments.
- Optional nextpage: string
  
  The JSON encoded nextpage variable, to be sent as a query string (optional).
Returns Promise<Comments>
A Promise that resolves to the comments for the video.
- Defined in piped-api.ts:58

playlist

playlist(id, nextpage?): Promise<Playlist | NextPagePlaylist>
Retrieves a playlist based on its ID.
Parameters
- id: string
  
  The ID of the playlist to retrieve.
- Optional nextpage: string
  
  The token for the next page of results (optional).
Returns Promise<Playlist | NextPagePlaylist>
A Promise that resolves to a Playlist or NextPagePlaylist object.
- Defined in piped-api.ts:107

search

search(query, filter?): Promise<Search>
Searches videos for a given query with an optional filter.
Parameters
- query: string
  
  The query to search for.
- Optional filter: string = "all"
  
  The optional filter to apply.
Returns Promise<Search>
- A Promise that resolves to the search results.
- Defined in piped-api.ts:149

sponsors

sponsors(id, category?): Promise<Sponsors>
Retrieves sponsors based on the provided ID and category.
Parameters
- id: string
  
  The ID of the video.
- category: string[] = ...
  
  The category of sponsors you would like to skip. Example: ["sponsor"].
Returns Promise<Sponsors>
A promise that resolves to the sponsors.
- Defined in piped-api.ts:133

streams

streams(videoId): Promise<Streams>
Retrieves the streams for a given video ID.
Parameters
- videoId: string
  
  The ID of the video.
Returns Promise<Streams>
A promise that resolves to the streams for the given video ID.
- Defined in piped-api.ts:47

suggestions

suggestions(query): Promise<string[]>
Retrieves suggestions based on the given query.
Parameters
- query: string
  
  The query string to search for suggestions.
Returns Promise<string[]>
A promise that resolves to an array of string suggestions.
- Defined in piped-api.ts:122

trending

trending(region): Promise<Video[]>
Retrieves the trending videos for a specific region.
Parameters
- region: string
  
  The region for which to retrieve trending videos.
Returns Promise<Video[]>
- A promise that resolves to an array of Video objects representing the trending videos.
- Defined in piped-api.ts:37

user

user(name): Promise<Channel>
Retrieves a user by their name.
Parameters
- name: string
  
  The name of the user.
Returns Promise<Channel>
A Promise that resolves to the user's channel.
- Defined in piped-api.ts:96

Generated using TypeDoc