All series¶
- GET /api/v1/series
Retrieve the info of every series.
Example request¶
curl -i http://example.com/api/v1/series \
-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: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"]
],
"categories": [
{
"name": "Drama",
"description": "Drama"
}
],
"cover": "http://example.com/media/series/some-manga/cover.jpg",
"completed": false,
"volumes": {
"1": {
"0": {
"url": "http://example.com/reader/some-manga/1/0/",
"title": "Prologue",
"full_title": "Vol. 1, Ch. 0: Prologue",
"pages_list": [
"001.jpg",
"002.jpg",
"003.jpg",
"004.jpg"
],
"pages_root": "http://example.com/media/series/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 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.
categories (array of object) - The series’ categories. Each object contains the name and description of the category.
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:
url (string) - The URL of the chapter.
title (string) - The title of the chapter.
full_title (string) - The title as shown on the site.
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 published.
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.