| sidebar_position |
|---|
1 |
import ApiCodeBlock from '../../src/components/ApiCodeBlock'; import Highlight from '../../src/components/Highlight'; import ApiTryIt from '../../src/components/ApiTryIt';
export const endpoints = [ { method: 'GET', uri: '/v1/anime/:id' }, { method: 'GET', uri: '/v1/anime' }, { method: 'GET', uri: '/v1/random/anime/:count/:nsfw' } ];
This is an object representing an Anime show. The API allows you to retrieve individual Anime as well as a list of them using various filters.
Unique identifier for an Anime.
AniList external unique identifier.
MyAnimeList external unique identifier.
TheMovieDatabase external unique identifier.
The show's format destination.
"TV": 0,
"TV_SHORT": 1,
"MOVIE": 2,
"SPECIAL": 3,
"OVA": 4,
"ONA": 5,
"MUSIC": 6The show's global release status.
"FINISHED": 0,
"RELEASING": 1,
"NOT_YET_RELEASED": 2,
"CANCELLED": 3A dictionary of the show's titles organized by localization.
A dictionary of the show's descriptions organized by localization.
The show's global release date.
The known show's global end date.
The known show's episode release day.
"Sunday": 0,
"Monday": 1,
"Tuesday": 2,
"Wednesday": 3,
"Thursday": 4,
"Friday": 5,
"Saturday": 6The season on which the show has been released.
"WINTER": 0,
"SPRING": 1,
"SUMMER": 2,
"FALL": 3,
"UNKNOWN": 4The year on which the show has been released.
Number of episodes released for the show.
The show's episode average duration in minutes.
External link to the show's trailer video. Possible services:
- Youtube
- Dailymotion
The show's cover image.
Indicates if the show has an a cover images associated with it.
The show's cover main color, in HEX format.
The show's banner image.
A collection of the show's associated genres. You can find all possible values here.
A collection of the show's associated sagas.
{
// Map of strings
// Contains the saga's title in various localizations
"titles": {}
// Map of strings
// Contains the saga's description in various localizations
"descriptions": {}
// Integer
// The saga's first episode number
"episode_from": 0
// Integer
// The saga's last episode number
"episode_to": 0
// Integer
// The saga's total episodes count
"episodes_count": 0
}The show's precedent Anime's unique identifier in story-line.
The show's successive Anime's unique identifier in story-line.
The show's global appreciation indicator. Minimum value is 0 and maximum is 100.
Indicates if the show is marked as NotSafeForWork
The show's recommended Anime's unique identifier because similar. Ordered by descendent rating.
{
"anilist_id": 21,
"mal_id": 21,
"format": 0,
"status": 1,
"titles": {
"rj": "ONE PIECE",
"en": "ONE PIECE",
"jp": "ONE PIECE",
"fr": "One Piece",
"it": "One Piece"
},
"descriptions": {
"en": "Gold Roger was known as the Pirate King, the strongest and mo...",
"fr": "Il fut un temps où Gold Roger était le plus grand de tous les...",
"it": "Monkey D. Rufy è un giovane pirata sognatore che da piccolo h...",
"jp": "海賊王を夢見る少年モンキー・D・ルフィを主人公とする、「ひとつなぎの..."
},
"start_date": "1999-10-20T00:00:00Z",
"end_date": "1970-01-01T00:00:00Z",
"weekly_airing_day": 0,
"season_period": 3,
"season_year": 1999,
"episodes_count": 981,
"episode_duration": 24,
"cover_image": "https://s4.anilist.co/file/anilistcdn/media/anime/cov...",
"cover_color": "#e4a15d",
"banner_image": "https://s4.anilist.co/file/anilistcdn/media/anime/ba...",
"genres": [
"Action",
"Adventure",
"Comedy",
"Drama",
"Fantasy",
"Pirates",
"Shounen",
"Ensemble Cast",
"Super Power",
"Ships",
"Male Protagonist",
"Conspiracy",
"Tragedy",
"Crime",
"Time Skip",
"Politics",
"Boys' Love",
"War",
"Shapeshifting",
"Swordplay",
"Lost Civilization",
"Guns",
"Animals",
"Anachronism",
"Primarily Adult Cast",
"Cyborg",
"Skeleton",
"Espionage",
"Primarily Male Cast",
"Gender Bending",
"Ninja",
"Henshin",
"Real Robot",
"Anti-Hero",
"Mermaid",
"Battle Royale",
"Assassins",
"Tanned Skin",
"Zombie",
"Time Manipulation",
"Kuudere"
],
"sagas": [{
"titles": {
"en": "East Blue Arc",
"fr": "Saga East Blue",
"it": "Saga del Mare Orientale",
"jp": "1st 東の海編"
},
"descriptions": {
"en": "Influenced by Shanks, Luffy starts his journey to become the ...",
"fr": "Influencé par Shanks, Luffy commence son voyage pour devenir ...",
"it": "La prima stagione si intitola Saga del Mare Orientale (EAST B...",
"jp": "ルフィは、たった１人の海賊として大海原へと旅立つ。海軍基地の..."
},
"episode_from": 1,
"episode_to": 61,
"episodes_count": 61
}, ...
],
"score": 86,
"recommendations": [
2022,
10,
745,
2974,
147,
416
],
"nsfw": true,
"has_cover_image": true,
"id": 11
}Retrieves an Anime show, based on its unique identifier.
No parameters.
Returns an Anime object if a valid identifier was provided.
export const retrieveAnimeParams = [ { name: ':id', type: 'number', placeholder: ':id', value: '11' } ];
Returns a list of Anime objects.
The Anime are returned sorted by score, with the most popular Anime appearing first.
A case-insensitive pattern filter on the list based on the titles field values.
A filter on the list based on the anilist_id field value.
A filter on the list based on the mal_id field value.
A filter on the list based on the tmdb_id field value.
A filter on the list based on the format field value.
A filter on the list based on the status field value.
A filter on the list based on the season_year field value.
A filter on the list based on the season_period field value.
A case-sensitive pattern filter on the list based on the genres field values.
A filter on the list which excludes Anime classified as Not Safe For Work.
A filter on the list which excludes Anime without episodes available.
Returns an array of Anime objects with a size based on the filter provided.
export const getListAnimeParams = [ { name: 'title', type: 'text', placeholder: 'title', value: 'One Piece' }, { name: 'anilist_id', type: 'number', placeholder: 'anilist_id', value: '' }, { name: 'mal_id', type: 'number', placeholder: 'mal_id', value: '' }, { name: 'tmdb_id', type: 'number', placeholder: 'tmdb_id', value: '' }, { name: 'formats', type: 'text', placeholder: 'formats', value: '0,1' }, { name: 'status', type: 'text', placeholder: 'status', value: '1' }, { name: 'year', type: 'number', placeholder: 'year', value: '1999' }, { name: 'season', type: 'text', placeholder: 'season', value: '3' }, { name: 'genres', type: 'text', placeholder: 'genres', value: 'Pirates,War,Cyborg' }, { name: 'nsfw', type: 'checkbox', placeholder: 'nsfw', value: true }, { name: 'with_episodes', type: 'checkbox', placeholder: 'with_episodes', value: false }, ];
Retrieves a random Anime show list.
No parameters.
Returns a random Anime list.
export const retrieveRandomAnimeParams = [ { name: ':count', type: 'number', placeholder: ':count', value: '5' }, { name: ':nsfw', type: 'checkbox', placeholder: 'nsfw', value: true } ];