jikan-api-lightweight-client
Version:
Lightweight Jikan API client. Exports only minimal Fetch call. Fully compatible with AWS LLRT.
2,763 lines (2,641 loc) • 131 kB
text/typescript
// This file is auto-generated by @hey-api/openapi-ts
/**
* User's anime list status filter options
*/
export type user_anime_list_status_filter =
| 'all'
| 'watching'
| 'completed'
| 'onhold'
| 'dropped'
| 'plantowatch';
/**
* Available Anime order_by properties
*/
export type anime_search_query_orderby =
| 'mal_id'
| 'title'
| 'start_date'
| 'end_date'
| 'episodes'
| 'score'
| 'scored_by'
| 'rank'
| 'popularity'
| 'members'
| 'favorites';
/**
* Available Anime audience ratings<br><br><b>Ratings</b><br><ul><li>G - All Ages</li><li>PG - Children</li><li>PG-13 - Teens 13 or older</li><li>R - 17+ (violence & profanity)</li><li>R+ - Mild Nudity</li><li>Rx - Hentai</li></ul>
*/
export type anime_search_query_rating =
| 'g'
| 'pg'
| 'pg13'
| 'r17'
| 'r'
| 'rx';
/**
* Available Anime statuses
*/
export type anime_search_query_status = 'airing' | 'complete' | 'upcoming';
/**
* Available Anime types
*/
export type anime_search_query_type =
| 'tv'
| 'movie'
| 'ova'
| 'special'
| 'ona'
| 'music'
| 'cm'
| 'pv'
| 'tv_special';
/**
* Available Character order_by properties
*/
export type characters_search_query_orderby = 'mal_id' | 'name' | 'favorites';
/**
* Club Search Query Category
*/
export type club_search_query_category =
| 'anime'
| 'manga'
| 'actors_and_artists'
| 'characters'
| 'cities_and_neighborhoods'
| 'companies'
| 'conventions'
| 'games'
| 'japan'
| 'music'
| 'other'
| 'schools';
/**
* Club Search Query OrderBy
*/
export type club_search_query_orderby =
| 'mal_id'
| 'name'
| 'members_count'
| 'created';
/**
* Club Search Query Type
*/
export type club_search_query_type = 'public' | 'private' | 'secret';
/**
* Users Search Query Gender.
*/
export type users_search_query_gender = 'any' | 'male' | 'female' | 'nonbinary';
/**
* Filter genres by type
*/
export type genre_query_filter =
| 'genres'
| 'explicit_genres'
| 'themes'
| 'demographics';
/**
* Order by magazine data
*/
export type magazines_query_orderby = 'mal_id' | 'name' | 'count';
/**
* User's anime list status filter options
*/
export type user_manga_list_status_filter =
| 'all'
| 'reading'
| 'completed'
| 'onhold'
| 'dropped'
| 'plantoread';
/**
* Available Manga order_by properties
*/
export type manga_search_query_orderby =
| 'mal_id'
| 'title'
| 'start_date'
| 'end_date'
| 'chapters'
| 'volumes'
| 'score'
| 'scored_by'
| 'rank'
| 'popularity'
| 'members'
| 'favorites';
/**
* Available Manga statuses
*/
export type manga_search_query_status =
| 'publishing'
| 'complete'
| 'hiatus'
| 'discontinued'
| 'upcoming';
/**
* Available Manga types
*/
export type manga_search_query_type =
| 'manga'
| 'novel'
| 'lightnovel'
| 'oneshot'
| 'doujin'
| 'manhwa'
| 'manhua';
/**
* Available People order_by properties
*/
export type people_search_query_orderby =
| 'mal_id'
| 'name'
| 'birthday'
| 'favorites';
/**
* Producers Search Query Order By
*/
export type producers_query_orderby =
| 'mal_id'
| 'count'
| 'favorites'
| 'established';
/**
* Search query sort direction
*/
export type search_query_sort = 'desc' | 'asc';
/**
* Top items filter types
*/
export type top_anime_filter =
| 'airing'
| 'upcoming'
| 'bypopularity'
| 'favorite';
/**
* Top items filter types
*/
export type top_manga_filter =
| 'publishing'
| 'upcoming'
| 'bypopularity'
| 'favorite';
/**
* The type of reviews to filter by. Defaults to anime.
*/
export type top_reviews_type_enum = 'anime' | 'manga';
/**
* Anime Episodes Resource
*/
export type anime_episodes = {
data?: Array<{
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL. This is the URL of the episode's video. If there is no video url, this will be null.
*/
url?: string | null;
/**
* Title
*/
title?: string;
/**
* Title Japanese
*/
title_japanese?: string | null;
/**
* title_romanji
*/
title_romanji?: string | null;
/**
* Aired Date ISO8601
*/
aired?: string | null;
/**
* Aggregated episode score (1.00 - 5.00) based on MyAnimeList user voting
*/
score?: number | null;
/**
* Filler episode
*/
filler?: boolean;
/**
* Recap episode
*/
recap?: boolean;
/**
* Episode discussion forum URL
*/
forum_url?: string | null;
}>;
} & pagination;
/**
* Anime News Resource
*/
export type anime_news = pagination & news;
/**
* Anime Videos Episodes Resource
*/
export type anime_videos_episodes = {
data?: Array<{
/**
* MyAnimeList ID or Episode Number
*/
mal_id?: number;
/**
* Episode Title
*/
title?: string;
/**
* Episode Subtitle
*/
episode?: string;
/**
* Episode Page URL
*/
url?: string;
images?: common_images;
}>;
} & pagination;
/**
* Character Pictures
*/
export type character_pictures = {
data?: Array<{
/**
* Default JPG Image Size URL
*/
image_url?: string | null;
/**
* Large JPG Image Size URL
*/
large_image_url?: string | null;
}>;
};
/**
* Club Member
*/
export type club_member = {
data?: Array<{
/**
* User's username
*/
username?: string;
/**
* User URL
*/
url?: string;
images?: user_images;
}>;
};
/**
* Manga News Resource
*/
export type manga_news = pagination & news;
/**
* Manga Pictures
*/
export type manga_pictures = {
data?: Array<manga_images>;
};
/**
* Character Pictures
*/
export type person_pictures = {
data?: Array<people_images>;
};
/**
* Random Resources
*/
export type random = {
data?: Array<anime | manga | character | person>;
};
/**
* Anime resources currently airing
*/
export type schedules = {
data?: Array<anime>;
} & pagination_plus;
/**
* User Results
*/
export type users_search = {
data?: Array<{
/**
* MyAnimeList URL
*/
url?: string;
/**
* MyAnimeList Username
*/
username?: string;
images?: user_images;
/**
* Last Online Date ISO8601
*/
last_online?: string;
}>;
} & pagination;
/**
* List of available seasons
*/
export type seasons = {
data?: Array<{
/**
* Year
*/
year?: number;
/**
* List of available seasons
*/
seasons?: Array<string>;
}>;
};
/**
* Anime & Manga Reviews Resource
*/
export type reviews_collection = {
data?: Array<anime_review | manga_review>;
};
/**
* User Friends
*/
export type user_friends = {
data?: Array<
{
user?: user_meta;
} & {
/**
* Last Online Date ISO8601 format
*/
last_online?: string;
/**
* Friends Since Date ISO8601 format
*/
friends_since?: string;
}
>;
} & pagination;
/**
* User Clubs
*/
export type user_clubs = {
data?: Array<{
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* Club Name
*/
name?: string;
/**
* Club URL
*/
url?: string;
}>;
} & pagination;
/**
* Watch Episodes
*/
export type watch_episodes = {
data?: Array<{
entry?: anime_meta;
/**
* Recent Episodes (max 2 listed)
*/
episodes?: Array<{
/**
* MyAnimeList ID
*/
mal_id?: string;
/**
* MyAnimeList URL
*/
url?: string;
/**
* Episode Title
*/
title?: string;
/**
* For MyAnimeList Premium Users
*/
premium?: boolean;
}>;
/**
* Region Locked Episode
*/
region_locked?: boolean;
}>;
} & pagination;
/**
* Watch Promos
*/
export type watch_promos = pagination & {
/**
* Promo Title
*/
title?: string;
} & {
data?: Array<{
entry?: anime_meta;
trailer?: Array<trailer>;
}>;
};
/**
* Anime Characters Resource
*/
export type anime_characters = {
data?: Array<{
/**
* Character details
*/
character?: {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: character_images;
/**
* Character Name
*/
name?: string;
};
/**
* Character's Role
*/
role?: string;
voice_actors?: Array<{
person?: {
mal_id?: number;
url?: string;
images?: people_images;
name?: string;
};
language?: string;
}>;
}>;
};
/**
* Anime Collection Resource
*/
export type anime_search = {
data?: Array<anime>;
} & pagination_plus;
/**
* Anime Episode Resource
*/
export type anime_episode = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
/**
* Title
*/
title?: string;
/**
* Title Japanese
*/
title_japanese?: string | null;
/**
* title_romanji
*/
title_romanji?: string | null;
/**
* Episode duration in seconds
*/
duration?: number | null;
/**
* Aired Date ISO8601
*/
aired?: string | null;
/**
* Filler episode
*/
filler?: boolean;
/**
* Recap episode
*/
recap?: boolean;
/**
* Episode Synopsis
*/
synopsis?: string | null;
};
/**
* Full anime Resource
*/
export type anime_full = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: anime_images;
trailer?: trailer_base;
/**
* Whether the entry is pending approval on MAL or not
*/
approved?: boolean;
/**
* All titles
*/
titles?: Array<title>;
/**
* Title
* @deprecated
*/
title?: string;
/**
* English Title
* @deprecated
*/
title_english?: string | null;
/**
* Japanese Title
* @deprecated
*/
title_japanese?: string | null;
/**
* Other Titles
* @deprecated
*/
title_synonyms?: Array<string>;
/**
* Anime Type
*/
type?: 'TV' | 'OVA' | 'Movie' | 'Special' | 'ONA' | 'Music' | null;
/**
* Original Material/Source adapted from
*/
source?: string | null;
/**
* Episode count
*/
episodes?: number | null;
/**
* Airing status
*/
status?: 'Finished Airing' | 'Currently Airing' | 'Not yet aired' | null;
/**
* Airing boolean
*/
airing?: boolean;
aired?: daterange;
/**
* Parsed raw duration
*/
duration?: string | null;
/**
* Anime audience rating
*/
rating?:
| 'G - All Ages'
| 'PG - Children'
| 'PG-13 - Teens 13 or older'
| 'R - 17+ (violence & profanity)'
| 'R+ - Mild Nudity'
| 'Rx - Hentai'
| null;
/**
* Score
*/
score?: number | null;
/**
* Number of users
*/
scored_by?: number | null;
/**
* Ranking
*/
rank?: number | null;
/**
* Popularity
*/
popularity?: number | null;
/**
* Number of users who have added this entry to their list
*/
members?: number | null;
/**
* Number of users who have favorited this entry
*/
favorites?: number | null;
/**
* Synopsis
*/
synopsis?: string | null;
/**
* Background
*/
background?: string | null;
/**
* Season
*/
season?: 'summer' | 'winter' | 'spring' | 'fall' | null;
/**
* Year
*/
year?: number | null;
broadcast?: broadcast;
producers?: Array<mal_url>;
licensors?: Array<mal_url>;
studios?: Array<mal_url>;
genres?: Array<mal_url>;
explicit_genres?: Array<mal_url>;
themes?: Array<mal_url>;
demographics?: Array<mal_url>;
relations?: Array<{
/**
* Relation type
*/
relation?: string;
entry?: Array<mal_url>;
}>;
theme?: {
openings?: Array<string>;
endings?: Array<string>;
};
external?: Array<{
name?: string;
url?: string;
}>;
streaming?: Array<{
name?: string;
url?: string;
}>;
};
/**
* Anime Type
*/
export type type = 'TV' | 'OVA' | 'Movie' | 'Special' | 'ONA' | 'Music';
/**
* Airing status
*/
export type status = 'Finished Airing' | 'Currently Airing' | 'Not yet aired';
/**
* Anime audience rating
*/
export type rating =
| 'G - All Ages'
| 'PG - Children'
| 'PG-13 - Teens 13 or older'
| 'R - 17+ (violence & profanity)'
| 'R+ - Mild Nudity'
| 'Rx - Hentai';
/**
* Season
*/
export type season = 'summer' | 'winter' | 'spring' | 'fall';
/**
* Anime Relations
*/
export type anime_relations = {
data?: Array<{
/**
* Relation type
*/
relation?: string;
entry?: Array<mal_url>;
}>;
};
/**
* Anime Resource
*/
export type anime = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: anime_images;
trailer?: trailer_base;
/**
* Whether the entry is pending approval on MAL or not
*/
approved?: boolean;
/**
* All titles
*/
titles?: Array<title>;
/**
* Title
* @deprecated
*/
title?: string;
/**
* English Title
* @deprecated
*/
title_english?: string | null;
/**
* Japanese Title
* @deprecated
*/
title_japanese?: string | null;
/**
* Other Titles
* @deprecated
*/
title_synonyms?: Array<string>;
/**
* Anime Type
*/
type?: 'TV' | 'OVA' | 'Movie' | 'Special' | 'ONA' | 'Music' | null;
/**
* Original Material/Source adapted from
*/
source?: string | null;
/**
* Episode count
*/
episodes?: number | null;
/**
* Airing status
*/
status?: 'Finished Airing' | 'Currently Airing' | 'Not yet aired' | null;
/**
* Airing boolean
*/
airing?: boolean;
aired?: daterange;
/**
* Parsed raw duration
*/
duration?: string | null;
/**
* Anime audience rating
*/
rating?:
| 'G - All Ages'
| 'PG - Children'
| 'PG-13 - Teens 13 or older'
| 'R - 17+ (violence & profanity)'
| 'R+ - Mild Nudity'
| 'Rx - Hentai'
| null;
/**
* Score
*/
score?: number | null;
/**
* Number of users
*/
scored_by?: number | null;
/**
* Ranking
*/
rank?: number | null;
/**
* Popularity
*/
popularity?: number | null;
/**
* Number of users who have added this entry to their list
*/
members?: number | null;
/**
* Number of users who have favorited this entry
*/
favorites?: number | null;
/**
* Synopsis
*/
synopsis?: string | null;
/**
* Background
*/
background?: string | null;
/**
* Season
*/
season?: 'summer' | 'winter' | 'spring' | 'fall' | null;
/**
* Year
*/
year?: number | null;
broadcast?: broadcast;
producers?: Array<mal_url>;
licensors?: Array<mal_url>;
studios?: Array<mal_url>;
genres?: Array<mal_url>;
explicit_genres?: Array<mal_url>;
themes?: Array<mal_url>;
demographics?: Array<mal_url>;
};
/**
* Anime Staff Resource
*/
export type anime_staff = {
data?: Array<{
/**
* Person details
*/
person?: {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: people_images;
/**
* Name
*/
name?: string;
};
/**
* Staff Positions
*/
positions?: Array<string>;
}>;
};
/**
* Anime Statistics Resource
*/
export type anime_statistics = {
data?: {
/**
* Number of users watching the resource
*/
watching?: number;
/**
* Number of users who have completed the resource
*/
completed?: number;
/**
* Number of users who have put the resource on hold
*/
on_hold?: number;
/**
* Number of users who have dropped the resource
*/
dropped?: number;
/**
* Number of users who have planned to watch the resource
*/
plan_to_watch?: number;
/**
* Total number of users who have the resource added to their lists
*/
total?: number;
scores?: Array<{
/**
* Scoring value
*/
score?: number;
/**
* Number of votes for this score
*/
votes?: number;
/**
* Percentage of votes for this score
*/
percentage?: number;
}>;
};
};
/**
* Anime Opening and Ending Themes
*/
export type anime_themes = {
data?: {
openings?: Array<string>;
endings?: Array<string>;
};
};
/**
* Anime Videos Resource
*/
export type anime_videos = {
data?: {
promo?: Array<{
/**
* Title
*/
title?: string;
trailer?: trailer;
}>;
episodes?: Array<{
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
/**
* Title
*/
title?: string;
/**
* Episode
*/
episode?: string;
images?: common_images;
}>;
music_videos?: Array<{
/**
* Title
*/
title?: string;
video?: trailer;
meta?: {
title?: string | null;
author?: string | null;
};
}>;
};
};
/**
* Character casted in anime
*/
export type character_anime = {
data?: Array<{
/**
* Character's Role
*/
role?: string;
anime?: anime_meta;
}>;
};
/**
* Characters Search Resource
*/
export type characters_search = {
data?: Array<character>;
} & pagination_plus;
/**
* Character Resource
*/
export type character_full = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: character_images;
/**
* Name
*/
name?: string;
/**
* Name
*/
name_kanji?: string | null;
/**
* Other Names
*/
nicknames?: Array<string>;
/**
* Number of users who have favorited this entry
*/
favorites?: number;
/**
* Biography
*/
about?: string | null;
anime?: Array<{
/**
* Character's Role
*/
role?: string;
anime?: anime_meta;
}>;
manga?: Array<{
/**
* Character's Role
*/
role?: string;
manga?: manga_meta;
}>;
voices?: Array<{
/**
* Character's Role
*/
language?: string;
person?: person_meta;
}>;
};
/**
* Character casted in manga
*/
export type character_manga = {
data?: Array<{
/**
* Character's Role
*/
role?: string;
manga?: manga_meta;
}>;
};
/**
* Character Resource
*/
export type character = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: character_images;
/**
* Name
*/
name?: string;
/**
* Name
*/
name_kanji?: string | null;
/**
* Other Names
*/
nicknames?: Array<string>;
/**
* Number of users who have favorited this entry
*/
favorites?: number;
/**
* Biography
*/
about?: string | null;
};
/**
* Character voice actors
*/
export type character_voice_actors = {
data?: Array<{
/**
* Character's Role
*/
language?: string;
person?: person_meta;
}>;
};
/**
* Clubs Search Resource
*/
export type clubs_search = {
data?: Array<club>;
} & pagination;
/**
* Club Relations
*/
export type club_relations = {
data?: {
anime?: Array<mal_url>;
manga?: Array<mal_url>;
characters?: Array<mal_url>;
};
};
/**
* Club Resource
*/
export type club = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* Club name
*/
name?: string;
/**
* Club URL
*/
url?: string;
images?: common_images;
/**
* Number of club members
*/
members?: number;
/**
* Club Category
*/
category?:
| 'actors & artists'
| 'anime'
| 'characters'
| 'cities & neighborhoods'
| 'companies'
| 'conventions'
| 'games'
| 'japan'
| 'manga'
| 'music'
| 'others'
| 'schools';
/**
* Date Created ISO8601
*/
created?: string;
/**
* Club access
*/
access?: 'public' | 'private' | 'secret';
};
/**
* Club Category
*/
export type category =
| 'actors & artists'
| 'anime'
| 'characters'
| 'cities & neighborhoods'
| 'companies'
| 'conventions'
| 'games'
| 'japan'
| 'manga'
| 'music'
| 'others'
| 'schools';
/**
* Club access
*/
export type access = 'public' | 'private' | 'secret';
/**
* Club Staff Resource
*/
export type club_staff = {
data?: Array<{
/**
* User URL
*/
url?: string;
/**
* User's username
*/
username?: string;
}>;
};
/**
* Youtube Details
*/
export type trailer = trailer_base & trailer_images;
/**
* Youtube Details
*/
export type trailer_base = {
/**
* YouTube ID
*/
youtube_id?: string | null;
/**
* YouTube URL
*/
url?: string | null;
/**
* Parsed Embed URL
*/
embed_url?: string | null;
};
/**
* Youtube Images
*/
export type trailer_images = {
images?: {
/**
* Default Image Size URL (120x90)
*/
image_url?: string | null;
/**
* Small Image Size URL (640x480)
*/
small_image_url?: string | null;
/**
* Medium Image Size URL (320x180)
*/
medium_image_url?: string | null;
/**
* Large Image Size URL (480x360)
*/
large_image_url?: string | null;
/**
* Maximum Image Size URL (1280x720)
*/
maximum_image_url?: string | null;
};
};
/**
* Date range
*/
export type daterange = {
/**
* Date ISO8601
*/
from?: string | null;
/**
* Date ISO8601
*/
to?: string | null;
/**
* Date Prop
*/
prop?: {
/**
* Date Prop From
*/
from?: {
/**
* Day
*/
day?: number | null;
/**
* Month
*/
month?: number | null;
/**
* Year
*/
year?: number | null;
};
/**
* Date Prop To
*/
to?: {
/**
* Day
*/
day?: number | null;
/**
* Month
*/
month?: number | null;
/**
* Year
*/
year?: number | null;
};
/**
* Raw parsed string
*/
string?: string | null;
};
};
/**
* Broadcast Details
*/
export type broadcast = {
/**
* Day of the week
*/
day?: string | null;
/**
* Time in 24 hour format
*/
time?: string | null;
/**
* Timezone (Tz Database format https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
*/
timezone?: string | null;
/**
* Raw parsed broadcast string
*/
string?: string | null;
};
/**
* Parsed URL Data
*/
export type mal_url = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* Type of resource
*/
type?: string;
/**
* Resource Name/Title
*/
name?: string;
/**
* MyAnimeList URL
*/
url?: string;
};
/**
* Parsed URL Data
*/
export type mal_url_2 = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* Type of resource
*/
type?: string;
/**
* Resource Name/Title
*/
title?: string;
/**
* MyAnimeList URL
*/
url?: string;
};
/**
* Entry Meta data
*/
export type entry_meta = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
/**
* Image URL
*/
image_url?: string;
/**
* Entry Name/Title
*/
name?: string;
};
/**
* Related resources
*/
export type relation = {
/**
* Relation type
*/
relation?: string;
/**
* Related entries
*/
entry?: Array<mal_url>;
};
export type pagination = {
pagination?: {
last_visible_page?: number;
has_next_page?: boolean;
};
};
export type pagination_plus = {
pagination?: {
last_visible_page?: number;
has_next_page?: boolean;
items?: {
count?: number;
total?: number;
per_page?: number;
};
};
};
export type user_meta = {
/**
* MyAnimeList Username
*/
username?: string;
/**
* MyAnimeList Profile URL
*/
url?: string;
images?: user_images;
};
/**
* User Meta By ID
*/
export type user_by_id = {
/**
* MyAnimeList URL
*/
url?: string;
/**
* MyAnimeList Username
*/
username?: string;
};
export type user_images = {
/**
* Available images in JPG
*/
jpg?: {
/**
* Image URL JPG
*/
image_url?: string | null;
};
/**
* Available images in WEBP
*/
webp?: {
/**
* Image URL WEBP
*/
image_url?: string | null;
};
};
export type anime_meta = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: anime_images;
/**
* Entry title
*/
title?: string;
};
export type manga_meta = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: manga_images;
/**
* Entry title
*/
title?: string;
};
export type character_meta = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: character_images;
/**
* Entry name
*/
name?: string;
};
export type person_meta = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: people_images;
/**
* Entry name
*/
name?: string;
};
export type anime_images = {
/**
* Available images in JPG
*/
jpg?: {
/**
* Image URL JPG
*/
image_url?: string | null;
/**
* Small Image URL JPG
*/
small_image_url?: string | null;
/**
* Image URL JPG
*/
large_image_url?: string | null;
};
/**
* Available images in WEBP
*/
webp?: {
/**
* Image URL WEBP
*/
image_url?: string | null;
/**
* Small Image URL WEBP
*/
small_image_url?: string | null;
/**
* Image URL WEBP
*/
large_image_url?: string | null;
};
};
export type manga_images = {
/**
* Available images in JPG
*/
jpg?: {
/**
* Image URL JPG
*/
image_url?: string | null;
/**
* Small Image URL JPG
*/
small_image_url?: string | null;
/**
* Image URL JPG
*/
large_image_url?: string | null;
};
/**
* Available images in WEBP
*/
webp?: {
/**
* Image URL WEBP
*/
image_url?: string | null;
/**
* Small Image URL WEBP
*/
small_image_url?: string | null;
/**
* Image URL WEBP
*/
large_image_url?: string | null;
};
};
export type character_images = {
/**
* Available images in JPG
*/
jpg?: {
/**
* Image URL JPG
*/
image_url?: string | null;
/**
* Small Image URL JPG
*/
small_image_url?: string | null;
};
/**
* Available images in WEBP
*/
webp?: {
/**
* Image URL WEBP
*/
image_url?: string | null;
/**
* Small Image URL WEBP
*/
small_image_url?: string | null;
};
};
export type people_images = {
/**
* Available images in JPG
*/
jpg?: {
/**
* Image URL JPG
*/
image_url?: string | null;
};
};
export type common_images = {
/**
* Available images in JPG
*/
jpg?: {
/**
* Image URL JPG
*/
image_url?: string | null;
};
};
export type title = {
/**
* Title type
*/
type?: string;
/**
* Title value
*/
title?: string;
};
/**
* External links
*/
export type external_links = {
data?: Array<{
name?: string;
url?: string;
}>;
};
/**
* Forum Resource
*/
export type forum = {
data?: Array<{
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
/**
* Title
*/
title?: string;
/**
* Post Date ISO8601
*/
date?: string;
/**
* Author MyAnimeList Username
*/
author_username?: string;
/**
* Author Profile URL
*/
author_url?: string;
/**
* Comment count
*/
comments?: number;
/**
* Last comment details
*/
last_comment?: {
/**
* Last comment URL
*/
url?: string;
/**
* Author MyAnimeList Username
*/
author_username?: string;
/**
* Author Profile URL
*/
author_url?: string;
/**
* Last comment date posted ISO8601
*/
date?: string | null;
};
}>;
};
/**
* Genres Collection Resource
*/
export type genres = {
data?: Array<genre>;
};
/**
* Genre Resource
*/
export type genre = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* Genre Name
*/
name?: string;
/**
* MyAnimeList URL
*/
url?: string;
/**
* Genre's entry count
*/
count?: number;
};
/**
* Magazine Collection Resource
*/
export type magazines = {
data?: Array<magazine>;
} & pagination;
/**
* Magazine Resource
*/
export type magazine = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* Magazine Name
*/
name?: string;
/**
* MyAnimeList URL
*/
url?: string;
/**
* Magazine's manga count
*/
count?: number;
};
/**
* Manga Characters Resource
*/
export type manga_characters = {
data?: Array<{
character?: character_meta;
/**
* Character's Role
*/
role?: string;
}>;
};
/**
* Manga Search Resource
*/
export type manga_search = {
data?: Array<manga>;
} & pagination_plus;
/**
* Manga Resource
*/
export type manga_full = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: manga_images;
/**
* Whether the entry is pending approval on MAL or not
*/
approved?: boolean;
/**
* All Titles
*/
titles?: Array<title>;
/**
* Title
* @deprecated
*/
title?: string;
/**
* English Title
* @deprecated
*/
title_english?: string | null;
/**
* Japanese Title
* @deprecated
*/
title_japanese?: string | null;
/**
* Other Titles
* @deprecated
*/
title_synonyms?: Array<string>;
/**
* Manga Type
*/
type?:
| 'Manga'
| 'Novel'
| 'Light Novel'
| 'One-shot'
| 'Doujinshi'
| 'Manhua'
| 'Manhwa'
| 'OEL'
| null;
/**
* Chapter count
*/
chapters?: number | null;
/**
* Volume count
*/
volumes?: number | null;
/**
* Publishing status
*/
status?:
| 'Finished'
| 'Publishing'
| 'On Hiatus'
| 'Discontinued'
| 'Not yet published';
/**
* Publishing boolean
*/
publishing?: boolean;
published?: daterange;
/**
* Score
*/
score?: number | null;
/**
* Number of users
*/
scored_by?: number | null;
/**
* Ranking
*/
rank?: number | null;
/**
* Popularity
*/
popularity?: number | null;
/**
* Number of users who have added this entry to their list
*/
members?: number | null;
/**
* Number of users who have favorited this entry
*/
favorites?: number | null;
/**
* Synopsis
*/
synopsis?: string | null;
/**
* Background
*/
background?: string | null;
authors?: Array<mal_url>;
serializations?: Array<mal_url>;
genres?: Array<mal_url>;
explicit_genres?: Array<mal_url>;
themes?: Array<mal_url>;
demographics?: Array<mal_url>;
relations?: Array<{
/**
* Relation type
*/
relation?: string;
entry?: Array<mal_url>;
}>;
external?: Array<{
name?: string;
url?: string;
}>;
};
/**
* Manga Type
*/
export type type2 =
| 'Manga'
| 'Novel'
| 'Light Novel'
| 'One-shot'
| 'Doujinshi'
| 'Manhua'
| 'Manhwa'
| 'OEL';
/**
* Publishing status
*/
export type status2 =
| 'Finished'
| 'Publishing'
| 'On Hiatus'
| 'Discontinued'
| 'Not yet published';
/**
* Manga Resource
*/
export type manga = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
images?: manga_images;
/**
* Whether the entry is pending approval on MAL or not
*/
approved?: boolean;
/**
* All Titles
*/
titles?: Array<title>;
/**
* Title
* @deprecated
*/
title?: string;
/**
* English Title
* @deprecated
*/
title_english?: string | null;
/**
* Japanese Title
* @deprecated
*/
title_japanese?: string | null;
/**
* Manga Type
*/
type?:
| 'Manga'
| 'Novel'
| 'Light Novel'
| 'One-shot'
| 'Doujinshi'
| 'Manhua'
| 'Manhwa'
| 'OEL'
| null;
/**
* Chapter count
*/
chapters?: number | null;
/**
* Volume count
*/
volumes?: number | null;
/**
* Publishing status
*/
status?:
| 'Finished'
| 'Publishing'
| 'On Hiatus'
| 'Discontinued'
| 'Not yet published';
/**
* Publishing boolean
*/
publishing?: boolean;
published?: daterange;
/**
* Score
*/
score?: number | null;
/**
* Number of users
*/
scored_by?: number | null;
/**
* Ranking
*/
rank?: number | null;
/**
* Popularity
*/
popularity?: number | null;
/**
* Number of users who have added this entry to their list
*/
members?: number | null;
/**
* Number of users who have favorited this entry
*/
favorites?: number | null;
/**
* Synopsis
*/
synopsis?: string | null;
/**
* Background
*/
background?: string | null;
authors?: Array<mal_url>;
serializations?: Array<mal_url>;
genres?: Array<mal_url>;
explicit_genres?: Array<mal_url>;
themes?: Array<mal_url>;
demographics?: Array<mal_url>;
};
/**
* Manga Statistics Resource
*/
export type manga_statistics = {
data?: {
/**
* Number of users reading the resource
*/
reading?: number;
/**
* Number of users who have completed the resource
*/
completed?: number;
/**
* Number of users who have put the resource on hold
*/
on_hold?: number;
/**
* Number of users who have dropped the resource
*/
dropped?: number;
/**
* Number of users who have planned to read the resource
*/
plan_to_read?: number;
/**
* Total number of users who have the resource added to their lists
*/
total?: number;
scores?: Array<{
/**
* Scoring value
*/
score?: number;
/**
* Number of votes for this score
*/
votes?: number;
/**
* Percentage of votes for this score
*/
percentage?: number;
}>;
};
};
/**
* More Info Resource
*/
export type moreinfo = {
data?: {
/**
* Additional information on the entry
*/
moreinfo?: string | null;
};
};
export type news = {
data?: Array<{
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
/**
* Title
*/
title?: string;
/**
* Post Date ISO8601
*/
date?: string;
/**
* Author MyAnimeList Username
*/
author_username?: string;
/**
* Author Profile URL
*/
author_url?: string;
/**
* Forum topic URL
*/
forum_url?: string;
images?: common_images;
/**
* Comment count
*/
comments?: number;
/**
* Excerpt
*/
excerpt?: string;
}>;
};
/**
* Person anime staff positions
*/
export type person_anime = {
data?: Array<{
/**
* Person's position
*/
position?: string;
anime?: anime_meta;
}>;
};
/**
* People Search
*/
export type people_search = {
data?: Array<person>;
} & pagination_plus;
/**
* Person Resource
*/
export type person_full = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
/**
* Person's website URL
*/
website_url?: string | null;
images?: people_images;
/**
* Name
*/
name?: string;
/**
* Given Name
*/
given_name?: string | null;
/**
* Family Name
*/
family_name?: string | null;
/**
* Other Names
*/
alternate_names?: Array<string>;
/**
* Birthday Date ISO8601
*/
birthday?: string | null;
/**
* Number of users who have favorited this entry
*/
favorites?: number;
/**
* Biography
*/
about?: string | null;
anime?: Array<{
/**
* Person's position
*/
position?: string;
anime?: anime_meta;
}>;
manga?: Array<{
/**
* Person's position
*/
position?: string;
manga?: manga_meta;
}>;
voices?: Array<{
/**
* Person's Character's role in the anime
*/
role?: string;
anime?: anime_meta;
character?: character_meta;
}>;
};
/**
* Person's mangaography
*/
export type person_manga = {
data?: Array<{
/**
* Person's position
*/
position?: string;
manga?: manga_meta;
}>;
};
/**
* Person Resource
*/
export type person = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
/**
* Person's website URL
*/
website_url?: string | null;
images?: people_images;
/**
* Name
*/
name?: string;
/**
* Given Name
*/
given_name?: string | null;
/**
* Family Name
*/
family_name?: string | null;
/**
* Other Names
*/
alternate_names?: Array<string>;
/**
* Birthday Date ISO8601
*/
birthday?: string | null;
/**
* Number of users who have favorited this entry
*/
favorites?: number;
/**
* Biography
*/
about?: string | null;
};
/**
* Person's voice acting roles
*/
export type person_voice_acting_roles = {
data?: Array<{
/**
* Person's Character's role in the anime
*/
role?: string;
anime?: anime_meta;
character?: character_meta;
}>;
};
/**
* Pictures Resource
*/
export type pictures = {
data?: Array<{
images?: anime_images;
}>;
};
/**
* Pictures Resource
*/
export type pictures_variants = {
data?: Array<{
images?: common_images;
}>;
};
/**
* Producers Collection Resource
*/
export type producers = {
data?: Array<producer>;
} & pagination;
/**
* Producers Resource
*/
export type producer_full = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
/**
* All titles
*/
titles?: Array<title>;
images?: common_images;
/**
* Producers's member favorites count
*/
favorites?: number;
/**
* Producers's anime count
*/
count?: number;
/**
* Established Date ISO8601
*/
established?: string | null;
/**
* About the Producer
*/
about?: string | null;
external?: Array<{
name?: string;
url?: string;
}>;
};
/**
* Producers Resource
*/
export type producer = {
/**
* MyAnimeList ID
*/
mal_id?: number;
/**
* MyAnimeList URL
*/
url?: string;
/**
* All titles
*/
titles?: Array<title>;
images?: common_images;
/**
* Producers's member favorites count
*/
favorites?: number;
/**
* Producers's anime count
*/
count?: number;
/**
* Established Date ISO8601
*/
established?: string | null;
/**
* About the Producer
*/
about?: string | null;
};
export type user_about = {
data?: Array<{
/**
* User About. NOTE: About information is customizable by users through BBCode on MyAnimeList. This means users can add multimedia content, different text sizes, etc. Due to this freeform, Jikan returns parsed HTML. Validate on your end!
*/
about?: string | null;
}>;
};
export type user_favorites = {
/**
* Favorite Anime
*/
anime?: Array<
{
type?: string;
start_year?: number;
} & anime_meta
>;
/**
* Favorite Manga
*/
manga?: Array<
{
type?: string;
start_year?: number;
} & manga_meta
>;
/**
* Favorite Characters
*/
characters?: Array<character_meta & mal_url_2>;
/**
* Favorite People
*/
people?: Array<character_meta>;
};
/**
* Transform the resource into an array.
*/
export type user_profile_full = {
/**
* MyAnimeList ID
*/
mal_id?: number | null;
/**
* MyAnimeList Username
*/
username?: string;
/**
* MyAnimeList URL
*/
url?: string;
images?: user_images;
/**
* Last Online Date ISO8601
*/
last_online?: string | null;
/**
* User Gender
*/
gender?: string | null;
/**
* Birthday Date ISO8601
*/
birthday?: string | null;
/**
* Location
*/
location?: string | null;
/**
* Joined Date ISO8601
*/
joined?: string | null;
statistics?: {
/**
* Anime Statistics
*/
anime?: {
/**
* Number of days spent watching Anime
*/
days_watched?: number;
/**
* Mean Score
*/
mean_score?: number;
/**
* Anime Watching
*/
watching?: number;
/**
* Anime Completed
*/
completed?: number;
/**
* Anime On-Hold
*/
on_hold?: number;
/**
* Anime Dropped
*/
dropped?: number;
/**
* Anime Planned to Watch
*/
plan_to_watch?: number;
/**
* Total Anime entries on User list
*/
total_entries?: number;
/**
* Anime re-watched
*/
rewatched?: number;
/**
* Number of Anime Episodes Watched
*/
episodes_watched?: number;
};
/**
* Manga Statistics
*/
manga?: {
/**
* Number of days spent reading Manga
*/
days_read?: number;
/**
* Mean Score
*/
mean_score?: number;
/**
* Manga Reading
*/
reading?: number;
/**
* Manga Completed
*/
completed?: number;
/**
* Manga On-Hold
*/
on_hold?: number;
/**
* Manga Dropped
*/
dropped?: number;
/**
* Manga Planned to Read
*/
plan_to_read?: number;
/**
* Total Manga entries on User list
*/
total_entries?: number;
/**
* Manga re-read
*/
reread?: number;
/**
* Number of Manga Chapters Read
*/
chapters_read?: number;
/**
* Number of Manga Volumes Read
*/
volumes_read?: number;
};
};
external?: Array<{
name?: string;
url?: string;
}>;
};
export type user_history = {
data?: Array<history>;
};
/**
* Transform the resource into an array.
*/
export type history = {
entry?: mal_url;
/**
* Number of episodes/chapters watched/read
*/
increment?: number;
/**
* Date ISO8601
*/
date?: string;
};
export type user_updates = {
data?: {
/**
* Last updated Anime
*/
anime?: Array<
{
entry?: anime_meta;
} & {
score?: number | null;
status?: string;
episodes_seen?: number | null;
episodes_total?: number | null;
/**
* ISO8601 format
*/
date?: string;
}
>;
/**
* Last updated Manga
*/
manga?: Array<
{
entry?: manga_meta;
} & {
score?: number | null;
status?: string;
chapters_read?: number | null;
chapters_total?: number | null;
volumes_read?: number | null;
volumes_total?: number | null;
/**
* ISO8601 format
*/
date?: string;
}
>;
};
};
export type user_profile = {
/**
* MyAnimeList ID
*/
mal_id?: number | null;
/**
* MyAnimeList Username
*/
username?: string;
/**
* MyAnimeList URL
*/
url?: string;
images?: user_images;
/**
* Last