Name |
|
Description |
|
Required |
|
Restriction |
|
|
sort |
|
Results sort order |
|
false |
|
String matching one of 'most recent', 'most discussed', 'title', 'run length', 'collection position', 'most downloaded', 'top rated', 'most viewed'. At least 1 value. |
|
|
range |
|
Maximum age of results |
|
false |
|
String matching one of 'month', 'today', 'year', 'week'. |
|
|
userQuery |
|
User-entered query |
|
false |
|
String. |
|
|
videoId |
|
Get videos that have these videoIds |
|
false |
|
Integer. At least 1 value. |
|
|
permalink |
|
Get videos that have these permalinks |
|
false |
|
String. At least 1 value. |
|
|
maxContentRating |
|
Maximum content rating |
|
false |
|
Integer. |
|
|
category |
|
Get videos in this category |
|
false |
|
String. At least 1 value. |
|
|
language |
|
Get videos in this language |
|
false |
|
String. At least 1 value. |
|
|
subtitle |
|
Get videos with subtitles in this language |
|
false |
|
String. At least 1 value. |
|
|
metadata |
|
Get videos with this metadata key=value pair |
|
false |
|
String. At least 1 value. |
|
|
excludeMetadata |
|
Get videos excluding this metadata key=value pair |
|
false |
|
String. At least 1 value. |
|
|
publisherName |
|
Get videos by this publisher |
|
false |
|
String. At least 1 value. |
|
|
featured |
|
Featured results |
|
false |
|
Boolean true/false. |
|
|
minAverageRating |
|
Get videos with this average rating or higher |
|
false |
|
Float at least 0.0. |
|
|
maxAverageRating |
|
Get videos with this average rating or lower |
|
false |
|
Float at least 0.0. |
|
|
contentSource |
|
Get videos with this content source |
|
false |
|
String. At least 1 value. |
|
|
collectionPermalink |
|
Get videos from the collection with this permalink |
|
false |
|
String. At least 1 value. |
|
|
excludeCollectionPermalink |
|
Exclude videos in the collection with this permalink |
|
false |
|
String. At least 1 value. |
|
|
tag |
|
Get videos with this tag |
|
false |
|
String. At least 1 value. |
|
|
minLength |
|
Get videos at least this many seconds long |
|
false |
|
Integer. |
|
|
maxLength |
|
Get videos at most this many seconds long |
|
false |
|
Integer. |
|
|
safe |
|
Allow sexy category by setting safe to false |
|
false |
|
Boolean true/false. |
|
|
editorTag |
|
Get videos with this editor tag |
|
false |
|
String. At least 1 value. |
|
|
excludeEditorTag |
|
Exclude videos with this editor tag |
|
false |
|
String. At least 1 value. |
|
|
deviceCompatibility |
|
Get videos playable on this device. |
|
false |
|
String matching one of 'iPod'. |
|
|
maxResults |
|
The maximum number of results to return |
|
false |
|
Integer between 0 and 1000. |
|
|
offset |
|
The offset into the result set to begin returning results |
|
false |
|
Integer at least 0. |
|
|
apiKey |
|
An API key (Complete your developer profile here and a key will be emailed to you) |
|
true |
|
String. |
|
|
|
|
|
|
|
|
|
|
|