Filters are used to refine your search results when working with the video object. This page provides the complete list of supported video filters.
API v2 now availableVisit the API v2 documentation or follow the migration guide to upgrade.
| Fields | Description |
|---|---|
360_degree | Limit the result set to 360 videos. |
advertising_instream_blocked | Limit the result set to advertising_instream_blocked |
allowed_in_playlists | Limit the results to videos which are allowed in playlists. |
availability | Limit the result set to available videos. |
channel | Limit the result set to this category. |
country | Limit the result set to this country (declarative). |
created_after | Limit the result set to videos created after this date and time. |
created_before | Limit the result set to videos created before this date and time. |
exclude_channel_ids | List of channels ids to exclude from the result set. |
exclude_ids | List of video ids to exclude from the result set. |
explicit | Limit the result set to the provided explicit value for videos. |
exportable | Limit the result set to exportable (i.e: no-export flag not set) videos. |
featured | Limit the result set to featured videos. |
flags | List of simple boolean flags available to reduce the result set. |
has_game | Limit the result set to videos related to a video-game. |
hd | Limit the result set to high definition videos (vertical resolution greater than or equal to 720p). |
ids | Limit the result set to this list of video identifiers (works only with xIDs). |
in_history | Limit the result set to videos in your watch history. |
is_created_for_kids | Limit the result set to the provided is_created_for_kids value for videos. |
languages | Limit the result set to this list of languages. |
limit | Limits the number of results per page. Max: 100 |
list | Limit the result set to this video list. Warning: Can not be combined with a search. |
live | Limit the result set to live streaming videos. |
live_offair | Limit the result set to off-air live streaming videos. |
live_onair | Limit the result set to on-air live streaming videos. |
live_upcoming | Limit the result set to upcoming live streaming videos. |
longer_than | Limit the results to videos with a duration longer than or equal to the specified number of minutes. |
mode | Limit the result set to videos of this mode. |
no_live | Limit the result set to non-live streaming videos. |
no_live_recording | Limit the result set to live recording videos. |
no_premium | Limit the result set to free video content. |
nogenre | Limit the result set by excluding this genre. |
owners | Limit the result set to this list of user identifiers or logins. |
page | The page number to load. Allows to navigate from one page to the other when the results are on several pages. Max: 10 if limit=100Depends if has_more at the top of the page is true or false |
partner | Limit the result set to partner videos. |
password_protected | Limit the result set to password protected partner videos. |
premium | Limit the result set to premium SVOD and TVOD video content. |
private | Limit the result set to private videos. |
related_videos_algorithm | Forces the recommendation result to use a specfic algorithm |
search | Limit the result set to this full text search. |
shorter_than | Limit the results to videos with a duration shorter than or equal to the specified number of minutes. |
sort | Change the default result set ordering. |
timeframe | Limit the result set to videos created after this N last seconds. |
ugc | Limit the result set to user generated video content (no partner content). |
ugc_partner | Limit the result set to user generated or partner video content. |
unpublished | Limit the result set to unpublished videos. |
verified | Limit the result set to verified partner videos. |
360_degree
360_degreeLimit the result set to 360 videos.
| Type | Sample value |
|---|---|
| flag | n/a |
advertising_instream_blocked
advertising_instream_blockedLimit the result set to advertising_instream_blocked.
| Type | Sample value |
|---|---|
| boolean | true or false |
allowed_in_playlists
allowed_in_playlistsLimit the results to videos which are allowed in playlists.
| Type | Sample value |
|---|---|
| boolean | true or false |
availability
availabilityLimit the result set to available videos.
| Type | Sample value |
|---|---|
| boolean | true or false |
channel
channelLimit the result set to this category.
| Type | Sample value |
|---|---|
| object | newsList of all categories. |
country
countryLimit the result set to this country (declarative).
Min length: 1
Max length: 150
| Type | Sample value |
|---|---|
| string | US |
created_after
created_afterLimit the result set to videos after this date and time.
| Type | Sample value |
|---|---|
| date | 1287507036 |
created_before
created_beforeLimit the result set to videos created before this date and time.
| Type | Sample value |
|---|---|
| date | 1287507036 |
exclude_channel_ids
exclude_channel_idsList of categories to exclude from the result set.
| Type | Sample value |
|---|---|
| array | [people,fun,school]List of all categories . |
exclude_ids
exclude_idsList of video ids to exclude from the result set.
| Type | Sample value |
|---|---|
| array | [xk2k3,x26m1j4,xkeg4] |
explicit
explicitLimit the result set to the provided explicit value for videos.
| Type | Sample value |
|---|---|
| boolean | true or false |
exportable
exportableLimit the result set to exportable (i.e: no-export flag not set) videos.
| Type | Sample value |
|---|---|
| flag | n/a |
featured
featuredLimit the result set to featured videos.
| Type | Sample value |
|---|---|
| flag | n/a |
flags
flagsList of simple boolean flags available to reduce the result set.
| Type | Allowed values |
|---|---|
| array | featured, hd, bypass_visibility_check, public, no_geoblock, no_hd, ugc, ugc_partner, live, no_live, live_onair, live_offair, live_upcoming, no_live_recording, has_game, premium, no_premium, in_history, no_repost, not_claimed, 360_degree, availability, hero, repost, is_created_for_kids, is_podcast_episode, explicit, private, unpublished, poster, no_explicit, no_poster, exportable, is_vertical, allowed_in_playlists, advertising_instream_blocked, partner, verified, password_protected |
has_game
has_gameLimit the result set to videos related to a video-game.
| Type | Sample value |
|---|---|
| flag | n/a |
hd
hdLimit the result set to high definition videos (vertical resolution greater than or equal to 720p).
| Type | Sample value |
|---|---|
| flag | n/a |
ids
idsLimit the result set to this list of video identifiers (works only with xIDs).
| Type | Sample value |
|---|---|
| array | [xk2k3,x26m1j4,xkeg4] |
in_history
in_historyLimit the result set to videos in your watch history.
| Type | Sample value |
|---|---|
| flag | n/a |
is_created_for_kids
is_created_for_kidsLimit the result set to the provided is_created_for_kids value for videos.
| Type | Sample value |
|---|---|
| boolean | true or false |
languages
languagesLimit the result set to this list of languages.
Min length: 1
Max length: 150
| Type | Sample value |
|---|---|
| array | [fr,en,it] |
limit
limitLimits the number of results per page.
Max: 100
| Type | Sample value |
|---|---|
| number | 50 |
list
listLimit the result set to this video list.
Warning: Can not be combined with a search.
| Type | Allowed values |
|---|---|
| string | what-to-watch or recommended |
live
liveLimit the result set to live streaming videos.
| Type | Sample value |
|---|---|
| flag | n/a |
live_offair
live_offairLimit the result set to off-air live streaming videos.
| Type | Sample value |
|---|---|
| flag | n/a |
live_onair
live_onairLimit the result set to on-air live streaming videos.
| Type | Sample value |
|---|---|
| flag | n/a |
live_upcoming
live_upcomingLimit the result set to upcoming live streaming videos.
| Type | Sample value |
|---|---|
| flag | n/a |
longer_than
longer_thanLimit the results to videos with a duration longer than or equal to the specified number of minutes.
Min value: 0
| Type | Sample value |
|---|---|
| number | 3600 |
mode
modeLimit the result set to videos of this mode.
| Type | Allowed values |
|---|---|
| string | vod or live |
no_live
no_liveLimit the result set to non-live streaming videos.
| Type | Sample value |
|---|---|
| flag | n/a |
no_live_recording
no_live_recordingLimit the result set to live recording videos.
| Type | Sample value |
|---|---|
| flag | n/a |
no_premium
no_premiumLimit the result set to free video content.
| Type | Sample value |
|---|---|
| flag | n/a |
nogenre
nogenreLimit the result set by excluding this genre.
Min length: 1
Max length: 150
| Type | Allowed values |
|---|---|
| string | Comedy |
owners
ownersLimit the result set to this list of user identifiers or logins.
Min length: 1
Max length: 150
| Type | Allowed values |
|---|---|
| array | user1,user2,user3 |
page
pageThe page number to load. Allows to navigate from one page to the other when the results are on several pages.
Max: 10 if limit=100
Depends if has_more at the top of the page is true or false
| Type | Sample value |
|---|---|
| number | 1 |
partner
partnerLimit the result set to partner videos.
| Type | Sample value |
|---|---|
| flag | n/a |
password_protected
password_protectedLimit the result set to password protected partner videos.
| Type | Sample value |
|---|---|
| boolean | true or false |
premium
premiumLimit the result set to premium SVOD and TVOD video content.
| Type | Sample value |
|---|---|
| flag | n/a |
private
privateLimit the result set to private videos.
| Type | Sample value |
|---|---|
| boolean | true or false |
related_videos_algorithm
related_videos_algorithmForces the recommendation result to use a specific algorithm.
Min length: 1
Max length: 150
| Type | Allowed values |
|---|---|
| string | uploader-only, uploader-with-siblings, uploader-with-parent or uploader-with-children |
search
searchLimit the result set to this full text search.
Min length: 1
Max length: 150
| Type | Sample value |
|---|---|
| string | football |
shorter_than
shorter_thanLimit the results to videos with a duration shorter than or equal to the specified number of minutes.
Min length: 0
| Type | Sample values |
|---|---|
| number | 60 |
sort
sortChange the default result set ordering.
| Type | Allowed values |
|---|---|
| string | recent, visited, visited-hour, visited-today, visited-week, visited-month, relevance, random, trending, old, live-audience, least-visited, live-airing-time or id-asc |
timeframe
timeframeLimit the result set to videos created after this N last seconds.
Min value: 0
| Type | Sample values |
|---|---|
| number | 86400 |
ugc
ugcLimit the result set to user generated video content (no partner content).
| Type | Sample value |
|---|---|
| flag | n/a |
ugc_partner
ugc_partnerLimit the result set to user generated or partner video content.
| Type | Sample value |
|---|---|
| flag | n/a |
unpublished
unpublishedLimit the result set to unpublished videos.
| Type | Sample value |
|---|---|
| boolean | true or false |
verified
verifiedLimit the result set to verified partner videos.
| Type | Sample value |
|---|---|
| flag | n/a |