NinjaJc01/jikan-rest

The REST API for Jikan

Jikan - Unofficial MyAnimeList.net REST API

Jikan is a REST API for MyAnimeList.net. It scrapes the website to satisfy the need for an API - which 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 the lackluster official API, 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.

Getting Started

Requirements

• PHP 7.1+
• Composer
• Redis

Installation

🐳 Docker

• JikanREST Docker by Fethi El Hassasna

Linux

This is specifically for Ubuntu, but other distributions should work similarly.

1. Install requirements:

• Add PHP related packages: sudo add-apt-repository -y ppa:ondrej/php
• sudo apt update && sudo apt upgrade
• Install requirements: sudo apt install curl git python-software-properties php redis-server
• Verify that PHP 7.1+ is installed: php -v
• Install the corresponding php-xml and php-mbstring packages for your version, e.g:
  • PHP 7.1: sudo apt install php7.1-xml php7.1-mbstring
  • PHP 7.3: sudo apt install php7.3-xml php7.3-mbstring
• Install composer: curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer

2. Start the redis server: sudo service redis start

Mac

1. Install brew
2. Install requirements: brew install php composer redis
3. Start the redis server: brew services start redis

Run

1. git clone https://github.com/jikan-me/jikan-rest.git
2. cd jikan-rest
3. Rename .env.dist to .env: mv .env.dist .env
4. composer update
5. composer install

To start the server, create a virtual host and point it to /public:

php -S localhost:8000 -t public

Jikan is now hosted on http://localhost:8000/v3/

Information

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

• REST DOCUMENTATION
• Apps/Projects using JikanREST

Wrappers

• [.NET] Jikan.net by Ervie
• [Python] JikanPy by Andrew Conant & Abhinav Kasamsetty
• [Ruby] Jikan.rb by Zerocchi
• [JavaScript] JikanJS by Zuritor
• [Java] Jikan4java by Doomsdayrs
• [PHP] jikan-php by Jan Vernieuwe
• [Node.js] jikan-node by xy137
• [Dart] jikan-dart by Rafal Wachol
• [TypeScript] jikants by Julien Broyard

Add your wrapper here

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