Volume¶

GET /api/v1/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/v1/series/some-manga/1 \
     -H 'If-Modified-Since: Fri, 24 Aug 2018 12:48:01 GMT'

Request headers¶

If-Modified-Since: Send a conditional request checking the Last-Modified header.

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_list": [
      "001.jpg",
      "002.jpg",
      "003.jpg",
      "004.jpg"
    ],
    "pages_root": "http://example.com/media/some-manga/1/0/",
    "date": "Sun, 26 Aug 2018 16:14:52 GMT",
    "final": false
  }
}

Response headers¶

Date: The date of the request.
Server: Information regarding the server.
Content-Type: The content type of the response. (always application/json)
Last-Modified: The date the resource was last modified. Useful for caching responses.
ETag: The version identifier of the resource. Useful for caching responses.
X-Frame-Options: Sent by Django’s clickjacking middleware.
Content-Length: The size of the response body in bytes.

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_list (array of string) - A list of pages of the chapter.
pages_root (array of string) - The root URl of the pages.
date (string) - The date the chapter was uploaded.
final (boolean) - Whether the chapter is the finale of the series.

Status Codes¶

200 OK - No error.
304 Not Modified - The request was conditional and the content hasn’t been modified.
404 Not Found - The requested series or volume doesn’t exist.
400 Bad Request - The volume parameter was invalid.