Skip to content

AllanJone/myanimelistAPI-wrapper

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Description

A C# Wrapper for myanimelist main API. It contains async and sync methods for all available API calls by myanimelist. Check below for documentation and examples.

Getting started

Or using NuGet Package Manager

Install-Package malapi-wrapper -Version 2.1.0

Sample examples

Example 1

var api = new MALAPI.API("USERNAME", "PASSWORD");
var searchResult = api.SearchController.SearchForAnime("Full Metal");
foreach (var entry in searchResult.Entries)
{
	if (entry.StartDate.Ticks == 0) //If there's no start date.
		Console.WriteLine($"{entry.Title} -> Not yet aired.");
	else if (entry.EndDate.Ticks == 0) //If there's no end date.
		Console.WriteLine($"{entry.Title} -> {entry.StartDate.ToShortDateString()} to unknown.");
	else
		Console.WriteLine($"{entry.Title} -> {entry.StartDate.ToShortDateString()} to {entry.EndDate.ToShortDateString()}");
}

In the above example we search for Full Metal and print the result based on their start/end dates.
We use Search Controller, as Search requires myanimelist authentication we've used API Constructor with username and password.


Example 2

var api = new MALAPI.API(); //Doesn't require authentication.
var list = api.UsersController.GetUserAnimeList("3dprogrammer");
Console.WriteLine($"{list.Info.DaysSpentWatching} days watching anime.");
foreach (var entry in list.Animes)
{
	    Console.WriteLine($"{entry.SeriesTitle} - {entry.MyStatus} # {entry.MyScore}");
}

Here we get 3dprogrammer user anime list, print out the total days he spent watching anime and print 3dprogrammer anime list in a nice fashion.
We use Users Controller which doesn't require authentication. (Here you can use either one of the constructors, both will function the same).


Example 3

var api = new MALAPI.API("USERNAME", "PASSWORD");
var searchResult = await api.SearchController.SearchForAnimeAsync("Bakuman");
foreach (var entry in searchResult.Entries)
{
	//This is the exact same as the bottom one.
	if (entry.EntryType == MALAPI.AnimeType.TV)
	{
		var anime = new MALAPI.Dto.AnimeEntry();
		anime.Status = MALAPI.AnimeListStatus.Completed;
		anime.Score = MALAPI.EntryScore.Masterpiece;
		var result = await api.AnimeController.AddAnimeAsync(anime, entry.Id);
		Console.WriteLine(result); //Created or detailed error message.
	}

	//OR
	if (entry.EntryType == MALAPI.AnimeType.TV)
	{
		var result = await api.AnimeController.AddAnimeAsync(entry, MALAPI.AnimeListStatus.Completed);
		Console.WriteLine(result); //Created or detailed error message.
	}
}

In the last example we use async method to search asynchronously for the anime Bakuman and then add it to our list if the type of the anime series is MALAPI.AnimeType.TV. By two different ways

  • Create the AnimeEntry ourself and populate it with data then add it to the list.
  • Or just add the search result entry.

Note that you should use either one of the methods above in the example to add anime, using two will only result in error message.

We Use the Anime/Manga Controllers to Add, Update or Delete entries from the authenticated user's list.

Documentation

MALAPI.API

This is the main API object you deal with the entire time. You use it to manage all the Controllers.

API Controllers
AnimeController
UsersController
MangaController
SearchController

There's 2 constructors available for this class.

var api = new MALAPI.API()

Initializes new mal client without any authentication. Using Controllers that requires authentication such as AnimeController / SearchController with throw an exception.

var api = new MALAPI.API("USERNAME","PASSWORD")

Initializes new authenticated myanimelist client.

AnimeController

A controller to managa myanimelist anime API.
Requires API authentication.

Method name Method description
AddAnime Adds anime entry to specific user's list.
AddAnime Adds found anime search entry to specific user's list.
AddAnimeAsync Adds anime entry to specific user's list asynchronously.
AddAnimeAsync Adds found anime search entry to specific user's list asynchronously.
UpdateAnime Updates existing anime in user's list.
UpdateAnimeAsync Updates existing anime in user's list asynchronously.
DeleteAnime Deletes existing anime from user's list.
DeleteAnimeAsync Deletes existing anime from user's list asynchronously.

MangaController

A controller to manage myanimelist manga API.
Requires API authentication.

Method name Method description
AddManga Adds manga entry to specific user's list.
AddManga Adds found manga search entry to specific user's list.
AddMangaAsync Adds manga entry to specific user's list asynchronously.
AddMangaAsync Adds found manga search entry to specific user's list asynchronously.
UpdateManga Updates existing manga in user's list.
UpdateMangaAsync Updates existing manga in user's list asynchronously.
DeleteManga Deletes existing manga from user's list.
DeleteMangaAsync Deletes existing manga from user's list asynchronously.

SearchController

A controller to manage myanimelist search API.
Requires API authentication.

Method name Method description
SearchForAnime Searches myanimelist for anime.
SearchForAnimeAsync Searches myanimelist for anime asynchronously.
SearchForManga Searches myanimelist for manga.
SearchForMangaAsync Searches myanimelist for manga asynchronously.

UsersController

A controller to manage myanimelist user lists API.
Doesn't require API authentication.

Method name Method description
GetUserAnimeList Retrieves anime list for specific user.
GetUserAnimeListAsync Retrieves anime list for specific user asynchronously.
GetUserMangaList Retrieves manga list for specific user.
GetUserMangaListAsync Retrieves manga list for specific user asynchronously.

About

C# API Wrapper for myanimelist

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 100.0%