mirror of
https://github.com/TeamPiped/piped_dart.git
synced 2024-08-14 22:27:49 +00:00
507 lines
15 KiB
Markdown
507 lines
15 KiB
Markdown
# piped_api.api.UnauthenticatedApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *https://pipedapi.kavin.rocks*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**channelInfoId**](UnauthenticatedApi.md#channelinfoid) | **GET** /channel/{channelId} | Gets Channel Information from ID.
|
|
[**channelInfoName**](UnauthenticatedApi.md#channelinfoname) | **GET** /c/{name} | Gets Channel Information from name.
|
|
[**channelInfoUsername**](UnauthenticatedApi.md#channelinfousername) | **GET** /user/{username} | Gets Channel Information from username.
|
|
[**channelNextPage**](UnauthenticatedApi.md#channelnextpage) | **GET** /nextpage/channel/{channelId} | Gets more channel videos
|
|
[**comments**](UnauthenticatedApi.md#comments) | **GET** /comments/{videoId} | Gets Comments
|
|
[**commentsNextPage**](UnauthenticatedApi.md#commentsnextpage) | **GET** /nextpage/comments/{videoId} | Gets more comments
|
|
[**feedUnauthenticated**](UnauthenticatedApi.md#feedunauthenticated) | **GET** /feed/unauthenticated | Generate a feed while unauthenticated, from a list of channelIds.
|
|
[**search**](UnauthenticatedApi.md#search) | **GET** /search | Searches for videos, channels, and playlists.
|
|
[**searchNextPage**](UnauthenticatedApi.md#searchnextpage) | **GET** /nextpage/search | Gets more search results
|
|
[**streamInfo**](UnauthenticatedApi.md#streaminfo) | **GET** /streams/{videoId} | Gets Video Information
|
|
[**trending**](UnauthenticatedApi.md#trending) | **GET** /trending | Gets all Trending Videos
|
|
|
|
|
|
# **channelInfoId**
|
|
> ChannelInfo channelInfoId(channelId)
|
|
|
|
Gets Channel Information from ID.
|
|
|
|
Gets all available Channel information about a channel.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
|
|
final api = PipedApi().getUnauthenticatedApi();
|
|
final String channelId = UCs6KfncB4OV6Vug4o_bzijg; // String | The channel ID of the YouTube channel you want to get information about.
|
|
|
|
try {
|
|
final response = api.channelInfoId(channelId);
|
|
print(response);
|
|
} catch on DioError (e) {
|
|
print('Exception when calling UnauthenticatedApi->channelInfoId: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**channelId** | **String**| The channel ID of the YouTube channel you want to get information about. |
|
|
|
|
### Return type
|
|
|
|
[**ChannelInfo**](ChannelInfo.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **channelInfoName**
|
|
> ChannelInfo channelInfoName(name)
|
|
|
|
Gets Channel Information from name.
|
|
|
|
Gets all available Channel information about a channel.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
|
|
final api = PipedApi().getUnauthenticatedApi();
|
|
final String name = Dream; // String | The name of the YouTube channel you want to get information about.
|
|
|
|
try {
|
|
final response = api.channelInfoName(name);
|
|
print(response);
|
|
} catch on DioError (e) {
|
|
print('Exception when calling UnauthenticatedApi->channelInfoName: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **String**| The name of the YouTube channel you want to get information about. |
|
|
|
|
### Return type
|
|
|
|
[**ChannelInfo**](ChannelInfo.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **channelInfoUsername**
|
|
> ChannelInfo channelInfoUsername(username)
|
|
|
|
Gets Channel Information from username.
|
|
|
|
Gets all available Channel information about a channel.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
|
|
final api = PipedApi().getUnauthenticatedApi();
|
|
final String username = DreamTraps; // String | The username of the YouTube channel you want to get information about.
|
|
|
|
try {
|
|
final response = api.channelInfoUsername(username);
|
|
print(response);
|
|
} catch on DioError (e) {
|
|
print('Exception when calling UnauthenticatedApi->channelInfoUsername: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**username** | **String**| The username of the YouTube channel you want to get information about. |
|
|
|
|
### Return type
|
|
|
|
[**ChannelInfo**](ChannelInfo.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **channelNextPage**
|
|
> StreamsPage channelNextPage(channelId, nextpage)
|
|
|
|
Gets more channel videos
|
|
|
|
Gets more channel videos.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
|
|
final api = PipedApi().getUnauthenticatedApi();
|
|
final String channelId = UCs6KfncB4OV6Vug4o_bzijg; // String | The channel ID of the YouTube channel you want to get more videos from.
|
|
final String nextpage = nextpage_example; // String | The next page token to get more videos from.
|
|
|
|
try {
|
|
final response = api.channelNextPage(channelId, nextpage);
|
|
print(response);
|
|
} catch on DioError (e) {
|
|
print('Exception when calling UnauthenticatedApi->channelNextPage: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**channelId** | **String**| The channel ID of the YouTube channel you want to get more videos from. |
|
|
**nextpage** | **String**| The next page token to get more videos from. |
|
|
|
|
### Return type
|
|
|
|
[**StreamsPage**](StreamsPage.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **comments**
|
|
> CommentsPage comments(videoId)
|
|
|
|
Gets Comments
|
|
|
|
Gets the comments for a video.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
|
|
final api = PipedApi().getUnauthenticatedApi();
|
|
final String videoId = dQw4w9WgXcQ; // String | The video ID of the YouTube video you want to get comments from.
|
|
|
|
try {
|
|
final response = api.comments(videoId);
|
|
print(response);
|
|
} catch on DioError (e) {
|
|
print('Exception when calling UnauthenticatedApi->comments: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**videoId** | **String**| The video ID of the YouTube video you want to get comments from. |
|
|
|
|
### Return type
|
|
|
|
[**CommentsPage**](CommentsPage.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **commentsNextPage**
|
|
> CommentsPage commentsNextPage(videoId, nextpage)
|
|
|
|
Gets more comments
|
|
|
|
Gets more comments.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
|
|
final api = PipedApi().getUnauthenticatedApi();
|
|
final String videoId = dQw4w9WgXcQ; // String | The video ID of the YouTube video you want to get more comments from.
|
|
final String nextpage = nextpage_example; // String | The next page token to get more comments from.
|
|
|
|
try {
|
|
final response = api.commentsNextPage(videoId, nextpage);
|
|
print(response);
|
|
} catch on DioError (e) {
|
|
print('Exception when calling UnauthenticatedApi->commentsNextPage: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**videoId** | **String**| The video ID of the YouTube video you want to get more comments from. |
|
|
**nextpage** | **String**| The next page token to get more comments from. |
|
|
|
|
### Return type
|
|
|
|
[**CommentsPage**](CommentsPage.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **feedUnauthenticated**
|
|
> BuiltList<StreamItem> feedUnauthenticated(channels)
|
|
|
|
Generate a feed while unauthenticated, from a list of channelIds.
|
|
|
|
Generates a user feed while unauthenticated.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
|
|
final api = PipedApi().getUnauthenticatedApi();
|
|
final BuiltList<String> channels = ["UCs6KfncB4OV6Vug4o_bzijg","UClcE-kVhqyiHCcjYwcpfj9w"]; // BuiltList<String> | A list of channelIds to generate a feed from.
|
|
|
|
try {
|
|
final response = api.feedUnauthenticated(channels);
|
|
print(response);
|
|
} catch on DioError (e) {
|
|
print('Exception when calling UnauthenticatedApi->feedUnauthenticated: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**channels** | [**BuiltList<String>**](String.md)| A list of channelIds to generate a feed from. |
|
|
|
|
### Return type
|
|
|
|
[**BuiltList<StreamItem>**](StreamItem.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **search**
|
|
> SearchPage search(q, filter)
|
|
|
|
Searches for videos, channels, and playlists.
|
|
|
|
Searches for videos, channels, and playlists.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
|
|
final api = PipedApi().getUnauthenticatedApi();
|
|
final String q = Techlore; // String | The search query string.
|
|
final SearchFilter filter = ; // SearchFilter | The filter parameter specifies a filter query that restricts the results to items that match the filter.
|
|
|
|
try {
|
|
final response = api.search(q, filter);
|
|
print(response);
|
|
} catch on DioError (e) {
|
|
print('Exception when calling UnauthenticatedApi->search: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**q** | **String**| The search query string. |
|
|
**filter** | [**SearchFilter**](.md)| The filter parameter specifies a filter query that restricts the results to items that match the filter. |
|
|
|
|
### Return type
|
|
|
|
[**SearchPage**](SearchPage.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **searchNextPage**
|
|
> SearchPage searchNextPage(nextpage, q, filter)
|
|
|
|
Gets more search results
|
|
|
|
Gets more search results.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
|
|
final api = PipedApi().getUnauthenticatedApi();
|
|
final String nextpage = nextpage_example; // String | The next page token to get more search results from.
|
|
final String q = Techlore; // String | The search query string.
|
|
final SearchFilter filter = ; // SearchFilter | The filter parameter specifies a filter query that restricts the results to items that match the filter.
|
|
|
|
try {
|
|
final response = api.searchNextPage(nextpage, q, filter);
|
|
print(response);
|
|
} catch on DioError (e) {
|
|
print('Exception when calling UnauthenticatedApi->searchNextPage: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**nextpage** | **String**| The next page token to get more search results from. |
|
|
**q** | **String**| The search query string. |
|
|
**filter** | [**SearchFilter**](.md)| The filter parameter specifies a filter query that restricts the results to items that match the filter. |
|
|
|
|
### Return type
|
|
|
|
[**SearchPage**](SearchPage.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **streamInfo**
|
|
> VideoInfo streamInfo(videoId)
|
|
|
|
Gets Video Information
|
|
|
|
Gets all available Stream information about a video.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
|
|
final api = PipedApi().getUnauthenticatedApi();
|
|
final String videoId = dQw4w9WgXcQ; // String | The video ID of the YouTube video you want to get information about.
|
|
|
|
try {
|
|
final response = api.streamInfo(videoId);
|
|
print(response);
|
|
} catch on DioError (e) {
|
|
print('Exception when calling UnauthenticatedApi->streamInfo: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**videoId** | **String**| The video ID of the YouTube video you want to get information about. |
|
|
|
|
### Return type
|
|
|
|
[**VideoInfo**](VideoInfo.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **trending**
|
|
> BuiltList<StreamItem> trending(region)
|
|
|
|
Gets all Trending Videos
|
|
|
|
Gets all Trending Videos in the requested country.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:piped_api/api.dart';
|
|
|
|
final api = PipedApi().getUnauthenticatedApi();
|
|
final Regions region = US; // Regions | The Region to get trending videos from.
|
|
|
|
try {
|
|
final response = api.trending(region);
|
|
print(response);
|
|
} catch on DioError (e) {
|
|
print('Exception when calling UnauthenticatedApi->trending: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**region** | [**Regions**](.md)| The Region to get trending videos from. |
|
|
|
|
### Return type
|
|
|
|
[**BuiltList<StreamItem>**](StreamItem.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|