Welcome to the official MyAnimeList's API club! This is a place where developers can talk about the API, ask questions, look for help to fix bugs, suggest new features, and showcase their projects. Join us and subscribe to the club!
DISCLAIMER: the API is in open beta. It may contain bugs and lacks several features.
Overview
MyAnimeList provides access to a free API (Application Programming Interface) you can use to programmatically interact with several aspects of the website. It can be used to build both hobbyist and commercial applications.
Currently, the API doesn't let you access all the functionalities offered by the website. Many features are still being implemented and may not be suitable for certain scenarios.
For instance, the API can be used to:- retrieve some information about specific anime or manga;
- access general and seasonal rankings;
- update a user's anime/manga list;
- read forum topics¹;
- get some information about the authenticated user.
However, the API cannot be used (yet) to:- post comments in the forum²;
- send private messages to other users²;
- query the characters or people databases³;
- access the news or featured articles pages;
- interact with several other functionalities found on the website.
(¹) Only the main forum boards can be accessed.
(²) It's technically possible to send messages and post forum comments using the API, but the recent introduction of Google reCAPTCHA made it impossible to perform such actions in an automated manner.
(³) The characters and people endpoints exist but are undocumented and under active development. Don't use them.
Getting started
To start using the API, head to the API panel in your account settings. After reviewing the API License and Developer Agreement, you can create your first application. Don't worry if you cannot fill in all the information, you can come back later.
After doing so, you will receive a Client ID and, for web applications, a Client Secret. They are required to authenticate your users and interact with the API.
If you only need to access publicly available information, you can skip the OAuth procedure and immediately start using the API. Read more here.
On the other hand, if you also need access to a user's private data or take actions on their behalf, you must complete the OAuth2 authentication phase to receive an Access Token. You can read more about this on the official documentation or, alternatively, on my third-party guide.
Once you've chosen your authentication scheme, you can start using the API by consulting the list of all available endpoints.
Click here to see a sample Python programme that performs the OAuth authentication procedure and retrieves the user's name.
Questions?
Feel free to leave a comment or open a new topic to ask a question or showcase your project!
Also, don't forget to join our unofficial Discord server! |