Filter values
GET/v1.3/filters
Which genres, countries, platforms, tags and companies the database holds and how many titles each has, for dropdowns.
Values for the catalog’s filters and how many titles each has, largest first. Build dropdowns and type-ahead hints from it.
Every facet row has one shape: value, exactly what you pass to the filter; the labels label_ru and label_en; and the title count count. Tags add kind, platforms add country and poster_url.
| facet | catalog filter |
|---|---|
genres | genre |
countries | country |
regions | region |
kinds | kind |
platforms | platform |
tags | tag |
companies | companies |
Each facet holds its first 50 values by default, and {facet}_total says how many there are in all. facet keeps the facets you need, limit changes the cap, and limit=0 lifts it. q searches the labels in both languages, and for tags and companies it searches the whole dictionary, not just the values shown: q=steampunk finds the “Steampunk” tag, q=A24 the A24 studio, q=США the US platforms. Companies stop at 5,000 rows even with limit=0; the full number is in companies_total.
presets expands the presets into ordinary filters: start from one and adjust it.
Query parameters
facetcsvWhich facets to return, comma-separated.
country_decades, the number of titles per country by decade, comes only when you name it.genrescountrieskindsregionsplatformstagscompaniescountry_decadesDefault:all but
Example:country_decadesfacet=genres,countriesqstringKeep the values whose label contains this string, in any language:
q=netfinds Netflix. For tags and companies it searches the whole dictionary.Example:q=netlimitintegerHow many values to return per facet.
0means no cap.Default:50
Example:limit=0langru | enKeep one language in the response. Without it, text fields come in
_ruand_enpairs. More in Response languages.Example:lang=en
Response fields
{facet}arrayA facet’s values:
genres,countries,kinds,regions,platforms,tags,companies.Show 7 fields
valuestringWhat to pass to the catalog filter:
drama,us,netflix.label_ru · label_enstring | nullThe label in Russian and in English.
countintegerHow many titles have this value.
kindenumTags only: a subgenre, keyword or mood, from the
tag_kindsset.country · poster_urlstring | nullPlatforms only: the country as an ISO 3166-1 code (
usfor ABC) and the logo.
{facet}_totalintegerHow many values the facet holds with
qapplied, before thelimitcap.year_rangeobjectThe earliest and latest year in the database:
min,max.presetsarrayThe catalog’s presets: the same row as the
presetsset in/enums(value,label_ru,label_en), plusfilters, what the preset expands to.country_decadesarrayOn request only: a row like a country’s, plus
decades, titles by decade,decadeandcount.
Errors
| status | code | when |
|---|---|---|
| 400 | invalid_request | An unknown facet in |
| 401 | unauthorized | The |
| 429 | rate_limited | The per-second rate limit or the daily quota is used up. |
Every code and what to do about it is on the Errors page.