Streaming Availability — Try the interactive demo
A guided live test. Prefer the raw endpoints? See the API reference & playground →
Enter an API key from your Dashboard to enable the examples below. Requests send it to this platform for authentication.
Log in / Sign up · Dashboard →
Please paste your API key first.
Endpoints
Your API key is attached automatically to each call.
/api/project/streaming-availability/get-changes List new, removed, updated, expiring and upcoming titles for a country
Details
Returns the catalog changes for one country, 25 per page, ordered by the date of the change. Pass change_type to pick one of the documented change kinds (new, removed, updated, expiring, upcoming), item_type to pick the kind of item (show, and per the source description also season or episode), and country as an ISO 3166-1 alpha-2 code. Narrow further with catalogs (up to 32 service selectors), show_type (movie or series, only meaningful when item_type is show), order_direction (asc or desc), and inclusive from/to Unix timestamps. For past change types the window must fall between today and 31 days ago; for future change types between today and 31 days ahead. include_unknown_dates only affects future change types, since past changes always carry a timestamp. output_language localizes the joined show records (en, es, tr, fr). Paginate with cursor set to the previous response's nextCursor, URL-escaped because the value can contain ? and &. The first request needs no cursor. The response has four top-level fields, all observed live: changes (the page of change records), shows (the affected titles keyed by show id), hasMore and nextCursor. Each change record carries changeType, itemType, showId, showType, streamingOptionType, timestamp (Unix seconds), link (a deep link to the title on the service) and service (id, name, homePage, themeColorCode, imageSet). Each joined show carries id, itemType, showType, title, originalTitle, overview, releaseYear, runtime (minutes), rating, imdbId, tmdbId, genres (id and name), cast, directors, imageSet (verticalPoster, horizontalPoster, horizontalBackdrop at several widths) and streamingOptions keyed by country code, with per-option type, link, videoLink, audios, subtitles, availableSince, expiresSoon and the offering service. Field names come from a live probe (change_type=new, item_type=show, country=us, catalogs=netflix, show_type=movie) that returned 25 changes with hasMore true; the source description documents the other change types and item types, which were not exercised in that probe.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/streaming-availability/get-countries List every supported country with its streaming services
Details
Returns the full coverage directory in one response: an object keyed by ISO 3166-1 alpha-2 country code, with no pagination parameters. A live probe with no parameters returned 65 countries. Each country object has countryCode, name and services. Each service has id (the value other endpoints accept as a catalog selector), name, homePage, themeColorCode, imageSet (lightThemeImage, darkThemeImage, whiteImage logo URLs), streamingOptionTypes and addons. streamingOptionTypes is an object of booleans for addon, buy, rent, free and subscription, recording which offer types that service actually sells in that country. Each addon has id, name, homePage, themeColorCode and its own imageSet; counts vary widely by service and country (a live sample ranged from none to well over a hundred). output_language (en, es, tr, fr) localizes the returned names. These service and addon ids are the valid catalogs selectors for catalog and change queries, so this directory is the lookup that keeps those filters honest. The country set, field names and per-country service counts above were observed live; the source description confirms the directory lists supported services with names, logos, supported streaming types and available addons.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/streaming-availability/get-country Get one country's streaming services, offer types and add-ons
Details
Returns a single country object for the ISO 3166-1 alpha-2 code in the country-code path parameter: countryCode, name and services. A live probe for us returned the United States with 20 services. Each service has id, name, homePage, themeColorCode, imageSet (lightThemeImage, darkThemeImage and whiteImage logo URLs), streamingOptionTypes and addons. streamingOptionTypes is an object of booleans for addon, buy, rent, free and subscription, so you can tell whether a service sells rentals, purchases, a free tier or only subscriptions in that country. Each addon has id, name, homePage, themeColorCode and its own imageSet. In the US sample, six services carried addons, ranging from one to 140 (Prime Video). output_language (en, es, tr, fr) localizes the returned names. Use this when you already know the country and want its service ids, offer types and addon ids to validate a catalogs selector before querying a catalog or change feed. The field names and counts above were observed live for us; the source description confirms the payload lists the country's supported services with names, logos, supported streaming types and available addons.
| Parameter | In | Value |
|---|---|---|
| path | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/streaming-availability/get-genres List supported streaming genres
Details
Returns the full list of genres used to classify movies and series, as a plain JSON array of objects with a string id and a display name. The only input is the optional output_language query parameter (en, es, tr or fr, default en), which selects the language of the output. In a sample call with default settings the endpoint answered HTTP 200 with a root array of 21 entries, each carrying exactly the fields id (for example scifi or thriller) and name (for example Science Fiction or Thriller); no wrapper object, cursor or pagination fields were present. The ids are the values accepted by the genres parameter of the filtered catalog search, so this list is the vocabulary behind genre filtering. The sample call used the default language only, so translated names for es, tr and fr are documented but were not verified in the sample.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/streaming-availability/search-shows-by-filters Browse a streaming catalog by genre, year, rating and keyword
Details
Searches the streaming catalog of one country, optionally limited to chosen services, and returns a cursor-paginated list of movies and series. The only required input is country (ISO 3166-1 alpha-2). Optional filters are catalogs (up to 32 comma-separated entries such as netflix, prime.subscription or hulu.addon.hbo), genres with genres_relation (and or or), keyword matched against title and overview, show_original_language, year_min and year_max, and rating_min and rating_max. Sorting uses order_by (original_title, release_date, rating or one of four popularity windows) with order_direction; series_granularity (show, season or episode) sets how much series detail is returned, output_language selects en, es, tr or fr, and cursor fetches the next page. Documented response: an object with a shows array, a hasMore flag and a nextCursor string. Each show carries its title, IMDb and TMDb ids, release year, and streaming options with deep links, subtitles, audios and video quality. Besides the requested services, each show also lists availability on other services in the same country; availability from other countries is never included. Page size is 20 when show_type is movie or series_granularity is show, 10 for series at episode granularity, and 15 otherwise. Observed in a sample call (country us, catalogs netflix, show_type movie, order_by popularity_alltime, series_granularity show): HTTP 200 with 20 shows, hasMore true and a string nextCursor. Each sample show exposed itemType, showType, id, imdbId, tmdbId, title, overview, releaseYear, originalTitle, genres, directors, cast, rating, runtime, streamingOptions (an object keyed by country code holding a list of options) and imageSet. Each option exposed service, type, addon, link, videoLink, price, quality, audios, subtitles, expiresSoon, expiresOn and availableSince. The source response example is cut off and its image links carry expiry data, so only the sample field list above should be treated as verified.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/streaming-availability/search-shows-by-title Search movies and series by title with streaming options for one country
Details
Searches movies and series by a title phrase and returns a JSON array of matching shows, each with the streaming availability for the country you choose. Two inputs are required: country (an ISO 3166-1 alpha-2 code such as us; the countries endpoint lists the supported ones) and title (the phrase to search). Optional inputs are show_type, which restricts the search to one kind of show (the sample call used movie; omit it to search movies and series together), output_language (en, es, tr or fr, default en) and series_granularity (show, season or episode, default show; it only affects series, and show keeps the response smallest). At most 20 items are returned, unless more than 20 shows have exactly the given title, in which case all exact matches are returned. There is no pagination. Availability is included only for the requested country, and a hit may not be streamable there, because the title and show type are the only search criteria. Observed in a sample call (country us, title batman, show_type movie, series_granularity show): HTTP 200 with a root array of 20 show objects. Each object exposed itemType, showType, id, imdbId, tmdbId, title, originalTitle, overview, releaseYear, genres (id and name pairs), directors, cast, rating, imageSet and streamingOptions; 19 of the 20 also carried runtime. streamingOptions was an object keyed by country code (us in the sample) holding option entries with service, type, link, quality, audios, subtitles, expiresSoon and availableSince; rent and buy options added a price object (amount, currency, formatted), and some options added expiresOn, videoLink or addon. The documentation does not enumerate show_type values beyond the movie example, and only movie results were exercised in the sample call.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/streaming-availability/get-show Get one movie or series by internal, IMDb or TMDb id with global streaming availability
Details
Returns the details of a single show, together with its streaming availability, looked up by the id path value. The id can be the internal show id, an IMDb id (tt followed by digits, for example tt0120338 for Titanic) or a TMDb id written as movie/<number> for movies or tv/<number> for series (for example movie/597 or tv/1396); the type of id is detected automatically. Optional query inputs are country, output_language and series_granularity. country is an ISO 3166-1 alpha-2 code: when it is omitted, availability across all countries is returned, and when it is supplied only that country is included, which is the recommended way to get a smaller, faster response. output_language accepts en, es, tr or fr (default en). series_granularity accepts show, season or episode and only affects series; its default on this endpoint is episode, so choose show if you do not need season and episode info. Observed in a sample call (id tt0120338, country us, series_granularity show): HTTP 200 with a single JSON object for the movie Titanic (internal id 136). It exposed itemType, showType, id, imdbId, tmdbId, title, originalTitle, overview, releaseYear, genres (id and name pairs), directors, cast, rating, runtime, imageSet and streamingOptions. streamingOptions was an object keyed by country code (only us in the sample) whose entries had service, type, link, audios, subtitles, expiresSoon and availableSince, plus quality on most entries; the types seen were subscription, free, rent, buy and addon, rent and buy entries added a price object (amount, currency, formatted), and some entries added expiresOn or videoLink. Not exercised by the sample call: the TMDb id form, calling without country, and the documented 404 error body, which the source documentation shows as a JSON object with a message field.
| Parameter | In | Value |
|---|---|---|
| path | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/streaming-availability/deprecated Legacy show lookup by type and id, marked deprecated; use Get Show for new work
Details
A legacy endpoint at /shows/{type}/{id} that the source spec labels only as Deprecated. It takes two required path values, type and id, both strings, and declares no query parameters, so there is no country, output_language or series_granularity control on this path. The spec provides no description, allowed values or examples for either path value. No sample call was made for it and no response example was supplied, so its response fields are undocumented here and should not be assumed to match any other endpoint; verify the output yourself before relying on it. For new integrations use Get Show at /shows/{id}, which accepts an internal id, an IMDb id (tt followed by digits) or a TMDb id (movie/<number> or tv/<number>) and adds the optional country, output_language and series_granularity inputs. This entry exists mainly so existing callers can recognize the old path and plan their migration.
| Parameter | In | Value |
|---|---|---|
| path | ||
| path |
Request cost is temporarily unavailable. No price is assumed.