Jikan - Unofficial MyAnimeList.net REST API

Jikan is a REST API for MyAnimeList.net. It scrapes the website to satisfy the need for some API functionality - that MyAnimeList lacks.

The raison d'être of Jikan is to assist developers easily get the data they need for their apps and projects without having to depend on unstable APIs, or sidetracking their projects to develop parsers.

The word Jikan literally translates to Time in Japanese (時間). And that's what this API saves you of. ;)

Notice: Jikan does not support authenticated requests. You can not update your lists. Use the official MyAnimeList API for this.

Index

• What's new?
• Getting Started
  • Requirements
  • 🐳 Docker
  • Installation Prerequisites
  • Installation
  • Configuration
  • Ignition
  • Configuring Cache Driver (optional)
  • Configuring Cache Method (optional)
  • Configuring Supervisord (optional)
• Troubleshooting
• Artisan Commands
• Information
• Wrappers
• Running Tests
• Backers
• Disclaimer

What's new?

Getting Started

Requirements

• PHP ^7.4
• Composer
• MongoDB

Getting started

Requirements

• PHP ^7.4.7
• MongoDB
• Apache (optional)

Installation

Prerequisites

1. Install git and build-essentials for compiling PHP MongoDB library sudo apt install git build-essential
2. Install
   1. PHP: sudo apt update && sudo apt -y install software-properties-common && sudo add-apt-repository ppa:ondrej/php && sudo apt-get update && sudo apt -y install php7.4
   2. PHP dependencies sudo apt install php7.4-{mbstring,xml,dev,pear,zip,common}
3. Install PHP MongoDB driver sudo pecl install mongodb
4. Add extension=mongodb.so to your php.ini
5. Installing Apache (optional)

   1. sudo apt install apache2

   2. Set AllowOverride All in apache2.conf for <Directory /var/www/>

   3. Edit your virtual host document root

      1. By default in /etc/apache2/sites-available/000-default.conf: DocumentRoot /var/www/jikan-rest/public

   4. Enable mod rewrite sudo a2enmod deflate && sudo a2enmod rewrite

   5. Enable mod deflate (for GZIP responses): sudo a2enmod deflate && sudo a2enmod rewrite

   6. Restart apache: sudo service apache2 restart

Jikan REST

1. Clone the repo in /var/www - git clone https://github.com/jikan-me/jikan-rest.git
2. Switch to v4 branch git checkout v4
3. Install composer
4. Install project dependencies with composer php path/to/composer.phar install

Information

If you don't want to host your instance, there's a public API available.

• REST DOCUMENTATION
• Apps/Projects using JikanREST

Wrappers

Language	Wrappers
JavaScript	JikanJS by Zuritor
Java	Jikan4java by Doomsdayrs reactive-jikan by Sandro Marques
Python	JikanPy by Abhinav Kasamsetty
Node.js	jikan-node by xy137 jikan-nodejs by ribeirogab
TypeScript	jikants by Julien Broyard jikan-client by Javier Blanco
PHP	jikan-php by Jan Vernieuwe
.NET	Jikan.net by Ervie
Elixir	JikanEx by Sean Breckenridge
Go	jikan-go by Daren Liang jikan2go by nokusukun
Ruby	Jikan.rb by Zerocchi
Dart	jikan-dart by Rafal Wachol
Kotlin	JikanKt by Ganedra Afrasya

Add your wrapper here

Running Tests

php vendor/bin/phpunit tests

Note: Tests may fail due to rate limit from MyAnimeList (HTTP 429)

---

Backers

Sugoi (すごい) Backers

Thank you to all our Sugoi (すごい) backers! 🙏 [Become a sugoi backer]

• Jared Allard (jaredallard)
• hugonun (hug_onun)

Backers

Thank you to all our backers! 🙏 [Become a backer]

• PurplePinapples
• Barkdoll (Jesse)
• Piotr Szymczak (Drutol)
• Jason Weatherly (jamesthebard)
• Cesar Irad Mendoza (aberuwu)

Sponsors

Thank you to all our sponsors! [Become a sponsor]

• Hibiki Matsujo

---

DISCLAIMER

• Jikan is not affiliated with MyAnimeList.net
• You are responsible for the usage of this API. Please be respectful towards MyAnimeList's Terms Of Service