API vyhledávání

Endpointy vyhledávání převádějí textový dotaz na ID. GET /3/search/movie najde filmy a sourozenecké cesty najdou seriály, osoby, kolekce, společnosti a klíčová slova, nebo všechna média najednou přes multi. JSON odpovídá TMDB v3, výsledky jsou stránkované po 20 a edge cachuje dotaz 10 minut.

Aktualizováno Zobrazit jako Markdown

Hledání filmů

GET /3/search/movie přijme textový dotaz a vrátí stránkovaný seznam odpovídajících filmů, nejlepší shoda první. Použijte jej k převodu toho, co uživatel napsal, na ID filmu a pak s tímto ID zavolejte detail filmu.

Příklad hledá Inception omezené na rok 2010 a vypíše ID, název a datum vydání.

bashjspyphpgo
curl -sSf --get "https://api.amodb.dev/3/search/movie" \
  --data-urlencode "query=inception" \
  --data-urlencode "year=2010" \
  -H "Authorization: Bearer $AMODB_KEY"
const params = new URLSearchParams({ query: 'inception', year: '2010', language: 'en-US' });
const res = await fetch(`https://api.amodb.dev/3/search/movie?${params}`, {
  headers: { Authorization: `Bearer ${process.env.AMODB_KEY}` },
});
if (!res.ok) throw new Error(`amodb returned ${res.status}`);
const { results, total_results } = await res.json();
console.log(`${total_results} matches`);
for (const m of results.slice(0, 5)) console.log(m.id, m.title, m.release_date);
import os
import requests

r = requests.get(
    "https://api.amodb.dev/3/search/movie",
    params={"query": "inception", "year": 2010, "language": "en-US"},
    headers={"Authorization": f"Bearer {os.environ['AMODB_KEY']}"},
    timeout=10,
)
r.raise_for_status()
data = r.json()
print(data["total_results"], "matches")
for m in data["results"][:5]:
    print(m["id"], m["title"], m["release_date"])
<?php
$url = 'https://api.amodb.dev/3/search/movie?' . http_build_query([
    'query' => 'inception',
    'year' => 2010,
    'language' => 'en-US',
]);
$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('AMODB_KEY')],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status !== 200) {
    throw new RuntimeException("amodb returned $status");
}
$data = json_decode($body, true);
foreach (array_slice($data['results'], 0, 5) as $m) {
    echo $m['id'], ' ', $m['title'], ' ', $m['release_date'], PHP_EOL;
}
package main

import (
	"encoding/json"
	"fmt"
	"net/http"
	"net/url"
	"os"
	"time"
)

type SearchPage struct {
	TotalResults int `json:"total_results"`
	Results      []struct {
		ID          int    `json:"id"`
		Title       string `json:"title"`
		ReleaseDate string `json:"release_date"`
	} `json:"results"`
}

func main() {
	q := url.Values{"query": {"inception"}, "year": {"2010"}, "language": {"en-US"}}
	req, _ := http.NewRequest("GET", "https://api.amodb.dev/3/search/movie?"+q.Encode(), nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("AMODB_KEY"))
	client := &http.Client{Timeout: 10 * time.Second}
	res, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	if res.StatusCode != http.StatusOK {
		panic(res.Status)
	}
	var p SearchPage
	if err := json.NewDecoder(res.Body).Decode(&p); err != nil {
		panic(err)
	}
	fmt.Println(p.TotalResults, "matches")
	for _, m := range p.Results {
		fmt.Println(m.ID, m.Title, m.ReleaseDate)
	}
}

Parametry

  • queryquerypovinný
    Hledaný text. Zakódujte jej do URL: mezery se změní na %20 nebo +.
  • api_keyqueryjeden ze dvou
    Váš klíč. Použijte jej, nebo hlavičku Authorization: Bearer.
  • yearquery
    Čtyřmístný rok. Ponechá filmy s libovolným datem vydání v tom roce, v jakékoli zemi.
  • primary_release_yearquery
    Čtyřmístný rok. Odpovídá jen primárnímu datu vydání, takže může vrátit méně titulů než year.
  • regionquery
    Dvoupísmenný kód země velkými písmeny, například US. Nahradí release_date datem v dané zemi, pokud je známo. Tituly neodstraňuje.
  • include_adultquery
    Přijímá se a ignoruje. Tituly pro dospělé se nikdy nevracejí.
  • languagequery
    Tag TMDB, například en-US nebo it-IT. Podporuje se 14 základních jazyků, cokoli jiného se vrátí k angličtině. Výchozí en-US.
  • pagequery
    Číslo stránky od 1 do 500. Výchozí 1.

Pole odpovědi

PoleTypPoznámky
pageintegerStránka, o kterou jste požádali.
resultsarrayAž 20 položek, nejlepší shoda první.
total_pages, total_resultsintegerVelikost sady výsledků pro tento dotaz. Omezeno na 500 stránek a 10000 výsledků.
idintegerID filmu pro endpoint detailu.
title, original_titlestringLokalizovaný a původní název.
original_languagestringDvoupísmenný kód jazyka, ve kterém byl film natočen.
overviewstringLokalizovaný text, prázdný, když překlad neexistuje.
release_datestringYYYY-MM-DD, prázdné u titulů bez data.
genre_idsarray of integersID žánrů, ne názvy. Převeďte je přes žánry.
poster_path, backdrop_pathstring nebo nullPřipojte k https://img.amodb.dev/t/p/{size}.
popularity, vote_average, vote_countnumberHodnoty pořadí a skóre.
adult, videobooleanadult je vždy false. video je true u položek označených jako videoobsah.

Příklad odpovědi

JSON
{
  "page": 1,
  "results": [
    {
      "adult": false,
      "backdrop_path": "/zSBVQIvx4UIHoFf1oDvixHyIQrz.jpg",
      "genre_ids": [28, 878, 80],
      "id": 27205,
      "original_language": "en",
      "original_title": "Inception",
      "overview": "Cobb, a skilled thief who commits corporate espionage by infiltrating the subconscious of his targets is of...",
      "popularity": 60.9811,
      "poster_path": "/xlaY2zyzMfkhk0HSC5VUwzoZPU1.jpg",
      "release_date": "2010-07-15",
      "title": "Inception",
      "video": false,
      "vote_average": 8.373,
      "vote_count": 40459
    },
    {
      "adult": false,
      "backdrop_path": "/p8K8Z4yjaslJx5mTsIC5L6LJxQB.jpg",
      "genre_ids": [16, 28, 53],
      "id": 64956,
      "original_language": "en",
      "original_title": "Inception: The Cobol Job",
      "overview": "Cobb, Arthur and Nash are enlisted by Cobol Engineering.",
      "popularity": 1.9401,
      "poster_path": "/sNxqwtyHMNQwKWoFYDqcYTui5Ok.jpg",
      "release_date": "2010-12-07",
      "title": "Inception: The Cobol Job",
      "video": false,
      "vote_average": 7.2,
      "vote_count": 320
    },
    {
      "adult": false,
      "backdrop_path": null,
      "genre_ids": [10402],
      "id": 973484,
      "original_language": "en",
      "original_title": "Inception: Music from the Motion Picture",
      "overview": "The Special Features Blu-ray disc contains a lossless DTS-HD MA 5.1 surround mix of the Inception soundtrack.",
      "popularity": 0.4911,
      "poster_path": "/7uM4DyRVAcgagvhZoWrkrqMPbqV.jpg",
      "release_date": "2010-12-07",
      "title": "Inception: Music from the Motion Picture",
      "video": true,
      "vote_average": 7,
      "vote_count": 3
    }
  ],
  "total_pages": 1,
  "total_results": 3
}

Odpověď obsahuje všechny tři shody. Byla stažena z živého API a zkráceny byly jen dlouhé řetězce overview.

Další endpointy hledání

Všechny cesty níže sdílejí základ https://api.amodb.dev/3, vyžadují query a vracejí stejný obal page, results, total_pages a total_results. Každá také přijímá page od 1 do 500. include_adult se přijímá u všech a ignoruje.

Metoda a cestaNajdeDalší parametryPole položky
GET /search/tvSeriályfirst_air_date_year, year, languagename, original_name, first_air_date, origin_country
GET /search/personOsobylanguagename, original_name, known_for_department, gender, profile_path, known_for
GET /search/multiFilmy, seriály a osoby dohromadylanguagemedia_type plus pole daného typu
GET /search/collectionKolekce filmůlanguagename, original_name, overview, poster_path, backdrop_path
GET /search/companyProdukční společnostižádnéname, logo_path, origin_country
GET /search/keywordKlíčová slovažádnéid, name

U seriálů first_air_date_year ponechá seriály, jejichž první vysílání je v daném roce, zatímco year ponechá i starší seriály, které v daném roce vysílaly. Hledání the s year=2010 vrátí The Simpsons, které se poprvé vysílaly v roce 1989, a stejné hledání s first_air_date_year=2010 nikoli. Když pošlete obojí, musí platit obojí. Položky osob nesou až 3 tituly known_for, každý s media_type. /search/multi year ignoruje.

Nalezené entity pokračují na stránkách seriály, osoby, kolekce, společnosti a televizní sítě a klíčová slova.

Multi hledání

media_type je movie, tv nebo person a říká, jaká pole čekat. Položky filmů nesou title a položky seriálů a osob nesou name.

JavaScript
const byType = { movie: [], tv: [], person: [] };
for (const r of results) byType[r.media_type]?.push(r.title || r.name);
console.log(byType);

Chyby

/search/tv a /search/person odpovídají na dotaz bez shody HTTP 200, prázdným polem results a total_results rovným 0. V tuto chvíli /search/movie, /search/multi, /search/keyword, /search/company a /search/collection odpovídají na stejný případ HTTP 500 a status_code 11. Berte 500 na těchto cestách jako „žádné výsledky“, pokud se neopakuje u dotazů, o kterých víte, že odpovídají.

HTTPstatus_codeKdy
4017Klíč chybí nebo je nesprávný.
40236Platnost tarifu skončila.
40537Zavolali jste metodu pro zápis.
42925Překročen počet požadavků za minutu. Počkejte tolik sekund, kolik říká Retry-After.
50011Dotaz na film, multi, klíčové slovo, společnost nebo kolekci, který nic nenajde, nebo page mimo 1 až 500.
50424Backend neodpověděl včas. Zkuste to jednou znovu.

Úplný seznam viz chyby a okna viz limity požadavků.

Praktické poznámky

  • Edge cachuje hledání 10 minut a sdílí kopii mezi klíči. Každé volání se přesto počítá do vašich 20, 40 nebo 120 požadavků za minutu, protože limit se vyhodnocuje před cache.
  • U vyhledávacího pole počkejte 300 ms po posledním stisku klávesy a rozpracovaný požadavek zrušte. Pole, které odesílá na každou klávesu, může vyčerpat tarif s 20 požadavky za minutu během pár sekund.
  • Než dotaz použijete jako klíč cache u sebe, převeďte ho na malá písmena a ořízněte.
  • Titul podle ID z IMDb vyhledáte bez hledání přes hledání podle externího ID.
  • ID klíčového slova z /search/keyword vstupuje do filtru with_keywords v discover a ID společnosti do with_companies.