piped_dart/doc/ChannelApi.md

piped_api.api.ChannelApi

Load the API package

import 'package:piped_api/api.dart';

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

Method	HTTP request	Description
channelInfoId	GET /channel/{channelId}	Gets Channel Information from ID.
channelInfoName	GET /c/{name}	Gets Channel Information from name.
channelInfoUsername	GET /user/{username}	Gets Channel Information from username.
channelNextPage	GET /nextpage/channel/{channelId}	Gets more channel videos

channelInfoId

ChannelInfo channelInfoId(channelId)

Gets Channel Information from ID.

Gets all available Channel information about a channel.

Example

import 'package:piped_api/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 = api.channelInfoId(channelId);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ChannelApi->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

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

channelInfoName

ChannelInfo channelInfoName(name)

Gets Channel Information from name.

Gets all available Channel information about a channel.

Example

import 'package:piped_api/api.dart';

final api = PipedApi().getChannelApi();
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 ChannelApi->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

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

channelInfoUsername

ChannelInfo channelInfoUsername(username)

Gets Channel Information from username.

Gets all available Channel information about a channel.

Example

import 'package:piped_api/api.dart';

final api = PipedApi().getChannelApi();
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 ChannelApi->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

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

channelNextPage

StreamsPage channelNextPage(channelId, nextpage)

Gets more channel videos

Gets more channel videos.

Example

import 'package:piped_api/api.dart';

final api = PipedApi().getChannelApi();
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 ChannelApi->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

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]