A small Wrapper for the unofficial MAL API Jikan (v4)
npm install @mateoaranda/jikanjs!GitHub Workflow Status !Known Vulnerabilities
JikanJS
=======
this is a v4 version of zuritor's jikanjs
npm install @mateoaranda/jikanjs --save
javascript
const jikanjs = require('@mateoaranda/jikanjs');
`
Modify API URL
It is possible to change the API Base URL
`javascript
jikanjs.settings.setBaseURL('apiurl'); // sets the API Base URL
`
API Methods
* All API functions are promised Based
* Information of all possible parameters are located at the documentation
`javascript
jikanjs.loadAnime(id [, request [, parameters]])
jikanjs.loadCharacter(id [, request])
jikanjs.loadClub(id [, request [, page]])
jikanjs.loadGenres(type [, page [, limit [, filter]]])
jikanjs.loadMagazines([page])
jikanjs.loadManga(id [, request [, page]])
jikanjs.loadPerson(id [, request])
jikanjs.loadProducers([page])
jikanjs.loadRandom(type)
jikanjs.loadRecommendations(type [, page])
jikanjs.loadReviews(type [, page])
jikanjs.loadSchedule(day [, page [, limit]])
jikanjs.loadUser(username [, request [, page]])
jikanjs.loadAnimelist(username [, limit [, offset]])
jikanjs.loadMangalist(username [, limit [, offset]])
jikanjs.loadSeason(year, season [, page])
jikanjs.loadSeasonArchive()
jikanjs.loadCurrentSeason([page])
jikanjs.loadUpcomingSeason([page])
jikanjs.loadTop(type [, page [, subtype [, filter]]])
jikanjs.search(type, query [, limit [, parameters]])
jikanjs.raw(urlParts [, queryParameters [, mal]])
`
Examples
$3
id: Anime ID
request: full, characters, staff, episodes, news, forum, videos, videosepisodes, pictures, statistics, moreinfo, recommendations, userupdates, reviews, relations, themes, external
parameters: query parameters, check the docs for more info
`javascript
await jikanjs.loadAnime(31240); // Anime Information
await jikanjs.loadAnime(31240, 'episodes'); // All Episodes
await jikanjs.loadAnime(31240, 'episodes', 15); // Episode 15
await jikanjs.loadAnime(31240, 'forum', { filter: 'episode' });
`
$3
id: Character ID
request: full, anime, manga, voices, pictures
`javascript
await jikanjs.loadCharacter(118737); // Character information
await jikanjs.loadCharacter(118737, 'pictures'); // Character pictures
`
$3
id: Club ID
request: members, staff, relations
page: Page number, available on members request, default: 1
`javascript
await jikanjs.loadClub(73113); // Club information
await jikanjs.loadClub(73113, 'members', 10); // 10th Page of this club members
`
$3
type: either anime or manga
filter: genres, explicit_genres, themes, demographics
`javascript
await jikanjs.loadGenres('anime'); // All anime genres
await jikanjs.loadGenres('manga', 'explicit_genres'); // Manga explicit genres
`
$3
page: Page Number, default: 1
`javascript
await jikanjs.loadMagazines(); // Magazines collection
`
$3
id: Manga ID
request: full, characters, news, forum, pictures, statistics, moreinfo, recommendations, userupdates, reviews, relations, external
page: Page Number, available on news userupdates reviews requests
`javascript
await jikanjs.loadManga(74697); // Manga information
await jikanjs.loadManga(74697, 'reviews', 1); // First page of reviews
`
$3
id: Person ID
request: full, anime, voices, manga, pictures
`javascript
await jikanjs.loadPerson(34785); // Person information
await jikanjs.loadPerson(34785, 'voices'); // All Person's Voice Acting Roles
`
$3
page: Page Number, default: 1
`javascript
await jikanjs.loadProducers(); // Producers collection
`
$3
type: anime, manga, characters, people, users
`javascript
await jikanjs.loadRandom('anime'); // Some random anime
`
$3
type: either anime or manga
page: Page Number, default: 1
`javascript
await jikanjs.loadRecommendations('anime'); // First page of recent anime recommendations
`
$3
type: either anime or manga
page: Page Number, default: 1
preliminary: Receive reviews tagged as preliminary? Default: false
spoiler: Receive reviews tagged as a spoiler? Default: false
`javascript
await jikanjs.loadReviews('manga'); // First page of recent manga reviews
`
$3
day: monday, tuesday, wednesday, thursday, friday, saturday, sunday, other, unknown
page: Page Number, default: 1
limit: Result limit number
kids: Filter entries with the Kids Genre, Default: false
sfw: Filter entries with the Hentai Genre, Default: false
unapproved: Include entries which are unapproved, Default: false
`javascript
await jikanjs.loadSchedule('monday'); // Monday's anime schedule
`
$3
username: User's username
request: full, statistics, favorites, userupdates, about, history, friends, reviews, recommendations, clubs, external
page: Page number, available on friends reviews recommendations clubs requests
`javascript
await jikanjs.loadUser('pepito'); // Profile information
await jikanjs.loadUser('pepito', 'friends', 6); // 6th page of pepito's friends
`
$3
username: User's Username
limit: Amount of elements to receive, Default: 1000
offset: Offset, Default: 0
`javascript
await jikanjs.loadAnimelist('pepito'); // pepito's animelist
`
$3
username: User's Username
limit: Amount of elements to receive, Default: 1000
offset: Offset, Default: 0
`javascript
await jikanjs.loadMangalist('pepito'); /// pepito's mangalist
`
$3
year: Season Year (1970-Now)
season: winter, spring, summer, fall
page: Page Number, default: 1
`javascript
await jikanjs.loadSeason(2021, 'fall'); // First page of Fall 2021 animes
`
$3
`javascript
await jikanjs.loadSeasonArchive(); // Seasons collection
`
$3
page: Page Number, default: 1
`javascript
await jikanjs.loadCurrentSeason(); // First page of the current season's animes
`
$3
page: Page Number, default: 1
`javascript
await jikanjs.loadUpcomingSeason(3); // Third page of next season's animes
`
$3
type: anime, manga, people, characters, reviews
page: Page Number, default: 1 (25 items per page)
subtype:
⠀⠀anime: tv, movie, ova, special, ona, music, cm, pv, tv_special
⠀⠀manga: manga, novel, lightnovel, oneshot, doujin, manhwa, manhua
filter:
⠀⠀anime: airing, upcoming, bypopularity, favorite
⠀⠀manga: publishing, upcoming, bypopularity, favorite
`javascript
await jikanjs.loadTop('anime'); // Top 25 animes
await jikanjs.loadTop('anime', 1, 'movie'); // First page of top anime movies
`
$3
type: anime, manga, people, characters, clubs
query: search term
limit: results limit number
parameters: extra query parameters, see docs for more info on this
`javascript
await jikanjs.search('characters', 'Emilia', 1); // Search for a character named "Emilia"
`
$3
urlParts: Array with api endpoint path, e.g. [anime, 1] to load the anime with the id of 1
queryParameters: query parameters, needs to be a key value pair like { page: 1 }
mal: Request to MAL API? Default: false
`javascript
await jikanjs.raw(['anime', 1]); // Same as loadAnime(1);
``