JSON documentation

Contentv2

Main body

Intent

Describes a Content (i.e. a book inside the queue or the library)

Corresponding class

JsonContent

Field	Format	Description
url	URL	URL where the book has been initially downloaded
title	String	Title
coverImageUrl	URL	URL of the cover image
qtyPages	Positive Integer	Number of pages
uploadDate	POSIX timestamp	Date where the book has been uploaded to the website you got it from
downloadDate	POSIX timestamp	See dedicated FAQ entry
downloadCompletionDate	POSIX timestamp	See dedicated FAQ entry
status	StatusContent	One of the values of the enum (e.g. "DOWNLOADED")
site	Site	One of the values of the enum (e.g. "NHENTAI")
favourite	true/false	True if the book has been favourited
rating	0..5	Number of stars
completed	true/false	True if the book has been marked as completed
reads	Positive Integer	Number of times the book has been opened for reading
lastReadDate	POSIX timestamp	Last time the book has been opened for reading
lastReadPageIndex	Positive Integer	Index of the last page that has been read
downloadMode	0 or 1	0 = Downloaded / 1 = Streamed
manuallyMerged	true/false	True if the book is the result of a manual merging
bookPreferences	Dictionary (Key/value)	List of specific preferences saved for that book (empty by default)
attributes	Dictionary (Key/List of Attribute)	Metadata
imageFiles	List of ImageFile	Pages / Pictures
chapters	List of Chapter	Chapters
errorRecords	List of ErrorRecord	Errors encountered while downloading (only when the book is in the queue)
groups	List of Group	Groups
isFrozen	true/false	True if the book is in the frozen state (only when the book is in the queue)

Attribute

Intent

Describes a metadata element (i.e. a tag or an artist)

Corresponding class

JsonAttribute

Field	Format	Description
name	String	Name
type	AttributeType	One of the values of the enum (e.g. "TAG")
url	URL	URL of the dedicated page on the website

ImageFile

Intent

Describes an image / a page of the book

Corresponding class

JsonImageFile

Field	Format	Description
order	Positive Integer	Order of the page
url	URL	URL of the image on the website you got it from
pageUrl	URL	URL of the page where the image was located on the website you got it from
name	String	Name of the image (usually the order)
isCover	true/false	True if the image should be used as the cover thumb (it won't be displayed by the reader)
favourite	true/false	True if the image has been favourited
isRead	true/false	True if the image has been read
status	StatusContent	One of the values of the enum (e.g. "DOWNLOADED")
mimeType	String	MIME-type of the image
pHash	Integer	Perceptive hash of the image; used to detect duplicates (default:0)
isTransformed	true/false	True if the image has been transformed at least once
chapterOrder	Positive integer	Order of the chapter the image is attached to (default:0)

Chapter

Intent

Describes an chapter of the book

Corresponding class

JsonChapter

Field	Format	Description
order	Positive Integer	Order of the page
url	URL	URL of the image on the website you got it from
name	String	Title of the chapter
uniqueId	String	Unique ID of this chapter (default:order)

Group

Intent

Describes a group of books

Corresponding class

JsonGroupItem

Field	Format	Description
groupingId	Positive Integer	Category; usually 98 for Custom Group
groupName	String	Name of the group
order	Positive Integer	Order of the group in its category (default:-1 if the groups have never been reordered)