API Query Parameters

This page lists standard MOVIECLIPS API parameters and custom parameters that the MOVIECLIPS API supports. For example, a request to the following URL searches for the second set of 10 videos matching the query term “car”.

http://api.movieclips.com/v2/search/videos?
    q=car
    &offset=10
    &count=10

Standard API Query Parameters

The MOVIECLIPS API supports the following standard query parameters.

Name	Definition
count	The count parameter specifies the maximum number of results that should be included in the result set. This parameter works in conjunction with the offset parameter to determine which results to return. For example, to request the second set of 10 results – i.e. results 11-20 – set the count parameter to 10 and the ofset parameter to 10. The default value of this parameter is 25.
offset	The offset parameter specifies the index of the first matching result that should be included in the result set. This parameter uses a zero-based index, meaning the first result is 0, the second result is 1 and so forth. This parameter works in conjunction with the count parameter to determine which results to return. For example, to request the second set of 10 results – i.e. results 11-20 – set the offset parameter to 10 and the count parameter to 10.

Custom Parameters

In addition to the standard query parameters, the MOVIECLIPS API defines the following API-specific query parameters:

• Search Parameters
  • q
• Additional parameters for video and data feeds
  • filter_by

Name	Definition
filter_by	The filter_by parameter allows you to limit the type of video objects returned in you result set. Valid values for this parameter are clip, trailer, mashups and top-ten. Also valid is to pass a comma delimited list of values. For example, if you wanted the result set to be filtered to just include clips and trailers, you wouldd append this to the requested url ?filter_by=clip,trailer. The default behavior is to include all types.
q	The q parameter specifies a search query term. MOVIECLIPS will search all video metadata for videos matching the term. Video metadata includes titles, keywords, descriptions, people, dialogue and metadata categories. Note that any spaces, quotes or other punctuation in the parameter value must be URL-escaped. To search for an exact phrase, enclose the phrase in quotation marks. For example, to search for videos matching the phrase “brad pitt”, set the q parameter to %22brad%20pitt%22.