Series Page Data#

Endpoint: /series_page_data/{slug}

class guyamoe_api_types.series_page_data.SeriesPageData(data: Dict[str, Any])#

class guyamoe_api_types.series_page_data.SeriesPageData(**attrs: Any) → SeriesPageData

Bases: dict

A dictionary containing various metadata about a page.

alt_titles: List[str]#: A list of alternate titles for the series.

alt_titles_str: str#: A string containing all alternate titles for the series.

author: str#: The author of the series.

available_features: List[str]#

A list of features that are available for the series. This list is static for all responses and currently looks like:

[
    "detailed",
    "compact",
    "volumeCovers",
    "rss",
    "download"
]

canonical_url: str#: The full URL to the series page on the website.

chapter_list: List[List[Union[str, int, List[int]]]]#

A list of lists containing information on each chapter.

The sub-lists can be thought of as a tuple where the elements mean the following, in order:

The chapter number.
The chapter number (again).
The chapter title.
A slugified version of the chapter number. Dots are replaced with dashes. For integer chapter numbers this value should be the same as the first and second elements.
The name of the group that uploaded the chapter or Multiple Groups if the chapter is uploaded by multiple groups.
The date and time the chapter was published. This is another tuple-like list that has these elements:
1. The year.
2. The month, starting from 0.
3. The day.
4. The hour.
5. The minute.
6. The second.
The chapter’s volume (integer) or the string null.

cover_vol_url: str#: A Relative URL to the cover image of the series.

cover_vol_url_webp: str#: An URL similar to cover_vol_url, but the file is a .webp file.

embed_image: str#: A full URL to the image that should be shown for Facebook/Twitter/other social media embeds.

metadata: List[List[Union[str, int]]]#

A list of lists containing the metadata for each volume in the series. Each sub-list is actually a key-value pair, where the first element is the name and the second element is the value. The value can be a string or an integer.

So far, the structure of the metadata is as follows:

[
    [
        "Author",
        "<author>"
    ],
    [
        "Artist",
        "<artist>"
    ],
    [
        "Views",
        123456
    ],
    [
        "Last Updated",
        "Ch. <latest chapter number> - <year>-<month>-<day>"
    ]
]

reader_modifier: str#: The part of the relative_url that does not contain the slug. The modifier can be used in conjunction with :attr`.slug` to construct the relative url to the series page.

relative_url: str#: The Relative URL to the series page on the website.

root_domain: str#: The root domain of the series. This is a domain name without the protocol.

series: str#: The title of the series.

series_id: int#: The internal ID of the series.

slug: str#: The slug of the series.

synopsis: str#: The synopsis of the series.

version_query: str#: A query string containing the first 7 characters of the git commit’s SHA-1 ID that the server is running off of.

volume_list: List[List[Union[int, List[List[Union[str, List[int]]]]]]]#

A list of lists containing information on each volume.

The sub-lists can be thought of as a tuple where the elements mean the following, in order:

The volume number.
A list of lists containing chapters in the volume. Each chapter entry can be thought of as a tuple where the elements mean the following, in order:
1. The chapter number.
2. A slugified version of the chapter number. Dots are replaced with dashes. For integer chapter numbers this value should be the same as the first and second elements.
3. The name of the group that uploaded the chapter or Multiple Groups if the chapter is uploaded by multiple groups.
4. The date and time the chapter was published. This is another tuple-like list that has these elements:
  1. The year.
  2. The month, starting from 0.
  3. The day.
  4. The hour.
  5. The minute.
  6. The second.