### Get Recommendations Source: https://jikanpy.readthedocs.io Retrieves recommendations for anime or manga. Supports pagination to fetch results from different pages. ```python await jikan.recommendations(type='anime') ``` ```python await jikan.recommendations(type='manga', page=2) ``` -------------------------------- ### Get Person Information Source: https://jikanpy.readthedocs.io Fetches information about a person using their ID. ```python jikan.people(1) ``` -------------------------------- ### Get Reviews Source: https://jikanpy.readthedocs.io Fetches reviews for anime or manga. Pagination is available to retrieve reviews from specific pages. ```python await jikan.reviews(type='anime') ``` ```python await jikan.reviews(type='manga', page=2) ``` -------------------------------- ### Get Recommendations Source: https://jikanpy.readthedocs.io Retrieves recommendations for anime or manga. Supports pagination to fetch results from different pages. ```python >>> jikan.recommendations(type='anime') >>> jikan.recommendations(type='manga', page=2) ``` -------------------------------- ### Get Reviews Source: https://jikanpy.readthedocs.io Fetches reviews for anime or manga. Pagination is available to retrieve reviews from different pages. ```python >>> jikan.reviews(type='anime') >>> jikan.reviews(type='manga', page=2) ``` -------------------------------- ### Get Club Information Source: https://jikanpy.readthedocs.io Fetches details for a specific club using its ID. ```python jikan.clubs(379) ``` -------------------------------- ### user_by_id Source: https://jikanpy.readthedocs.io Gets user name and URL from a MyAnimeList User ID. ```APIDOC ## user_by_id ### Description Gets user name and URL from a MyAnimeList User ID. ### Method `user_by_id(_user_id: int_)` ### Parameters #### Path Parameters - **user_id** (int) - MyAnimeList user ID. #### Query Parameters None ### Request Example ```python await jikan.user_by_id(user_id=1) ``` ### Response #### Success Response - Returns a Dictionary containing information about the user ID. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### jikan.recommendations Source: https://jikanpy.readthedocs.io Gets recommendations for a given resource type (anime or manga). You can also specify a page number for pagination. ```APIDOC ## jikan.recommendations ### Description Gets recommendations for a given resource type (anime or manga). You can also specify a page number for pagination. ### Parameters #### Path Parameters - **type** (str) - Required - Type of resource to get. Available types are: anime and manga. #### Query Parameters - **page** (int, optional) - Page number of the results. Defaults to None. ### Request Example ```python jikan.recommendations(type='anime') jikan.recommendations(type='manga', page=2) ``` ### Response #### Success Response (200) - **Returns** (Dict) - Dictionary containing resource information. ``` -------------------------------- ### Get User by ID Source: https://jikanpy.readthedocs.io Fetches user information, including name and URL, using their MyAnimeList ID. ```python >>> await jikan.user_by_id(user_id=1) ``` -------------------------------- ### Get Character Information Source: https://jikanpy.readthedocs.io Retrieves information about a specific character using their ID. ```python jikan.characters(6356) ``` -------------------------------- ### Get User by ID Source: https://jikanpy.readthedocs.io Retrieve user information using their MyAnimeList user ID. ```python >>> jikan.user_by_id(user_id=1) ``` -------------------------------- ### jikan.reviews Source: https://jikanpy.readthedocs.io Gets reviews for a given resource type (anime or manga). You can also specify a page number for pagination. ```APIDOC ## jikan.reviews ### Description Gets reviews for a given resource type (anime or manga). You can also specify a page number for pagination. ### Parameters #### Path Parameters - **type** (str) - Required - Type of resource to get. Available types are: anime and manga. #### Query Parameters - **page** (int, optional) - Page number of the results. Defaults to None. ### Request Example ```python jikan.reviews(type='anime') jikan.reviews(type='manga', page=2) ``` ### Response #### Success Response (200) - **Returns** (Dict) - Dictionary containing resource information. ``` -------------------------------- ### jikan.season_history Source: https://jikanpy.readthedocs.io Gets all the years and their respective season names from MyAnimeList. ```APIDOC ## jikan.season_history ### Description Gets all the years and their respective season names from MyAnimeList. ### Request Example ```python jikan.season_history() ``` ### Response #### Success Response (200) - **Returns** (Dict) - Dictionary containing all the years and season names. ``` -------------------------------- ### Get Producer Information Source: https://jikanpy.readthedocs.io Retrieves information about a producer or studio by their ID. Supports fetching 'full' details or 'external' links. ```python >>> jikan.producers(id=4) >>> jikan.producers(id=4, extension='full') >>> jikan.producers(id=4, extension='external') ``` -------------------------------- ### Get Season History Source: https://jikanpy.readthedocs.io Fetches a history of all years and their corresponding season names available on MyAnimeList. ```python >>> jikan.season_history() ``` -------------------------------- ### Get Watch Activity Source: https://jikanpy.readthedocs.io Retrieve information about recent or popular episodes and promos. Supports various extensions and parameter filtering. ```python >>> jikan.watch(extension='episodes') >>> jikan.watch(extension='episodes/popular') >>> jikan.watch(extension='promos') >>> jikan.watch(extension='promos/popular', parameters={'limit': 10}) ``` -------------------------------- ### Get Anime Seasons Source: https://jikanpy.readthedocs.io Retrieve anime seasons by year and season, or get currently airing or upcoming seasons. Supports pagination and filtering via parameters. ```python >>> jikan.seasons() >>> jikan.seasons(year=2018, season='winter') >>> jikan.seasons(year=2016, season='spring') >>> jikan.seasons(extension='now') >>> jikan.seasons(extension='upcoming') >>> jikan.seasons( year=2021, season='winter', page=2, parameters={'filter': 'tv'} ) ``` -------------------------------- ### Get Genres Source: https://jikanpy.readthedocs.io Retrieves anime or manga genres, with options to filter by specific genre types or categories. ```APIDOC ## Get Genres ### Description Gets anime or manga genres. You can specify the type ('anime' or 'manga') and optionally filter by genre categories like 'genres', 'explicit_genres', 'themes', or 'demographics'. ### Parameters * **type** (str) - Type to get items from. Possible values are 'anime' and 'manga'. * **filter** (str, optional) - Filter genres by specific categories. Defaults to None. ### Returns Dictionary containing MAL genres and search URLs. ### Return type Dict[str, Any] ### Examples ```python jikan.genres(type='anime') jikan.genres(type='manga', filter='themes') ``` ``` -------------------------------- ### magazine Source: https://jikanpy.readthedocs.io Deprecated: Gets Magazine information by ID. ```APIDOC ## magazine ### Description Deprecated: Gets Magazine information by ID. ### Parameters * **magazine_id** (int) - ID of the magazine to get the information of. * **page** (int, optional) - Page number for paginated results. Defaults to None. ### Returns Dictionary containing information about the magazine. ### Return type Dict[str, Any] ``` -------------------------------- ### top Source: https://jikanpy.readthedocs.io Gets top items on MyAnimeList across various categories like anime, manga, people, characters, and reviews. Supports pagination. ```APIDOC ## top ### Description Gets top items on MyAnimeList across various categories like anime, manga, people, characters, and reviews. Supports pagination. ### Method `top(_type: str_, _page: Optional[int] = None_, _parameters: Optional[Dict[str, Any]] = None_)` ### Parameters #### Path Parameters None #### Query Parameters - **type** (str) - Type to get top items from. Possible values are anime, manga, people, characters, and reviews. - **page** (int, optional) - Page number of the results. Defaults to None. - **parameters** (dict, optional) - Dictionary containing key,value pairs for ?key=value in url query. Defaults to None. ### Request Example ```python await jikan.top(type='manga') await jikan.top(type='anime', page=2) ``` ### Response #### Success Response - Returns a Dictionary containing top items on MyAnimeList. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### characters Source: https://jikanpy.readthedocs.io Gets information on a character by their ID. You can also retrieve extended information if available. ```APIDOC ## characters ### Description Gets information on a character. You can specify an extension to retrieve special information if available. ### Parameters * **id** (int) - ID of the character to get the information of. * **extension** (str, optional) - Special information (via URL param) to get of the character. Possible values are in the Jikan API documentation. Defaults to None. ### Returns Dictionary containing information about the character. ### Return type Dict ### Examples ```python await jikan.characters(6356) ``` ``` -------------------------------- ### Get Random Resource Source: https://jikanpy.readthedocs.io Fetches a random resource of a specified type. Available types include anime, manga, characters, people, and users. ```python await jikan.random(type='anime') ``` ```python await jikan.random(type='characters') ``` ```python await jikan.random(type='users') ``` -------------------------------- ### Get Watch Activity Source: https://jikanpy.readthedocs.io Fetches information about recent activity, such as episodes or promos. Supports various extensions and custom parameters for filtering. ```python >>> await jikan.watch(extension='episodes') >>> await jikan.watch(extension='episodes/popular') >>> await jikan.watch(extension='promos') >>> await jikan.watch(extension='promos/popular', parameters={'limit': 10}) ``` -------------------------------- ### clubs Source: https://jikanpy.readthedocs.io Gets information on a club by its ID. You can also retrieve extended information if available. ```APIDOC ## clubs ### Description Gets information on a club. You can specify an extension to retrieve special information if available. ### Parameters * **id** (int) - ID of the club to get the information of. * **extension** (str, optional) - Special information (via URL param) to get of the club. Possible values are in the Jikan API documentation. Defaults to None. ### Returns Dictionary containing information about the club. ### Return type Dict ### Examples ```python await jikan.clubs(379) ``` ``` -------------------------------- ### jikan.random Source: https://jikanpy.readthedocs.io Gets a random resource of a specified type. Available types include anime, manga, characters, people, and users. ```APIDOC ## jikan.random ### Description Gets a random resource of a specified type. Available types include anime, manga, characters, people, and users. ### Parameters #### Path Parameters - **type** (str) - Required - Type of resource to get. Available types are: anime, manga, characters, people, users. ### Request Example ```python jikan.random(type='anime') jikan.random(type='characters') jikan.random(type='users') ``` ### Response #### Success Response (200) - **Returns** (Dict) - Dictionary containing resource information. ``` -------------------------------- ### Get People Information Source: https://jikanpy.readthedocs.io Fetches information about a person by their ID. Optionally retrieve associated pictures or other details using the 'extension' parameter. ```python >>> jikan.people(2) >>> jikan.people(2, extension='pictures') >>> jikan.people(2, extension='pictures', parameters={'limit': 10} ) ``` -------------------------------- ### Get Season History Source: https://jikanpy.readthedocs.io Retrieves a history of all years and their corresponding season names available on MyAnimeList. ```python await jikan.season_history() ``` -------------------------------- ### Get Person Information Source: https://jikanpy.readthedocs.io Fetches information about a specific person using their ID. Can optionally retrieve associated pictures with additional parameters. ```python await jikan.people(2) ``` ```python await jikan.people(2, extension='pictures') ``` ```python await jikan.people(2, extension='pictures', parameters={'limit': 10} ) ``` -------------------------------- ### Get User Information Source: https://jikanpy.readthedocs.io Fetch detailed information about a user by their username. Supports extensions like 'full', 'friends', 'history', and pagination for some extensions. Parameters can be used for filtering. ```python >>> jikan.users(username='Xinil') >>> jikan.users(username='Xinil', extension='full') >>> jikan.users(username='Xinil', extension='friends', page=2) >>> jikan.users(username='Xinil', extension='history', parameters={'type': 'anime'}) ``` -------------------------------- ### manga Source: https://jikanpy.readthedocs.io Gets information on a specific manga by its ID. You can also retrieve extended information and paginate through results. ```APIDOC ## manga ### Description Gets information on a manga. You can specify an extension to retrieve special information and paginate through results. ### Parameters * **id** (int) - ID of the manga to get the information of. * **extension** (str, optional) - Special information to get of the manga. Possible values are in the Jikan API documentation. Defaults to None. * **page** (int, optional) - Page number for paginated results. Defaults to None. ### Returns Dictionary containing information about the manga. ### Return type Dict ### Examples ```python await jikan.manga(1630) ``` ``` -------------------------------- ### jikan.producers Source: https://jikanpy.readthedocs.io Gets anime by the producer/studio/licensor. You can specify the producer ID and optionally retrieve extended information. ```APIDOC ## jikan.producers ### Description Gets anime by the producer/studio/licensor. You can specify the producer ID and optionally retrieve extended information. ### Parameters #### Path Parameters - **id** (int) - Required - Producer ID from MyAnimeList. #### Query Parameters - **extension** (str, optional) - Special information (via URL param) to get of the producer. Possible values are in the Jikan API documentation. Defaults to None. ### Request Example ```python jikan.producers(id=4) jikan.producers(id=4, extension='full') jikan.producers(id=4, extension='external') ``` ### Response #### Success Response (200) - **Returns** (Dict) - Dictionary containing producer information. ``` -------------------------------- ### Get Anime Episode by IDs Source: https://jikanpy.readthedocs.io Fetches specific episode information for an anime using both the anime ID and the episode ID. ```APIDOC ## Get Anime Episode by IDs ### Description Gets a specific episode's information for a given anime, using both the anime ID and the episode ID. ### Parameters * **anime_id** (int) - ID of the anime to get the episode of. * **episode_id** (int) - ID of the episode to get. ### Returns Dictionary containing information about the episode. ### Return type Dict[str, Any] ### Examples ```python jikan.anime_episode_by_id(anime_id=1, episode_id=1) ``` ``` -------------------------------- ### jikan.schedules Source: https://jikanpy.readthedocs.io Gets anime scheduled for a specific day of the week. You can also specify a page number and additional URL parameters. ```APIDOC ## jikan.schedules ### Description Gets anime scheduled for a specific day of the week. You can also specify a page number and additional URL parameters. ### Parameters #### Query Parameters - **day** (str, optional) - Day of the week to get the scheduled anime. Defaults to None. - **page** (int, optional) - Page number of the results. Defaults to None. - **parameters** (dict, optional) - Dictionary containing key,value pairs for ?key=value in url query. Defaults to None. ### Request Example ```python jikan.schedules() jikan.schedules(day='monday') ``` ### Response #### Success Response (200) - **Returns** (Dict) - Dictionary containing anime scheduled. ``` -------------------------------- ### users Source: https://jikanpy.readthedocs.io Gets information about a specific user based on their username. Supports extensions for additional details and pagination. ```APIDOC ## users ### Description Gets information about a specific user based on their username. Supports extensions for additional details and pagination. ### Method `users(_username: str_, _extension: Optional[str] = None_, _page: Optional[int] = None_, _parameters: Optional[Dict[str, Any]] = None_)` ### Parameters #### Path Parameters None #### Query Parameters - **username** (str) - MyAnimeList username. - **extension** (str, optional) - Special information (via URL param) to get of the producer. Possible values are in the Jikan API documentation. Defaults to None. - **page** (int, optional) - Page number of the results. Check API doc for information on which extensions accept paging. Defaults to None. - **parameters** (dict, optional) - Dictionary containing key,value pairs for ?key=value in url query. Defaults to None. ### Request Example ```python await jikan.users(username='Xinil') await jikan.users(username='Xinil', extension='full') await jikan.users(username='Xinil', extension='friends', page=2) await jikan.users(username='Xinil', extension='history', parameters={'type': 'anime'}) ``` ### Response #### Success Response - Returns a Dictionary containing information about the user. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### watch Source: https://jikanpy.readthedocs.io Gets information about recent activity of a specific resource type. Supports extensions for different activity types like episodes and promos, and allows for query parameters. ```APIDOC ## watch ### Description Gets information about recent activity of a specific resource type. Supports extensions for different activity types like episodes and promos, and allows for query parameters. ### Method `watch(_extension: str_, _parameters: Optional[Dict[str, Any]] = None_)` ### Parameters #### Path Parameters None #### Query Parameters - **extension** (str, optional) - Special information (via URL param) to get of the producer. Possible values are in the Jikan API documentation. Defaults to None. - **parameters** (dict, optional) - Dictionary containing key,value pairs for ?key=value in url query. Defaults to None. ### Request Example ```python await jikan.watch(extension='episodes') await jikan.watch(extension='episodes/popular') await jikan.watch(extension='promos') await jikan.watch(extension='promos/popular', parameters={'limit': 10}) ``` ### Response #### Success Response - Returns a Dictionary containing information about recent/popular episodes or promos. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Person by ID Source: https://jikanpy.readthedocs.io Fetches information about a specific person using their ID. Optional extensions can be used for related data. ```APIDOC ## Get Person by ID ### Description Gets information on a person by their ID. An optional extension can be used to retrieve specific related data. ### Parameters * **id** (int) - ID of the person to get the information of. * **extension** (str, optional) - Special information (via URL param) to get of the person. Defaults to None. ### Returns Dictionary containing information about the person. ### Return type Dict[str, Any] ### Examples ```python # Example for getting person information would go here if provided in source. ``` ``` -------------------------------- ### Get Club by ID Source: https://jikanpy.readthedocs.io Fetches information about a specific club using its ID. Extensions can be used for related data. ```APIDOC ## Get Club by ID ### Description Gets information on a club by its ID. An optional extension can be used to retrieve specific related data. ### Parameters * **id** (int) - ID of the club to get the information of. * **extension** (str, optional) - Special information (via URL param) to get of the club. Defaults to None. ### Returns Dictionary containing information about the club. ### Return type Dict[str, Any] ### Examples ```python jikan.clubs(379) ``` ``` -------------------------------- ### Get Specific Anime Episode by ID Source: https://jikanpy.readthedocs.io Retrieves details for a specific episode of an anime, identified by both the anime ID and the episode ID. ```python >>> await jikan.anime_episode_by_id(anime_id=1, episode_id=1) ``` -------------------------------- ### Get Random Resource Source: https://jikanpy.readthedocs.io Fetches a random resource of a specified type. Supported types include anime, manga, characters, people, and users. ```python >>> jikan.random(type='anime') >>> jikan.random(type='characters') >>> jikan.random(type='users') ``` -------------------------------- ### Get Manga Information Source: https://jikanpy.readthedocs.io Fetches general information about a manga using its ID. Supports retrieving specific extensions and pagination. ```python >>> await jikan.manga(1630) ``` -------------------------------- ### Get Club Information Source: https://jikanpy.readthedocs.io Retrieves details for a specific club using its ID. The 'extension' parameter can be used for related data if available. ```python >>> await jikan.clubs(379) ``` -------------------------------- ### Get Anime Information Source: https://jikanpy.readthedocs.io Fetches general information about an anime using its ID. Supports retrieving specific extensions like episodes or news, and pagination for episodes. ```python >>> await jikan.anime(14719) >>> await jikan.anime(14719, extension='episodes') >>> await jikan.anime(14719, extension='episodes', page=2) >>> await jikan.anime(14719, extension='news') ``` -------------------------------- ### Get Producer Information Source: https://jikanpy.readthedocs.io Retrieves anime associated with a producer or studio using their ID. Supports fetching 'full' or 'external' details. ```python await jikan.producers(producer_id=4) ``` ```python await jikan.producers(id=4, extension='full') ``` ```python await jikan.producers(id=4, extension='external') ``` -------------------------------- ### jikan.people Source: https://jikanpy.readthedocs.io Gets information about a person. You can optionally retrieve specific details like pictures or filter results using parameters. ```APIDOC ## jikan.people ### Description Gets information about a person. You can optionally retrieve specific details like pictures or filter results using parameters. ### Parameters #### Path Parameters - **id** (int) - Required - The ID of the person from MyAnimeList. #### Query Parameters - **extension** (str, optional) - Special information (via URL param) to get of the person. Possible values are in the Jikan API documentation. Defaults to None. - **parameters** (dict, optional) - Dictionary containing key,value pairs for ?key=value in url query. Defaults to None. ### Request Example ```python jikan.people(2) jikan.people(2, extension='pictures') jikan.people(2, extension='pictures', parameters={'limit': 10} ) ``` ### Response #### Success Response (200) - **Returns** (Dict) - Dictionary containing information about the person. ``` -------------------------------- ### Get Specific Anime Episode Source: https://jikanpy.readthedocs.io Fetches details for a specific episode of an anime, requiring both the anime ID and the episode ID. ```python jikan.anime_episode_by_id(anime_id=1, episode_id=1) ``` -------------------------------- ### Get Anime by Season Source: https://jikanpy.readthedocs.io Retrieves anime information for a specific year and season, or the current season if no parameters are provided. Supports filtering by year, season, and additional parameters. ```python Gets information on anime of the specific season or the current seasaon if no parameters are specified. Parameters:| * **year** (`int`, optional) – Year to get anime of. Defaults to None. * **season** (`str`, optional) – Season to get anime of. Possible values are winter, spring, summer, and fall. Defaults to None. ``` -------------------------------- ### Get Anime or Manga Genres Source: https://jikanpy.readthedocs.io Fetches genres for either anime or manga. Allows filtering by specific genre types like 'themes' or 'demographics'. ```python >>> await jikan.genres(type='anime') >>> await jikan.genres(type='manga', filter='themes') ``` -------------------------------- ### Get User Information Source: https://jikanpy.readthedocs.io Retrieves detailed information about a specific user by their username. Supports extensions for full details, friends, or history, and can include pagination and custom parameters. ```python >>> await jikan.users(username='Xinil') >>> await jikan.users(username='Xinil', extension='full') >>> await jikan.users(username='Xinil', extension='friends', page=2) >>> await jikan.users(username='Xinil', extension='history', parameters={'type': 'anime'}) ``` -------------------------------- ### anime Source: https://jikanpy.readthedocs.io Gets information on a specific anime by its ID. You can also retrieve extended information like episodes or news, and paginate through results. ```APIDOC ## anime ### Description Gets information on an anime. You can specify an extension to retrieve special information like episodes or news, and paginate through results. ### Parameters * **id** (int) - ID of the anime to get the information of. * **extension** (str, optional) - Special information (via URL param) to get of the anime. Possible values are in the Jikan API documentation. Defaults to None. * **page** (int, optional) - Page number for paginated results. Defaults to None. ### Returns Dictionary containing information about the anime. ### Return type Dict[str, Any] ### Examples ```python await jikan.anime(14719) await jikan.anime(14719, extension='episodes') await jikan.anime(14719, extension='episodes', page=2) await jikan.anime(14719, extension='news') ``` ``` -------------------------------- ### genres Source: https://jikanpy.readthedocs.io Gets anime or manga items filtered by genre. You can specify the type (anime or manga) and a filter for specific genre categories. ```APIDOC ## genres ### Description Gets anime or manga by genre. You can specify the type and a filter for genre categories. ### Parameters * **type** (str) - Type to get items from. Possible values are anime and manga. * **filter** (str, optional) - Filter genres by “genres”, “explicit_genres”, “themes”, or “demographics”. Defaults to None. ### Returns Dictionary containing MAL genres and search URLs. ### Return type Dict ### Examples ```python await jikan.genres(type='anime') await jikan.genres(type='manga', filter='themes') ``` ``` -------------------------------- ### Get Manga by ID Source: https://jikanpy.readthedocs.io Retrieves detailed information about a specific manga using its ID. You can also fetch extended information and paginate through results. ```APIDOC ## Get Manga by ID ### Description Gets information on a manga by its ID. You can also specify an extension to retrieve specific details and use the page parameter for paginated results. ### Parameters * **id** (int) - ID of the manga to get the information of. * **extension** (str, optional) - Special information (via URL param) to get of the manga. Defaults to None. * **page** (int, optional) - Page number of the results for paginated data. Defaults to None. ### Returns Dictionary containing information about the manga. ### Return type Dict[str, Any] ### Examples ```python jikan.manga(1630) ``` ``` -------------------------------- ### Get Scheduled Anime Source: https://jikanpy.readthedocs.io Retrieves a list of scheduled anime, optionally filtered by a specific day of the week. Supports pagination and custom query parameters. ```python await jikan.schedules() ``` ```python await jikan.schedules(day='monday') ``` -------------------------------- ### Get Anime or Manga by Genre Source: https://jikanpy.readthedocs.io Retrieves a list of anime or manga belonging to a specific genre. You can filter by different genre types like themes or demographics. ```python jikan.genres(type='anime') ``` ```python jikan.genres(type='manga', filter='themes') ``` -------------------------------- ### Get Manga Information Source: https://jikanpy.readthedocs.io Retrieves general information about a specific manga using its ID. You can also fetch extended information and paginate through results. ```python jikan.manga(1630) ``` -------------------------------- ### Get Top Anime or Manga Source: https://jikanpy.readthedocs.io Fetch top-ranked items from MyAnimeList by type (anime, manga, people, characters, reviews). Supports pagination. ```python >>> jikan.top(type='manga') >>> jikan.top(type='anime', page=2) ``` -------------------------------- ### Get Character Information Source: https://jikanpy.readthedocs.io Fetches information about a character using their ID. The 'extension' parameter can be used to retrieve related data if supported by the API. ```python >>> await jikan.characters(6356) ``` -------------------------------- ### Get Character by ID Source: https://jikanpy.readthedocs.io Retrieves information about a specific character using their ID. Optional extensions can be used to fetch related data. ```APIDOC ## Get Character by ID ### Description Gets information on a character by their ID. An optional extension can be used to retrieve specific related data. ### Parameters * **id** (int) - ID of the character to get the information of. * **extension** (str, optional) - Special information (via URL param) to get of the character. Defaults to None. ### Returns Dictionary containing information about the character. ### Return type Dict[str, Any] ### Examples ```python jikan.characters(6356) ``` ``` -------------------------------- ### Get Anime Information Source: https://jikanpy.readthedocs.io Retrieves general information about a specific anime using its ID. You can also fetch extended information like episodes or news, and paginate through results. ```python jikan.anime(14719) ``` ```python jikan.anime(14719, extension='episodes') ``` ```python jikan.anime(14719, extension='episodes', page=2) ``` ```python jikan.anime(14719, extension='news') ``` -------------------------------- ### Get Scheduled Anime Source: https://jikanpy.readthedocs.io Retrieves a list of anime scheduled for a specific day of the week or all scheduled anime if no day is specified. Supports pagination and custom query parameters. ```python >>> jikan.schedules() >>> jikan.schedules(day='monday') ``` -------------------------------- ### Get Top Anime or Manga Source: https://jikanpy.readthedocs.io Retrieves top-rated anime or manga from MyAnimeList. Specify the type and optionally the page number and custom query parameters. ```python >>> await jikan.top(type='manga') >>> await jikan.top(type='anime', page=2) ``` -------------------------------- ### Initialize AioJikan with custom base URL or session Source: https://jikanpy.readthedocs.io Shows how to instantiate AioJikan with a custom base URL or by providing a pre-configured aiohttp ClientSession. ```python >>> aio_jikan_1 = AioJikan() >>> aio_jikan_2 = AioJikan(selected_base='http://localhost:8000/v4') >>> aio_jikan_3 = AioJikan( session=aiohttp.ClientSession(headers={'x-test': 'true'}) ) ``` -------------------------------- ### Get Anime by ID Source: https://jikanpy.readthedocs.io Retrieves detailed information about a specific anime using its ID. You can also fetch extended information like episodes or news, and paginate through results. ```APIDOC ## Get Anime by ID ### Description Gets information on an anime by its ID. You can also specify an extension to retrieve specific details like episodes or news, and use the page parameter for paginated results. ### Parameters * **id** (int) - ID of the anime to get the information of. * **extension** (str, optional) - Special information to get of the anime (e.g., 'episodes', 'news'). Defaults to None. * **page** (int, optional) - Page number of the results for paginated data. Defaults to None. ### Returns Dictionary containing information about the anime. ### Return type Dict[str, Any] ### Examples ```python jikan.anime(14719) jikan.anime(14719, extension='episodes') jikan.anime(14719, extension='episodes', page=2) jikan.anime(14719, extension='news') ``` ``` -------------------------------- ### Initialize AioJikan with default session Source: https://jikanpy.readthedocs.io Demonstrates how to initialize AioJikan using an asynchronous context manager. This is the recommended way to ensure the session is properly closed. ```python import asyncio from jikanpy import AioJikan async def main(): async with AioJikan() as aio_jikan: pass # You can also construct AioJikan like below, but make sure to close # the object aio_jikan_2 = AioJikan() await aio_jikan_2.close() asyncio.run(main()) ``` -------------------------------- ### people Source: https://jikanpy.readthedocs.io Gets information on a person by their ID. Optionally, you can retrieve specific extensions like pictures or other details available in the Jikan API documentation. You can also pass additional parameters for more refined requests. ```APIDOC ## people ### Description Gets information on a person. ### Method GET ### Endpoint /people/{id}/{extension} ### Parameters #### Path Parameters - **id** (int) - Required - ID of the person to get the information of. - **extension** (str) - Optional - Special information to get of the person. Possible values are in the Jikan API documentation. #### Query Parameters - **parameters** (dict) - Optional - Dictionary containing key,value pairs for ?key=value in url query. ### Request Example ```python await jikan.people(2) await jikan.people(2, extension='pictures') await jikan.people(2, extension='pictures', parameters={'limit': 10} ) ``` ``` -------------------------------- ### Instantiate Jikan Object with Custom Base URL or Session Source: https://jikanpy.readthedocs.io Demonstrates creating Jikan objects with a custom base URL or by passing a pre-configured Requests session. ```python jikan_1 = Jikan() jikan_2 = Jikan(selected_base='http://localhost:8000/v4') jikan_3 = jikan = Jikan(session=requests.Session()) ``` -------------------------------- ### seasons Source: https://jikanpy.readthedocs.io Gets information on anime of the specific season or the current season if no parameters are specified. Supports filtering by year, season, and includes options for extensions and pagination. ```APIDOC ## seasons ### Description Gets information on anime of the specific season or the current season if no parameters are specified. Supports filtering by year, season, and includes options for extensions and pagination. ### Method `seasons(_year: Optional[int] = None_, _season: Optional[str] = None_, _extension: Optional[str] = None_, _page: Optional[int] = None_, _parameters: Optional[Dict[str, Any]] = None_)` ### Parameters #### Path Parameters None #### Query Parameters - **year** (int, optional) - Year to get anime of. Defaults to None. - **season** (str, optional) - Season to get anime of. Possible values are winter, spring, summer, and fall. Defaults to None. - **extension** (str, optional) - Special information (via URL param) to get of the season. Possible values are in the Jikan API documentation. Note: getSeasonsList is unsupported here, instead use season_history. Defaults to None. - **page** (int, optional) - Page number of the results. Defaults to None. - **parameters** (dict, optional) - Dictionary containing key,value pairs for ?key=value in url query. Defaults to None. ### Request Example ```python jikan.seasons() jikan.seasons(year=2018, season='winter') jikan.seasons(year=2016, season='spring') jikan.seasons(extension='now') jikan.seasons(extension='upcoming') jikan.seasons( year=2021, season='winter', page=2, parameters={'filter': 'tv'} ) ``` ### Response #### Success Response - Returns a Dictionary containing information on anime of the season. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Jikan Initialization Source: https://jikanpy.readthedocs.io Initializes the Jikan object, optionally specifying a base URL or a custom requests session. ```APIDOC ## Jikan Initialization ### Description Constructs the Jikan object. You can optionally specify a base URL for the Jikan API or provide a custom Requests session object. ### Parameters * **selected_base** (str, optional) - Base url of Jikan API. Defaults to the official Jikan API URL. * **session** (requests.Session, optional) - A pre-existing Requests session object. ### Returns Instance of Jikan. ### Return type Jikan ### Examples ```python from jikanpy import Jikan jikan_1 = Jikan() jikan_2 = Jikan(selected_base='http://localhost:8000/v4') jikan_3 = Jikan(session=requests.Session()) ``` ``` -------------------------------- ### jikan.seasons Source: https://jikanpy.readthedocs.io Gets information on anime of a specific season or the current season if no parameters are specified. You can filter by year, season, and retrieve additional information or paginate results. ```APIDOC ## jikan.seasons ### Description Gets information on anime of a specific season or the current season if no parameters are specified. You can filter by year, season, and retrieve additional information or paginate results. ### Parameters #### Query Parameters - **year** (int, optional) - Year to get anime of. Defaults to None. - **season** (str, optional) - Season to get anime of. Possible values are winter, spring, summer, and fall. Defaults to None. - **extension** (str, optional) - Special information (via URL param) to get of the anime. Defaults to None. - **page** (int, optional) - Page number of the results. Defaults to None. - **parameters** (dict, optional) - Dictionary containing key,value pairs for ?key=value in url query. Defaults to None. ### Response #### Success Response (200) - **Returns** (Dict) - Dictionary containing information on anime of the specified season. ``` -------------------------------- ### AioJikan Initialization Source: https://jikanpy.readthedocs.io Constructs the AioJikan object. You can optionally provide a custom base URL or an existing aiohttp session. ```APIDOC ## AioJikan Initialization ### Description Constructs the AioJikan object. You can optionally provide a custom base URL or an existing aiohttp session. ### Parameters * **selected_base** (str, optional) - Base url of Jikan API. Defaults to the official Jikan API URL. * **session** (aiohttp.ClientSession, optional) - Defaults to a new aiohttp session object. ### Returns Instance of AioJikan. ### Return type AioJikan ### Examples ```python aio_jikan_1 = AioJikan() aio_jikan_2 = AioJikan(selected_base='http://localhost:8000/v4') aio_jikan_3 = AioJikan( session=aiohttp.ClientSession(headers={'x-test': 'true'}) ) ``` ``` -------------------------------- ### Instantiate Jikan Object Source: https://jikanpy.readthedocs.io Initializes the Jikan object for synchronous API requests. You can use the default base URL or specify a custom one, and optionally provide a pre-existing Requests session. ```python from jikanpy import Jikan jikan = Jikan() ``` -------------------------------- ### recommendations Source: https://jikanpy.readthedocs.io Retrieves recommendations for either anime or manga. You can specify the type of resource and the page number for paginated results. ```APIDOC ## recommendations ### Description Gets recommendations for type resource. ### Method GET ### Endpoint /recommendations/{type} ### Parameters #### Path Parameters - **type** (str) - Required - Type of of resource to get. Available types are: anime and manga. #### Query Parameters - **page** (int) - Optional - Page number of the results. ### Request Example ```python await jikan.recommendations(type='anime') await jikan.recommendations(type='manga', page=2) ``` ``` -------------------------------- ### jikan.watch Source: https://jikanpy.readthedocs.io Fetches information about recent activity, such as episodes or promos, with optional filtering and pagination. ```APIDOC ## jikan.watch ### Description Fetches information about recent activity, such as episodes or promos, with optional filtering and pagination. ### Parameters #### Path Parameters - **extension** (str, optional) – Special information (via URL param) to get of the producer. Possible values are in the Jikan API documentation. Defaults to None. #### Query Parameters - **parameters** (dict, optional) – Dictionary containing key,value pairs for ?key=value in url query. Defaults to None. ### Response #### Success Response - Returns: Dictionary containing information about recent/popular episodes or promos. - Return type: Dict ### Request Example ``` >>> jikan.watch(extension='episodes') >>> jikan.watch(extension='episodes/popular') >>> jikan.watch(extension='promos') >>> jikan.watch(extension='promos/popular', parameters={'limit': 10}) ``` ``` -------------------------------- ### reviews Source: https://jikanpy.readthedocs.io Fetches reviews for anime or manga. You can specify the type of resource and the page number for paginated results. ```APIDOC ## reviews ### Description Gets reviews for type resource. ### Method GET ### Endpoint /reviews/{type} ### Parameters #### Path Parameters - **type** (str) - Required - Type of of resource to get. Available types are: anime and manga. #### Query Parameters - **page** (int) - Optional - Page number of the results. ### Request Example ```python await jikan.reviews(type='anime') await jikan.reviews(type='manga', page=2) ``` ``` -------------------------------- ### random Source: https://jikanpy.readthedocs.io Fetches a random resource of a specified type. Supported types include anime, manga, characters, people, and users. ```APIDOC ## random ### Description Gets a random type resource. ### Method GET ### Endpoint /random/{type} ### Parameters #### Path Parameters - **type** (str) - Required - Type of resource to get. Available types are: anime, manga, characters, people, users. ### Request Example ```python await jikan.random(type='anime') await jikan.random(type='characters') await jikan.random(type='users') ``` ``` -------------------------------- ### jikan.user_by_id Source: https://jikanpy.readthedocs.io Fetches user information, including name and URL, using their MyAnimeList user ID. ```APIDOC ## jikan.user_by_id ### Description Fetches user information, including name and URL, using their MyAnimeList user ID. ### Parameters #### Path Parameters - **user_id** (int) – MyAnimeList user ID ### Response #### Success Response - Returns: Dictionary containing information about the user ID. - Return type: Dict ### Request Example ``` >>> jikan.user_by_id(user_id=1) ``` ``` -------------------------------- ### search Source: https://jikanpy.readthedocs.io Searches for various types of resources on MyAnimeList, including anime, manga, characters, people, and more. You can specify the search type, your query, and paginate through the results. Additional parameters can be provided for more specific searches. ```APIDOC ## search ### Description Searches for a query on MyAnimeList. ### Method GET ### Endpoint /search/{search_type} ### Parameters #### Path Parameters - **search_type** (str) - Required - Where to search. Possible values are anime, characters, clubs, magazines, manga, people, producers, and users. #### Query Parameters - **query** (str) - Required - Query to search for. - **page** (int) - Optional - Page number of the results. - **parameters** (dict) - Optional - Dictionary containing key,value pairs for ?key=value in url query. Check API doc for information on the parameters each search endpoint accepts. ### Request Example ```python await jikan.search('anime', 'Jojo') await jikan.search('anime', 'Jojo', page=2) await jikan.search('anime', 'Jojo', parameters={'type': 'tv'}) await jikan.search( 'anime', 'Jojo', page=2, parameters={'genre': 37, 'type': 'tv'} ) ``` ``` -------------------------------- ### jikan.users Source: https://jikanpy.readthedocs.io Retrieves detailed information about a specific user based on their username, with options for extensions and pagination. ```APIDOC ## jikan.users ### Description Retrieves detailed information about a specific user based on their username, with options for extensions and pagination. ### Parameters #### Path Parameters - **username** (str) – MyAnimeList username. #### Query Parameters - **extension** (str, optional) – Special information (via URL param) to get of the producer. Possible values are in the Jikan API documentation. Defaults to None. - **page** (int, optional) – Page number of the results. Check API doc for information on which extensions accept paging. Defaults to None. - **parameters** (dict, optional) – Dictionary containing key,value pairs for ?key=value in url query. Defaults to None. ### Response #### Success Response - Returns: Dictionary containing information about the user. - Return type: Dict ### Request Example ``` >>> jikan.users(username='Xinil') >>> jikan.users(username='Xinil', extension='full') >>> jikan.users(username='Xinil', extension='friends', page=2) >>> jikan.users(username='Xinil', extension='history', parameters={'type': 'anime'}) ``` ``` -------------------------------- ### close Source: https://jikanpy.readthedocs.io Closes the underlying aiohttp session used by AioJikan. ```APIDOC ## close ### Description Close AioHTTP session ### Returns None ``` -------------------------------- ### jikan.top Source: https://jikanpy.readthedocs.io Retrieves top items from MyAnimeList across various categories like anime, manga, people, characters, and reviews. ```APIDOC ## jikan.top ### Description Retrieves top items from MyAnimeList across various categories like anime, manga, people, characters, and reviews. ### Parameters #### Path Parameters - **type** (str) – Type to get top items from. Possible values are anime, manga, people, characters, and reviews. #### Query Parameters - **page** (int, optional) – Page number of the results. Defaults to None. - **parameters** (dict, optional) – Dictionary containing key,value pairs for ?key=value in url query. Defaults to None. ### Response #### Success Response - Returns: Dictionary containing top items on MyAnimeList. - Return type: Dict ### Request Example ``` >>> jikan.top(type='manga') >>> jikan.top(type='anime', page=2) ``` ``` -------------------------------- ### schedules Source: https://jikanpy.readthedocs.io Retrieves anime scheduled for a specific day of the week. You can also paginate results and provide additional query parameters. ```APIDOC ## schedules ### Description Gets anime scheduled. ### Method GET ### Endpoint /schedules/{day} ### Parameters #### Path Parameters - **day** (str) - Optional - Day of the week to get the scheduled anime. #### Query Parameters - **page** (int) - Optional - Page number of the results. - **parameters** (dict) - Optional - Dictionary containing key,value pairs for ?key=value in url query. ### Request Example ```python await jikan.schedules() await jikan.schedules(day='monday') ``` ```