API сериалов

Детали сериала

GET /3/tv/{series_id} возвращает основную запись одного сериала: названия, описание, статус, жанры, телесети, список сезонов и указатели на последнюю и следующую серии. Id это числовой tv id из TMDB, поэтому сериал, который вы храните как 1396, сохраняет тот же id и здесь. Id фильмов и id сериалов относятся к разным пространствам, поэтому всегда храните тип медиа рядом с числом.

Пример запрашивает Breaking Bad на английском и добавляет возрастные рейтинги и внешние оценки в том же вызове.

curl -sSf "https://api.amodb.dev/3/tv/1396?language=en-US&append_to_response=content_ratings,ratings" \
  -H "Authorization: Bearer $AMODB_KEY"

const params = new URLSearchParams({ language: 'en-US', append_to_response: 'content_ratings,ratings' });
const res = await fetch(`https://api.amodb.dev/3/tv/1396?${params}`, {
  headers: { Authorization: `Bearer ${process.env.AMODB_KEY}` },
});
if (!res.ok) throw new Error(`amodb returned ${res.status}`);
const show = await res.json();
const us = show.content_ratings.results.find((r) => r.iso_3166_1 === 'US');
console.log(show.name, show.status, show.number_of_seasons, us?.rating);

import os
import requests

r = requests.get(
    "https://api.amodb.dev/3/tv/1396",
    params={"language": "en-US", "append_to_response": "content_ratings,ratings"},
    headers={"Authorization": f"Bearer {os.environ['AMODB_KEY']}"},
    timeout=10,
)
r.raise_for_status()
show = r.json()
us = next((x for x in show["content_ratings"]["results"] if x["iso_3166_1"] == "US"), None)
print(show["name"], show["status"], show["number_of_seasons"], us and us["rating"])

<?php
$url = 'https://api.amodb.dev/3/tv/1396?' . http_build_query([
    'language' => 'en-US',
    'append_to_response' => 'content_ratings,ratings',
]);
$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");
}
$show = json_decode($body, true);
echo $show['name'], ' ', $show['status'], ' ', $show['number_of_seasons'], PHP_EOL;

package main

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

type Show struct {
	Name             string `json:"name"`
	Status           string `json:"status"`
	NumberOfSeasons  int    `json:"number_of_seasons"`
	NumberOfEpisodes int    `json:"number_of_episodes"`
	Next             *struct {
		AirDate string `json:"air_date"`
	} `json:"next_episode_to_air"`
}

func main() {
	q := url.Values{"language": {"en-US"}}
	req, _ := http.NewRequest("GET", "https://api.amodb.dev/3/tv/1396?"+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 s Show
	if err := json.NewDecoder(res.Body).Decode(&s); err != nil {
		panic(err)
	}
	next := "none scheduled"
	if s.Next != nil {
		next = s.Next.AirDate
	}
	fmt.Println(s.Name, s.Status, s.NumberOfSeasons, s.NumberOfEpisodes, next)
}

Параметры

• series_idпутьобязателен
  Числовой id сериала, например 1396.
• api_keyqueryодно из двух
  Ваш ключ. Используйте его или заголовок Authorization: Bearer.
• languagequery
  Тег TMDB, например en-US, uk-UA или es-ES. Обслуживаются 14 базовых языков. По умолчанию en-US.
• append_to_responsequery
  Список подресурсов через запятую, которые нужно добавить в ответ, до 20 значений.

Поля ответа

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

GET /3/tv/1396?language=en-US&append_to_response=content_ratings,ratings, длинные массивы и тексты сокращены:

{
  "adult": false,
  "backdrop_path": "/ycFcYYnzVc8mWw41neszGPMyKc3.jpg",
  "created_by": [],
  "episode_run_time": [
    48,
    49
  ],
  "first_air_date": "2008-01-20",
  "genres": [
    {
      "id": 18,
      "name": "Drama"
    },
    {
      "id": 80,
      "name": "Crime"
    }
  ],
  "homepage": "",
  "id": 1396,
  "in_production": false,
  "languages": [
    "en"
  ],
  "last_air_date": "2013-09-29",
  "last_episode_to_air": {
    "air_date": "2013-09-29",
    "episode_number": 16,
    "episode_type": "standard",
    "id": 62161,
    "name": "פלינה",
    "overview": "הסדרה זוכת הפרסים מגיעה לסיום דרמתי בפרק החותם אותה.",
    "production_code": "",
    "runtime": 56,
    "season_number": 5,
    "show_id": 1396,
    "still_path": "/pA0YwyhvdDXP3BEGL2grrIhq8aM.jpg",
    "vote_average": 0,
    "vote_count": 0
  },
  "name": "Breaking Bad",
  "next_episode_to_air": null,
  "networks": [
    {
      "id": 174,
      "logo_path": "/pmvRmATOCaDykE6JrVoeYxlFHw3.png",
      "name": "AMC",
      "origin_country": "US"
    }
  ],
  "number_of_episodes": 62,
  "number_of_seasons": 5,
  "origin_country": [
    "US"
  ],
  "original_language": "en",
  "original_name": "Breaking Bad",
  "overview": "Walter White, a New Mexico chemistry teacher, is diagnosed with Stage III cancer and given a prognosis of o...",
  "popularity": 268.4968,
  "poster_path": "/anFx9aTOOYqgS3v7x3R84Kz67ly.jpg",
  "production_companies": [
    {
      "id": 2605,
      "logo_path": null,
      "name": "Gran Via Productions",
      "origin_country": "US"
    },
    {
      "id": 11073,
      "logo_path": "/wHs44fktdoj6c378ZbSWfzKsM2Z.png",
      "name": "Sony Pictures Television",
      "origin_country": "US"
    }
  ],
  "production_countries": [
    {
      "iso_3166_1": "US",
      "name": "United States of America"
    }
  ],
  "seasons": [
    {
      "air_date": "2009-02-17",
      "episode_count": 9,
      "id": 3577,
      "name": "特别篇",
      "overview": "",
      "poster_path": "/ikBSCmgG5Z4jequUUAjKpf1QG3T.jpg",
      "season_number": 0,
      "vote_average": 0
    },
    {
      "air_date": "2008-01-20",
      "episode_count": 7,
      "id": 3572,
      "name": "Season 1",
      "overview": "High school chemistry teacher Walter White's life is suddenly transformed by a dire medical diagnosis. Stre...",
      "poster_path": "/91EIXdWxmp2mHNRsSuDW3WyDJLj.jpg",
      "season_number": 1,
      "vote_average": 0
    }
  ],
  "spoken_languages": [
    {
      "english_name": "English",
      "iso_639_1": "en",
      "name": "English"
    },
    {
      "english_name": "Spanish",
      "iso_639_1": "es",
      "name": "Español"
    }
  ],
  "status": "Ended",
  "tagline": "Change the equation.",
  "vote_average": 9,
  "vote_count": 18863,
  "content_ratings": {
    "results": [
      {
        "descriptors": [],
        "iso_3166_1": "AT",
        "rating": "16"
      },
      {
        "descriptors": [],
        "iso_3166_1": "AU",
        "rating": "MA 15+"
      }
    ]
  },
  "ratings": {
    "imdb": {
      "value": 9.5,
      "votes": 2671962
    },
    "kinopoisk": {
      "value": 8.9,
      "votes": null
    },
    "metacritic": null,
    "rotten_tomatoes": {
      "value": 96,
      "votes": null
    },
    "tmdb": {
      "value": 9,
      "votes": 18863
    }
  }
}

Блоки content_ratings и ratings приходят из append_to_response. Названия и описания внутри seasons, last_episode_to_air и next_episode_to_air хранятся для каждой записи отдельно и могут не следовать language, как показывает название серии на иврите выше. Локализованные тексты сезонов и серий читайте в разделе сезоны и серии.

Статус и указатели на серии

status показывает, на каком этапе жизни находится сериал, а next_episode_to_air подсказывает, когда проверить снова.

У продолжающегося сериала между сезонами next_episode_to_air равен null, поэтому читайте null как «дата неизвестна», а не как «завершен».

Массив seasons содержит одно краткое описание на сезон, а сезон 0 содержит спецвыпуски. Чтобы прочитать серии сезона, вызовите эндпоинт из раздела сезоны и серии.

Связанные эндпоинты сериалов

У всех путей общая база https://api.amodb.dev/3, а эндпоинты с локализованным текстом принимают также language.

Списки рекомендаций и похожих всегда возвращают страницу 1 с 20 элементами. Ответ lists постраничный с параметром page, по 20 списков на страницу. Постраничные списки в других местах API принимают page от 1 до 500.

Возрастные рейтинги приходят записями results с iso_3166_1, rating и descriptors, поэтому выбирайте запись для страны зрителя. Сервисы просмотра сгруппированы по коду страны, и в каждой стране есть link плюс списки flatrate, rent и buy с provider_id, provider_name, logo_path и display_priority. Id сервисов для фильтрации берутся из справочных списков на странице жанры и справочные списки.

Список групп серий возвращает id (строку), name, description, type, episode_count, group_count и network. amodb перечисляет группы, но не предоставляет эндпоинт, который возвращает серии одной группы. Он также не предоставляет пути changes из TMDB.

Больше данных в одном вызове

Перечислите подресурсы в append_to_response, и каждый придет под своим ключом. Весь вызов засчитывается один раз в ваши 20, 40 или 120 запросов в минуту. Работает до 20 значений, неизвестные имена игнорируются без ошибки. Для сериала доступны такие значения:

Ошибки

Неудачный вызов возвращает тело ошибки TMDB. Неверный id дает status_code 34 с сообщением «The resource you requested could not be found.»

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

Практические заметки

• Детали сериала и все перечисленные выше подресурсы кэшируются на 6 часов. Опрашивайте last_episode_to_air не чаще нескольких раз в день.
• Запрашивайте язык, который показываете. Пустой overview означает, что перевода нет, поэтому повторите запрос с en-US как запасной вариант.
• Используйте number_of_seasons как границу цикла, когда загружаете все сезоны по одному вызову на сезон.
• Чтобы получить список сериалов, а не читать один, смотрите поиск, discover и списки трендов.