Tankoubon API | Nightly Release

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": [
    {
      "tankid": "TANK_1749925516",
      "name": "sailor moon",
      "archives": [
        "e69e43e1355267f7d32a4f9b7f2fe108d2401ebf",
        "e69e43e1355267f7d32a4f9b7f2fe108d2401ebg"
      ]
    }
  ],
  "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, with the archives list paginated. The amount of archives per page depends on the server archives_per_page setting.

Path parameters

idstringRequired

ID of the Tankoubon desired

Query parameters

include_full_databooleanOptional

If set to true, a full_data array will be added to the response with full Archive metadata.

pageintegerOptional

Page of the Archives list. You can use -1 to return all archives if needed.

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}

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

{
  "result": {
    "archives": [
      "text"
    ],
    "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 to update.

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/x-www-form-urlencoded
Accept: */*
Content-Length: 79

"archives=['text']&metadata={'name':'text','summary':'text','tags':'text'}"

{
  "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)>

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
}

hashtagGet all Tankoubons

hashtag🔑 Create a Tankoubon

hashtagGet a single Tankoubon

hashtag🔑 Update Tankoubon metadata/contents

hashtag🔑 Delete Tankoubon

hashtag🔑 Add an Archive to a Tankoubon

hashtag🔑 Remove an Archive from a Tankoubon

Get all Tankoubons

🔑 Create a Tankoubon

Get a single Tankoubon

🔑 Update Tankoubon metadata/contents

🔑 Delete Tankoubon

🔑 Add an Archive to a Tankoubon

🔑 Remove an Archive from a Tankoubon