listyoutubevideos - List YouTube Videos
Returns a list of videos that match the API request parameters.
credentialKeystring
Your 1001fx credential key. See https://1001fx.com/app/credentials/list
Example:
yourCredentialKeychartobject
Filters videos based on the chart filter. One of chart, id or myRating needs to be provided.
Example:
{
"chart": "mostPopular",
"regionCode": "DE",
"videoCategoryId": "20"
}chartstring
The chart parameter identifies the chart that you want to retrieve. - mostPopular: Return the most popular videos for the specified content region and video category.
Possible values are: mostPopular
Example:
mostPopularregionCodestring
The regionCode parameter instructs the API to select a video chart available in the specified region. The parameter value is an ISO 3166-1 alpha-2 country code. See https://1001fx.com/functions/listyoutubei18nregions.
Example:
DEvideoCategoryIdstring
The videoCategoryId parameter identifies the video category for which the chart should be retrieved. By default, charts are not restricted to a particular category. The default value is 0.
Example:
DEpageTokenstring
The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
idobject
Filters videos based on the id filter. One of chart, id or myRating needs to be provided.
Example:
{
"videoIds": [
"kJQP7kiw5Fk",
"JGwWNGJdvx8"
]
}videoIdsarray
The videoIds parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the videos ID.
Example:
[
"kJQP7kiw5Fk",
"JGwWNGJdvx8"
]
myRatingobject
Filters videos based on the myRating filter. One of chart, id or myRating needs to be provided.
Example:
{
"myRating": "like",
"maxResults": 2
}myRatingstring
Set this parameters value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user. - dislike: Returns only videos disliked by the authenticated user.. - like: Returns only video liked by the authenticated user.
Possible values are: dislike, like
Example:
likemaxResultsnumber
Specifies the maximum number of items that should be returned in the result set. Defaults to 5.
Minimum: 1
Maximum: 50
Example:
2pageTokenstring
The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
hlstring
The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resources snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resourcess default language. See https://1001fx.com/functions/listyoutubei18nlanguages.
Example:
demaxWidthnumber
The maxWidth parameter specifies the maximum width of the embedded player returned in the player.embedHtml property. You can use this parameter to specify that instead of the default dimensions, the embed code should use a width appropriate for your application layout. If the maxHeight parameter is also provided, the player may be narrower than maxWidth in order to not violate the maximum height.
Minimum: 72
Maximum: 8192
Example:
1920maxHeightnumber
The maxHeight parameter specifies the maximum height of the embedded player returned in the player.embedHtml property. You can use this parameter to specify that instead of the default dimensions, the embed code should use a height appropriate for your application layout. If the maxWidth parameter is also provided, the player may be shorter than the maxHeight in order to not violate the maximum width.
Minimum: 72
Maximum: 8192
Example:
1080Available on
