API

فایل base.json یک سریال همه فصل‌ها و قسمت‌های آن را در بر دارد، پس با یک درخواست کل سریال را دریافت می‌کنید. نام‌ها و توضیحات سریال، فصل‌ها و قسمت‌ها در فایل‌های زبان هستند.

فایل‌ها

https://api.watchittrackit.com/v1/tv/{id}/base.json
https://api.watchittrackit.com/v1/tv/{id}/{lang}.json
https://api.watchittrackit.com/v1/tv/slugs/{shard}.json

هر تصویر یک شیء با مسیرهای full و thumb است.

base.json

فیلد	نوع	توضیح
type	string	نوع رکورد.
id	number	شناسه TheTVDB.
slug	string	slug نشانی URL، یکتا در هر نوع.
popularity	number	امتیاز محبوبیت TheTVDB؛ امتیاز بالاتر یعنی محبوب‌تر. امتیازها فقط در یک نوع قابل مقایسه‌اند.
deleted	boolean	اگر رکورد حذف شده باشد true است. فایل‌هایش همچنان منتشر می‌مانند.
firstAired	string	تاریخ نخستین قسمت (YYYY-MM-DD).
lastAired	string	تاریخ آخرین قسمت.
status	string	وضعیت پخش از TheTVDB، مانند Continuing or Ended.
network	string	شبکه.
originalLanguage	string	کد زبان اصلی.
originalCountry	string	کشور اصلی (کد سه‌حرفی).
image	image	تصویر اصلی: پوستر برای آثار، عکس برای افراد.
images	{ [kind]: image }	بهترین تصویر از هر نوع: poster, background, banner, icon, clearart, clearlogo.
imagesByLang	{ [kind]: image[] }	برای هر نوع، بهترین تصویر در هر زبان، همراه با کد زبان، اندازه و امتیاز آن.
cast	credit[]	بازیگران، به ترتیب تیتراژ.
crew	credit[]	سایر افراد دارای اعتبار، همراه با سمتشان.
topBilledIds	number[]	شناسه افرادی که باید اول نمایش داده شوند.
seasons	season[]	فصل‌ها به ترتیب پخش، هر کدام با قسمت‌هایش.
genres	string[]	slugهای ژانر، مطابق تعریف TheTVDB.
languages	string[]	زبان‌هایی که این رکورد برایشان فایل دارد.
remoteIds	{ [site]: string }	شناسه‌ها در سایت‌های دیگر (imdb, tmdb, wikidata, …)، به تفکیک سایت.

نمونه

{
  "type": "tv",
  "id": 81189,
  "slug": "breaking-bad",
  "popularity": 3287090,
  "deleted": false,
  "firstAired": "2008-01-20",
  "lastAired": "2013-09-29",
  "status": "Ended",
  "images": {
    "poster": { "full": "/images/tv/81189/1340353429.jpg", "thumb": "/images/tv/81189/1340353429.t.jpg" }
  },
  "cast": [
    { "id": 255211, "activityId": 180, "role": "Walter White", "slug": "bryan-cranston", "topBilled": false, "deleted": false }
  ],
  "seasons": [
    {
      "id": 30272, "number": 1, "deleted": false,
      "episodes": [{ "id": 349232, "number": 1, "aired": "2008-01-20", "runtime": 58, "deleted": false }]
    }
  ],
  "genres": ["drama", "crime"],
  "languages": ["de", "en", "fr"],
  "remoteIds": { "imdb": "tt0903747" }
}

فصل‌ها

فیلد	نوع	توضیح
id	number	شناسه TheTVDB.
number	number	شماره فصل؛ 0 برای قسمت‌های ویژه است.
deleted	boolean	اگر رکورد حذف شده باشد true است. فایل‌هایش همچنان منتشر می‌مانند.
image	image	تصویر اصلی: پوستر برای آثار، عکس برای افراد.
images	{ [kind]: image }	بهترین تصویر از هر نوع: poster, background, banner, icon, clearart, clearlogo.
imagesByLang	{ [kind]: image[] }	برای هر نوع، بهترین تصویر در هر زبان، همراه با کد زبان، اندازه و امتیاز آن.
episodes	episode[]	قسمت‌های فصل.

قسمت‌ها

فیلد	نوع	توضیح
id	number	شناسه TheTVDB.
number	number	شماره قسمت در فصل خود.
aired	string	تاریخ پخش (YYYY-MM-DD).
runtime	number	مدت به دقیقه.
image	image	تصویر اصلی: پوستر برای آثار، عکس برای افراد.
criticalToStory	boolean	به‌عنوان قسمتی ضروری برای داستان علامت خورده است.
specialType	string	نوع قسمت ویژه (قسمت‌های فصل 0).
deleted	boolean	اگر رکورد حذف شده باشد true است. فایل‌هایش همچنان منتشر می‌مانند.

عوامل

هر مورد در cast و crew:

فیلد	نوع	توضیح
id	number	شناسه فرد.
activityId	number	شناسه اعتبار، یکتا برای هر اعتبار.
role	string	نقش ایفاشده (بازیگران).
job	string	سمت (عوامل پشت صحنه): director, writer, producer, …
slug	string	slug فرد.
image	image	عکس فرد.
topBilled	boolean	اعتبار برجسته.
deleted	boolean	اگر فرد حذف شده باشد true است.

فایل‌های زبان

فیلد	نوع	توضیح
type	string	نوع رکورد.
id	number	شناسه TheTVDB.
lang	string	زبان این فایل.
name	string	نام به این زبان.
overview	string	توضیح به این زبان.
credits	{ [personId]: { name, role } }	برای هر شناسه فرد: نام او به این زبان و نقشش.
seasons	{ [seasonId]: { name, overview } }	برای هر شناسه فصل: نام و توضیح آن.
episodes	{ [episodeId]: { name, overview } }	برای هر شناسه قسمت: نام و توضیح آن.

نمونه

{
  "type": "tv",
  "id": 81189,
  "lang": "en",
  "name": "Breaking Bad",
  "overview": "When Walter White, a chemistry teacher, …",
  "credits": { "255211": { "name": "Bryan Cranston", "role": "Walter White" } },
  "seasons": { "30272": { "overview": "High school chemistry teacher Walter White…" } },
  "episodes": { "349232": { "name": "Pilot", "overview": "When an unassuming high school chemistry teacher…" } }
}

یافتن یک اثر با slug آن

نشانی‌های URL سریال‌ها و فیلم‌ها از slug استفاده می‌کنند (breaking-bad). فهرست slug هر slug را به شناسه‌اش نگاشت می‌کند و به 256 فایل کوچک تقسیم شده است: نام فایل هر slug دو نویسه اول هگزادسیمال SHA-1 آن slug است.

// Node.js
import { createHash } from "node:crypto"

const slug = "breaking-bad"
const shard = createHash("sha1").update(slug, "utf8").digest("hex").slice(0, 2)
const index = await fetch(`https://api.watchittrackit.com/v1/tv/slugs/${shard}.json`).then((r) => r.json())
const id = index[slug]
const record = await fetch(`https://api.watchittrackit.com/v1/tv/${id}/base.json`).then((r) => r.json())