README.md

piped_api (EXPERIMENTAL)

This is an API specification for Piped API instances.

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Build package: org.openapitools.codegen.languages.DartDioClientCodegen For more information, please visit https://github.com/TeamPiped/Piped/issues

Requirements

• Dart 2.15.0+ or Flutter 2.8.0+
• Dio 5.0.0+ (https://pub.dev/packages/dio)

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  piped_api: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  piped_api:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  piped_api:
    path: /path/to/piped_api

Getting Started

Please follow the installation procedure and then run the following:

import 'package:piped_api/piped_api.dart';


final api = PipedApi().getChannelApi();
final String channelId = UCs6KfncB4OV6Vug4o_bzijg; // String | The channel ID of the YouTube channel you want to get information about.

try {
    final response = await api.channelInfoId(channelId);
    print(response);
} catch on DioError (e) {
    print("Exception when calling ChannelApi->channelInfoId: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://pipedapi.kavin.rocks

Class	Method	HTTP request	Description
ChannelApi	channelInfoId	GET /channel/{channelId}	Gets Channel Information from ID.
ChannelApi	channelInfoName	GET /c/{name}	Gets Channel Information from name.
ChannelApi	channelInfoUsername	GET /user/{username}	Gets Channel Information from username.
ChannelApi	channelNextPage	GET /nextpage/channel/{channelId}	Gets more channel videos
FeedApi	feedUnauthenticated	GET /feed/unauthenticated	Generate a feed while unauthenticated, from a list of channelIds.
SearchApi	search	GET /search	Searches for videos, channels, and playlists.
SearchApi	searchNextPage	GET /nextpage/search	Gets more search results
UnauthenticatedApi	channelInfoId	GET /channel/{channelId}	Gets Channel Information from ID.
UnauthenticatedApi	channelInfoName	GET /c/{name}	Gets Channel Information from name.
UnauthenticatedApi	channelInfoUsername	GET /user/{username}	Gets Channel Information from username.
UnauthenticatedApi	channelNextPage	GET /nextpage/channel/{channelId}	Gets more channel videos
UnauthenticatedApi	comments	GET /comments/{videoId}	Gets Comments
UnauthenticatedApi	commentsNextPage	GET /nextpage/comments/{videoId}	Gets more comments
UnauthenticatedApi	feedUnauthenticated	GET /feed/unauthenticated	Generate a feed while unauthenticated, from a list of channelIds.
UnauthenticatedApi	search	GET /search	Searches for videos, channels, and playlists.
UnauthenticatedApi	searchNextPage	GET /nextpage/search	Gets more search results
UnauthenticatedApi	streamInfo	GET /streams/{videoId}	Gets Video Information
UnauthenticatedApi	trending	GET /trending	Gets all Trending Videos
VideoApi	comments	GET /comments/{videoId}	Gets Comments
VideoApi	commentsNextPage	GET /nextpage/comments/{videoId}	Gets more comments
VideoApi	streamInfo	GET /streams/{videoId}	Gets Video Information

Documentation For Models

• ChannelInfo
• ChannelItem
• Comment
• CommentsPage
• ExceptionError
• PlaylistItem
• Regions
• SearchFilter
• SearchItem
• SearchPage
• Stream
• StreamItem
• StreamsPage
• Subtitle
• VideoInfo

Documentation For Authorization

Endpoints do not require authorization.

Author

[email protected]