{ "openapi": "3.0.0", "info": { "title": "Streaming Availability - cheaper version", "description": "Netflix, Prime, Disney+, HBO, Hulu, AppleTV and many others. Lookup which shows are available on streaming services across 60 countries with deep links.", "version": "1.0.0", "x-category": "Movies" }, "servers": [ { "url": "https://www.doorprofit.com/rapidapi/f8eaaaffdc5098d60d4e703e0c1bb53d" } ], "paths": { "/shows/{type}/{id}": { "get": { "summary": "Deprecated", "description": "Deprecated", "operationId": "get_shows_type_id", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/genres": { "get": { "summary": "Get Genres", "description": "Get the list of supported genres.", "operationId": "get_genres", "parameters": [ { "name": "output_language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the output language.\nDetermines in which language the output will be in.\n", "example": "en" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/changes": { "get": { "summary": "Get Changes", "description": "Query the new, removed, updated, expiring or upcoming movies/series/seasons/episodes in a given list of streaming services.\nResults are ordered by the date of the changes.\nChanges listed per page is `25`.\n\nChanges are listed under `changes` field, and shows affected by these changes are listed under `shows` field.", "operationId": "get_changes", "parameters": [ { "name": "country", "in": "query", "required": true, "schema": { "type": "string" }, "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the target country.\nSee `/countries` endpoint to get the list of supported countries.\n" }, { "name": "from", "in": "query", "required": false, "schema": { "type": "number" }, "description": "[Unix Time Stamp](https://www.unixtimestamp.com/) to only query the changes happened/happening after this date (inclusive).\nFor `past` changes such as `new`, `removed` or `updated`, the timestamp must be between today and `31` days ago.\nFor `future` changes such as `expiring` or `upcoming`, the timestamp must be between today and `31` days from now in the future.\n\nIf not supplied, the default value for `past` changes is `31` days ago, and for `future` changes is today.\n" }, { "name": "to", "in": "query", "required": false, "schema": { "type": "number" }, "description": "[Unix Time Stamp](https://www.unixtimestamp.com/) to only query the changes happened/happening before this date (inclusive).\nFor `past` changes such as `new`, `removed` or `updated`, the timestamp must be between today and `31` days ago.\nFor `future` changes such as `expiring` or `upcoming`, the timestamp must be between today and `31` days from now in the future.\n\nIf not supplied, the default value for `past` changes is today, and for `future` changes is `31` days from now.\n" }, { "name": "output_language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the output language.\nDetermines in which language the output will be in.\n", "example": "en" }, { "name": "order_direction", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Determines whether to order the results in ascending or descending order.\n", "example": "asc" }, { "name": "include_unknown_dates", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Whether to include the changes with unknown dates.\n`past` changes such as `new`, `removed` or `updated` will always have a timestamp thus this parameter does not affect them.\n`future` changes such as `expiring` or `upcoming` may not have a timestamp if the exact date is not known\n(e.g. some services do not explicitly state the exact date of some of the upcoming/expiring shows).\nIf set as `true`, the changes with unknown dates will be included in the response.\nIf set as `false`, the changes with unknown dates will be excluded from the response.\n\nWhen ordering, the changes with unknown dates will be treated as if their timestamp is 0.\nThus, they will appear first in the ascending order and last in the descending order.\n", "example": "false" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Cursor is used for pagination.\nAfter each request, the response includes a `hasMore` boolean field to tell if there are more results that did not fit into the returned list.\nIf it is set as `true`, to get the rest of the result set, send a new request\n(with the same parameters for other fields),\nand set the `cursor` parameter as the `nextCursor` value of the response of the previous request.\nDo not forget to escape the `cursor` value before putting it into a query as it might contain characters such as `?`and `&`.\n\nThe first request naturally does not require a `cursor` parameter.\n" }, { "name": "show_type", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Type of shows to search in.\nIf not supplied, both movies and series will be included in the search results.\n", "example": "movie" }, { "name": "change_type", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Type of changes to query.", "example": "new" }, { "name": "catalogs", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A comma separated list of up to 32 catalogs to search in.\nSee `/countries` endpoint to get the supported services in each country and their ids.\n\nWhen 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.\n\nIf no catalogs are passed, the endpoint will search in all the available catalogs in the country.\n\nSyntax of the catalogs supplied in the list can be as the followings:\n\n- ``: Searches in the entire catalog of that service,\nincluding (if applicable) rentable, buyable shows or shows available through addons e.g. `netflix`, `prime`, `apple`\n\n- `.`: Only returns the shows that are available in that service with the given streaming option type.\nValid streaming option types are `subscription`, `free`, `rent`, `buy` and `addon`\ne.g. `peacock.free` only returns the shows on Peacock that are free to watch,\n`prime.subscription` only returns the shows on Prime Video that are available to watch with a Prime subscription.\n`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.\n\n- `.addon.`: Only returns the shows that are available in that service with the given addon.\nCheck `/countries` endpoint to fetch the available addons for a service in each country. Some sample values are: `hulu.addon.hbo`, `prime.addon.hbomaxus`.\n" }, { "name": "item_type", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Type of items to search in.\nIf `item_type` is `show`, you can use `show_type` parameter to only search for movies or series.\n", "example": "show" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/countries": { "get": { "summary": "Get Countries", "description": "Get all the supported countries and the list of the supported services and their details for each country.\n\nDetails of services include names, logos, supported streaming types (subscription, rent, buy, free etc.) and list of available addons/channels.", "operationId": "get_countries", "parameters": [ { "name": "output_language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the output language.\nDetermines in which language the output will be in.\n", "example": "en" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/countries/{country-code}": { "get": { "summary": "Get Country", "description": "Get a country and the list of the supported services and their details.\n\nDetails of services include names, logos, supported streaming types (subscription, rent, buy, free etc.) and list of available addons/channels.", "operationId": "get_countries_country_code", "parameters": [ { "name": "output_language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the output language.\nDetermines in which language the output will be in.\n", "example": "en" }, { "name": "country-code", "in": "query", "required": true, "schema": { "type": "string" }, "description": "[ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country.\n" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/shows/search/filters": { "get": { "summary": "Search Shows by Filters", "description": "Search through the catalog of the given streaming services in the given country.\nProvides filters such as show language, genres, keyword and release year.\nOutput includes all the information about the shows,\nsuch as title, IMDb ID, TMDb ID, release year,\ndeep links to streaming services,\navailable subtitles, audios, available video quality\nand many more!\nApart from the info about the given country-service combinations,\noutput also includes information about streaming availability in the other services for the given country.\nStreaming availability info from the other countries are not included in the response.\n\nWhen `show_type` is `movie` or `series_granularity` is `show`, items per page is 20.\nWhen `show_type` is `series` and `series_granularity` is `episode` items per page is 10.\nOtherwise, items per page is 15.", "operationId": "get_shows_search_filters", "parameters": [ { "name": "catalogs", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A comma separated list of up to 32 catalogs to search in.\nSee `/countries` endpoint to get the supported services in each country and their ids.\n\nWhen 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.\n\nIf no catalogs are passed, the endpoint will search in all the available catalogs in the country.\n\nSyntax of the catalogs supplied in the list can be as the followings:\n\n- ``: Searches in the entire catalog of that service,\nincluding (if applicable) rentable, buyable shows or shows available through addons e.g. `netflix`, `prime`, `apple`\n\n- `.`: Only returns the shows that are available in that service with the given streaming option type.\nValid streaming option types are `subscription`, `free`, `rent`, `buy` and `addon`\ne.g. `peacock.free` only returns the shows on Peacock that are free to watch,\n`prime.subscription` only returns the shows on Prime Video that are available to watch with a Prime subscription.\n`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.\n\n- `.addon.`: Only returns the shows that are available in that service with the given addon.\nCheck `/countries` endpoint to fetch the available addons for a service in each country. Some sample values are: `hulu.addon.hbo`, `prime.addon.hbomaxus`.\n" }, { "name": "series_granularity", "in": "query", "required": false, "schema": { "type": "string" }, "description": "`series_granularity` determines the level of detail for series. It does not affect movies.\n\nIf `series_granularity` is `show`, then the output will not include season and episode info.\n\nIf `series_granularity` is `season`, then the output will include season info but not episode info.\n\nIf `series_granularity` is `episode`, then the output will include season and episode info.\n\nIf you do not need season and episode info, then it is recommended to set `series_granularity` as `show`\nto reduce the size of the response and increase the performance of the endpoint.\n\nIf you need deep links for individual seasons and episodes, then you should set `series_granularity` as `episode`.\nIn this case response will include full streaming info for seasons and episodes,\nsimilar to the streaming info for movies and series; including deep links into seasons and episodes,\nindividual subtitle/audio and video quality info etc.\n", "example": "show" }, { "name": "country", "in": "query", "required": true, "schema": { "type": "string" }, "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the target country.\nSee `/countries` endpoint to get the list of supported countries.\n" }, { "name": "rating_max", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Maximum rating of the shows." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Cursor is used for pagination.\nAfter each request, the response includes a `hasMore` boolean field to tell if there are more results that did not fit into the returned list.\nIf it is set as `true`, to get the rest of the result set, send a new request\n(with the same parameters for other fields),\nand set the `cursor` parameter as the `nextCursor` value of the response of the previous request.\nDo not forget to escape the `cursor` value before putting it into a query as it might contain characters such as `?`and `&`.\n\nThe first request naturally does not require a `cursor` parameter.\n" }, { "name": "year_max", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Maximum release/air year of the shows." }, { "name": "genres", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A comma seperated list of genre ids to only search within the shows in those genre.\nSee `/genres` endpoint to see the available genres and their ids.\nUse `genres_relation` parameter to specify between returning shows that have at least one of the given genres\nor returning shows that have all of the given genres.\n" }, { "name": "order_direction", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Determines whether to order the results in ascending or descending order.\n\nDefault value when ordering alphabetically or based on dates/times is `asc`.\n\nDefault value when ordering by rating or popularity is `desc`.\n", "example": "asc" }, { "name": "order_by", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Determines the ordering of the shows.\nMake sure to set `descending_order` parameter as `true` when ordering by popularity or rating\nso that shows with the highest popularity or rating will be returned first.\n", "example": "original_title" }, { "name": "year_min", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Minimum release/air year of the shows." }, { "name": "show_original_language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "[ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code to only search within the shows whose original language matches with the provided language.\n" }, { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A keyword to only search within the shows have that keyword in their overview or title." }, { "name": "genres_relation", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Only used when there are multiple genres supplied in `genres` parameter.\n\nWhen `or`, the endpoint returns any show that has at least one of the given genres.\nWhen `and`, it only returns the shows that have all of the given genres.\n", "example": "and" }, { "name": "output_language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the output language.\nDetermines in which language the output will be in.\n", "example": "en" }, { "name": "show_type", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Type of shows to search in.\nIf not supplied, both movies and series will be included in the search results.\n", "example": "movie" }, { "name": "rating_min", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Minimum rating of the shows." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/shows/search/title": { "get": { "summary": "Search Shows by Title", "description": "Search for movies and series by a title.\nMaximum amount of items returned are `20`\nunless there are more than 20 shows with the exact given title input.\nIn that case all the items have 100% match with the title will be returned.\n\nStreaming availability info for the target country is included in the response,\nbut not for the other countries.\n\nResults might include shows that are not streamable in the target country.\nOnly criteria for the search are the title and the show type.\n\nNo pagination is supported.", "operationId": "get_shows_search_title", "parameters": [ { "name": "country", "in": "query", "required": true, "schema": { "type": "string" }, "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the target country.\nSee `/countries` endpoint to get the list of supported countries.\n" }, { "name": "series_granularity", "in": "query", "required": false, "schema": { "type": "string" }, "description": "`series_granularity` determines the level of detail for series. It does not affect movies.\n\nIf `series_granularity` is `show`, then the output will not include season and episode info.\n\nIf `series_granularity` is `season`, then the output will include season info but not episode info.\n\nIf `series_granularity` is `episode`, then the output will include season and episode info.\n\nIf you do not need season and episode info, then it is recommended to set `series_granularity` as `show`\nto reduce the size of the response and increase the performance of the endpoint.\n\nIf you need deep links for individual seasons and episodes, then you should set `series_granularity` as `episode`.\nIn this case response will include full streaming info for seasons and episodes,\nsimilar to the streaming info for movies and series; including deep links into seasons and episodes,\nindividual subtitle/audio and video quality info etc.\n", "example": "show" }, { "name": "title", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Title phrase to search for." }, { "name": "show_type", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Type of shows to search in.\nIf not supplied, both movies and series will be included in the search results.\n", "example": "movie" }, { "name": "output_language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the output language.\nDetermines in which language the output will be in.\n", "example": "en" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/shows/{id}": { "get": { "summary": "Get Show", "description": "Get the details of a show via `id`, `imdbId` or `tmdbId`, including the global streaming availability info.", "operationId": "get_shows_id", "parameters": [ { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the optional target country.\nIf this parameter is not supplied, global streaming availability across all the countries will be returned.\nIf it is supplied, only the streaming availability info from the given country will be returned.\nIf you are only interested in the streaming availability in a single country,\nthen it is recommended to use this parameter to reduce the size of the response and increase the performance of the endpoint.\nSee `/countries` endpoint to get the list of supported countries.\n" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "`id` of the show. You can also pass an IMDb Id or a TMDB Id as an `id`.\nThe endpoint will automatically detect the type of the id and fetch the show accordingly.\n\nWhen passing an IMDb Id,\nit should be in the format of `tt`. (e.g. `tt0120338` for Titanic)\n\nWhen passing a TMDB Id,\nit should be in the format of `movie/` for movies and `tv/` for series.\n(e.g. `tv/1396` for Breaking Bad and `movie/597` for Titanic)\n" }, { "name": "series_granularity", "in": "query", "required": false, "schema": { "type": "string" }, "description": "`series_granularity` determines the level of detail for series. It does not affect movies.\n\nIf `series_granularity` is `show`, then the output will not include season and episode info.\n\nIf `series_granularity` is `season`, then the output will include season info but not episode info.\n\nIf `series_granularity` is `episode`, then the output will include season and episode info.\n\nIf you do not need season and episode info, then it is recommended to set `series_granularity` as `show`\nto reduce the size of the response and increase the performance of the endpoint.\n\nIf you need deep links for individual seasons and episodes, then you should set `series_granularity` as `episode`.\nIn this case response will include full streaming info for seasons and episodes,\nsimilar to the streaming info for movies and series; including deep links into seasons and episodes,\nindividual subtitle/audio and video quality info etc.\n", "example": "episode" }, { "name": "output_language", "in": "query", "required": false, "schema": { "type": "string" }, "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of the output language.\nDetermines in which language the output will be in.\n", "example": "en" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } } } }