v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-10-3183068.7 KB
shows

Search Shows by filters

Search through the catalog of the given streaming services in the given country. Provides filters such as show language, genres, keyword and release year. Output includes all the information about the shows, such as title, IMDb ID, TMDb ID, release year, deep links to streaming services, available subtitles, audios, available video quality and many more! Apart from the info about the given country-service combinations, output also includes information about streaming availability in the other services for the given country. Streaming availability info from the other countries are not included in the response.

When show_type is movie or series_granularity is show, items per page is 20. When show_type is series and series_granularity is episode items per page is 10. Otherwise, items per page is 15.

get/shows/search/filters

Query parameters

countrystring required

ISO 3166-1 alpha-2 code of the target country. See /countries endpoint to get the list of supported countries.

catalogsstring[]

A comma separated list of up to 32 catalogs to search in. See /countries endpoint to get the supported services in each country and their ids.

When multiple catalogs are passed as a comma separated list, any show that is in at least one of the catalogs will be included in the result.

If no catalogs are passed, the endpoint will search in all the available catalogs in the country.

Syntax of the catalogs supplied in the list can be as the followings:

  • <sevice_id>: Searches in the entire catalog of that service, including (if applicable) rentable, buyable shows or shows available through addons e.g. netflix, prime, apple

  • <sevice_id>.<streaming_option_type>: Only returns the shows that are available in that service with the given streaming option type. Valid streaming option types are subscription, free, rent, buy and addon e.g. peacock.free only returns the shows on Peacock that are free to watch, prime.subscription only returns the shows on Prime Video that are available to watch with a Prime subscription. hulu.addon only returns the shows on Hulu that are available via an addon, prime.rent only returns the shows on Prime Video that are rentable.

  • <sevice_id>.addon.<addon_id>: Only returns the shows that are available in that service with the given addon. Check /countries endpoint to fetch the available addons for a service in each country. Some sample values are: hulu.addon.hbo, prime.addon.hbomaxus.

output_language'en' | 'es' | 'tr' | 'fr'

ISO 639-1 code of the output language. Determines in which language the output will be in.

show_type'movie' | 'series'

Type of a show.

Type of shows to search in. If not supplied, both movies and series will be included in the search results.

genresGenreId[]

A comma seperated list of genre ids to only search within the shows in those genre. See /genres endpoint to see the available genres and their ids. Use genres_relation parameter to specify between returning shows that have at least one of the given genres or returning shows that have all of the given genres.

genres_relation'and' | 'or'

Only used when there are multiple genres supplied in genres parameter.

When or, the endpoint returns any show that has at least one of the given genres. When and, it only returns the shows that have all of the given genres.

show_original_languagestring

ISO 639-1 language code to only search within the shows whose original language matches with the provided language.

year_mininteger

Minimum release/air year of the shows.

year_maxinteger

Maximum release/air year of the shows.

rating_mininteger

Minimum rating of the shows.

rating_maxinteger

Maximum rating of the shows.

keywordstring

A keyword to only search within the shows have that keyword in their overview or title.

series_granularity'show' | 'season' | 'episode'

series_granularity determines the level of detail for series. It does not affect movies.

If series_granularity is show, then the output will not include season and episode info.

If series_granularity is season, then the output will include season info but not episode info.

If series_granularity is episode, then the output will include season and episode info.

If you do not need season and episode info, then it is recommended to set series_granularity as show to reduce the size of the response and increase the performance of the endpoint.

If you need deep links for individual seasons and episodes, then you should set series_granularity as episode. In this case response will include full streaming info for seasons and episodes, similar to the streaming info for movies and series; including deep links into seasons and episodes, individual subtitle/audio and video quality info etc.

order_by'original_title' | 'release_date' | 'rating' | 'popularity_alltime' | 'popularity_1year' | 'popularity_1month' | 'popularity_1week'

Determines the ordering of the shows.

You can switch between ascending and descending order by using the order_direction parameter.

order_direction'asc' | 'desc'

Determines whether to order the results in ascending or descending order.

Default value when ordering alphabetically or based on dates/times is asc.

Default value when ordering by rating or popularity is desc.

cursorstring

Cursor is used for pagination. After each request, the response includes a hasMore boolean field to tell if there are more results that did not fit into the returned list. If it is set as true, to get the rest of the result set, send a new request (with the same parameters for other fields), and set the cursor parameter as the nextCursor value of the response of the previous request. Do not forget to escape the cursor value before putting it into a query as it might contain characters such as ?and &.

The first request naturally does not require a cursor parameter.

Response

Response to a search by filters query.

hasMoreboolean required

Whether there are more shows available.

nextCursorstring

Cursor value to pass to get the next set of shows.

Example response

{
  "shows": [
    {
      "summary": "The Godfather",
      "externalValue": "https://www.movieofthenight.com/v4/examples/shows/god-father"
    }
  ]
}