Response Types and Payloads

Most of the data in here will be irrelevant to 95% of the userbase. However if someone wishes to contribute to Hondana then they will likely read or amend this data.

I do withold the right that this data can change at any time and NOT be regarded as a breaking change due to following the upstream (MangaDex)’s dev cycle.’

Common

hondana.types_.common.LanguageCode

alias of Literal[‘ar’, ‘bg’, ‘bn’, ‘ca’, ‘cs’, ‘da’, ‘de’, ‘el’, ‘en’, ‘es-la’, ‘es’, ‘fa’, ‘fi’, ‘fr’, ‘he’, ‘hi’, ‘hu’, ‘id’, ‘it’, ‘ja’, ‘ja-ro’, ‘ko’, ‘ko-ro’, ‘lt’, ‘mn’, ‘ms’, ‘my’, ‘nl’, ‘no’, ‘pl’, ‘pt-br’, ‘pt’, ‘ro’, ‘ru’, ‘sh’, ‘sv’, ‘th’, ‘tl’, ‘tr’, ‘uk’, ‘vi’, ‘zh-hk’, ‘zh’, ‘zh-ro’]

class hondana.types_.common.LocalizedString

Examples

A localised string:

{
    "en": "An english string",
    "fr": "Une corde française"
}

Artist

class hondana.types_.artist.ArtistResponse

id: str

type: Literal["artist"]

attributes: ArtistAttributesResponse

relationships: List[RelationshipResponse]

This key is optional, in the event this payload is gotten from the “relationships” of another object.

This key can contain minimal or full data depending on the includes[] parameter of its request. See here for more info: https://api.mangadex.org/docs.html#section/Reference-Expansion

class hondana.types_.artist.ArtistAttributesResponse

name: str

imageUrl: Optional[str]

biography: LocalizedString

twitter: Optional[str]

pixiv: Optional[str]

melonBook: Optional[str]

fanBox: Optional[str]

booth: Optional[str]

nicoVideo: Optional[str]

skeb: Optional[str]

fantia: Optional[str]

tumblr: Optional[str]

youtube: Optional[str]

weibo: Optional[str]

naver: Optional[str]

namicomi: Optional[str]

website: Optional[str]

version: int

createdAt: str

updatedAt: str

class hondana.types_.artist.GetSingleArtistResponse

result: Literal["ok", "error"]

response: Literal["entity"]

data: List[ArtistResponse]

class hondana.types_.artist.GetMultiArtistResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[ArtistResponse]

limit: int

offset: int

total: int

Auth

class hondana.types_.auth.TokenResponse

session: str

refresh: str

class hondana.types_.auth.CheckPayload

result: Literal["ok"]

isAuthenticated: bool

roles: List[str]

permissions: List[str]

class hondana.types_.auth.RefreshPayload

result: Literal["ok", "error"]

token: TokenResponse

message: str

class hondana.types_.auth.LoginPayload

result: Literal["ok", "error"]

token: TokenResponse

Author

class hondana.types_.author.AuthorResponse

id: str

type: Literal["author"]

attributes: AuthorAttributesResponse

relationships: List[RelationshipResponse]

This key is optional, in the event this payload is gotten from the “relationships” of another object.

This key can contain minimal or full data depending on the includes[] parameter of its request. See here for more info: https://api.mangadex.org/docs.html#section/Reference-Expansion

class hondana.types_.author.AuthorAttributesResponse

name: str

imageUrl: Optional[str]

biography: Optional[LocalizedString]

twitter: Optional[str]

pixiv: Optional[str]

melonBook: Optional[str]

fanBox: Optional[str]

booth: Optional[str]

nicoVideo: Optional[str]

skeb: Optional[str]

fantia: Optional[str]

tumblr: Optional[str]

youtube: Optional[str]

weibo: Optional[str]

naver: Optional[str]

namicomi: Optional[str]

website: Optional[str]

version: int

createdAt: str

updatedAt: str

class hondana.types_.author.GetSingleAuthorResponse

result: Literal[ok, error]

response: Literal[entity]

data: AuthorResponse

class hondana.types_.author.GetMultiAuthorResponse

result: Literal[ok, error]

response: Literal[collection]

data: List[AuthorResponse]

limit: int

offset: int

total: int

Chapter

class hondana.types_.chapter.ChapterResponse

id: str

type: Literal["chapter"]

attributes: ChapterAttributesResponse

relationships: List[RelationshipResponse]

This key is optional, in the event this payload is gotten from the “relationships” of another object.

This key can contain minimal or full data depending on the includes[] parameter of its request. See here for more info: https://api.mangadex.org/docs.html#section/Reference-Expansion

class hondana.types_.chapter.ChapterAttributesResponse

title: Optional[str]

volume: str

chapter: str

pages: int

translatedLanguage: str

externalUrl: Optional[str]

version: int

createdAt: str

updatedAt: str

publishAt: str

readableAt: str

isUnavailable: bool

class hondana.types_.chapter.GetSingleChapterResponse

result: Literal["ok", "error"]

response: Literal["entity"]

data: ChapterResponse

class hondana.types_.chapter.GetMultiChapterResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[ChapterResponse]

limit: int

offset: int

total: int

class hondana.types_.chapter.GetAtHomeResponse

result: Literal["ok"]

baseUrl: str

chapter: :class`~hondana.types_.GetAtHomeChapterResponse`

class hondana.types_.chapter.GetAtHomeChapterResponse

hash: str

data: List[str]

dataSaver: List[str]

class hondana.types_.chapter.ChapterReadResponse

chapterId: str

readDate: str

class hondana.types_.chapter.ChapterReadHistoryResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[ChapterReadResponse]

limit: int

offset: int

total: int

Cover

class hondana.types_.cover.CoverResponse

id: str

type: Literal["cover_art"]

attributes: CoverAttributesResponse

relationships: List[RelationshipResponse]

This key is optional, in the event this payload is gotten from the “relationships” of another object.

This key can contain minimal or full data depending on the includes[] parameter of its request. See here for more info: https://api.mangadex.org/docs.html#section/Reference-Expansion

class hondana.types_.cover.CoverAttributesResponse

volume: Optional[str]

fileName: str

description: Optional[str]

locale: Optional[LanguageCode]

version: int

createdAt: str

updatedAt: str

class hondana.types_.cover.GetSingleCoverResponse

result: Literal["ok", "error"]

response: Literal["entity"]

data: CoverResponse

class hondana.types_.cover.GetMultiCoverResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[CoverResponse]

limit: int

offset: int

total: int

CustomList

class hondana.types_.custom_list.CustomListResponse

id: class:str

type: Literal["custom_list"]

attributes: CustomListAttributesResponse

class hondana.types_.custom_list.CustomListAttributesResponse

name: str

visibility: CustomListVisibility

pinned: NotRequired[bool]

version: int

class hondana.types_.custom_list.GetSingleCustomListResponse

result: Literal["ok", "error"]

response: Literal["entity"]

data: CustomListResponse

class hondana.types_.custom_list.GetMultiCustomListResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[CustomListResponse]

limit: int

offset: int

total: int

Errors

class hondana.types_.errors.ErrorType

id: str

The ID of the error.

status: int

The http status code of the error.

title: str

The error title.

detail: str

The details of the error.

class hondana.types_.errors.APIError

result: Literal["error"]

errors: List[ErrorType]

Forums

class hondana.types_.forums.ForumAttributesResponse

class hondana.types_.forums.ForumDataResponse

class hondana.types_.forums.ForumPayloadResponse

Legacy

hondana.types_.legacy.LegacyMappingType

alias of Literal[‘group’, ‘manga’, ‘chapter’, ‘tag’]

class hondana.types_.legacy.LegacyMappingResponse

id: str

type: Literal["mapping_id"]

attributes: LegacyMappingAttributesResponse

class hondana.types_.legacy.LegacyMappingAttributesResponse

type: LegacyMappingType

legacyId: int

newId: str

class hondana.types_.legacy.GetLegacyMappingResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[LegacyMappingResponse]

limit: int

offset: int

total: int

Manga

class hondana.types_.manga.MangaLinks

Please see here for more explicit info on these:-

https://api.mangadex.org/docs.html#section/Static-data/Manga-links-data

al: Optional[str]

anilist key

ap: Optional[str]

animeplanet key

bw: Optional[str]

bookwalker.jp key

mu: Optional[str]

mangaupdates key

nu: Optional[str]

novelupdates key

kt: Optional[str]

kitsu.io key

amz: Optional[str]

amazon key

ebj: Optional[str]

ebookjapan key

mal: Optional[str]

myanimelist key

cdj: Optional[str]

cdjapan key

raw: Optional[str]

engtl: Optional[str]

class hondana.types_.manga.MangaResponse

id: str

type: Literal["manga"]

attributes: MangaAttributesResponse

relationships: List[RelationshipResponse]

This key is optional, in the event this payload is gotten from the “relationships” of another object.

This key can contain minimal or full data depending on the includes[] parameter of its request. See here for more info: https://api.mangadex.org/docs.html#section/Reference-Expansion

related: MangaRelationType

This key is optional.

class hondana.types_.manga.GetMangaResponse

result: Literal["ok", "error"]

response: Literal["entity"]

data: MangaResponse

class hondana.types_.manga.MangaAttributesResponse

title: LocalizedString

altTitle: List[LocalizedString]

description: LocalizedString

isLocked: bool

links: MangaLinks

originalLanguage: str

lastVolume: Optional[str]

lastChapter: Optional[str]

publicationDemographic: Optional[PublicationDemographic]

status: MangaStatus

year: Optional[int]

contentRating: Optional[ContentRating]

chapterNumbersResetOnNewVolume: bool

latestUploadedChapter: str

availableTranslatedLanguages: List[LanguageCode]

tags: List[TagResponse]

state: MangaState

version: int

createdAt: str

updatedAt: str

isLocked: Optional[bool]

This key is optional

class hondana.types_.manga.MangaRelationAttributesResponse

relation: MangaRelationType

version: int

class hondana.types_.manga.MangaRelationCreateResponse

result: Literal["ok", "error"]

response: Literal["entity"]

data: MangaRelation

class hondana.types_.manga.MangaSearchResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[MangaResponse]

limit: int

offset: int

total: int

class hondana.types_.manga.MangaRelation

id: str

type: Literal["manga_relation"]

attributes: MangaRelationAttributesResponse

relationships: List[RelationshipResponse]

This key is optional, in the event this payload is gotten from the “relationships” of another object.

This key can contain minimal or full data depending on the includes[] parameter of its request. See here for more info: https://api.mangadex.org/docs.html#section/Reference-Expansion

related: MangaRelationType

This key is optional.

class hondana.types_.manga.MangaRelationResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[MangaRelation]

limit: int

offset: int

total: int

class hondana.types_.manga.VolumesAndChaptersResponse

chapters: Dict[str, ChaptersResponse]

count: int

volume: str

class hondana.types_.manga.ChaptersResponse

chapter: str

count: str

class hondana.types_.manga.GetMangaVolumesAndChaptersResponse

result: Literal["ok", "error"]

volumes: Optional[Dict[str, VolumesAndChaptersResponse]]

class hondana.types_.manga.MangaReadMarkersResponse

result: Literal["ok"]

data: List[str]

class hondana.types_.manga.MangaGroupedReadMarkersResponse

result: Literal["ok"]

data: Dict[str, List[str]]

class hondana.types_.manga.MangaSingleReadingStatusResponse

result: Literal["ok"]

status: ReadingStatus

class hondana.types_.manga.MangaMultipleReadingStatusResponse

result: Literal["ok"]

statuses: Dict[str, ReadingStatus]

Mapping of [manga_id: ReadingStatus value]

Relationship

hondana.types_.relationship.RelationshipResponse

id: str

type: Literal["manga", "chapter", "scanlation_group", "author", "cover_art", "artist", user]

attributes: Dict[str, str]

This key is optional

This key can contain minimal or full data depending on the includes[] parameter of it’s request. See here for more info: https://api.mangadex.org/docs.html#section/Reference-Expansion

relationships: List[Dict[str, str]]

This key is optional

This key will be a one level nested list of relationships for each object in the relationship.

Report

class hondana.types_.report.ReportReasonResponse

id: str

type: Literal["report_reason"]

attributes: GetReportReasonAttributesResponse

class hondana.types_.report.GetReportReasonAttributesResponse

reason: LocalizedString

detailsRequired: bool

category: ReportCategory

version: int

class hondana.types_.report.GetReportReasonResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[ReportReasonResponse]

limit: int

offset: int

total: int

Scanlator Group

class hondana.types_.scanlator_group.ScanlationGroupResponse

id: str

type: Literal["scanlation_group"]

attributes: ScanlationGroupAttributesResponse

relationships: List[RelationshipResponse]

This key is optional, in the event this payload is gotten from the “relationships” of another object.

This key can contain minimal or full data depending on the includes[] parameter of its request. See here for more info: https://api.mangadex.org/docs.html#section/Reference-Expansion

class hondana.types_.scanlator_group.ScanlationGroupAttributesResponse

name: str

altNames: List[str]

website: Optional[str]

ircServer: Optional[str]

ircChannel: Optional[str]

discord: Optional[str]

contactEmail: Optional[str]

description: Optional[str]

twitter: Optional[str]

mangaUpdates: Optional[str]

focusedLanguage: Optional[List[str]]

locked: bool

official: bool

verified: bool

inactive: bool

exLicensed: bool

This key may not be present.

publishDelay: str

version: int

createdAt: str

updatedAt: str

class hondana.types_.scanlator_group.GetSingleScanlationGroupResponse

result: Literal["ok", "error"]

response: Literal["entity"]

data: ScanlationGroupResponse

class hondana.types_.scanlator_group.GetMultiScanlationGroupResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[ScanlationGroupResponse]

limit: int

offset: int

total: int

Settings

class hondana.types_.settings.Settings

Currently not documented.

class hondana.types_.settings.SettingsPayload

result: Literal["ok", "error"]

updatedAt: str

Represents an ISO-8601 datetime.

settings: Settings

template: str

UUID of the template.

Statistics

class hondana.types_.statistics.StatisticsRatingResponse

average: Optional[float]

bayesian: Optional[float]

distribution: Dict[str, int]

class hondana.types_.statistics.BatchStatisticsRatingResponse

average: float

bayesian: float

class hondana.types_.statistics.MangaStatisticsResponse

rating: StatisticsRatingResponse

follows: int

class hondana.types_.statistics.BatchStatisticsResponse

rating: BatchStatisticsRatingResponse

follows: int

class hondana.types_.statistics.GetMangaStatisticsResponse

result: Literal["ok"]

statistics: Dict[str, StatisticsRatingResponse]

class hondana.types_.statistics.BatchGetStatisticsResponse

result: Literal["ok"]

statistics: Dict[str, BatchStatisticsResponse]

class hondana.types_.statistics.PersonalMangaRatingsResponse

rating: int

createdAt: str

class hondana.types_.statistics.GetPersonalMangaRatingsResponse

result: Literal["ok"]

ratings: Dict[str, PersonalMangaRatingsResponse]

class hondana.types_.statistics.CommentMetaData

threadId: int

repliesCount: int

class hondana.types_.statistics.StatisticsCommentsResponse

comments: Optional[CommentMetaData]

class hondana.types_.statistics.GetCommentsStatisticsResponse

result: Literal["ok"]

statistics: Dict[str, StatisticsCommentsResponse]

Tags

class hondana.types_.tags.TagResponse

id: str

type: Literal["tag"]

attributes: TagAttributesResponse

relationships: List[RelationshipResponse]

This key can contain minimal or full data depending on the includes[] parameter of its request. See here for more info: https://api.mangadex.org/docs.html#section/Reference-Expansion

class hondana.types_.tags.TagAttributesResponse

name: LocalizedString

description: LocalizedString

group: str

version: int

class hondana.types_.tags.GetTagListResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[TagResponse]

limit: int

offset: int

total: int

Token

class hondana.types_.token.TokenPayload

typ: Literal[Bearer]

iss: Literal[https://auth.mangadex.org/realms/mangadex]

Issuer name

aud: Literal[account]

Token audience

iat: int

Time token was issued in UTC timestamp

exp: int

Expiring time in UTC timestamp

sid: str

Session UUID

auth_time: int

Time when authentication occurred in UTC timestamp.

jti: str

JWT unique identifier

sub str

Token subject UUID.

azp: str

Authorized party name

session_state: dict[str, _InnerSessionState]

The current session state data

scope: str

A space delimited list of oauth scopes

roles: list[str]

A list of roles the user has in the API

groups: str

A space delimited string of groups one has in the API

preferred_username: str

The username of the current user

email_address: str

The email address of the current user

User

class hondana.types_.user.UserResponse

id: str

type: Literal["user"]

attributes: GetUserAttributesResponse

relationships: List[RelationshipResponse]

This key is optional, in the event this payload is gotten from the “relationships” of another object.

This key can contain minimal or full data depending on the includes[] parameter of its request. See here for more info: https://api.mangadex.org/docs.html#section/Reference-Expansion

class hondana.types_.user.GetUserAttributesResponse

username: str

version: int

roles: List[str]

class hondana.types_.user.GetSingleUserResponse

result: Literal["ok", "error"]

response: Literal["entity"]

data: UserResponse

limit: int

offset: int

total: int

class hondana.types_.user.GetMultiUserResponse

result: Literal["ok", "error"]

response: Literal["collection"]

data: List[UserResponse]

limit: int

offset: int

total: int

Upload

class hondana.types_.upload.UploadSessionAttributes

isCommitted: bool

isProcessed: bool

isDeleted: bool

version: int

createdAt: str

updatedAt: str

class hondana.types_.upload.GetUploadSessionResponse

result: Literal["ok", "error"]

response: Literal["entity"]

data: :class:~hondana.types_.GetUploadSessionDataResponse`

class hondana.types_.upload.ChapterUploadAttributes

isCommitted bool

isProcessed: bool

isDeleted: bool

class hondana.types_.upload.ChapterUploadData

id: str

type: Literal["upload_session"]

attributes: ChapterUploadAttributes

relationships: List[RelationshipResponse]

class hondana.types_.upload.BeginChapterUploadResponse

result: Literal["ok", "error"]

data: ChapterUploadData

class hondana.types_.upload.UploadedChapterPageAttributes

originalFileName: str

fileHash: str

fileSize: int

mimeType: str

version: int

class hondana.types_.upload.UploadedChapterDataResponse

id: str

type: Literal["upload_session_file"]

attributes: UploadedChapterPageAttributes

class hondana.types_.upload.UploadedChapterResponse

result: Literal["ok", "error"]

errors: List[ErrorType]

data: List[UploadedChapterDataResponse]