Series

All series

GET /api/series

Retrieve the info of every series.

Example request

curl -i http://example.com/api/series \
     -H 'If-Modified-Since: Fri, 24 Aug 2018 12:48:01 GMT'

Request headers

Example response

HTTP/1.1 200 OK
Date: Tue, 28 Aug 2018 09:35:27 GMT
Server: WSGIServer/0.2 CPython/3.7.0
Content-Type: application/json
Last-Modified: Sun, 26 Aug 2018 16:40:11 GMT
ETag: "2ce26c7f5182ce4aa4793147627b2a96"
X-Frame-Options: SAMEORIGIN
Content-Length: 510

[
  {
    "slug": "some-manga",
    "title": "Some Manga",
    "aliases": [
      "Some Mango"
    ],
    "url": "https://example.com/reader/some-manga/",
    "description": "Some description.",
    "authors": [
      ["John Doe", "Johnnie Doe"],
      ["Jack Doe"]
    ],
    "artists": [
      ["Jane Doe"]
    ],
    "cover": "http://example.com/media/series/some-manga/cover.jpg",
    "completed": false,
    "volumes": {
      "1": {
        "0": {
          "title": "Prologue",
          "url": "http://example.com/reader/some-manga/1/0/",
          "pages": [
            "001.jpg",
            "002.jpg",
            "003.jpg",
            "004.jpg"
          ],
          "date": "Sun, 26 Aug 2018 16:14:52 GMT",
          "final": false
        }
      }
    }
  }
]

Response headers

Response body

The response body is an array of JSON objects. Each object contains the following:

  • slug (string) - The slug of the series.
  • title (string) - The title of the series.
  • aliases (array of string) - Other names for the series.
  • url (string) - The URL of the series.
  • description (string) - The description of the series.
  • authors (array of array) - The series’ authors. Each array contains the name and aliases of the author.
  • artists (array of array) - The series’ artists. Each array contains the name and aliases of the artist.
  • cover (string) - The URL of the series’ cover.
  • completed (boolean) - Whether the series is completed.
  • volumes (object) - The volumes of the series. The key of each volume is its number. The value is an object containing the volume’s chapters. Each chapter’s key is its number and its value contains the following:
  • title (string) - The title of the chapter.
  • url (string) - The URL of the chapter.
  • pages (array of string) - The pages of the chapter.
  • date (string) - The date the chapter was uploaded.
  • final (boolean) - Whether the chapter is the finale of the series.

Status Codes

Single series

GET /api/series/:slug

Retrieve the info of a certain series.

Request parameters

  • slug (string) - The slug of the series.

Example request

curl -i http://example.com/api/series/some-manga \
     -H 'If-Modified-Since: Fri, 24 Aug 2018 12:48:01 GMT'

Request headers

Example response

HTTP/1.1 200 OK
Date: Tue, 28 Aug 2018 09:35:27 GMT
Server: WSGIServer/0.2 CPython/3.7.0
Content-Type: application/json
Last-Modified: Sun, 26 Aug 2018 16:40:11 GMT
ETag: "877d416e5573564ef3148716a799bb1a"
X-Frame-Options: SAMEORIGIN
Content-Length: 507

{
  "slug": "some-manga",
  "title": "Some Manga",
  "aliases": [
    "Some Mango"
  ],
  "url": "http://example.com/reader/some-manga/",
  "description": "Some description.",
  "authors": [
    ["John Doe", "Johnnie Doe"],
    ["Jack Doe"]
  ],
  "artists": [
    ["Nemo Nobody"]
  ],
  "cover": "http://example.com/media/series/some-manga/cover.jpg",
  "completed": false,
  "volumes": {
    "1": {
      "0": {
        "title": "Prologue",
        "url": "http://example.com/reader/some-manga/1/0/",
        "pages": [
          "001.jpg",
          "002.jpg",
          "003.jpg",
          "004.jpg"
        ],
        "date": "Sun, 26 Aug 2018 16:14:52 GMT",
        "final": false
      }
    }
  }
}

Response headers

Response body

The response body is a JSON object containing the following:

  • slug (string) - The slug of the series.
  • title (string) - The title of the series.
  • aliases (array of string) - Other names for the series.
  • url (string) - The URL of the series.
  • description (string) - The description of the series.
  • authors (array of array) - The series’ authors. Each array contains the name and aliases of the author.
  • artists (array of array) - The series’ artists. Each array contains the name and aliases of the artist.
  • cover (string) - The URL of the series’ cover.
  • completed (boolean) - Whether the series is completed.
  • volumes (object) - The volumes of the series. The key of each volume is its number. The value is an object containing the volume’s chapters. Each chapter’s key is its number and its value contains the following:
  • title (string) - The title of the chapter.
  • url (string) - The URL of the chapter.
  • pages (array of string) - The pages of the chapter.
  • date (string) - The date the chapter was uploaded.
  • final (boolean) - Whether the chapter is the finale of the series.

Status Codes

Volume

GET /api/series/:slug/:volume

Retrieve all chapters of a volume.

Request parameters

  • slug (string) - The slug of the series.
  • volume (int) - A volume of the series.

Example request

curl -i http://example.com/api/series/some-manga/1 \
     -H 'If-Modified-Since: Fri, 24 Aug 2018 12:48:01 GMT'

Request headers

Example response

HTTP/1.1 200 OK
Date: Tue, 28 Aug 2018 09:35:27 GMT
Server: WSGIServer/0.2 CPython/3.7.0
Content-Type: application/json
Last-Modified: Sun, 26 Aug 2018 16:14:52 GMT
ETag: "88bc064c71f4d4e925c6725de3077fd4"
X-Frame-Options: SAMEORIGIN
Content-Length: 187

{
  "0": {
    "title": "Prologue",
    "url": "http://example.com/reader/some-manga/1/0/",
    "pages": [
      "001.jpg",
      "002.jpg",
      "003.jpg",
      "004.jpg"
    ],
    "date": "Sun, 26 Aug 2018 16:14:52 GMT",
    "final": false
  }
}

Response headers

Response body

The response body is a JSON object. The key of each object is the chapter number. The value is an object containing the info of the chapter:

  • title (string) - The title of the chapter.
  • url (string) - The URL of the chapter.
  • pages (array of string) - The pages of the chapter.
  • date (string) - The date the chapter was uploaded.
  • final (boolean) - Whether the chapter is the finale of the series.

Status Codes

Chapter

GET /api/series/:slug/:volume/:chapter

Retrieve all chapters of a volume.

Request parameters

  • slug (string) - The slug of the series.
  • volume (int) - A volume of the series.
  • chapter (int) - A chapter of the volume.

Example request

curl -i http://example.com/api/series/some-manga/1/0 \
     -H 'If-Modified-Since: Fri, 24 Aug 2018 12:48:01 GMT'

Request headers

Example response

HTTP/1.1 200 OK
Date: Tue, 28 Aug 2018 09:35:27 GMT
Server: WSGIServer/0.2 CPython/3.7.0
Content-Type: application/json
Last-Modified: Sun, 26 Aug 2018 16:14:52 GMT
ETag: "11b9df2f0904dc4f1b2dfaa7d7419bbc"
X-Frame-Options: SAMEORIGIN
Content-Length: 181

{
  "title": "Prologue",
  "url": "http://example.com/reader/some-manga/1/0/",
  "pages": [
    "001.jpg",
    "002.jpg",
    "003.jpg",
    "004.jpg"
  ],
  "date": "Sun, 26 Aug 2018 16:14:52 GMT",
  "final": false
}

Response headers

Response body

The response body is a JSON object containing the following:

  • title (string) - The title of the chapter.
  • url (string) - The URL of the chapter.
  • pages (array of string) - The pages of the chapter.
  • date (string) - The date the chapter was uploaded.
  • final (boolean) - Whether the chapter is the finale of the series.

Status Codes