API wyszukiwania

Wyszukiwanie filmów

GET /3/search/movie przyjmuje zapytanie tekstowe i zwraca listę pasujących filmów z paginacją, najlepsze dopasowanie pierwsze. Użyj go, by zamienić to, co wpisał użytkownik, na ID filmu, a potem wywołaj szczegóły filmu z tym ID.

Przykład szuka Inception, ograniczonego do 2010, i wypisuje ID, tytuł i datę premiery.

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

• queryquerywymagany
  Tekst do wyszukania. Zakoduj go w URL: spacje zmieniają się w %20 lub +.
• api_keyqueryjeden z dwóch
  Twój klucz. Użyj go albo nagłówka Authorization: Bearer.
• yearquery
  Czterocyfrowy rok. Zostawia filmy z dowolną datą premiery w tym roku, w dowolnym kraju.
• primary_release_yearquery
  Czterocyfrowy rok. Pasuje tylko do głównej daty premiery, więc może zwrócić mniej tytułów niż year.
• regionquery
  Dwuliterowy kod kraju wielkimi literami, na przykład US. Zastępuje release_date datą w tym kraju, gdy jest znana. Nie usuwa tytułów.
• include_adultquery
  Przyjmowany i ignorowany. Tytuły dla dorosłych nigdy nie są zwracane.
• languagequery
  Tag TMDB, na przykład en-US lub it-IT. Obsługiwanych jest 14 języków bazowych, wszystko inne wraca do angielskiego. Domyślnie en-US.
• pagequery
  Numer strony od 1 do 500. Domyślnie 1.

Pola odpowiedzi

Przykładowa odpowiedź

{
  "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
}

Odpowiedź zawiera wszystkie trzy dopasowania. Pobrano ją z działającego API, a skrócono tylko długie ciągi overview.

Inne endpointy wyszukiwania

Wszystkie poniższe ścieżki mają wspólną bazę https://api.amodb.dev/3, wymagają query i zwracają tę samą kopertę page, results, total_pages i total_results. Każda przyjmuje też page od 1 do 500. include_adult jest przyjmowane we wszystkich i ignorowane.

W przypadku seriali first_air_date_year zostawia seriale, których pierwsza emisja przypada na ten rok, a year zostawia też starsze seriale emitowane w tym roku. Wyszukanie the z year=2010 zwraca The Simpsons, które po raz pierwszy emitowano w 1989, a to samo wyszukiwanie z first_air_date_year=2010 nie. Jeśli wyślesz oba, oba muszą pasować. Pozycje osób niosą do 3 tytułów known_for, każdy z media_type. /search/multi ignoruje year.

Znalezione encje mają dalszy ciąg na stronach seriale, osoby, kolekcje, firmy i sieci telewizyjne i słowa kluczowe.

Wyszukiwanie multi

media_type to movie, tv lub person i mówi, jakich pól się spodziewać. Pozycje filmów niosą title, a pozycje seriali i osób niosą name.

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

Błędy

/search/tv i /search/person odpowiadają na zapytanie bez dopasowania HTTP 200, pustą tablicą results i total_results równym 0. Obecnie /search/movie, /search/multi, /search/keyword, /search/company i /search/collection odpowiadają na ten sam przypadek HTTP 500 i status_code 11. Traktuj 500 na tych ścieżkach jako „brak wyników”, chyba że powtarza się dla zapytań, o których wiesz, że pasują.

Pełną listę zobacz w błędy, a okna w limity żądań.

Praktyczne uwagi

• Edge trzyma wyszukiwanie w cache przez 10 minut i współdzieli kopię między kluczami. Każde wywołanie nadal liczy się do twoich 20, 40 lub 120 żądań na minutę, bo limit działa przed cache.
• W polu wyszukiwania poczekaj 300 ms po ostatnim naciśnięciu klawisza i anuluj żądanie w toku. Pole, które wysyła zapytanie przy każdym klawiszu, może w kilka sekund zużyć plan z 20 żądaniami na minutę.
• Zamień zapytanie na małe litery i przytnij je, zanim użyjesz go jako klucza cache u siebie.
• Aby znaleźć tytuł po ID z IMDb, pomiń wyszukiwanie i użyj wyszukiwania po zewnętrznym ID.
• ID słowa kluczowego z /search/keyword zasila filtr with_keywords w discover, a ID firmy filtr with_companies.