Skip to content

Latest commit

 

History

History
1311 lines (1258 loc) · 41.9 KB

usage.wiki

File metadata and controls

1311 lines (1258 loc) · 41.9 KB
Raw

Ryuuganime entries usage

This file will guide user on using Ryuuganime Anime Index File, while we trying our best creating this file like API documentation.

Table of Contents

First guide and initialization

Currently, we don't have any API for accessing database. Instead, you can use GitHub Raw links to access our data.

For machine-readable index listing, please to use index.json (recommended) or index.yaml.

We currently provide data in HJSON, JSON, YAML, and XML file format. at the moment. Thus, all data were standardized by our JSON Schema for entry.

This document will covers AIO solution on your project in any programming language.

Encoding

Ryuuganime is using UTF-8 (Unicode) with Windows' End of Line Sequence format (CRLF).

Client

Ryuuganime does not need to create any client first to request API. You only need to use GitHub Raw URL to GET, and you are done!

Data fetching URI

File fetching

  • Fetching anime data from repo
    https://raw.githubusercontent.com/ryuuganime/ryuuganime-db/master/json/<RYU-ID>/<RYU-ID>.json
    Please keep in mind that you need to change <RYU-ID> before fetch data.
  • Fetching anime index list
    https://raw.githubusercontent.com/ryuuganime/ryuuganime-db/master/list.json

Data dumps

  • GitHub Release
    https://github.com/ryuuganime/ryuuganime-db/releases/latest/download/dumps.tar.gz
    All content are gzipped in tarball format.

Using ryuuganime-db anime entry JSON file

Introduction

For our basic usage introduction, we will using RYU-1 (Ryuuganime ID: 1) on /json/000/001.json.

First, you need to get the latest metadata by request GET HTML data from GitHub Raw: 

https://raw.githubusercontent.com/ryuuganime/ryuuganime-db/master/json/000/001.json

You will get: 

{
    "$schema": "../../schemas/entry.json",
    "title": {
        "native": "富豪刑事 Balance:UNLIMITED",
        "en_Latn": "Fugou Keiji: Balance:Unlimited",
        "ar_001": "المحقق المليونير - الرصيد: غير محدود",
        "he_IL": "בלש מיליונר - איזון: ללא הגבלה",
        "id_ID": "Detektif Milyuner - Balance:UNLIMITED",
        "en_US": "The Millionaire Detective – Balance: UNLIMITED",
        "ja_JP": "富豪刑事 Balance:UNLIMITED",
        "de_DE": null,
        "ko_KR": "부호형사 Balance:UNLIMITED",
        "fr_FR": null,
        "pt_PT": null,
        "ru_RU": "Богатый детектив. Баланс: Неограничен",
        "es_ES": "El Detective Millonario - Equilibrio:Ilimitado",
        "zh_Hans": "富豪刑事 Balance:UNLIMITED",
        "zh_Hant": "富豪刑事 Balance:UNLIMITED",
        "vi_VN": "Thám Tử Triệu Phú"
    },
    "backdrop": "https://artworks.thetvdb.com/banners/series/376211/backgrounds/5e8f9ab57e0ed.jpg",
    "visualKey": "https://artworks.thetvdb.com/banners/series/376211/posters/62114838.jpg",
    "synopsis": {
        "ar_001": "قصة أنمي Fugou Keiji: Balance:Unlimited تدور حول المحقق دايسكي كانبي المليونير فاحش الثراء الذي يحل القضايا بطرق وقحة غير تقليدية.",
        "he_IL": null,
        "id_ID": "Daisuke Kanbe, seorang detektif dengan aset luar biasa. Daisuke Kanbe ditugaskan ke Markas Besar Pencegahan Kejahatan Modern, hanya mereka yang telah menyebabkan masalah bagi Departemen Kepolisian Metropolitan yang dikirim. Di sana, Daisuke bertemu dengan Haru Katou. Mereka harus bekerja sama untuk mengungkap berbagai kasus misteri.",
        "en_US": "The incredibly wealthy Daisuke Kanbe audaciously solves cases in unconventional ways. Kanbe is assigned to the \"Modern Crimes Task Unit\" — a unit created to keep problematic officers away from others. There, Kanbe becomes partners with Katou.",
        "ja_JP": "ケタ外れの資産をもつ神戸家の御曹司・大助が赴任したのは、 警視庁で問題を起こした人間だけが送り込まれる 「現代犯罪対策本部準備室」、通称「現対本部」。 そこで大助は情に厚い男・加藤 春とバディを組まされる。 人の命すら値踏みする大助に対して「世の中金じゃねぇ」と反発する加藤。 対立する2人の前に立ちはだかる、様々な事件と謎。 常識を超えた捜査が今、始まる――！",
        "de_DE": "Die Anime-Serie »The Millionaire Detective – Balance: UNLIMITED« dreht sich um den wohlhabenden und materialistisch veranlagten Detektiv Daisuke Kambe. Nachdem Daisuke Probleme auf seiner Polizeibehörde verursacht hat, wird er zum Hauptquartier zur Verhütung moderner Verbrechen gesandt, was eine Art Sammelpool für Leute wie ihn ist, die der Polizei nichts als Ärger bereitet haben.\nDort trifft er auf seinen künftigen Partner Haru Kato, die beide unterschiedlicher nicht sein könnten. Denn Kato ist der festen Überzeugung, dass Geld nicht alles auf der Welt ist und daher hat er für Daisukes materiell geprägte Lebensweise nicht viel übrig. Doch die beiden Detektive müssen ihre persönlichen Differenzen überwinden, um gemeinsam die vor ihnen liegenden Kriminalfälle lösen zu können.",
        "ko_KR": "부유한 자산을 가진 칸베 가문의 후계자 다이스케가 부임하게 된 곳은, 경시청에서 문제를 일으킨 사람들만 보내진다는 현대 범죄 대책 본부 준비실, 통칭 '현대 본부'.\n그 곳에서 다이스케는 정이 많은 남자 카토 하루와 함께 팀을 이루게 되고, 카토는 사람의 목숨에 값을 매기는 다이스케에게 세상은 돈이 다가 아니라며 반발한다.\n대립하는 두 사람의 앞을 가로막는 여러가지 사건과 수수께끼.\n상식을 뛰어넘는 수사가 지금, 시작된다-",
        "fr_FR": "Lorsque qu’une personne du Département de la Police métropolitaine de Tokyo pose problème, elle est transférée dans le « Nouveau Quartier Général Anti-Criminalité ». C’est là qu’est envoyé Daisuke, le fils riche et exceptionnel de l’illustre famille Kambe. Contre toute attente, il fera équipe avec le bienveillant Haru Kato. Daisuke, lui, considère que la vie a un prix, alors que Kato pense au contraire qu’elle est inestimable. Deux personnes que tout oppose, unies face aux nombreux mystères et incidents qui se dressent devant eux... C’est le début d’enquêtes défiant toute logique !",
        "pt_PT": "A história gira em torno do milionário Daisuke Kambe, herdeiro de uma das famílias mais ricas do Japão, designado como detetive da Força-Tarefa de Prevenção ao Crime Moderno (também conhecida como MCPTF), no Departamento de Polícia Metropolitana de Tóquio. Aproveitando ao máximo sua vasta riqueza, ele não economiza para solucionar crimes complexos e tem a tendência de avaliar tudo, incluindo vidas humanas individuais em termos de seu valor monetário. Haru Katou, um detetive de coração compassivo que acredita que dinheiro não é tudo, é escolhido como parceiro de Kambe, mas é repelido por sua atitude materialista. Tendo personalidades diametralmente opostas, testemunhe como os dois se unem para enfrentar crimes e mistérios aparentemente insolúveis!",
        "ru_RU": "«Деньги могут всё!» — примерно такого девиза придерживается детектив Дайсукэ Камбэ, у которого денег куры не клюют. Однако к чести детектива, надо отметить, что финансы он тратит в том числе и на ведение расследований. Вот только не всех в столичном Управлении полиции устраивает такой подход, и Дайсукэ благополучно сплавляют в Главное управление по борьбе с современными преступлениями, где рано или поздно оказываются все неугодные и проблемные полицейские. В пару Дайсукэ назначают Хару Като, который не одобряет методы Дайсукэ и убеждён, что некоторые вещи не купишь. Двум детективам предстоит как-то притереться друг к другу, параллельно расследуя запутанные криминальные загадки.",
        "es_ES": "La historia se centra en el increíblemente rico Daisuke Kanbe, quien es un detective que se encarga de resolver casos de la manera más poco convencional. Aunque la novela de Tsutsui se publicó entre 1975 y 1977, el anime se desarrollará en la era moderna. Kanbe es asignado a la “Unidad de Combate de Crímenes Modernos”, una unidad que, de hecho, fue creada para apartar a los oficiales problemáticos de los demás. Allí, Kanbe se hace compañero de Katou.",
        "zh_Hans": "本作故事主要讲述刑警神户大助，利用大富豪父亲的巨大资产解决各种案件。\n拥有不可计数资产的神户家大少爷大助即将赴任的地方，是仅会接收警视厅中的问题份子的「现代犯罪对策本部准备室」，通称「现对本部」。\n大助在那里与重感情的男人加藤春组成了搭档。面对用钱衡量一切的大助，加藤以「世上并非只有金钱」加以反驳。各种各样的事件和谜团，阻挡在这对立的2人面前。超越常识的搜查现在开始！",
        "zh_Hant": "本作故事主要講述刑警神戶大助，利用大富豪父親的巨大資產解決各種案件。\n擁有不可計數資產的神戶家大少爺大助即將赴任的地方，是僅會接收警視廳中的問題份子的「現代犯罪對策本部準備室」，通稱「現對本部」。\n大助在那裏與重感情的男人加藤春組成了搭檔。面對用錢衡量一切的大助，加藤以「世上並非只有金錢」加以反駁。各種各樣的事件和謎團，阻擋在這對立的2人面前。超越常識的搜查現在開始！",
        "vi_VN": "Kanbe Daisuke, một thám tử xuất thân từ gia đình giàu có sở hữu khối tài sản lớn không đếm xuể, anh được giao làm thám tử cho Ban phòng chống tội phạm hiện đại tại Sở Cảnh sát Thủ đô Tokyo. Tại đây, Kanbe hợp tác với Haru Katou, người có quan niệm tiền không phải tất cả, không thiện cảm mấy với việc tiêu xài tiền của Kanbe. Những bí ẩn đầy thách thức mở ra trước mắt hai thám tử, họ cùng hợp tác giải quyết các vụ án."
    },
    "information": {
        "synonyms": {
            "en_Latn": [
                "Fugō Keiji Balance: Unlimited",
                "FugouKeijiBUL"
            ],
            "ar_001": null,
            "hu_HU": null,
            "he_IL": null,
            "id_ID": null,
            "en_US": [
                "Wealthy Detective"
            ],
            "ja_JP": null,
            "de_DE": null,
            "ko_KR": null,
            "fr_FR": null,
            "pt_PT": null,
            "ru_RU": null,
            "es_ES": null,
            "zh_Hans": null,
            "zh_Hant": null,
            "vi_VN": null
        },
        "type": {
            "en_US": "TV",
            "id_ID": "Serial TV"
        },
        "status": {
            "en_US": "Airing",
            "id_ID": "Mengudara"
        },
        "serialGenre": {
            "en_US": [
                "Drama",
                "Mystery",
                "Comedy",
                "Crime"
            ],
            "id_ID": [
                "Drama",
                "Misteri",
                "Komedi",
                "Kriminalitas"
            ]
        },
        "serialTags": {
            "en_US": [
                "Detectives",
                "Police",
                "Billionaire",
                "Investigation",
                "Male Protagonist"
            ],
            "id_ID": [
                "Detektif",
                "Polisi",
                "Milyuner",
                "Investigasi",
                "Tokoh Utama Laki-Laki"
            ]
        },
        "releaseSeason": {
            "en_US": "Spring",
            "id_ID": "Semi",
            "ja_JP": "春",
            "ko_KR": "봄",
            "zh_Hans": "春天",
            "zh_Hant": "春天"
        },
        "releaseYear": 2020,
        "episode": 11,
        "releaseDate": "2020-04-10",
        "endDate": null,
        "duration": 23,
        "totalDuration": null,
        "studio": "CloverWorks",
        "rating": "PG13+",
        "isNsfw": false,
        "adaptation": {
            "en_US": "Novel",
            "id_ID": "Novel"
        },
        "country": {
            "en_US": "Japan",
            "id_ID": "Jepang"
        },
        "officialWebsite": "https://www.fugoukeiji-bul.com/",
        "promotionalVideos": [
            "https://www.youtube.com/watch?v=Z2GGJHXtOJ8"
        ],
        "producers": [
            "Aniplex",
            "Dentsu",
            "Animax",
            "Movic",
            "Fuji TV",
            "Sonilude"
        ]
    },
    "scores": {
        "aniDB": {
            "id": 15364,
            "score": 6.07
        },
        "AniList": {
            "id": 114888,
            "score": 73
        },
        "AnimePlanet": {
            "url": "https://www.anime-planet.com/anime/the-millionaire-detective-balance-unlimited",
            "id": 14492,
            "score": 4.207
        },
        "ANN": {
            "id": 22980,
            "score": null
        },
        "aniSearch": {
            "url": "https://www.anisearch.com/anime/14906,fugou-keiji-balance-unlimited",
            "id": 14906,
            "score": 71
        },
        "Annict": {
            "id": 7271,
            "score": 86.67
        },
        "IMDb": {
            "code": "tt12117218",
            "score": 8.1
        },
        "KinoPoisk": {
            "id": 1368169,
            "score": null
        },
        "Kitsu": {
            "slug": "fugou-keiji-balance-unlimited",
            "id": 43056,
            "score": 80.56
        },
        "LiveChart": {
            "id": 9777,
            "score": 8.27
        },
        "MyAnimeList": {
            "id": 41120,
            "score": 7.51
        },
        "MyShows": {
            "id": 66109,
            "score": 4.44
        },
        "Nautiljon": {
            "url": "https://www.nautiljon.com/animes/fugou+keiji+balance+-+unlimited.html",
            "score": 8.97
        },
        "Notify": {
            "base64": "TM1LPA8Wg",
            "score": 8.32
        },
        "OtakOtaku": {
            "id": 1724,
            "score": 9
        },
        "Shikimori": {
            "id": 41120,
            "score": 7.51
        },
        "SIMKL": {
            "id": 1247789,
            "score": 8.6
        },
        "TMDB": {
            "url": "https://www.themoviedb.org/tv/98491-balance-unlimited",
            "id": 98491,
            "score": 80
        },
        "Trakt": {
            "url": "https://trakt.tv/shows/157673",
            "id": 157673,
            "score": 73
        },
        "TVTime": {
            "id": 376211,
            "score": 9.76
        }
    },
    "updatedDate": "2020-05-05T16:54:42+07:00",
    "streamLinks": {
        "Abematv": null,
        "AdultSwim": null,
        "AISPlay": null,
        "All4": null,
        "AniMe": null,
        "AnimeDigitalNetwork": null,
        "AnimeLab": "https://www.animelab.com/shows/balance-unlimited",
        "AnimeLog": null,
        "AnimeOnDemand": null,
        "AnimePlanet": null,
        "animeteleto": null,
        "AniOne": "https://www.youtube.com/playlist?list=PLxSscENEp7JjK6AR9OjeYkwGCVTgCFEWz",
        "ANIPLUS": null,
        "AniPlusAsia": null,
        "AsianCrush": null,
        "BahamutAnimeCrazy": null,
        "BandaiChannel": null,
        "BandaiSpirits": null,
        "bilibili": "https://www.bilibili.com/bangumi/media/md28228473",
        "Coalise": null,
        "ComicFestaAnimeZone": null,
        "ConTV": null,
        "Coolmic": null,
        "Crunchyroll": null,
        "dAnimeStore": null,
        "DMM": null,
        "FOD": null,
        "Funimation": "https://www.funimation.com/shows/the-millionaire-detective-balance-unlimited/",
        "Genflix": null,
        "GundamInfo": null,
        "Gyao": null,
        "HIDIVE": null,
        "Hulu": null,
        "iflix": null,
        "iQIYI": null,
        "JapaneseAnimatedFilmClassic": null,
        "Mangas": null,
        "MBSDougaizm": null,
        "MidnightPulp": null,
        "MuseAsia": {
            "en_001": null,
            "vi_VN": null,
            "ms_MY": null,
            "th_TH": null,
            "zh_Hant_HK": null,
            "zh_Hant_TW": null
        },
        "Netflix": "https://www.netflix.com/jp-en/title/81039113",
        "NicoNico": null,
        "PrimeVideo": null,
        "RetroCrush": null,
        "SelectaVision": null,
        "Sushiroll": null,
        "Telasa": null,
        "TencentVideo": null,
        "TVNOW": null,
        "Vimeo": null,
        "VIZ": null,
        "VRV": null,
        "VVVVID": null,
        "Wakanim": {
            "fr": "https://www.wakanim.tv/fr/v2/catalogue/show/842",
            "sc": "https://www.wakanim.tv/sc/v2/catalogue/show/844",
            "de": "https://www.wakanim.tv/de/v2/catalogue/show/843",
            "ru": "https://www.wakanim.tv/ru/v2/catalogue/show/845"
        },
        "WeTV": null,
        "YamatoAnimation": null,
        "YouTube": {
            "link": null,
            "isChannel": false
        }
    },
    "signature": {
        "name": "Natsu Tadama",
        "username": "@nattadasu",
        "discordId": 384089845527478300,
        "submissionDateTime": "2020-05-05T17:26:00+07:00",
        "sign": "RGlnaXRhbGx5IFNpZ25lZCBieSBOYXRzdSBUYWRhbWEgQCBBY2VoLCBJbmRvbmVzaWE="
    }
}

JSON attributes

  • Type: Object
  • Requires:
    $schema, title, backdrop, visualKey, synopsis, information, scores, updatedDate, streamLinks, signature
  • Additional properties: false

$schema

Path to Ryuuganime JSON schema for Entry.

  • Type: String
    • Format: URI
  • Pattern: "\.\./\.\./schemas/entry\.json or https://raw\.githubusercontent\.com/ryuuganime/ryuuganime-db/master/schemas/entry\.json

title

A serial title in multiple languages. Based on ICU locales.

  • Type: Object
  • Requires:
    native, en_Latn, ar_001, id_ID, en_US, ja_JP, de_DE, ko_KR, fr_FR, pt_PT, ru_RU, es_ES, zh_Hans, zh_Hant, vi_VN
  • Additional properties: true
    • Pattern: ^[a-z]{2,3}_[\w]{2,4}$
  • Not null: false
Field name Type Note
native String A serial title in native/origin language (Canonical). Value can not be empty.
en_Latn Serial title in romanized text. Required for main title on entry list. Value can not be empty.
ar_001 Serial title in Modern Standard/Written Arabic (العربية الفصحى).
id_ID Serial title in Indonesian.
en_US Serial title in English (United States) or else.
ja_JP Serial title in Japanese.
de_DE Serial title in German.
ko_KR Serial title in Korean.
fr_FR Serial title in French.
pt_PT Serial title in Portuguese.
ru_RU Serial title in Russian.
es_ES Serial title in Spanish.
zh_Hans Serial title in Simplified Chinese.
zh_Hant Serial title in Traditional Chinese.
vi_VN Serial title in Vietnamese.

backdrop

A backdrop/background/cover image URI of serial.

  • Type: String
    • Format: URI
  • Pattern: ^(https?)://

visualKey

A visual key/poster image URI of serial.

  • Type: String
    • Format: URI
  • Pattern: ^(https?)://

synopsis

A synopsis/plot of story of serial in several languages. Based on ICU locales.

  • Requires:
    en_Latn, ar_001, id_ID, en_US, ja_JP, de_DE, ko_KR, fr_FR, pt_PT, ru_RU, es_ES, zh_Hans, zh_Hant, vi_VN
  • Additional properties: true
  • Not null: false
Field name Type Note
ar_001 String Serial synopsis in Modern Standard/Written Arabic (العربية الفصحى).
id_ID Serial synopsis in Indonesian.
en_US Serial synopsis in English (United States) or else.
ja_JP Serial synopsis in Japanese.
de_DE Serial synopsis in German.
ko_KR Serial synopsis in Korean.
fr_FR Serial synopsis in French.
pt_PT Serial synopsis in Portuguese.
ru_RU Serial synopsis in Russian.
es_ES Serial synopsis in Spanish.
zh_Hans Serial synopsis in Simplified Chinese.
zh_Hant Serial synopsis in Traditional Chinese.
vi_VN Serial synopsis in Vietnamese.

information

A collection of information about serial.

  • Type: Object
  • Requires:
    synonyms, type, status, serialGenre, serialTags, releaseSeason, releaseYear, episode, releaseDate, endDate, duration, totalDuration, studio, rating, isNsfw, adaptation, country
  • Additional properties: false
  • Not null: true

synonyms

Serial title synonyms in several languages. Based on ICU locales.

  • Type: Object
  • Requires:
    en_Latn, ar_001, id_ID, en_US, ja_JP, de_DE, ko_KR, fr_FR, pt_PT, ru_RU, es_ES, zh_Hans, zh_Hant, vi_VN
  • Additional properties: true
  • Not null: false
Field name Type Note
en_Latn String Serial title synonyms in romanized text.
ar_001 Serial title synonyms in Modern Standard/Written Arabic (العربية الفصحى).
id_ID Serial title synonyms in Indonesian.
en_US Serial title synonyms in English (United States) or else.
ja_JP Serial title synonyms in Japanese.
de_DE Serial title synonyms in German.
ko_KR Serial title synonyms in Korean.
fr_FR Serial title synonyms in French.
pt_PT Serial title synonyms in Portuguese.
ru_RU Serial title synonyms in Russian.
es_ES Serial title synonyms in Spanish.
zh_Hans Serial title synonyms in Simplified Chinese.
zh_Hant Serial title synonyms in Traditional Chinese.
vi_VN Serial title synonyms in Vietnamese.

type

Serial type.

  • Type: Object
  • Requires:
    en_US, id_ID
  • Additional properties: false
  • Not null: true
Field name Type Note
en_US String Enum of: TV, ONA, OVA, OAD, Special, Movie, Music, Unknown
id_ID Enum of: TV, ONA, OVA, OAD, Spesial, Film, Musik, Tidak Diketahui

status

Describes the serial broadcast status.

  • Type: Object
  • Requires:
    en_US, id_ID
  • Additional properties: false
  • Not null: true
Field name Type Note
en_US String Enum of: Aired, Airing, Planned, TBA, and Unknown
id_ID Enum of: Ditayangkan, Mengudara, Direncanakan, Akan Diumumkan, and Tidak Diketahui

serialGenre

Genre(s) of the serial

  • Type: Object
  • Requires:
    en_US, id_ID
  • Additional properties: false
  • Not null: true
Field name Type Note
en_US Array Enum of: Action, Adventure, Comedy, Crime, Documentary, Drama, Fantasy, History, Horror, Mature, Mecha, Music, Mystery, Psychological, Romance, Science Fiction, Slice of Life, Sport, Supernatural, Thriller, War
id_ID Enum of: Aksi, Petualangan, Komedi, Kriminalitas, Dokumentasi, Drama, Fantasi, Sejarah, Horror, Dewasa, Mecha, Musik, Misteri, Psikologis, Romansa, Fiksi Ilmiah, Potongan Kehidupan, Olahraga, Supernatural, Thriller, Peperangan

serialTags

Represents serial specific tags/content. Similar to the serialGenres, but usually more focused on content, storyline, or themes. But, all of serialGenres value will be ignored if present on serialTags. See the wiki for more information.

  • Type: Object
  • Requires:
    en_US, id_ID
  • Additional properties: false
  • Not null: true
Field name Type Note
en_US Array Not an enum from: Action, Adventure, Comedy, Crime, Documentary, Drama, Fantasy, History, Horror, Mature, Mecha, Music, Mystery, Psychological, Romance, Science Fiction, Slice of Life, Sport, Supernatural, Thriller, War
id_ID Not an enum from: Aksi, Petualangan, Komedi, Kriminalitas, Dokumentasi, Drama, Fantasi, Sejarah, Horror, Dewasa, Mecha, Musik, Misteri, Psikologis, Romansa, Fiksi Ilmiah, Potongan Kehidupan, Olahraga, Supernatural, Thriller, Peperangan

releaseSeason

Season of serial releases.

  • Type: Object
  • Requires:
    en_US, id_ID, ja_JP, ko_KR, zh_Hans, zh_Hant
  • Additional properties: false
  • Not null: true
Field name Type Note
en_US String Enum of: Winter, Spring, Summer, Fall, Unknown
id_ID Enum of: Dingin, Semi, Panas, Gugur, Tidak Diketahui
ja_JP Enum of: 冬, 春, 夏, 秋, 不明
ko_KR Enum of: 겨울, 봄, 여름, 가을, 알
zh_Hans Enum of: 冬天, 春天, 夏天, 秋天, 未知
zh_Hant Enum of: 冬天, 春天, 夏天, 秋天, 未知

releaseYear

The year of the serial release, using a integrer/numeral format.

  • Type: Number
  • Minumum number: 1000
  • Maximum number: 2999
  • Not null: false

episode

Total episodes of serial.

  • Type: Number
  • Minumum number: 0
  • Not null: false

releaseDate

Start date of serial release, using YYYY-MM-DD format.

  • Type: String
    • Format: Date
  • Pattern: ^[12]{1}[0-9]{3}\-([0]{1}[1-9]{1}|[1]{1}[0-2]{1})\-([0-2]{1}[0-9]{1}|[3]{1}[01]{1})
  • Not null: false

endDate

End date of serial release, using YYYY-MM-DD format.

  • Type: String
    • Format: Date
  • Pattern: ^[12]{1}[0-9]{3}\-([0]{1}[1-9]{1}|[1]{1}[0-2]{1})\-([0-2]{1}[0-9]{1}|[3]{1}[01]{1})
  • Not null: false

duration

Duration per serial episode, using minute format.

  • Type: Number
  • Minumum number: 0
  • Not null: false

totalDuration

Total serial duration in minutes.

  • Type: Number
  • Minumum number: 0
  • Not null: false

studio

Studio producing series.

  • Type: String or Array
  • Not null: false

rating

Content rating of the serial

  • Type: String
  • Enum: G0+, PS2+, PG7+, PG13+, R8+, GU21+
  • Not null: false

isNsfw

Mark the serial if contains NSFW content.

  • Type: Boolean
  • Not null: true

adaptation

Mark the serial if it's adapted from different source or not.

  • Type: Object
  • Requires:
    en_US, id_ID
  • Additional properties: false
  • Not null: true
Field name Type Note
en_US String/null Enum of: Original, Comic, Manga, Manhwa, Manhua, Webtoon, Doujin, Novel, Game, Music, Drama, 4-koma, Fairy Tale
id_ID Enum of: Orisinal, Komik, Manga, Manhwa, Manhua, Webtoon, Doujin, Novel, Gim, Musik, Drama, 4-panel, Dongeng

country

Country of origin of serial. No country restrictions for this field.

  • Type: Object
  • Requires:
    en_US, id_ID
  • Additional properties: false
  • Not null: true
Field name Type Note
en_US String
id_ID

scores

Scores from several websites

  • Type: Object
  • Requires:
    aniDB, AniList, AnimePlanet, ANN, aniSearch, Annict, IMDb, KinoPoisk, Kitsu, LiveChart, MyAnimeList, MyShows, Nautiljon, Notify, OtakOtaku, Shikimori, SIMKL, TMDB, Trakt, TVTime
  • Additional properties: false
  • Not null: true
Field name Type Note
aniDB Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.00
  • Maximum: 10.00
  • Not null: false
AniList Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0
  • Maximum: 100
  • Not null: false
AnimePlanet Object
  url String
  • Format: URI
  • Pattern: ^(https?)://www\.anime-planet\.com/anime/[a-z0-9\-]+
  • Not null: false
id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.000
  • Maximum: 5.000
  • Not null: false
ANN Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.000
  • Maximum: 10.000
  • Not null: false
aniSearch Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0
  • Maximum: 100
  • Not null: false
Annict Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.00
  • Maximum: 100.00
  • Not null: false
IMDb Object
  • URL: https://imdb.com/
  • Required: code, score
  • Additional properties: false
  • Not null: true
  code String
  • Pattern: ^(tt)?[0-9]{5,}
score Number
  • Minimum: 0.0
  • Maximum: 10.0
  • Not null: false
KinoPoisk Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.00
  • Maximum: 100.00
  • Not null: false
Kitsu Object
  • URL: https://kitsu.io/
  • Required: id, score
  • Additional properties: false
  • Dependency:
    • id: slug
  • Not null: true
  slug String
  • Pattern: ^[\w\-\.]+
  • Not null: false
id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.00
  • Maximum: 100.00
  • Not null: false
LiveChart Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.00
  • Maximum: 10.00
  • Not null: false
MyAnimeList Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.00
  • Maximum: 10.00
  • Not null: false
MyShows Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.00
  • Maximum: 5.00
  • Not null: false
Nautiljon Object
  url String
  • Format: URI
  • Pattern: ^(https?)://(www\.)?nautiljon\.com/animes/
  • Not null: false
score Number
  • Minimum: 0.00
  • Maximum: 10.00
  • Not null: false
Notify Object
  base64 String
  • Pattern: ^[\w_\-]+
  • Not null: false
score Number
  • Minimum: 0.00
  • Maximum: 10.00
  • Not null: false
OtakOtaku Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.00
  • Maximum: 10.00
  • Not null: false
Shikimori Object
  • URL: https://shikimori.org/
  • Required: id, score
  • Additional properties: false
  • Dependencies:
    • moved: newId
    • newId: moved
  • Not null: true
  id Number
  • Exclusive Minimum: 0
  • Not null: false
moved Boolean
  • Default: false
newId String
  • Pattern: ^[A-Za-z]+[0-9]+
score Number
  • Minimum: 0.00
  • Maximum: 10.00
  • Not null: false
SIMKL Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.0
  • Maximum: 10.0
  • Not null: false
TMDB Object
  url String
  • Format: URI
  • Pattern: ^(https?)://(www\.themoviedb|themoviedb)\.org/(movie|tv)/[0-9]+
  • Not null: false
id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0
  • Maximum: 100
  • Not null: false
Trakt Object
  • URL: https://trakt.tv/
  • Required: id, score
  • Dependency:
    • id: url
  • Additional properties: false
  • Not null: true
  url String
  • Format: URI
  • Pattern: ^(https?)://trakt\.tv/(movies|shows)/([0-9]+|[\w\-]+)
  • Not null: false
id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0
  • Maximum: 100
  • Not null: false
TVTime Object
  id Number
  • Exclusive Minimum: 0
  • Not null: false
score
  • Minimum: 0.00
  • Maximum: 10.00
  • Not null: false

updatedDate

Date and time of latest changes to JSON. Based on ISO 8601.

  • Type: String
  • Format: Date-Time
  • Pattern:
    ^[12]{1}[0-9]{3}\-([0]{1}[1-9]{1}|[1]{1}[0-2]{1})-([0-2]{1}[0-9]{1}|[3]{1}[01]{1})T([01]{1}[0-9]{1}|[2]{1}[0-4]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})(\-|\+)([0]{1}[0-9]{1}|[1]{1}[0-3]{1}):([0-5]{1}[0-9]{1})
  • Additional properties: false
  • Not null: true

signature

A virtual signature of entry contributor

  • Type: Object
  • Requires: name, username, discordId, submissionDateTime, sign,
  • Additional properties: false
  • Not null: true
Field name Type Note
name String Contributor's name
  • Pattern: ^[\w\s\W\S]+
  • Not null: true
username Contributor GitHub username
  • Pattern: ^@[\w\s\W\S\.\-_]+
  • Not null: true
discordId Number Discord User ID
  • Pattern: ^[0-9]{16,}
  • Not null: true
submissionDateTime String Date and time of submission
  • Pattern:
    ^[12]{1}[0-9]{3}\-([0]{1}[1-9]{1}|[1]{1}[0-2]{1})-([0-2]{1}[0-9]{1}|[3]{1}[01]{1})T([01]{1}[0-9]{1}|[2]{1}[0-4]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})(\-|\+)([0]{1}[0-9]{1}|[1]{1}[0-3]{1}):([0-5]{1}[0-9]{1})
  • Not null: true
sign String/Number Unique random characters made by contributor
  • Not null: true

Guideline

  • Not null: boolean
    Value can be changed to null if true. Otherwise, value can not be changed to null if false.