Guide to Creating a Custom Search

Note: If the relatedToVideoId parameter is set, the only other supported parameters are regionCode, relevanceLanguage, safeSearch, and fields.

• completed – Only include completed broadcasts.
• live – Only include active broadcasts.
• upcoming – Only include upcoming broadcasts.

• The location parameter value identifies the point at the center of the area.
• The locationRadius parameter specifies the maximum distance that the location associated with a video can be from that point for the video to still be included in the search results.

The API returns an error if your request specifies a value for the location parameter but does not also specify a value for the locationRadius parameter.

The parameter value must be a floating point number followed by a measurement unit. Valid measurement units are m, km, ft, and mi. For example, valid parameter values include 1500m, 5km, 10000ft, and 0.75mi. The API does not support locationRadius parameter values larger than 1000 kilometers.

Note: See the definition of the location parameter for more information.

Acceptable values are:

• date – Resources are sorted in reverse chronological order based on the date they were created.
• rating – Resources are sorted from highest to lowest rating.
• relevance – Resources are sorted based on their relevance to the search query. This is the default value for this parameter.
• title – Resources are sorted alphabetically by title.
• viewCount – Resources are sorted from highest to lowest number of views. For live broadcasts, videos are sorted by number of concurrent viewers while the broadcasts are ongoing.

Your request can also use the Boolean NOT (-) and OR (|) operators to exclude videos or to find videos that are associated with one of several search terms. For example, to search for videos matching either “boating” or “sailing”, set the q parameter value to boating|sailing. Similarly, to search for videos matching either “boating” or “sailing” but not “fishing”, set the q parameter value to boating|sailing -fishing.

Acceptable values are:

• moderate – YouTube will filter some content from search results and, at the least, will filter content that is restricted in your locale. Based on their content, search results could be removed from search results or demoted in search results. This is the default parameter value.
• none – YouTube will not filter the search result set.
• strict – YouTube will try to exclude all restricted content from the search result set. Based on their content, search results could be removed from search results or demoted in search results.

Acceptable values are:

• any – Do not filter results based on caption availability.
• closedCaption – Only include videos that have captions.
• none – Only include videos that do not have captions.

Acceptable values are:

• any – Return all videos, regardless of their resolution.
• high – Only retrieve HD videos.
• standard – Only retrieve videos in standard definition.

Acceptable values are:

• 2d – Restrict search results to exclude 3D videos.
• 3d – Restrict search results to only include 3D videos.
• any – Include both 3D and non-3D videos in returned results. This is the default value.

Acceptable values are:

• any – Do not filter video search results based on their duration. This is the default value.
• long – Only include videos longer than 20 minutes.
• medium – Only include videos that are between four and 20 minutes long (inclusive).
• short – Only include videos that are less than four minutes long.

Acceptable values are:

• any – Return all videos, embeddable or not.
• true – Only retrieve embeddable videos.

Acceptable values are:

• any – Return all videos, regardless of which license they have, that match the query parameters.
• creativeCommon – Only return videos that have a Creative Commons license. Users can reuse videos with this license in other videos that they create. Learn more.
• youtube – Only return videos that have the standard YouTube license.

Acceptable values are:

• any – Return all videos, syndicated or not.
• true – Only retrieve syndicated videos.

Acceptable values are:

• any – Return all videos.
• episode – Only retrieve episodes of shows.
• movie – Only retrieve movies.