API поиска

Поиск фильмов

GET /3/search/movie принимает текстовый запрос и возвращает постраничный список подходящих фильмов, лучшее совпадение первым. Используйте его, чтобы превратить введенный пользователем текст в ID фильма, а затем вызовите детали фильма с этим ID.

Пример ищет Inception с ограничением 2010 годом и выводит ID, название и дату выхода.

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)
	}
}

Параметры

• queryqueryобязателен
  Текст для поиска. Закодируйте его для URL: пробелы превращаются в %20 или +.
• api_keyqueryодин из двух
  Ваш ключ. Используйте его или заголовок Authorization: Bearer.
• yearquery
  Год из четырех цифр. Оставляет фильмы с любой датой выхода в этом году, в любой стране.
• primary_release_yearquery
  Год из четырех цифр. Сравнивается только с основной датой выхода, поэтому может вернуть меньше тайтлов, чем year.
• regionquery
  Код страны из 2 букв в верхнем регистре, например US. Заменяет release_date датой в этой стране, если она известна. Тайтлы не убирает.
• include_adultquery
  Принимается и игнорируется. Фильмы для взрослых не возвращаются никогда.
• languagequery
  Тег TMDB, например en-US или it-IT. Обслуживаются 14 базовых языков, остальные откатываются на английский. По умолчанию en-US.
• pagequery
  Номер страницы от 1 до 500. По умолчанию 1.

Поля ответа

Пример ответа

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

В ответе все три совпадения. Он получен из работающего API, сокращены только длинные строки overview.

Другие эндпоинты поиска

Все пути ниже используют базу https://api.amodb.dev/3, требуют query и возвращают тот же конверт из page, results, total_pages и total_results. Каждый из них также принимает page от 1 до 500. Параметр include_adult принимается всеми и игнорируется.

Для сериалов first_air_date_year оставляет сериалы, у которых дата первого эфира приходится на этот год, а year также оставляет более старые сериалы, выходившие в эфир в этом году. Поиск the с year=2010 вернет The Simpsons, который впервые вышел в эфир в 1989 году, а тот же поиск с first_air_date_year=2010 не вернет. Если передать оба параметра, должны совпасть оба. Записи людей содержат до 3 тайтлов known_for, у каждого есть media_type. Путь /search/multi игнорирует year.

Найденные здесь сущности описаны дальше на страницах сериалы, люди, коллекции, компании и телесети и ключевые слова.

Мультипоиск

media_type равен movie, tv или person и подсказывает, каких полей ожидать. Записи фильмов содержат title, а записи сериалов и людей содержат name.

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

Ошибки

/search/tv и /search/person отвечают на запрос без совпадений HTTP 200, пустым массивом results и total_results, равным 0. Сейчас /search/movie, /search/multi, /search/keyword, /search/company и /search/collection отвечают в этом случае HTTP 500 и status_code 11. Считайте 500 на этих путях ответом «нет результатов», если он не повторяется для запросов, про которые вы знаете, что они находят совпадения.

Полный список смотрите на странице ошибки, а окна лимитов на странице лимиты запросов.

Практические советы

• Edge кэширует поиск на 10 минут и делит копию между ключами. Каждый вызов все равно учитывается в ваших 20, 40 или 120 запросах в минуту, потому что лимит запросов проверяется раньше кэша.
• Для поля поиска ждите 300 мс после последнего нажатия клавиши и отменяйте уже отправленный запрос. Поле, которое отправляет запрос на каждую клавишу, исчерпает тариф в 20 запросов в минуту за секунды.
• Приводите запрос к нижнему регистру и обрезайте пробелы, прежде чем использовать его как ключ кэша у себя.
• Чтобы найти тайтл по IMDb ID, пропустите поиск и используйте поиск по внешнему ID.
• ID ключевого слова из /search/keyword подставляется в фильтр with_keywords в discover, а ID компании в with_companies.