KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #claude-code #codex #dsh #dsh-plugin #ai-agent #ai-agents #deepseek-harness #agent-skills #macos #cli

myanimelist-api-v2

★ 48 Open GitHub ↗

An awesome wrapper on Nodejs for the new MyAnimeList's API v2!

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![NPM][npm-downloads]][npm-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]

<h3 align="center">MyAnimeList - API V2</h3>

An awesome library to connect with the new MyAnimeList's API v2!
 
 <a href="https://github.com/Chris-Kode/myanimelist-api-v2">Explore the docs »</a>
 
 
 <a href="https://github.com/Chris-Kode/myanimelist-api-v2/issues">Report Bug</a>
 ·
 <a href="https://github.com/Chris-Kode/myanimelist-api-v2/issues">Request Feature</a>

## Official documentation
This is the official documentation from MyAnimeList, if you need to verify any field. [https://myanimelist.net/apiconfig/references/api/v2](https://myanimelist.net/apiconfig/references/api/v2)
## Table of Contents

- [About the Project](#about-the-project)
  - [Built With](#built-with)
- [Getting Started](#getting-started)
  - [TODO](#todo)
  - [Prerequisites](#prerequisites)
  - [Install](#install)
- [Usage](#usage)
  - [Initial stepts before use the API](#initial-stepts-before-use-the-api)
  - [OAUTH](#oauth)
    - [urlAuthorize](#urlauthorize)
    - [accessToken](#accesstoken)
    - [refreshToken](#refreshtoken)
  - [API_ANIME](#api_anime)
    - [animes](#animes)
    - [anime](#anime)
    - [animeRanking](#animeranking)
    - [animeSeasonal](#animeseasonal)
    - [animeSuggestions](#animesuggestions)
  - [API_MANGA](#api_manga)
    - [mangas](#mangas)
    - [manga](#manga)
    - [mangaRanking](#mangaranking)
  - [API_ANIME_LIST](#api_anime_list)
    - [getListAnime](#getlistanime)
    - [deleteListAnime](#deletelistanime)
    - [updateListAnime](#updatelistanime)
  - [API_MANGA_LIST](#api_manga_list)
    - [getListManga](#getlistmanga)
    - [deleteListManga](#deletelistmanga)
    - [updateListManga](#updatelistmanga)
  - [API_USER](#api_user)
    - [me](#me)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## About The Project

This library has been made by the new MyAnimeList API update, as it has some notable changes, the library will continue to be updated and changes will be made as the official API is developed

### Built With

The library is made to be as light as possible.

- [NodeJS](https://github.com/nodejs/node)
- [Axios](https://github.com/axios/axios)

## Getting Started

### TODO

- API_OAUTH
  - [x] Access Token
  - [x] Refresh Token
  - [x] Generate url OAUTH2 for MyAnimeList
- API_ANIME
  - [x] Return all fields by default
  - [x] Search Anime by Id
  - [x] Seach Anime by a query text
  - [x] Anime by season
  - [x] Anime ranking
  - [x] Anime suggestions
  - [x] Return anime with custom fields by parameter
- API_MANGA
  - [x] Search Manga by Id
  - [x] Seach Manga by a query text
  - [x] Manga ranking
  - [x] Return all fields by default
  - [x] Return manga with custom fields by parameter
- API_USER
  - [x] Return user's profile current session
  - [x] Return all fields by default
  - [x] Return user with custom fields by parameter
- API_ANIME_LIST
  - [x] Get user's anime list
  - [x] Delete entry anime list
  - [x] Update entry anime list
- API_MANGA_LIST
  - [x] Get user's manga list
  - [x] Delete entry manga list
  - [x] Update entry manga list
- API_FORUM
  - [ ] TODO

### Prerequisites

1. You are going to need register your application first for the use of this API, so you can register here [https://myanimelist.net/apiconfig/create](https://myanimelist.net/apiconfig/create)
   You will get a result like this:
   ![ExampleFill](https://raw.githubusercontent.com/Chris-Kode/myanimelist-api-v2/master/document/ExampleFill.PNG)

2. Client_id and Client_Secret (if you need it) must not be disclosed.
3. App Redirect Url: In this field we must put the url to which it will be redirected after the user authorizes the use of his account in our application (can be localhost for test purpose)

## Install

Install the package to your project
`npm i @chris-kode/myanimelist-api-v2`

## Usage

This new API use PCKE for Oauth2 you can use this library to generate PCKE Challenge for the example i will use this library: [pkce-challenge](https://www.npmjs.com/package/pkce-challenge)

### Initial stepts before use the API

1.  To redirect to the url for authorize

```javascript
    const API = require("@chris-kode/myanimelist-api-v2");

const oauth = new API.OAUTH(CLIENT_ID);
    const pkceChallenge = require("pkce-challenge");

//save this variable value that contains the code_challenge and code_verification in a database or something
    const pkce = pkceChallenge();

const urlToRedirect = oauth.urlAuthorize(pkce.code_challenge); // this generate the url that you need to redirect

//This example is for expressjs, but you only need to do a redirection to the url generated
    res.redirect(urlToRedirect);
    ```

When the user authorize you, the user will be redirected again to the url that you filled at the information of the application, with a param "code", you are going to save this code in a database or something.

2.  Then when we have this code, we will need to create a session or a Access Token like this:

```javascript
    const API = require("@chris-kode/myanimelist-api-v2");
    const oauth = new API.OAUTH(CLIENT_ID);

//get the code that mal give us, and the code_challenge which we have generated before.
    oauth.accessToken(CODE, CODE_CHALLENGE).then(
      ((response) => {
        //PERFECT
        //save all the response at db or something, u will get something like this:
        /*{
            token_type: 'Bearer',
            expires_in: 2678400,
            access_token: 'eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImY4MWExNTIzYzBkZjI0MWNmNDlmZTg1Y2Y2MmQ5ZWU2ZDNjNDJlMGQ3ODIzN2I4ZjQ1NjkzMjUxZDdlYzhjZjIyYTVmNzdjZGY3MmJkMTkyIn0.e...,
            refresh_token: 'def502009f00fd0d08d50a7faca228bb4f88fa61df80e70aab290d6431115a16b44dc3e9215b3489a71caf9d594b8803129b6497619928025a420f107efd4560b45eb4e136bc4d0d72...'
        }*/
      }).catch((err) => {
        //ERROR
        //do something
      })
    );
    ```

3.  If the session is expired, you are going to need to refresh:

```javascript
    const API = require("@chris-kode/myanimelist-api-v2");
    const oauth = new API.OAUTH(CLIENT_ID);

//REFRESH TOKEN that we generated before, when we create a Access Token
    oauth.refreshToken(REFRESH_TOKEN).then(
      ((response) => {
        //PERFECT
        //save all the response at db or something, u will get something like this:
        /*{
            token_type: 'Bearer',
            expires_in: 2678400,
            access_token: 'eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImY4MWExNTIzYzBkZjI0MWNmNDlmZTg1Y2Y2MmQ5ZWU2ZDNjNDJlMGQ3ODIzN2I4ZjQ1NjkzMjUxZDdlYzhjZjIyYTVmNzdjZGY3MmJkMTkyIn0.e...,
            refresh_token: 'def502009f00fd0d08d50a7faca228bb4f88fa61df80e70aab290d6431115a16b44dc3e9215b3489a71caf9d594b8803129b6497619928025a420f107efd4560b45eb4e136bc4d0d72...'
        }*/
      }).catch((err) => {
        //ERROR
        //do something
      })
    );
    ```

### OAUTH

Initialize object

```javascript
//Client_Id as first parameter, and optional Cliente Secret if is need it.
const oauth = new API.OAUTH(CLIENT_ID, CLIENT_SECRET);
```

#### urlAuthorize

Function that return the url that we need to redirect for the user to authorize our application, we need a pcke code challenge, you can generate with this library: [pkce-challenge](https://www.npmjs.com/package/pkce-challenge)

Params:

- code_challenge => Generated code_challenge

```javascript
//first parameter we need a code_challenge
res.redirect(oauth.urlAuthorize(pcke.code_challenge));
```

#### accessToken

Function that generates a Bearer and Refresh Token, we will need to generate a session and makes petition to the API

Params:

- code => code that we get when our user has authorized us at the callback url
- code_challenge => the code_generated before, the same code_challenge that we generated before.

```javascript
oauth
  .accessToken(CODE, CODE_CHALLENGE)
  .then((response) => {
    //ALL OK
    //DO SOMETHING
  })
  .catch((err) => {
    //ALL BAD
    //DO SOMETHING
  });
```

#### refreshToken

Function that refresh the token that we got in "accessToken", if our token expired u can refresh with this function

Params:

- REFRESH_TOKEN => token that we got, in the step "accesstoken".

```javascript
oauth
  .refreshToken(REFRESH_TOKEN)
  .then((response) => {
    //ALL OK
    //DO SOMETHING
  })
  .catch((err) => {
    //ALL BAD
    //DO SOMETHING
  });
```

### API_ANIME

Initialize object

```javascript
//BEARER_TOKEN (ONLY THE TOKEN) = eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImY4MWExNTIzYzBkZjI0MWNmNDlmZTg1Y2Y2MmQ5ZWU2ZDNjNDJlMGQ3ODIzN2I4ZjQ1NjkzMjUxZDdlYzhjZjIyYTVmNzdjZGY3MmJkMTkyIn0.ey...
const anime = new API.API_ANIME(BEARER_TOKEN);
```

Structures
[structures.animeInList](src/Mal_Api_Authorized/Mal_Api_Anime/structures.json)

#### animes

(List of animes via a query text search)

Params:

- q => text to search (required)
- offset => default = 0
- limit => default = 100
- fields (Array) => fields to show, default = [structures.animeInList](src/Mal_Api_Authorized/Mal_Api_Anime/structures.json)

Example:

```javascript
  //Simple query
  anime.animes("one piece");

//Third page of one piece results, 50 limit, 100-150,
  anime.animes("one piece", 150, 50);
  ```

#### anime

(Specific anime by id, and return the anime with all details)

Params:

- id => number
- fields (Array) => fields to show, default = [structures.animeFull](src/Mal_Api_Authorized/Mal_Api_Anime/structures.json)

Example:

```javascript
  anime.anime(21);
  ```

#### animeRanking

(Ranking animes, with all type of rankings)

Params:

Example:

```javascript
  //Get all the ranking where is now airing
  anime.animeRanking("airing");

//Third page of ranking results, 50 limit, 100-150,
  anime.animeRanking("all", 150, 50);
  ```

#### animeSeasonal

(Seasonal Anime, by default is filled at actual season)

Params:

- year => a year, default => currentYear
- season => OPTIONS ["winter" | "spring" | "summer" | "fall"], default => currentSeason
- offset => default = 0
- limit => default = 100
- sort => OPTIONS ["anime_score" | "anime_num_list_users" | ""], default => ""
- fields (Array) => fields to show, default = [structures.animeInList](src/Mal_Api_Authorized/Mal_Api_Anime/structures.json)

Example:

```javascript
  //Get all the current anime season
  anime.animeSeasonal();

//Get the animes season of winter 2010
  anime.animeSeasonal(2010, "winter");

//Get the animes season of spring 2015, third page ordered by anime_score
  anime.animeSeasonal(2015, "spring", 150, 50, "anime_score");
  ```

#### animeSuggestions

(Anime suggestion from MAL)

Params:

- offset => default = 0
- limit => default = 100
- fields (Array) => fields to show, default = [structures.animeInList](src/Mal_Api_Authorized/Mal_Api_Anime/structures.json)

Example:

```javascript
  //Get the anime suggestion from MAL
  anime.animeSuggestions();
  ```

### API_MANGA

Initialize object

```javascript
/*BEARER_TOKEN (ONLY THE TOKEN) = eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImY4MWExNTIzYzBkZjI0MWNmNDlmZTg1Y2Y2MmQ5ZWU2ZDNjNDJlMGQ3ODIzN2I4ZjQ1NjkzMjUxZDdlYzhjZjIyYTVmNzdjZGY3MmJkMTkyIn0.ey...
 */
const manga = new API.API_MANGA(BEARER_TOKEN);
```

#### mangas

(List of mangas via a query text search)

Params:

- q => text to search (required)
- offset => default = 0
- limit => default = 100
- fields (Array) => default = [structures.mangaInList](src/Mal_Api_Authorized/Mal_Api_Manga/structures.json)

Example:

```javascript
  //Simple query
  manga.mangas("one piece");

//Third page of one piece results, 50 limit, 100-150,
  manga.mangas("one piece", 150, 50);
  ```

#### manga

(Specific manga by id, and return the manga with all details)

Params:

- id => number
- fields (Array) => default = [structures.mangaFull](src/Mal_Api_Authorized/Mal_Api_Manga/structures.json)

Example:

```javascript
  //Simple query
  manga.manga(13);
  ```

#### mangaRanking

(Ranking mangas, with all type of rankings)

Params:

Example:

```javascript
  //Get all the ranking where are mangas
  manga.mangaRanking("manga");

//Third page of ranking results, 50 limit, 100-150,
  anime.mangaRanking("all", 150, 50);
  ```

### API_ANIME_LIST

Initialize object

#### getListAnime

(Display user anime list with current session)

Params:

- user_name (String) (username) => default = "@me"
- offset (Number) => default = 0
- limit (Number) => default = 100
- fields (Array) => default = [structures](src/Mal_Api_Authorized/Mal_Api_List_Anime/structures.js) (This is a mix of anime structure and status structure)

```javascript
//Third page of results, 50 limit, 100-150,
anime_list.getList("@me", 150, 50);
```

#### deleteListAnime

(Delete a anime entry from the list with current session)

Params:

- anime_id (Number) => (anime_id that you want delete from the list)

```javascript
//Delete Boku no hero academy 3º season from my anime list.
anime_list.deleteList(36456);
```

#### updateListAnime

(Update anime entry from the list with current session)

Params:

- anime_id (Number) => (anime_id that you want update from the list)
- fieldsToUdpate (Object)(All the fields are optional) => {
  status: "watching" | "completed" | "on_hold" | "dropped" | "plan_to_watch",
  is_rewatching: true | false,
  score: 0-10,
  num_watched_episodes: Number,
  priority: 0-2,
  num_times_rewatched: Number,
  rewatch_value: 0-5,
  tags: String,
  comments: String
  }

```javascript
//Update Boku no hero 3 entry with status completed and score 9
anime_list.updateList(36456, { status: "completed", score: 9 });
```
### API_MANGA_LIST
Initialize object

(Display user manga list with current session)

Params:

```javascript
//Third page of results, 50 limit, 100-150,
manga_list.getList("@me", 150, 50);
```

#### deleteListManga
(Delete a manga entry from the list with current session)

Params:

- manga_id (Number) => (manga_id that you want delete from the list)

```javascript
//Delete Boku no Hero Academia from my manga list.
manga_list.deleteList(75989);
```
#### updateListManga

(Update manga entry from the list with current session)

Params:

- manga_id (Number) => (manga_id that you want update from the list)
- fieldsToUdpate (Object)(All the fields are optional) => {
  status: "reading" | "completed" | "on_hold" | "dropped" | "plan_to_read",
  is_rereading: true | false,
  score: 0-10,
  num_volumes_read: Number,
  num_chapters_read: Number,
  priority: 0-2,
  num_times_reread: Number,
  reread_value: 0-5,
  tags: String,
  comments: String
  }

```javascript
//Update Boku no hero Academia entry with status completed and score 9
manga_list.updateList(75989, { status: "completed", score: 9 });
```
### API_USER

Initialize object

#### me

(Displays User information with current session)

Params:

- fields (Array) => default = [structures.user](src/Mal_Api_Authorized/Mal_Api_User/structures.json)

```javascript
user.me();
```

## Roadmap

See the [open issues](https://github.com/Chris-Kode/myanimelist-api-v2/issues) for a list of proposed features (and known issues).

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Contact

Christian Andrés Bacho - [@FarokStyle](https://twitter.com/FarokStyle) - christian.andres.1204@gmail.com

Project Link: [https://github.com/Chris-Kode/myanimelist-api-v2](https://github.com/Chris-Kode/myanimelist-api-v2)

[contributors-shield]: https://img.shields.io/github/contributors/Chris-Kode/myanimelist-api-v2.svg?style=flat-square
[contributors-url]: https://github.com/Chris-Kode/myanimelist-api-v2/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Chris-Kode/myanimelist-api-v2.svg?style=flat-square
[forks-url]: https://github.com/Chris-Kode/myanimelist-api-v2/network/members
[stars-shield]: https://img.shields.io/github/stars/Chris-Kode/myanimelist-api-v2.svg?style=flat-square
[stars-url]: https://github.com/Chris-Kode/myanimelist-api-v2/stargazers
[issues-shield]: https://img.shields.io/github/issues/Chris-Kode/myanimelist-api-v2.svg?style=flat-square
[issues-url]: https://github.com/Chris-Kode/myanimelist-api-v2/issues
[license-shield]: https://img.shields.io/github/license/Chris-Kode/myanimelist-api-v2.svg?style=flat-square
[license-url]: https://github.com/Chris-Kode/myanimelist-api-v2/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/christian-andr%C3%A9s-bacho-a5abb016b/
[npm-url]: https://www.npmjs.com/package/@chris-kode/myanimelist-api-v2
[npm-downloads]: https://img.shields.io/npm/dt/@chris-kode/myanimelist-api-v2.svg

myanimelist-api-v2

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README