2022-06-17 13:18:44 +00:00
# piped_api (EXPERIMENTAL)
2022-02-06 12:22:59 +00:00
This is an API specification for Piped API instances.
This Dart package is automatically generated by the [OpenAPI Generator ](https://openapi-generator.tech ) project:
- API version: 1.0.0
2022-06-17 13:18:44 +00:00
- Build package: org.openapitools.codegen.languages.DartDioNextClientCodegen
2022-02-06 12:22:59 +00:00
For more information, please visit [https://github.com/TeamPiped/Piped/issues ](https://github.com/TeamPiped/Piped/issues )
## Requirements
2022-06-17 13:18:44 +00:00
* Dart 2.12.0 or later OR Flutter 1.26.0 or later
* Dio 4.0.0+
2022-02-06 12:22:59 +00:00
## Installation & Usage
2022-06-17 13:18:44 +00:00
### pub.dev
To use the package from [pub.dev ](https://pub.dev ), please include the following in pubspec.yaml
```yaml
dependencies:
piped_api: 1.0.0
```
2022-02-06 12:22:59 +00:00
### Github
If this Dart package is published to Github, please include the following in pubspec.yaml
2022-06-17 13:18:44 +00:00
```yaml
2022-02-06 12:22:59 +00:00
dependencies:
piped_api:
2022-06-17 13:18:44 +00:00
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
#ref: main
2022-02-06 12:22:59 +00:00
```
2022-06-17 13:18:44 +00:00
### Local development
To use the package from your local drive, please include the following in pubspec.yaml
```yaml
2022-02-06 12:22:59 +00:00
dependencies:
piped_api:
path: /path/to/piped_api
```
## Getting Started
Please follow the [installation procedure ](#installation--usage ) and then run the following:
```dart
2022-06-17 13:18:44 +00:00
import 'package:piped_api/piped_api.dart';
2022-02-06 12:22:59 +00:00
2022-06-17 13:18:44 +00:00
final api = PipedApi().getUnauthenticatedApi();
final String channelId = UCs6KfncB4OV6Vug4o_bzijg; // String | The channel ID of the YouTube channel you want to get information about.
2022-02-06 12:22:59 +00:00
try {
final response = await api.channelInfoId(channelId);
print(response);
2022-06-17 13:18:44 +00:00
} catch on DioError (e) {
2022-02-06 12:22:59 +00:00
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
------------ | ------------- | ------------- | -------------
2022-06-17 13:18:44 +00:00
[*UnauthenticatedApi* ](doc/UnauthenticatedApi.md ) | [**channelInfoId** ](doc/UnauthenticatedApi.md#channelinfoid ) | **GET** /channel/{channelId} | Gets Channel Information
[*UnauthenticatedApi* ](doc/UnauthenticatedApi.md ) | [**channelInfoName** ](doc/UnauthenticatedApi.md#channelinfoname ) | **GET** /c/{name} | Gets Channel Information
[*UnauthenticatedApi* ](doc/UnauthenticatedApi.md ) | [**channelInfoUsername** ](doc/UnauthenticatedApi.md#channelinfousername ) | **GET** /user/{username} | Gets Channel Information
[*UnauthenticatedApi* ](doc/UnauthenticatedApi.md ) | [**channelNextPage** ](doc/UnauthenticatedApi.md#channelnextpage ) | **GET** /nextpage/channel/{channelId} | Gets more channel videos
2022-06-25 09:55:47 +00:00
[*UnauthenticatedApi* ](doc/UnauthenticatedApi.md ) | [**comments** ](doc/UnauthenticatedApi.md#comments ) | **GET** /comments/{videoId} | Gets Comments
[*UnauthenticatedApi* ](doc/UnauthenticatedApi.md ) | [**commentsNextPage** ](doc/UnauthenticatedApi.md#commentsnextpage ) | **GET** /nextpage/comments/{videoId} | Gets more comments
2022-07-07 17:34:25 +00:00
[*UnauthenticatedApi* ](doc/UnauthenticatedApi.md ) | [**search** ](doc/UnauthenticatedApi.md#search ) | **GET** /search | Searches for videos, channels, and playlists.
[*UnauthenticatedApi* ](doc/UnauthenticatedApi.md ) | [**searchNextPage** ](doc/UnauthenticatedApi.md#searchnextpage ) | **GET** /nextpage/search | Gets more search results
2022-06-17 13:18:44 +00:00
[*UnauthenticatedApi* ](doc/UnauthenticatedApi.md ) | [**streamInfo** ](doc/UnauthenticatedApi.md#streaminfo ) | **GET** /streams/{videoId} | Gets Video Information
[*UnauthenticatedApi* ](doc/UnauthenticatedApi.md ) | [**trending** ](doc/UnauthenticatedApi.md#trending ) | **GET** /trending | Gets all Trending Videos
2022-02-06 12:22:59 +00:00
## Documentation For Models
- [ChannelInfo ](doc/ChannelInfo.md )
2022-07-07 17:34:25 +00:00
- [ChannelItem ](doc/ChannelItem.md )
2022-06-25 09:55:47 +00:00
- [Comment ](doc/Comment.md )
- [CommentsPage ](doc/CommentsPage.md )
2022-02-06 12:22:59 +00:00
- [ExceptionError ](doc/ExceptionError.md )
2022-07-07 17:34:25 +00:00
- [PlaylistItem ](doc/PlaylistItem.md )
2022-02-06 12:22:59 +00:00
- [Regions ](doc/Regions.md )
2022-07-07 17:34:25 +00:00
- [SearchFilter ](doc/SearchFilter.md )
- [SearchItem ](doc/SearchItem.md )
- [SearchPage ](doc/SearchPage.md )
2022-02-06 12:22:59 +00:00
- [Stream ](doc/Stream.md )
- [StreamItem ](doc/StreamItem.md )
2022-06-17 13:18:44 +00:00
- [StreamsPage ](doc/StreamsPage.md )
2022-02-07 13:25:54 +00:00
- [Subtitle ](doc/Subtitle.md )
2022-02-06 12:22:59 +00:00
- [VideoInfo ](doc/VideoInfo.md )
## Documentation For Authorization
All endpoints do not require authorization.
## Author
kavin@kavin.rocks