Data Models¶

Warning

Those models may or may note comply with MAL API official documentation. For more info refer to Inconsistencies

Universal¶

class malclient.Node¶

Object representing simplified anime/manga info

Show JSON schema

json

{
   "title": "Node",
   "description": "Object representing simplified anime/manga info",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "title": {
         "title": "Title",
         "type": "string"
      },
      "main_picture": {
         "$ref": "#/definitions/Asset"
      }
   },
   "required": [
      "id",
      "title"
   ],
   "definitions": {
      "Asset": {
         "title": "Asset",
         "description": "Asset object, commonly representing an image with two resolutions",
         "type": "object",
         "properties": {
            "large": {
               "title": "Large",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            },
            "medium": {
               "title": "Medium",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            }
         },
         "required": [
            "medium"
         ]
      }
   }
}

Fields

id (int)
title (str)
main_picture (Optional[malclient.Datamodels.models.Asset])

class malclient.Asset¶

Asset object, commonly representing an image with two resolutions

Show JSON schema

json

{
   "title": "Asset",
   "description": "Asset object, commonly representing an image with two resolutions",
   "type": "object",
   "properties": {
      "large": {
         "title": "Large",
         "minLength": 1,
         "maxLength": 2083,
         "format": "uri",
         "type": "string"
      },
      "medium": {
         "title": "Medium",
         "minLength": 1,
         "maxLength": 2083,
         "format": "uri",
         "type": "string"
      }
   },
   "required": [
      "medium"
   ]
}

Fields

large (Optional[pydantic.networks.HttpUrl])
medium (pydantic.networks.HttpUrl)

class malclient.Genre¶

Anime or Manga Genre

Show JSON schema

json

{
   "title": "Genre",
   "description": "Anime or Manga Genre",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "name": {
         "title": "Name",
         "type": "string"
      }
   },
   "required": [
      "id",
      "name"
   ]
}

Fields

id (int)
name (str)

class malclient.Relation¶

Object representing relations between anime and/or manga

Show JSON schema

json

{
   "title": "Relation",
   "description": "Object representing relations between anime and/or manga",
   "type": "object",
   "properties": {
      "node": {
         "$ref": "#/definitions/Node"
      },
      "relation_type": {
         "title": "Relation Type",
         "type": "string"
      },
      "relation_type_formatted": {
         "title": "Relation Type Formatted",
         "type": "string"
      }
   },
   "required": [
      "node",
      "relation_type",
      "relation_type_formatted"
   ],
   "definitions": {
      "Asset": {
         "title": "Asset",
         "description": "Asset object, commonly representing an image with two resolutions",
         "type": "object",
         "properties": {
            "large": {
               "title": "Large",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            },
            "medium": {
               "title": "Medium",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            }
         },
         "required": [
            "medium"
         ]
      },
      "Node": {
         "title": "Node",
         "description": "Object representing simplified anime/manga info",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "title": {
               "title": "Title",
               "type": "string"
            },
            "main_picture": {
               "$ref": "#/definitions/Asset"
            }
         },
         "required": [
            "id",
            "title"
         ]
      }
   }
}

Fields

node (malclient.Datamodels.models.Node)
relation_type (str)
relation_type_formatted (str)

class malclient.RelationType(value)¶

Enumerator representing possible relation types between anime and/or manga:

SEQUEL - Sequel
PREQUEL - Prequel
ALT_SETTING - Alternative Setting
ALT_VERSION - Alternative Version
SIDE_STORY - Side Story
PARENT_STORY - Parent Story
SUMMARY - Summary
FULL_STORY - Full Story
SPIN_OFF - Spin-Off
CHARACTER - Character
OTHER - Other

class malclient.Nsfw(value)¶

Enumerator representing nsfw stages:

WHITE - White
GRAY - Gray
BLACK - Black

class malclient.Recommendation¶

Representation of anime or manga recommendation

Show JSON schema

json

{
   "title": "Recommendation",
   "description": "Representation of anime or manga recommendation",
   "type": "object",
   "properties": {
      "num_recommendations": {
         "title": "Num Recommendations",
         "type": "integer"
      },
      "node": {
         "$ref": "#/definitions/Node"
      }
   },
   "required": [
      "num_recommendations",
      "node"
   ],
   "definitions": {
      "Asset": {
         "title": "Asset",
         "description": "Asset object, commonly representing an image with two resolutions",
         "type": "object",
         "properties": {
            "large": {
               "title": "Large",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            },
            "medium": {
               "title": "Medium",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            }
         },
         "required": [
            "medium"
         ]
      },
      "Node": {
         "title": "Node",
         "description": "Object representing simplified anime/manga info",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "title": {
               "title": "Title",
               "type": "string"
            },
            "main_picture": {
               "$ref": "#/definitions/Asset"
            }
         },
         "required": [
            "id",
            "title"
         ]
      }
   }
}

Fields

num_recommendations (int)
node (malclient.Datamodels.models.Node)

Anime Specific¶

class malclient.AnimeObject¶

Model of anime fetched from myanimelist

Show JSON schema

json

{
   "title": "AnimeObject",
   "description": "Model of anime fetched from myanimelist",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "title": {
         "title": "Title",
         "type": "string"
      },
      "main_picture": {
         "$ref": "#/definitions/Asset"
      },
      "alternative_titles": {
         "title": "Alternative Titles",
         "type": "object"
      },
      "start_date": {
         "title": "Start Date",
         "anyOf": [
            {
               "type": "string",
               "format": "date"
            },
            {
               "type": "string"
            }
         ]
      },
      "end_date": {
         "title": "End Date",
         "anyOf": [
            {
               "type": "string",
               "format": "date"
            },
            {
               "type": "string"
            }
         ]
      },
      "synopsis": {
         "title": "Synopsis",
         "type": "string"
      },
      "mean": {
         "title": "Mean",
         "type": "number"
      },
      "rank": {
         "title": "Rank",
         "type": "integer"
      },
      "popularity": {
         "title": "Popularity",
         "type": "integer"
      },
      "num_list_users": {
         "title": "Num List Users",
         "type": "integer"
      },
      "num_scoring_users": {
         "title": "Num Scoring Users",
         "type": "integer"
      },
      "nsfw": {
         "$ref": "#/definitions/Nsfw"
      },
      "genres": {
         "title": "Genres",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Genre"
         }
      },
      "created_at": {
         "title": "Created At",
         "anyOf": [
            {
               "type": "string",
               "format": "date-time"
            },
            {
               "type": "string"
            }
         ]
      },
      "updated_at": {
         "title": "Updated At",
         "anyOf": [
            {
               "type": "string",
               "format": "date-time"
            },
            {
               "type": "string"
            }
         ]
      },
      "media_type": {
         "$ref": "#/definitions/AnimeType"
      },
      "status": {
         "$ref": "#/definitions/AnimeStatus"
      },
      "my_list_status": {
         "$ref": "#/definitions/MyAnimeListStatus"
      },
      "pictures": {
         "title": "Pictures",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Asset"
         }
      },
      "background": {
         "title": "Background",
         "type": "string"
      },
      "related_anime": {
         "title": "Related Anime",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Relation"
         }
      },
      "related_manga": {
         "title": "Related Manga",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Relation"
         }
      },
      "recommendations": {
         "title": "Recommendations",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Recommendation"
         }
      },
      "list_status": {
         "$ref": "#/definitions/MyAnimeListStatus"
      },
      "ranking": {
         "$ref": "#/definitions/RankingObject"
      },
      "num_episodes": {
         "title": "Num Episodes",
         "type": "integer"
      },
      "start_season": {
         "$ref": "#/definitions/AnimeSeason"
      },
      "broadcast": {
         "$ref": "#/definitions/Broadcast"
      },
      "source": {
         "title": "Source",
         "anyOf": [
            {
               "$ref": "#/definitions/AnimeSource"
            },
            {
               "type": "string"
            }
         ]
      },
      "average_episode_duration": {
         "title": "Average Episode Duration",
         "type": "integer"
      },
      "rating": {
         "$ref": "#/definitions/Rating"
      },
      "studios": {
         "title": "Studios",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Studio"
         }
      },
      "statistics": {
         "$ref": "#/definitions/Statistics"
      },
      "videos": {
         "title": "Videos",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Video"
         }
      }
   },
   "required": [
      "id",
      "title"
   ],
   "definitions": {
      "Asset": {
         "title": "Asset",
         "description": "Asset object, commonly representing an image with two resolutions",
         "type": "object",
         "properties": {
            "large": {
               "title": "Large",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            },
            "medium": {
               "title": "Medium",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            }
         },
         "required": [
            "medium"
         ]
      },
      "Nsfw": {
         "title": "Nsfw",
         "description": "Enumerator representing nsfw stages:\n\n* **WHITE** - White\n* **GRAY** - Gray\n* **BLACK** - Black",
         "enum": [
            "white",
            "gray",
            "black"
         ]
      },
      "Genre": {
         "title": "Genre",
         "description": "Anime or Manga Genre",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "id",
            "name"
         ]
      },
      "AnimeType": {
         "title": "AnimeType",
         "description": "Enumerator representing anime type:\n\n* **Unknown**\n* **TV** - Streamed in Japanese TV\n* **OVA** - Original Video Animation\n* **Movie** - Animated Movie\n* **Special** - Special for an anime\n* **ONA** - Original Net Anime (f.e. Netflix Originals)\n* **Music** - Music Anime",
         "enum": [
            "unknown",
            "tv",
            "ova",
            "movie",
            "special",
            "ona",
            "music"
         ]
      },
      "AnimeStatus": {
         "title": "AnimeStatus",
         "description": "Enumerating representing current anime status\n\n* **FINISHED** - Finished Airing\n* **AIRING** - Currently Airing\n* **NOT_AIRED** - Not Yet Aired",
         "enum": [
            "finished_airing",
            "currently_airing",
            "not_yet_aired"
         ]
      },
      "MyAnimeListStatus": {
         "title": "MyAnimeListStatus",
         "description": "Status from users anime list",
         "type": "object",
         "properties": {
            "score": {
               "title": "Score",
               "type": "integer"
            },
            "status": {
               "title": "Status",
               "type": "string"
            },
            "is_rewatching": {
               "title": "Is Rewatching",
               "type": "boolean"
            },
            "updated_at": {
               "title": "Updated At",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date-time"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "num_episodes_watched": {
               "title": "Num Episodes Watched",
               "type": "integer"
            },
            "start_date": {
               "title": "Start Date",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "finish_date": {
               "title": "Finish Date",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "priority": {
               "title": "Priority",
               "type": "integer"
            },
            "num_times_rewatched": {
               "title": "Num Times Rewatched",
               "type": "integer"
            },
            "rewatch_value": {
               "title": "Rewatch Value",
               "type": "integer"
            },
            "tags": {
               "title": "Tags",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "comments": {
               "title": "Comments",
               "type": "string"
            }
         },
         "required": [
            "score",
            "status",
            "is_rewatching",
            "updated_at",
            "num_episodes_watched"
         ]
      },
      "Node": {
         "title": "Node",
         "description": "Object representing simplified anime/manga info",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "title": {
               "title": "Title",
               "type": "string"
            },
            "main_picture": {
               "$ref": "#/definitions/Asset"
            }
         },
         "required": [
            "id",
            "title"
         ]
      },
      "Relation": {
         "title": "Relation",
         "description": "Object representing relations between anime and/or manga",
         "type": "object",
         "properties": {
            "node": {
               "$ref": "#/definitions/Node"
            },
            "relation_type": {
               "title": "Relation Type",
               "type": "string"
            },
            "relation_type_formatted": {
               "title": "Relation Type Formatted",
               "type": "string"
            }
         },
         "required": [
            "node",
            "relation_type",
            "relation_type_formatted"
         ]
      },
      "Recommendation": {
         "title": "Recommendation",
         "description": "Representation of anime or manga recommendation",
         "type": "object",
         "properties": {
            "num_recommendations": {
               "title": "Num Recommendations",
               "type": "integer"
            },
            "node": {
               "$ref": "#/definitions/Node"
            }
         },
         "required": [
            "num_recommendations",
            "node"
         ]
      },
      "RankingObject": {
         "title": "RankingObject",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "rank": {
               "title": "Rank",
               "type": "integer"
            },
            "previous_rank": {
               "title": "Previous Rank",
               "type": "integer"
            }
         },
         "required": [
            "rank"
         ]
      },
      "AnimeSeason": {
         "title": "AnimeSeason",
         "description": "Representation of anime season (f.e. winter 2022)",
         "type": "object",
         "properties": {
            "year": {
               "title": "Year",
               "type": "integer"
            },
            "season": {
               "title": "Season",
               "type": "string"
            }
         },
         "required": [
            "year",
            "season"
         ]
      },
      "Broadcast": {
         "title": "Broadcast",
         "description": "Object representing date of episode broadcast (in JST)",
         "type": "object",
         "properties": {
            "day_of_the_week": {
               "title": "Day Of The Week",
               "type": "string"
            },
            "start_time": {
               "title": "Start Time",
               "type": "string",
               "format": "time"
            }
         },
         "required": [
            "day_of_the_week"
         ]
      },
      "AnimeSource": {
         "title": "AnimeSource",
         "description": "Enumerator representing source of anime\n\n* **OTHER** - Other\n* **ORIGINAL** - Original\n* **MANGA** - Manga\n* **MANGA_4_KOMA** - 4-Koma, comedic manga format\n* **WEB_MANGA** - Web Manga\n* **WEB_NOVEL** - Web Novel\n* **DIGITAL_MANGA** - Digital Manga\n* **NOVEL** - Novel\n* **LIGHT_NOVEL** - Light Novel\n* **VISUAL_NOVEL** - Text-based video game\n* **GAME** - Game\n* **CARD_GAME** - Card Game\n* **BOOK** - Book\n* **PICTURE_BOOK** - Picture Book\n* **RADIO** - Radio\n* **MUSIC** - Music\n* **MIXED_MEDIA** - Mixed Media",
         "enum": [
            "other",
            "original",
            "manga",
            "4_koma_manga",
            "web_manga",
            "web_novel",
            "digital_manga",
            "novel",
            "light_novel",
            "visual_novel",
            "game",
            "card_game",
            "book",
            "picture_book",
            "radio",
            "music",
            "mixed_media"
         ]
      },
      "Rating": {
         "title": "Rating",
         "description": "Rating of shows provided by myanimelist:\n\n* **G** - All Ages\n* **PG** - Children\n* **PG_13** - Teens 13 and Older\n* **R** - 17+ (violence & profanity)\n* **RR** - Profanity & Mild Nudity\n* **Rx** - Hentai",
         "enum": [
            "g",
            "pg",
            "pg_13",
            "r",
            "r+",
            "rx"
         ]
      },
      "Studio": {
         "title": "Studio",
         "description": "Representation of anime studio",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "id",
            "name"
         ]
      },
      "Statistics": {
         "title": "Statistics",
         "description": "Object representing list statistics of anime on MAL",
         "type": "object",
         "properties": {
            "num_list_users": {
               "title": "Num List Users",
               "type": "integer"
            },
            "watching": {
               "title": "Watching",
               "type": "integer"
            },
            "completed": {
               "title": "Completed",
               "type": "integer"
            },
            "on_hold": {
               "title": "On Hold",
               "type": "integer"
            },
            "dropped": {
               "title": "Dropped",
               "type": "integer"
            },
            "plan_to_watch": {
               "title": "Plan To Watch",
               "type": "integer"
            }
         },
         "required": [
            "num_list_users",
            "watching",
            "completed",
            "on_hold",
            "dropped",
            "plan_to_watch"
         ]
      },
      "Video": {
         "title": "Video",
         "description": "Class containing information about video attached to anime, f.e. PV",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "title": {
               "title": "Title",
               "type": "string"
            },
            "url": {
               "title": "Url",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            },
            "created_at": {
               "title": "Created At",
               "type": "string",
               "format": "date-time"
            },
            "updated_at": {
               "title": "Updated At",
               "type": "string",
               "format": "date-time"
            },
            "thumbnail": {
               "title": "Thumbnail",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            }
         },
         "required": [
            "id",
            "title",
            "url",
            "created_at",
            "updated_at",
            "thumbnail"
         ]
      }
   }
}

Fields

media_type (Optional[malclient.Datamodels.enums.AnimeType])
status (Optional[malclient.Datamodels.enums.AnimeStatus])
my_list_status (Optional[malclient.Datamodels.models.MyAnimeListStatus])
num_episodes (Optional[int])
start_season (Optional[malclient.Datamodels.models.AnimeSeason])
broadcast (Optional[malclient.Datamodels.models.Broadcast])
source (Optional[Union[malclient.Datamodels.enums.AnimeSource, str]])
average_episode_duration (Optional[int])
rating (Optional[malclient.Datamodels.enums.Rating])
studios (Optional[list[malclient.Datamodels.models.Studio]])
statistics (Optional[malclient.Datamodels.models.Statistics])
videos (Optional[list[malclient.Datamodels.models.Video]])
list_status (Optional[malclient.Datamodels.models.MyAnimeListStatus])

populate(client)¶

Send new request and return new object containing full details

Parameters: client (malclient.Client) – client with which new data will be fetched
Returns: Fully populated AnimeObject
Return type: AnimeObject

class malclient.AnimeStatus(value)¶

Enumerating representing current anime status

FINISHED - Finished Airing
AIRING - Currently Airing
NOT_AIRED - Not Yet Aired

class malclient.AnimeType(value)¶

Enumerator representing anime type:

Unknown
TV - Streamed in Japanese TV
OVA - Original Video Animation
Movie - Animated Movie
Special - Special for an anime
ONA - Original Net Anime (f.e. Netflix Originals)
Music - Music Anime

class malclient.Broadcast¶

Object representing date of episode broadcast (in JST)

Show JSON schema

json

{
   "title": "Broadcast",
   "description": "Object representing date of episode broadcast (in JST)",
   "type": "object",
   "properties": {
      "day_of_the_week": {
         "title": "Day Of The Week",
         "type": "string"
      },
      "start_time": {
         "title": "Start Time",
         "type": "string",
         "format": "time"
      }
   },
   "required": [
      "day_of_the_week"
   ]
}

Fields

day_of_the_week (str)
start_time (Optional[datetime.time])

class malclient.MyAnimeListStatus¶

Status from users anime list

Show JSON schema

json

{
   "title": "MyAnimeListStatus",
   "description": "Status from users anime list",
   "type": "object",
   "properties": {
      "score": {
         "title": "Score",
         "type": "integer"
      },
      "status": {
         "title": "Status",
         "type": "string"
      },
      "is_rewatching": {
         "title": "Is Rewatching",
         "type": "boolean"
      },
      "updated_at": {
         "title": "Updated At",
         "anyOf": [
            {
               "type": "string",
               "format": "date-time"
            },
            {
               "type": "string"
            }
         ]
      },
      "num_episodes_watched": {
         "title": "Num Episodes Watched",
         "type": "integer"
      },
      "start_date": {
         "title": "Start Date",
         "anyOf": [
            {
               "type": "string",
               "format": "date"
            },
            {
               "type": "string"
            }
         ]
      },
      "finish_date": {
         "title": "Finish Date",
         "anyOf": [
            {
               "type": "string",
               "format": "date"
            },
            {
               "type": "string"
            }
         ]
      },
      "priority": {
         "title": "Priority",
         "type": "integer"
      },
      "num_times_rewatched": {
         "title": "Num Times Rewatched",
         "type": "integer"
      },
      "rewatch_value": {
         "title": "Rewatch Value",
         "type": "integer"
      },
      "tags": {
         "title": "Tags",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "comments": {
         "title": "Comments",
         "type": "string"
      }
   },
   "required": [
      "score",
      "status",
      "is_rewatching",
      "updated_at",
      "num_episodes_watched"
   ]
}

Fields

score (int)
status (str)
is_rewatching (bool)
updated_at (Union[datetime.datetime, str])
num_episodes_watched (int)
start_date (Optional[Union[datetime.date, str]])
finish_date (Optional[Union[datetime.date, str]])
priority (Optional[int])
num_times_rewatched (Optional[int])
rewatch_value (Optional[int])
tags (Optional[list[str]])
comments (Optional[str])

class malclient.Statistics¶

Object representing list statistics of anime on MAL

Show JSON schema

json

{
   "title": "Statistics",
   "description": "Object representing list statistics of anime on MAL",
   "type": "object",
   "properties": {
      "num_list_users": {
         "title": "Num List Users",
         "type": "integer"
      },
      "watching": {
         "title": "Watching",
         "type": "integer"
      },
      "completed": {
         "title": "Completed",
         "type": "integer"
      },
      "on_hold": {
         "title": "On Hold",
         "type": "integer"
      },
      "dropped": {
         "title": "Dropped",
         "type": "integer"
      },
      "plan_to_watch": {
         "title": "Plan To Watch",
         "type": "integer"
      }
   },
   "required": [
      "num_list_users",
      "watching",
      "completed",
      "on_hold",
      "dropped",
      "plan_to_watch"
   ]
}

Fields

num_list_users (int)
watching (int)
completed (int)
on_hold (int)
dropped (int)
plan_to_watch (int)

class malclient.Rating(value)¶

Rating of shows provided by myanimelist:

G - All Ages
PG - Children
PG_13 - Teens 13 and Older
R - 17+ (violence & profanity)
RR - Profanity & Mild Nudity
Rx - Hentai

class malclient.AnimeSeason¶

Representation of anime season (f.e. winter 2022)

Show JSON schema

json

{
   "title": "AnimeSeason",
   "description": "Representation of anime season (f.e. winter 2022)",
   "type": "object",
   "properties": {
      "year": {
         "title": "Year",
         "type": "integer"
      },
      "season": {
         "title": "Season",
         "type": "string"
      }
   },
   "required": [
      "year",
      "season"
   ]
}

Fields

year (int)
season (str)

class malclient.Season(value)¶: An enumeration.

class malclient.AnimeSource(value)¶

Enumerator representing source of anime

OTHER - Other
ORIGINAL - Original
MANGA - Manga
MANGA_4_KOMA - 4-Koma, comedic manga format
WEB_MANGA - Web Manga
WEB_NOVEL - Web Novel
DIGITAL_MANGA - Digital Manga
NOVEL - Novel
LIGHT_NOVEL - Light Novel
VISUAL_NOVEL - Text-based video game
GAME - Game
CARD_GAME - Card Game
BOOK - Book
PICTURE_BOOK - Picture Book
RADIO - Radio
MUSIC - Music
MIXED_MEDIA - Mixed Media

class malclient.Studio¶

Representation of anime studio

Show JSON schema

json

{
   "title": "Studio",
   "description": "Representation of anime studio",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "name": {
         "title": "Name",
         "type": "string"
      }
   },
   "required": [
      "id",
      "name"
   ]
}

Fields

id (int)
name (str)

class malclient.AnimeRankingType(value)¶

Representation of possible values for anime ranking type

ALL - Top Anime Series
AIRING - Top Airing Anime
UPCOMING - Top Upcoming Anime
TV - Top TV Anime Series
OVA - Top OVA Anime Series
MOVIE - Top Anime Movies
SPECIAL - Top Anime Specials
POPULAR - Top Anime by Popularity
FAVORITE - Top Favorite Anime

class malclient.SeasonalAnimeSorting(value)¶

Representation of seasonal anime sorting

SCORE - Sorted by score
USER_NUM - Sorted by number of users in list

class malclient.MyAnimeListSorting(value)¶

Sorting options for User Anime List

LIST_SCORE - Sorted by score given by user
LAST_UPDATE - Sorted by most recently updated
TITLE - Sorted by title
START_DATE - Sorted by broadcast start date
ID - Sorted by ID

Note

This is available only in alpha build of a wrapper

class malclient.Character¶

Show JSON schema

json

{
   "title": "Character",
   "description": "Helper model class used to generate all models used by this API",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "first_name": {
         "title": "First Name",
         "type": "string"
      },
      "last_name": {
         "title": "Last Name",
         "type": "string"
      },
      "role": {
         "title": "Role",
         "type": "string"
      },
      "alternative_name": {
         "title": "Alternative Name",
         "type": "string"
      },
      "main_picture": {
         "$ref": "#/definitions/Asset"
      },
      "biography": {
         "title": "Biography",
         "type": "string"
      },
      "pictures": {
         "title": "Pictures",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Asset"
         }
      },
      "animeography": {
         "title": "Animeography",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Animeography"
         }
      },
      "num_favorites": {
         "title": "Num Favorites",
         "type": "integer"
      }
   },
   "required": [
      "id",
      "first_name",
      "last_name"
   ],
   "definitions": {
      "Asset": {
         "title": "Asset",
         "description": "Asset object, commonly representing an image with two resolutions",
         "type": "object",
         "properties": {
            "large": {
               "title": "Large",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            },
            "medium": {
               "title": "Medium",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            }
         },
         "required": [
            "medium"
         ]
      },
      "Nsfw": {
         "title": "Nsfw",
         "description": "Enumerator representing nsfw stages:\n\n* **WHITE** - White\n* **GRAY** - Gray\n* **BLACK** - Black",
         "enum": [
            "white",
            "gray",
            "black"
         ]
      },
      "Genre": {
         "title": "Genre",
         "description": "Anime or Manga Genre",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "id",
            "name"
         ]
      },
      "AnimeType": {
         "title": "AnimeType",
         "description": "Enumerator representing anime type:\n\n* **Unknown**\n* **TV** - Streamed in Japanese TV\n* **OVA** - Original Video Animation\n* **Movie** - Animated Movie\n* **Special** - Special for an anime\n* **ONA** - Original Net Anime (f.e. Netflix Originals)\n* **Music** - Music Anime",
         "enum": [
            "unknown",
            "tv",
            "ova",
            "movie",
            "special",
            "ona",
            "music"
         ]
      },
      "AnimeStatus": {
         "title": "AnimeStatus",
         "description": "Enumerating representing current anime status\n\n* **FINISHED** - Finished Airing\n* **AIRING** - Currently Airing\n* **NOT_AIRED** - Not Yet Aired",
         "enum": [
            "finished_airing",
            "currently_airing",
            "not_yet_aired"
         ]
      },
      "MyAnimeListStatus": {
         "title": "MyAnimeListStatus",
         "description": "Status from users anime list",
         "type": "object",
         "properties": {
            "score": {
               "title": "Score",
               "type": "integer"
            },
            "status": {
               "title": "Status",
               "type": "string"
            },
            "is_rewatching": {
               "title": "Is Rewatching",
               "type": "boolean"
            },
            "updated_at": {
               "title": "Updated At",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date-time"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "num_episodes_watched": {
               "title": "Num Episodes Watched",
               "type": "integer"
            },
            "start_date": {
               "title": "Start Date",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "finish_date": {
               "title": "Finish Date",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "priority": {
               "title": "Priority",
               "type": "integer"
            },
            "num_times_rewatched": {
               "title": "Num Times Rewatched",
               "type": "integer"
            },
            "rewatch_value": {
               "title": "Rewatch Value",
               "type": "integer"
            },
            "tags": {
               "title": "Tags",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "comments": {
               "title": "Comments",
               "type": "string"
            }
         },
         "required": [
            "score",
            "status",
            "is_rewatching",
            "updated_at",
            "num_episodes_watched"
         ]
      },
      "Node": {
         "title": "Node",
         "description": "Object representing simplified anime/manga info",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "title": {
               "title": "Title",
               "type": "string"
            },
            "main_picture": {
               "$ref": "#/definitions/Asset"
            }
         },
         "required": [
            "id",
            "title"
         ]
      },
      "Relation": {
         "title": "Relation",
         "description": "Object representing relations between anime and/or manga",
         "type": "object",
         "properties": {
            "node": {
               "$ref": "#/definitions/Node"
            },
            "relation_type": {
               "title": "Relation Type",
               "type": "string"
            },
            "relation_type_formatted": {
               "title": "Relation Type Formatted",
               "type": "string"
            }
         },
         "required": [
            "node",
            "relation_type",
            "relation_type_formatted"
         ]
      },
      "Recommendation": {
         "title": "Recommendation",
         "description": "Representation of anime or manga recommendation",
         "type": "object",
         "properties": {
            "num_recommendations": {
               "title": "Num Recommendations",
               "type": "integer"
            },
            "node": {
               "$ref": "#/definitions/Node"
            }
         },
         "required": [
            "num_recommendations",
            "node"
         ]
      },
      "RankingObject": {
         "title": "RankingObject",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "rank": {
               "title": "Rank",
               "type": "integer"
            },
            "previous_rank": {
               "title": "Previous Rank",
               "type": "integer"
            }
         },
         "required": [
            "rank"
         ]
      },
      "AnimeSeason": {
         "title": "AnimeSeason",
         "description": "Representation of anime season (f.e. winter 2022)",
         "type": "object",
         "properties": {
            "year": {
               "title": "Year",
               "type": "integer"
            },
            "season": {
               "title": "Season",
               "type": "string"
            }
         },
         "required": [
            "year",
            "season"
         ]
      },
      "Broadcast": {
         "title": "Broadcast",
         "description": "Object representing date of episode broadcast (in JST)",
         "type": "object",
         "properties": {
            "day_of_the_week": {
               "title": "Day Of The Week",
               "type": "string"
            },
            "start_time": {
               "title": "Start Time",
               "type": "string",
               "format": "time"
            }
         },
         "required": [
            "day_of_the_week"
         ]
      },
      "AnimeSource": {
         "title": "AnimeSource",
         "description": "Enumerator representing source of anime\n\n* **OTHER** - Other\n* **ORIGINAL** - Original\n* **MANGA** - Manga\n* **MANGA_4_KOMA** - 4-Koma, comedic manga format\n* **WEB_MANGA** - Web Manga\n* **WEB_NOVEL** - Web Novel\n* **DIGITAL_MANGA** - Digital Manga\n* **NOVEL** - Novel\n* **LIGHT_NOVEL** - Light Novel\n* **VISUAL_NOVEL** - Text-based video game\n* **GAME** - Game\n* **CARD_GAME** - Card Game\n* **BOOK** - Book\n* **PICTURE_BOOK** - Picture Book\n* **RADIO** - Radio\n* **MUSIC** - Music\n* **MIXED_MEDIA** - Mixed Media",
         "enum": [
            "other",
            "original",
            "manga",
            "4_koma_manga",
            "web_manga",
            "web_novel",
            "digital_manga",
            "novel",
            "light_novel",
            "visual_novel",
            "game",
            "card_game",
            "book",
            "picture_book",
            "radio",
            "music",
            "mixed_media"
         ]
      },
      "Rating": {
         "title": "Rating",
         "description": "Rating of shows provided by myanimelist:\n\n* **G** - All Ages\n* **PG** - Children\n* **PG_13** - Teens 13 and Older\n* **R** - 17+ (violence & profanity)\n* **RR** - Profanity & Mild Nudity\n* **Rx** - Hentai",
         "enum": [
            "g",
            "pg",
            "pg_13",
            "r",
            "r+",
            "rx"
         ]
      },
      "Studio": {
         "title": "Studio",
         "description": "Representation of anime studio",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "id",
            "name"
         ]
      },
      "Statistics": {
         "title": "Statistics",
         "description": "Object representing list statistics of anime on MAL",
         "type": "object",
         "properties": {
            "num_list_users": {
               "title": "Num List Users",
               "type": "integer"
            },
            "watching": {
               "title": "Watching",
               "type": "integer"
            },
            "completed": {
               "title": "Completed",
               "type": "integer"
            },
            "on_hold": {
               "title": "On Hold",
               "type": "integer"
            },
            "dropped": {
               "title": "Dropped",
               "type": "integer"
            },
            "plan_to_watch": {
               "title": "Plan To Watch",
               "type": "integer"
            }
         },
         "required": [
            "num_list_users",
            "watching",
            "completed",
            "on_hold",
            "dropped",
            "plan_to_watch"
         ]
      },
      "Video": {
         "title": "Video",
         "description": "Class containing information about video attached to anime, f.e. PV",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "title": {
               "title": "Title",
               "type": "string"
            },
            "url": {
               "title": "Url",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            },
            "created_at": {
               "title": "Created At",
               "type": "string",
               "format": "date-time"
            },
            "updated_at": {
               "title": "Updated At",
               "type": "string",
               "format": "date-time"
            },
            "thumbnail": {
               "title": "Thumbnail",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            }
         },
         "required": [
            "id",
            "title",
            "url",
            "created_at",
            "updated_at",
            "thumbnail"
         ]
      },
      "Animeography": {
         "title": "Animeography",
         "description": "Object represents animeography of character.\nIt might be populated same way as AnimeObject, depending on fields requested.\nHowever it always contains role field, which represents role given to character in anime.\n\nThis object is only available in Character object.",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "title": {
               "title": "Title",
               "type": "string"
            },
            "main_picture": {
               "$ref": "#/definitions/Asset"
            },
            "alternative_titles": {
               "title": "Alternative Titles",
               "type": "object"
            },
            "start_date": {
               "title": "Start Date",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "end_date": {
               "title": "End Date",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "synopsis": {
               "title": "Synopsis",
               "type": "string"
            },
            "mean": {
               "title": "Mean",
               "type": "number"
            },
            "rank": {
               "title": "Rank",
               "type": "integer"
            },
            "popularity": {
               "title": "Popularity",
               "type": "integer"
            },
            "num_list_users": {
               "title": "Num List Users",
               "type": "integer"
            },
            "num_scoring_users": {
               "title": "Num Scoring Users",
               "type": "integer"
            },
            "nsfw": {
               "$ref": "#/definitions/Nsfw"
            },
            "genres": {
               "title": "Genres",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Genre"
               }
            },
            "created_at": {
               "title": "Created At",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date-time"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "updated_at": {
               "title": "Updated At",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date-time"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "media_type": {
               "$ref": "#/definitions/AnimeType"
            },
            "status": {
               "$ref": "#/definitions/AnimeStatus"
            },
            "my_list_status": {
               "$ref": "#/definitions/MyAnimeListStatus"
            },
            "pictures": {
               "title": "Pictures",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Asset"
               }
            },
            "background": {
               "title": "Background",
               "type": "string"
            },
            "related_anime": {
               "title": "Related Anime",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Relation"
               }
            },
            "related_manga": {
               "title": "Related Manga",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Relation"
               }
            },
            "recommendations": {
               "title": "Recommendations",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Recommendation"
               }
            },
            "list_status": {
               "$ref": "#/definitions/MyAnimeListStatus"
            },
            "ranking": {
               "$ref": "#/definitions/RankingObject"
            },
            "num_episodes": {
               "title": "Num Episodes",
               "type": "integer"
            },
            "start_season": {
               "$ref": "#/definitions/AnimeSeason"
            },
            "broadcast": {
               "$ref": "#/definitions/Broadcast"
            },
            "source": {
               "title": "Source",
               "anyOf": [
                  {
                     "$ref": "#/definitions/AnimeSource"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "average_episode_duration": {
               "title": "Average Episode Duration",
               "type": "integer"
            },
            "rating": {
               "$ref": "#/definitions/Rating"
            },
            "studios": {
               "title": "Studios",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Studio"
               }
            },
            "statistics": {
               "$ref": "#/definitions/Statistics"
            },
            "videos": {
               "title": "Videos",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Video"
               }
            },
            "role": {
               "title": "Role",
               "type": "string"
            }
         },
         "required": [
            "id",
            "title"
         ]
      }
   }
}

Fields

role (Optional[str])
alternative_name (Optional[str])
main_picture (Optional[malclient.Datamodels.models.Asset])
biography (Optional[str])
pictures (Optional[list[malclient.Datamodels.models.Asset]])
animeography (Optional[list[malclient.Datamodels.models.Animeography]])
num_favorites (Optional[int])

Note

This is available only in alpha build of a wrapper

Manga Specific¶

class malclient.MangaObject¶

Model of manga fetched from myanimelist Some fields may not be mentioned in official documentation

Show JSON schema

json

{
   "title": "MangaObject",
   "description": "Model of manga fetched from myanimelist\nSome fields may not be mentioned in official documentation",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "title": {
         "title": "Title",
         "type": "string"
      },
      "main_picture": {
         "$ref": "#/definitions/Asset"
      },
      "alternative_titles": {
         "title": "Alternative Titles",
         "type": "object"
      },
      "start_date": {
         "title": "Start Date",
         "anyOf": [
            {
               "type": "string",
               "format": "date"
            },
            {
               "type": "string"
            }
         ]
      },
      "end_date": {
         "title": "End Date",
         "anyOf": [
            {
               "type": "string",
               "format": "date"
            },
            {
               "type": "string"
            }
         ]
      },
      "synopsis": {
         "title": "Synopsis",
         "type": "string"
      },
      "mean": {
         "title": "Mean",
         "type": "number"
      },
      "rank": {
         "title": "Rank",
         "type": "integer"
      },
      "popularity": {
         "title": "Popularity",
         "type": "integer"
      },
      "num_list_users": {
         "title": "Num List Users",
         "type": "integer"
      },
      "num_scoring_users": {
         "title": "Num Scoring Users",
         "type": "integer"
      },
      "nsfw": {
         "$ref": "#/definitions/Nsfw"
      },
      "genres": {
         "title": "Genres",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Genre"
         }
      },
      "created_at": {
         "title": "Created At",
         "anyOf": [
            {
               "type": "string",
               "format": "date-time"
            },
            {
               "type": "string"
            }
         ]
      },
      "updated_at": {
         "title": "Updated At",
         "anyOf": [
            {
               "type": "string",
               "format": "date-time"
            },
            {
               "type": "string"
            }
         ]
      },
      "media_type": {
         "title": "Media Type",
         "anyOf": [
            {
               "$ref": "#/definitions/MangaType"
            },
            {
               "type": "string"
            }
         ]
      },
      "status": {
         "title": "Status",
         "anyOf": [
            {
               "$ref": "#/definitions/MangaStatus"
            },
            {
               "type": "string"
            }
         ]
      },
      "my_list_status": {
         "$ref": "#/definitions/MyMangaListStatus"
      },
      "pictures": {
         "title": "Pictures",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Asset"
         }
      },
      "background": {
         "title": "Background",
         "type": "string"
      },
      "related_anime": {
         "title": "Related Anime",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Relation"
         }
      },
      "related_manga": {
         "title": "Related Manga",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Relation"
         }
      },
      "recommendations": {
         "title": "Recommendations",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Recommendation"
         }
      },
      "list_status": {
         "$ref": "#/definitions/MyMangaListStatus"
      },
      "ranking": {
         "$ref": "#/definitions/RankingObject"
      },
      "num_volumes": {
         "title": "Num Volumes",
         "type": "integer"
      },
      "num_chapters": {
         "title": "Num Chapters",
         "type": "integer"
      },
      "authors": {
         "title": "Authors",
         "type": "array",
         "items": {
            "$ref": "#/definitions/MangaAuthor"
         }
      },
      "serialization": {
         "title": "Serialization",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Serialization"
         }
      }
   },
   "required": [
      "id",
      "title"
   ],
   "definitions": {
      "Asset": {
         "title": "Asset",
         "description": "Asset object, commonly representing an image with two resolutions",
         "type": "object",
         "properties": {
            "large": {
               "title": "Large",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            },
            "medium": {
               "title": "Medium",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            }
         },
         "required": [
            "medium"
         ]
      },
      "Nsfw": {
         "title": "Nsfw",
         "description": "Enumerator representing nsfw stages:\n\n* **WHITE** - White\n* **GRAY** - Gray\n* **BLACK** - Black",
         "enum": [
            "white",
            "gray",
            "black"
         ]
      },
      "Genre": {
         "title": "Genre",
         "description": "Anime or Manga Genre",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "id",
            "name"
         ]
      },
      "MangaType": {
         "title": "MangaType",
         "description": "Enumerator representing type of manga\n\n* **UNKNOWN** - Unknown\n* **MANGA** - Manga\n* **NOVEL** - Novel\n* **ONE_SHOT** = One-Shot\n* **DOUJIN** - Self-published Manga\n* **MANHWA** - Korean comic\n* **MANHUA** - Chinese comic\n* **LIGHT_NOVEL** - Light Novel\n* **OEL** - Original English-Language Manga",
         "enum": [
            "unknown",
            "manga",
            "novel",
            "one_shot",
            "doujinshi",
            "manhwa",
            "manhua",
            "oel",
            "light_novel"
         ]
      },
      "MangaStatus": {
         "title": "MangaStatus",
         "description": "Enumerating representing current manga status\n\n* **FINISHED** - Finished\n* **PUBLISHING** - Currently Publishing\n* **NOT_PUBLISHED** - Not Yet Published\n* **ON_HIATUS** - On Break\n* **DISCONTINUED** - Discontinued",
         "enum": [
            "finished",
            "currently_publishing",
            "not_yet_published",
            "on_hiatus",
            "discontinued"
         ]
      },
      "MyMangaListStatus": {
         "title": "MyMangaListStatus",
         "description": "Status from users manga list",
         "type": "object",
         "properties": {
            "score": {
               "title": "Score",
               "type": "integer"
            },
            "status": {
               "title": "Status",
               "type": "string"
            },
            "is_rereading": {
               "title": "Is Rereading",
               "type": "boolean"
            },
            "updated_at": {
               "title": "Updated At",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date-time"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "num_chapters_read": {
               "title": "Num Chapters Read",
               "type": "integer"
            },
            "num_volumes_read": {
               "title": "Num Volumes Read",
               "type": "integer"
            },
            "start_date": {
               "title": "Start Date",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "finish_date": {
               "title": "Finish Date",
               "anyOf": [
                  {
                     "type": "string",
                     "format": "date"
                  },
                  {
                     "type": "string"
                  }
               ]
            },
            "priority": {
               "title": "Priority",
               "type": "integer"
            },
            "num_times_reread": {
               "title": "Num Times Reread",
               "type": "integer"
            },
            "reread_value": {
               "title": "Reread Value",
               "type": "integer"
            },
            "tags": {
               "title": "Tags",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "comments": {
               "title": "Comments",
               "type": "string"
            }
         }
      },
      "Node": {
         "title": "Node",
         "description": "Object representing simplified anime/manga info",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "title": {
               "title": "Title",
               "type": "string"
            },
            "main_picture": {
               "$ref": "#/definitions/Asset"
            }
         },
         "required": [
            "id",
            "title"
         ]
      },
      "Relation": {
         "title": "Relation",
         "description": "Object representing relations between anime and/or manga",
         "type": "object",
         "properties": {
            "node": {
               "$ref": "#/definitions/Node"
            },
            "relation_type": {
               "title": "Relation Type",
               "type": "string"
            },
            "relation_type_formatted": {
               "title": "Relation Type Formatted",
               "type": "string"
            }
         },
         "required": [
            "node",
            "relation_type",
            "relation_type_formatted"
         ]
      },
      "Recommendation": {
         "title": "Recommendation",
         "description": "Representation of anime or manga recommendation",
         "type": "object",
         "properties": {
            "num_recommendations": {
               "title": "Num Recommendations",
               "type": "integer"
            },
            "node": {
               "$ref": "#/definitions/Node"
            }
         },
         "required": [
            "num_recommendations",
            "node"
         ]
      },
      "RankingObject": {
         "title": "RankingObject",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "rank": {
               "title": "Rank",
               "type": "integer"
            },
            "previous_rank": {
               "title": "Previous Rank",
               "type": "integer"
            }
         },
         "required": [
            "rank"
         ]
      },
      "PersonBase": {
         "title": "PersonBase",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "first_name": {
               "title": "First Name",
               "type": "string"
            },
            "last_name": {
               "title": "Last Name",
               "type": "string"
            }
         },
         "required": [
            "id",
            "first_name",
            "last_name"
         ]
      },
      "MangaAuthor": {
         "title": "MangaAuthor",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "node": {
               "$ref": "#/definitions/PersonBase"
            },
            "role": {
               "title": "Role",
               "type": "string"
            }
         },
         "required": [
            "node",
            "role"
         ]
      },
      "Magazine": {
         "title": "Magazine",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "id",
            "name"
         ]
      },
      "Serialization": {
         "title": "Serialization",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "node": {
               "$ref": "#/definitions/Magazine"
            },
            "role": {
               "title": "Role",
               "type": "string"
            }
         },
         "required": [
            "node"
         ]
      }
   }
}

Fields

media_type (Optional[Union[malclient.Datamodels.enums.MangaType, str]])
status (Optional[Union[malclient.Datamodels.enums.MangaStatus, str]])
my_list_status (Optional[malclient.Datamodels.models.MyMangaListStatus])
num_volumes (Optional[int])
num_chapters (Optional[int])
authors (Optional[list[malclient.Datamodels.models.MangaAuthor]])
serialization (Optional[list[malclient.Datamodels.models.Serialization]])
list_status (Optional[malclient.Datamodels.models.MyMangaListStatus])

populate(client)¶

Send new request and return new object containing full details

Parameters: client (malclient.Client) – client with which new data will be fetched
Returns: Fully populated MangaObject
Return type: MangaObject

class malclient.MangaType(value)¶

Enumerator representing type of manga

UNKNOWN - Unknown
MANGA - Manga
NOVEL - Novel
ONE_SHOT = One-Shot
DOUJIN - Self-published Manga
MANHWA - Korean comic
MANHUA - Chinese comic
LIGHT_NOVEL - Light Novel
OEL - Original English-Language Manga

class malclient.MyMangaListStatus¶

Status from users manga list

Show JSON schema

json

{
   "title": "MyMangaListStatus",
   "description": "Status from users manga list",
   "type": "object",
   "properties": {
      "score": {
         "title": "Score",
         "type": "integer"
      },
      "status": {
         "title": "Status",
         "type": "string"
      },
      "is_rereading": {
         "title": "Is Rereading",
         "type": "boolean"
      },
      "updated_at": {
         "title": "Updated At",
         "anyOf": [
            {
               "type": "string",
               "format": "date-time"
            },
            {
               "type": "string"
            }
         ]
      },
      "num_chapters_read": {
         "title": "Num Chapters Read",
         "type": "integer"
      },
      "num_volumes_read": {
         "title": "Num Volumes Read",
         "type": "integer"
      },
      "start_date": {
         "title": "Start Date",
         "anyOf": [
            {
               "type": "string",
               "format": "date"
            },
            {
               "type": "string"
            }
         ]
      },
      "finish_date": {
         "title": "Finish Date",
         "anyOf": [
            {
               "type": "string",
               "format": "date"
            },
            {
               "type": "string"
            }
         ]
      },
      "priority": {
         "title": "Priority",
         "type": "integer"
      },
      "num_times_reread": {
         "title": "Num Times Reread",
         "type": "integer"
      },
      "reread_value": {
         "title": "Reread Value",
         "type": "integer"
      },
      "tags": {
         "title": "Tags",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "comments": {
         "title": "Comments",
         "type": "string"
      }
   }
}

Fields

score (Optional[int])
status (Optional[str])
is_rereading (Optional[bool])
updated_at (Optional[Union[datetime.datetime, str]])
num_chapters_read (Optional[int])
num_volumes_read (Optional[int])
start_date (Optional[Union[datetime.date, str]])
finish_date (Optional[Union[datetime.date, str]])
priority (Optional[int])
num_times_reread (Optional[int])
reread_value (Optional[int])
tags (Optional[list[str]])
comments (Optional[str])

class malclient.MangaStatus(value)¶

Enumerating representing current manga status

FINISHED - Finished
PUBLISHING - Currently Publishing
NOT_PUBLISHED - Not Yet Published
ON_HIATUS - On Break
DISCONTINUED - Discontinued

class malclient.MangaRankingType(value)¶

Representation of possible values for manga ranking type

ALL - All
MANGA - Top Manga
NOVELS - Top Novels
ONE_SHOTS - Top One Shot Manga
DOUJIN - Top Doujinshi
MANHWA - Top Manhwa
MANHUA - Top Manhua
POPULAR - Most popular
FAVORITE - Most Favorited

class malclient.MyMangaListSorting(value)¶

Sorting options for User Manga List

LIST_SCORE - Sorted by score given by user
LAST_UPDATE - Sorted by most recently updated
TITLE - Sorted by title
START_DATE - Sorted by series start date
ID - Sorted by manga ID

User¶

class malclient.User¶

Show JSON schema

json

{
   "title": "User",
   "description": "Helper model class used to generate all models used by this API",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "picture": {
         "title": "Picture",
         "type": "string"
      },
      "gender": {
         "title": "Gender",
         "type": "string"
      },
      "birthday": {
         "title": "Birthday",
         "anyOf": [
            {
               "type": "string",
               "format": "date"
            },
            {
               "type": "string"
            }
         ]
      },
      "location": {
         "title": "Location",
         "type": "string"
      },
      "joined_at": {
         "title": "Joined At",
         "anyOf": [
            {
               "type": "string",
               "format": "date-time"
            },
            {
               "type": "string"
            }
         ]
      },
      "time_zone": {
         "title": "Time Zone",
         "type": "string"
      },
      "is_supporter": {
         "title": "Is Supporter",
         "type": "boolean"
      },
      "anime_statistics": {
         "$ref": "#/definitions/UserAnimeStatistics"
      }
   },
   "required": [
      "id",
      "name",
      "picture"
   ],
   "definitions": {
      "UserAnimeStatistics": {
         "title": "UserAnimeStatistics",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "num_items_watching": {
               "title": "Num Items Watching",
               "type": "integer"
            },
            "num_items_completed": {
               "title": "Num Items Completed",
               "type": "integer"
            },
            "num_items_on_hold": {
               "title": "Num Items On Hold",
               "type": "integer"
            },
            "num_items_dropped": {
               "title": "Num Items Dropped",
               "type": "integer"
            },
            "num_items_plan_to_watch": {
               "title": "Num Items Plan To Watch",
               "type": "integer"
            },
            "num_items": {
               "title": "Num Items",
               "type": "integer"
            },
            "num_days_watched": {
               "title": "Num Days Watched",
               "type": "number"
            },
            "num_days_watching": {
               "title": "Num Days Watching",
               "type": "number"
            },
            "num_days_completed": {
               "title": "Num Days Completed",
               "type": "number"
            },
            "num_days_on_hold": {
               "title": "Num Days On Hold",
               "type": "number"
            },
            "num_days_dropped": {
               "title": "Num Days Dropped",
               "type": "number"
            },
            "num_days": {
               "title": "Num Days",
               "type": "number"
            },
            "num_episodes": {
               "title": "Num Episodes",
               "type": "integer"
            },
            "num_times_rewatched": {
               "title": "Num Times Rewatched",
               "type": "integer"
            },
            "mean_score": {
               "title": "Mean Score",
               "type": "number"
            }
         },
         "required": [
            "num_items_watching",
            "num_items_completed",
            "num_items_on_hold",
            "num_items_dropped",
            "num_items_plan_to_watch",
            "num_items",
            "num_days_watched",
            "num_days_watching",
            "num_days_completed",
            "num_days_on_hold",
            "num_days_dropped",
            "num_days",
            "num_episodes",
            "num_times_rewatched",
            "mean_score"
         ]
      }
   }
}

Fields

id (int)
name (str)
picture (str)
gender (Optional[str])
birthday (Optional[Union[datetime.date, str]])
location (Optional[str])
joined_at (Optional[Union[datetime.datetime, str]])
time_zone (Optional[str])
is_supporter (Optional[bool])
anime_statistics (Optional[malclient.Datamodels.models.UserAnimeStatistics])

class malclient.UserAnimeStatistics¶

Show JSON schema

json

{
   "title": "UserAnimeStatistics",
   "description": "Helper model class used to generate all models used by this API",
   "type": "object",
   "properties": {
      "num_items_watching": {
         "title": "Num Items Watching",
         "type": "integer"
      },
      "num_items_completed": {
         "title": "Num Items Completed",
         "type": "integer"
      },
      "num_items_on_hold": {
         "title": "Num Items On Hold",
         "type": "integer"
      },
      "num_items_dropped": {
         "title": "Num Items Dropped",
         "type": "integer"
      },
      "num_items_plan_to_watch": {
         "title": "Num Items Plan To Watch",
         "type": "integer"
      },
      "num_items": {
         "title": "Num Items",
         "type": "integer"
      },
      "num_days_watched": {
         "title": "Num Days Watched",
         "type": "number"
      },
      "num_days_watching": {
         "title": "Num Days Watching",
         "type": "number"
      },
      "num_days_completed": {
         "title": "Num Days Completed",
         "type": "number"
      },
      "num_days_on_hold": {
         "title": "Num Days On Hold",
         "type": "number"
      },
      "num_days_dropped": {
         "title": "Num Days Dropped",
         "type": "number"
      },
      "num_days": {
         "title": "Num Days",
         "type": "number"
      },
      "num_episodes": {
         "title": "Num Episodes",
         "type": "integer"
      },
      "num_times_rewatched": {
         "title": "Num Times Rewatched",
         "type": "integer"
      },
      "mean_score": {
         "title": "Mean Score",
         "type": "number"
      }
   },
   "required": [
      "num_items_watching",
      "num_items_completed",
      "num_items_on_hold",
      "num_items_dropped",
      "num_items_plan_to_watch",
      "num_items",
      "num_days_watched",
      "num_days_watching",
      "num_days_completed",
      "num_days_on_hold",
      "num_days_dropped",
      "num_days",
      "num_episodes",
      "num_times_rewatched",
      "mean_score"
   ]
}

Fields

num_items_watching (int)
num_items_completed (int)
num_items_on_hold (int)
num_items_dropped (int)
num_items_plan_to_watch (int)
num_items (int)
num_days_watched (float)
num_days_watching (float)
num_days_completed (float)
num_days_on_hold (float)
num_days_dropped (float)
num_days (float)
num_episodes (int)
num_times_rewatched (int)
mean_score (float)

Fields¶

class malclient.Fields(**kwargs)¶

Object containing all fields possible for anime and manga num_favorites, opening_themes, ending_themes are not documented by MAL

Available Fields¶
Value	Description
id	Unique ID from MyAnimeList
title	Name of the show
main_picture	Picture picked to represent series
alternative_titles	Synonyms and translations of title
start_date	start date
end_date	finish date
synopsis	Short description of series
background	Additional information about show You cannot contain this field in a list
mean	Average of all scores Sometimes, f.e. when number of users is low, mean won’t be calculated
rank	Position in ranking on website Sometimes, f.e. when number of users is low, rank won’t be calculated
popularity	Position in popularity ranking on website
num_list_users	Number of users who have this title in their lists
num_scoring_users	Number of users who have give score to this title
updated_at	Date and time of last update
genres	List of all genres assigned to this title
my_list_status	Entry from validated user list for this title
pictures	List containing all assets You cannot contain this field in a list.
related_anime	List of all related anime Currently not working for manga entries You cannot contain this field in a list.
related_manga	List of all related manga Currently not working for anime entries You cannot contain this field in a list.
recommendations	Summary of recommended titles for people who liked this o You cannot contain this field in a list.
nsfw	NSFW rating value
created_at	Creation date for this entry
media_type	Media type
status	Current airing status
num_favorites	Number of users who have this title in their favourites
num_episodes	Total number of episodes Available only for anime entries
start_season	Season in which anime started airing Available only for anime entries
broadcast	Day of broadcast Available only for anime entries
source	Media type for anime source Available only for anime entries
average_episode_duration	Avarage length of one episode Available only for anime entries
rating	TV age rating Available only for anime entries
studios	list of studios creating this anime Available only for anime entries
opening_themes	List of opening songs Available only for anime entries
ending_themes	List of ending songs Available only for anime entries
statistics	Number of users for each list status Available only for anime entries You cannot contain this field in a list.
num_volumes	Total number of volumes for this manga Available only for manga entries
num_chapters	Total number of chapters for this manga Available only for manga entries
authors	List of people who created this manga Available only for manga entries
serialization	Information on manga serialization Available only for manga entries You cannot contain this field in a list.

classmethod anime()¶: Generates Fields object containing all parameters taken by anime

classmethod empty()¶: Generates empty fields object Might be overridden by some classes, which have parameters set to True by default

classmethod manga()¶: Generates Fields object containing all parameters taken by manga

classmethod node()¶: Generates Fields object containing only parameters taken by node

class malclient.AuthorFields(**kwargs)¶

Helper fields class containing info about manga author

Available Fields¶
Value	Description
first_name	Author’s first name
last_name	Author’s last name

classmethod empty()¶: Generates empty fields object Might be overridden by some classes, which have parameters set to True by default

class malclient.ListStatusFields(**kwargs)¶

Helper fields class containing precise data for my_list_status

Available Fields¶
Field name	Description
Score	Number of points given
status	Status on list
updated_at	Date and time of last update
start_date	Start date
finish_date	Finish Date
priority	Importance, set by user
tags	Tags given to this entry by user
comments	Additional comment provided by user
num_episodes_watched	Number of episodes watched by user Available only for anime entries
is_rewatching	Describes if user is rewatching this series Available only for anime entries
num_times_rewatched	Number of times user already rewatched this series Available only for anime entries
rewatch_value	How likely is user to rewatch this series Available only for anime entries
is_rereading	Describes if user is rewatching this series Available only for manga entries
num_volumes_read	Number of volumes read by user Available only for anime entries
num_chapters_read	Number of chapters read by user Available only for anime entries
num_times_reread	Number of times user already reread this series Available only for manga entries
reread_value	How likely is user to reread this series Available only for manga entries

classmethod anime_full()¶: All fields for anime list status

classmethod empty()¶: Generates empty fields object Might be overridden by some classes, which have parameters set to True by default

classmethod manga_full()¶: All fields for manga list status

Note

This is available only in alpha build of a wrapper

class malclient.CharacterFields(**kwargs)¶

Available Fields¶
Value	Description
id	Character’s id on MAL
role	Character’s role in anime one of: [Main, Supporting]
first_name	Character’s first name
last_name	Character’s last name
alternative_name	List of alternative names
main_picture	Main picture for character
biography	Character’s description on MAL
pictures	List of all pictures for this character You cannot contain this field in a list.
animeography	List of all anime in which this character appears You cannot contain this field in a list.
num_favorite	Number of users who have this character in their favourites

Forums¶

class malclient.ForumTopic¶

Show JSON schema

json

{
   "title": "ForumTopic",
   "description": "Helper model class used to generate all models used by this API",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "title": {
         "title": "Title",
         "type": "string"
      },
      "created_at": {
         "title": "Created At",
         "anyOf": [
            {
               "type": "string",
               "format": "date-time"
            },
            {
               "type": "string"
            }
         ]
      },
      "created_by": {
         "$ref": "#/definitions/ForumAuthor"
      },
      "number_of_posts": {
         "title": "Number Of Posts",
         "type": "integer"
      },
      "last_post_created_at": {
         "title": "Last Post Created At",
         "anyOf": [
            {
               "type": "string",
               "format": "date"
            },
            {
               "type": "string"
            }
         ]
      },
      "is_locked": {
         "title": "Is Locked",
         "type": "boolean"
      }
   },
   "required": [
      "id",
      "title",
      "created_at",
      "created_by",
      "number_of_posts",
      "last_post_created_at",
      "is_locked"
   ],
   "definitions": {
      "ForumAuthor": {
         "title": "ForumAuthor",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "forum_avator": {
               "title": "Forum Avator",
               "type": "string"
            }
         },
         "required": [
            "id",
            "name"
         ]
      }
   }
}

Fields

id (int)
title (str)
created_at (Union[datetime.datetime, str])
created_by (malclient.Datamodels.models.ForumAuthor)
number_of_posts (int)
last_post_created_at (Union[datetime.date, str])
is_locked (bool)

class malclient.ForumCategory¶

Show JSON schema

json

{
   "title": "ForumCategory",
   "description": "Helper model class used to generate all models used by this API",
   "type": "object",
   "properties": {
      "title": {
         "title": "Title",
         "type": "string"
      },
      "boards": {
         "title": "Boards",
         "type": "array",
         "items": {
            "$ref": "#/definitions/ForumBoard"
         }
      }
   },
   "required": [
      "title",
      "boards"
   ],
   "definitions": {
      "ForumSubboard": {
         "title": "ForumSubboard",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "title": {
               "title": "Title",
               "type": "string"
            }
         },
         "required": [
            "id",
            "title"
         ]
      },
      "ForumBoard": {
         "title": "ForumBoard",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "title": {
               "title": "Title",
               "type": "string"
            },
            "description": {
               "title": "Description",
               "type": "string"
            },
            "subboards": {
               "title": "Subboards",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ForumSubboard"
               }
            }
         },
         "required": [
            "id",
            "title",
            "description",
            "subboards"
         ]
      }
   }
}

Fields

title (str)
boards (list[malclient.Datamodels.models.ForumBoard])

class malclient.ForumTopicDetail(title=None, posts=None, polls=None, paging_data={})¶

Object represents details about forum topic on MAL, has paging support for list of posts

Variables

title (str) – Forum topic Title
posts (list[ForumPost]) – List of posts in forum topic, with paging support
polls (list[ForumPoll]) – List of polls available in forum topic

class malclient.ForumBoard¶

Show JSON schema

json

{
   "title": "ForumBoard",
   "description": "Helper model class used to generate all models used by this API",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "title": {
         "title": "Title",
         "type": "string"
      },
      "description": {
         "title": "Description",
         "type": "string"
      },
      "subboards": {
         "title": "Subboards",
         "type": "array",
         "items": {
            "$ref": "#/definitions/ForumSubboard"
         }
      }
   },
   "required": [
      "id",
      "title",
      "description",
      "subboards"
   ],
   "definitions": {
      "ForumSubboard": {
         "title": "ForumSubboard",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "title": {
               "title": "Title",
               "type": "string"
            }
         },
         "required": [
            "id",
            "title"
         ]
      }
   }
}

Fields

id (int)
title (str)
description (str)
subboards (list[malclient.Datamodels.models.ForumSubboard])

class malclient.ForumSubboard¶

Show JSON schema

json

{
   "title": "ForumSubboard",
   "description": "Helper model class used to generate all models used by this API",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "title": {
         "title": "Title",
         "type": "string"
      }
   },
   "required": [
      "id",
      "title"
   ]
}

Fields

id (int)
title (str)

class malclient.ForumAuthor¶

Show JSON schema

json

{
   "title": "ForumAuthor",
   "description": "Helper model class used to generate all models used by this API",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "forum_avator": {
         "title": "Forum Avator",
         "type": "string"
      }
   },
   "required": [
      "id",
      "name"
   ]
}

Fields

id (int)
name (str)
forum_avator (Optional[str])

class malclient.ForumPost¶

Show JSON schema

json

{
   "title": "ForumPost",
   "description": "Helper model class used to generate all models used by this API",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "number": {
         "title": "Number",
         "type": "integer"
      },
      "created_at": {
         "title": "Created At",
         "anyOf": [
            {
               "type": "string",
               "format": "date-time"
            },
            {
               "type": "string"
            }
         ]
      },
      "created_by": {
         "$ref": "#/definitions/ForumAuthor"
      },
      "body": {
         "title": "Body",
         "type": "string"
      },
      "signature": {
         "title": "Signature",
         "type": "string"
      }
   },
   "required": [
      "id",
      "number",
      "created_at",
      "created_by",
      "body",
      "signature"
   ],
   "definitions": {
      "ForumAuthor": {
         "title": "ForumAuthor",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "forum_avator": {
               "title": "Forum Avator",
               "type": "string"
            }
         },
         "required": [
            "id",
            "name"
         ]
      }
   }
}

Fields

id (int)
number (int)
created_at (Union[datetime.datetime, str])
created_by (malclient.Datamodels.models.ForumAuthor)
body (str)
signature (str)

class malclient.ForumPoll¶

Show JSON schema

json

{
   "title": "ForumPoll",
   "description": "Helper model class used to generate all models used by this API",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "question": {
         "title": "Question",
         "type": "string"
      },
      "close": {
         "title": "Close",
         "type": "boolean"
      },
      "options": {
         "title": "Options",
         "type": "array",
         "items": {
            "$ref": "#/definitions/ForumPollOption"
         }
      }
   },
   "required": [
      "id",
      "question",
      "close",
      "options"
   ],
   "definitions": {
      "ForumPollOption": {
         "title": "ForumPollOption",
         "description": "Helper model class used to generate all models used by this API",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "integer"
            },
            "text": {
               "title": "Text",
               "type": "string"
            },
            "votes": {
               "title": "Votes",
               "type": "integer"
            }
         },
         "required": [
            "id",
            "text",
            "votes"
         ]
      }
   }
}

Fields

id (int)
question (str)
close (bool)
options (list[malclient.Datamodels.models.ForumPollOption])

class malclient.ForumPollOption¶

Show JSON schema

json

{
   "title": "ForumPollOption",
   "description": "Helper model class used to generate all models used by this API",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "integer"
      },
      "text": {
         "title": "Text",
         "type": "string"
      },
      "votes": {
         "title": "Votes",
         "type": "integer"
      }
   },
   "required": [
      "id",
      "text",
      "votes"
   ]
}

Fields

id (int)
text (str)
votes (int)