Tankoubon API

Endpoints related to Tankoubons.

Get all Tankoubons

get

Get list of Tankoubons paginated.

Query parameters

pageintegerOptional

Page of the list of Tankoubons.
The amount of tanks per page depends on the server archives_per_page setting.

Responses

200

Tankoubons

application/json

totalintegerOptional

Total count of Tankoubons on the server

filteredintegerOptional

Number of Tankoubons on the current page

get/tankoubons

GET /api/tankoubons HTTP/1.1
Host: lrr.tvc-16.science
Accept: */*

200

Tankoubons

{
  "result": [
    {
      "id": "TANK_1749925516",
      "name": "sailor moon",
      "summary": "",
      "tags": "",
      "archives": [
        "e69e43e1355267f7d32a4f9b7f2fe108d2401ebf",
        "e69e43e1355267f7d32a4f9b7f2fe108d2401ebg"
      ],
      "progress": 0
    }
  ],
  "total": 1,
  "filtered": 1
}

🔑 Create a Tankoubon

put

Create a new Tankoubon or update the name of an existing one.

Authorizations

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Body

namestringRequired

Name of the Tankoubon

tankidstringOptional

ID of an existing Tankoubon, if you want to change its name.

Responses

200

Success response

application/json

operationstring · enumOptionalPossible values:

tankoubon_idstringOptional

ID of the created/modified Tankoubon

successinteger · enumOptionalPossible values:

400

Error response

application/json

put/tankoubons

PUT /api/tankoubons HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 31

"name='text'&tankid='text'"

{
  "operation": "create_tankoubon",
  "tankoubon_id": "text",
  "success": 0
}

Get a single Tankoubon

get

Get the details of the specified tankoubon ID.

Path parameters

idstringRequired

ID of the Tankoubon desired

Responses

200

Tankoubon

application/json

idstringOptional

ID of this Tankoubon.

namestringOptional

Name of this Tankoubon.

summarystringOptional

tagsstringOptional

archivesone of[]Optional

Full list of archive IDs contained in this Tankoubon.

any · min: 40 · max: 40OptionalPattern: ^[0-9a-f]{40}$

any · min: 15 · max: 15OptionalPattern: ^TANK_[0-9]{10}$

progressintegerOptional

Reading progress (page number) for this Tankoubon.

400

Error response

application/json

get/tankoubons/{id}

GET /api/tankoubons/{id} HTTP/1.1
Host: lrr.tvc-16.science
Accept: */*

{
  "id": "text",
  "name": "text",
  "summary": "text",
  "tags": "text",
  "archives": [
    null
  ],
  "progress": 1
}

Get a single Tankoubon with full detail

get

Get the details of the specified tankoubon ID with paginated archive metadata. The amount of archives per page depends on the server archives_per_page setting.

Path parameters

idstringRequired

ID of the Tankoubon desired

Query parameters

pageintegerOptional

Page of the Archives list. Defaults to -1, which returns all archives.

Default: -1

Responses

200

Tankoubon

application/json

totalintegerOptional

The total amount of archives in this Tankoubon.

filteredintegerOptional

The amount of archives in the current page.

400

Error response

application/json

get/tankoubons/{id}/full

GET /api/tankoubons/{id}/full HTTP/1.1
Host: lrr.tvc-16.science
Accept: */*

{
  "result": {
    "id": "text",
    "name": "text",
    "summary": "text",
    "tags": "text",
    "progress": 1,
    "archives": [
      null
    ],
    "full_data": [
      {
        "arcid": "28697b96f0ac5858be2614ed10ca47742c9522fd",
        "isnew": false,
        "extension": "rar",
        "pagecount": 34,
        "progress": 3,
        "tags": "parody:fate grand order,  group:wadamemo,  artist:wada rco,  artbook,  full color",
        "lastreadtime": 1337038281,
        "title": "Fate GO MEMO",
        "filename": "Fate GO MEMO",
        "summary": null,
        "size": 1234567,
        "toc": [
          {
            "name": "Chapter 1",
            "page": 1
          },
          {
            "name": "Chapter 2",
            "page": 13
          },
          {
            "name": "Chapter 3",
            "page": 25
          }
        ]
      }
    ]
  },
  "total": 1,
  "filtered": 1
}

🔑 Update Tankoubon metadata/contents

put

Modify the full metadata (name, summary, additional tags) or the contents of a Tankoubon. If you only need to change the name of Tank, consider just using PUT /api/tankoubons.

Note: If there is no need to update something in one of the data keys, do not send the key -- This otherwise can result in unwanted results.

Authorizations

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters

idstringRequired

ID of the Tankoubon desired

Body

archivesstring[]Optional

Ordered array with the IDs of the archives.

Responses

200

Success response

application/json

operationstringRequired

Name of operation

errorstringOptional

Error message if any

successMessagestringOptional

Success message if any

successinteger · enumRequired

Returns 1 if operation was successful, else 0

Possible values:

400

Error response

application/json

423

The Tankoubon is currently locked for modification

application/json

put/tankoubons/{id}

PUT /api/tankoubons/{id} HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "archives": [
    "text"
  ],
  "metadata": {
    "name": "text",
    "summary": "text",
    "tags": "text",
    "append": true
  }
}

{
  "operation": "text",
  "error": "text",
  "successMessage": "text",
  "success": 0
}

🔑 Delete Tankoubon

delete

Remove a Tankoubon from the server. This doesn't delete underlying Archives.

Authorizations

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters

idstringRequired

ID of the Tankoubon desired

Responses

200

Success response

application/json

operationstringRequired

Name of operation

errorstringOptional

Error message if any

successMessagestringOptional

Success message if any

successinteger · enumRequired

Returns 1 if operation was successful, else 0

Possible values:

400

Error response

application/json

423

The Tankoubon is currently locked for modification

application/json

delete/tankoubons/{id}

DELETE /api/tankoubons/{id} HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

{
  "operation": "text",
  "error": "text",
  "successMessage": "text",
  "success": 0
}

🔑 Add an Archive to a Tankoubon

put

Append an archive at the final position of a Tankoubon.

Authorizations

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters

idstringRequired

ID of the Tankoubon to update.

archivestring · min: 40 · max: 40Required

ID of the Archive to append.

Responses

200

Success response

application/json

operationstringRequired

Name of operation

errorstringOptional

Error message if any

successMessagestringOptional

Success message if any

successinteger · enumRequired

Returns 1 if operation was successful, else 0

Possible values:

400

Error response

application/json

423

The Tankoubon is currently locked for modification

application/json

put/tankoubons/{id}/{archive}

PUT /api/tankoubons/{id}/{archive} HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

{
  "operation": "text",
  "error": "text",
  "successMessage": "text",
  "success": 0
}

🔑 Remove an Archive from a Tankoubon

delete

Authorizations

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters

idstringRequired

ID of the Tankoubon to update.

archivestring · min: 40 · max: 40Required

ID of the Archive to remove.

Responses

200

Result

application/json

operationstringRequired

Name of operation

errorstringOptional

Error message if any

successMessagestringOptional

Success message if any

successinteger · enumRequired

Returns 1 if operation was successful, else 0

Possible values:

400

Error response

application/json

423

The Tankoubon is currently locked for modification

application/json

delete/tankoubons/{id}/{archive}

DELETE /api/tankoubons/{id}/{archive} HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

{
  "operation": "text",
  "error": "text",
  "successMessage": "text",
  "success": 0
}

Get Tankoubon thumbnail

get

Get the cover thumbnail for a given Tankoubon. By default, the thumbnail is sourced from the first page of the first archive. This endpoint will return a placeholder image if it doesn't already exist. If you want to queue generation of the thumbnail in the background, you can use the no_fallback query parameter.

Path parameters

idstringRequired

ID of the Tankoubon desired

Query parameters

no_fallbackstring · enumOptional

Disables the placeholder image, queues the thumbnail for extraction and returns a JSON with code 202. This parameter does nothing if the image already exists. (You will get the image with code 200 no matter what)

Possible values:

Responses

200

If the thumbnail was already extracted, you get it directly.

application/octet-stream

string · binaryOptional

202

The thumbnail is queued for extraction. Use /api/minion/:jobid to track when your thumbnail is ready.

application/json

400

Error response

application/json

get/tankoubons/{id}/thumbnail

GET /api/tankoubons/{id}/thumbnail HTTP/1.1
Host: lrr.tvc-16.science
Accept: */*

binary

🔑 Update Tankoubon thumbnail

put

Set the cover thumbnail for the given Tankoubon using a global page number that spans all archives in the tank (in order). The global page is translated to the correct archive and local page automatically.

Authorizations

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters

idstringRequired

ID of the Tankoubon desired

Query parameters

pageinteger · min: 1Required

Global 1-indexed page number across all archives in the tankoubon. Page 1 is the first page of the first archive, and so on.

Responses

200

Tankoubon thumbnail updated

application/json

operationstring · enumOptionalPossible values:

successinteger · enumOptionalPossible values:

new_thumbnailstringOptional

Path to the new thumbnail file

400

Error response

application/json

put/tankoubons/{id}/thumbnail

PUT /api/tankoubons/{id}/thumbnail?page=1 HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

{
  "operation": "update_tankoubon_thumbnail",
  "success": 0,
  "new_thumbnail": "text"
}

Update Tankoubon reading progression

put

Tell the server which page of this Tankoubon you're currently reading, so that it updates its internal reading progression accordingly. The page number is global across all Archives in the tank (If a tank has two Archives with 20 and 25 pages, page 26 will be page 6 in Archive #2). ⚠ If the server is configured to use clientside progress tracking, this API call will return an error! Make sure to check using /api/info whether the server tracks reading progression or not before calling this endpoint.

Path parameters

idstring · min: 15 · max: 15Required

ID of the Tankoubon to update.

pageinteger · min: 1Required

Global 1-indexed page number to update the reading progress to. Must be a positive integer.

Responses

200

Success response

application/json

idstring · min: 15 · max: 15Optional

ID of the tankoubon updated

operationstring · enumOptional

Name of the operation

Possible values:

pageintegerOptional

Updated reading progress

lastreadtimeintegerOptional

Last read time in epoch seconds

successinteger · enumOptional

Returns 1 if successful, else 0

Possible values:

400

Generic error response

application/json

401

Authentication required when authprogress is enabled

application/json

put/tankoubons/{id}/progress/{page}

PUT /api/tankoubons/{id}/progress/{page} HTTP/1.1
Host: lrr.tvc-16.science
Accept: */*

{
  "id": "TANK_1589141306",
  "operation": "update_tank_progress",
  "page": 5,
  "lastreadtime": 123943543,
  "success": 1
}

PreviousCategory API NextStamps API

Last updated 4 days ago