piped_api

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.7.0 or later OR Flutter 1.12 or later

Installation & Usage

Github

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

name: piped_api
version: 1.0.0
description: Automatically generated OpenAPI bindings for Piped.
dependencies:
  piped_api:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      version: 'any'

Local

To use the package in 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/api.dart';


final api = UnauthenticatedApi();
final 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 (e) {
    print("Exception when calling UnauthenticatedApi->channelInfoId: $e\n");
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
UnauthenticatedApi	channelInfoId	GET /channel/{channelId}	Gets Channel Information
UnauthenticatedApi	channelInfoName	GET /c/{name}	Gets Channel Information
UnauthenticatedApi	channelInfoUsername	GET /user/{username}	Gets Channel Information
UnauthenticatedApi	streamInfo	GET /streams/{videoId}	Gets Video Information
UnauthenticatedApi	trending	GET /trending	Gets all Trending Videos

Documentation For Models

• ChannelInfo
• ExceptionError
• Regions
• Stream
• StreamItem
• Subtitle
• VideoInfo

Documentation For Authorization

All endpoints do not require authorization.

Author

kavin@kavin.rocks