Search API

Perform searches.

Search Archives

get

Search for Archives. You can use the IDs of this JSON with the other endpoints.

Query parameters

categorystring · min: 14 · max: 14Optional

ID of the category you want to restrict this search to.

filterstringOptional

Search query. You can use the following special characters in it:

Quotation Marks ("...") Exact string search. Allows a search term to include spaces. Everything placed inside a pair of quotation marks is treated as a singular term. Wildcard characters are still interpreted as wildcards.

Question Mark (?), Underscore (_) Wildcard. Can match any single character.

Asterisk (*), Percentage Sign (%) Wildcard. Can match any sequence of characters (including none).

Subtraction Sign (-) Exclusion. When placed before a term, prevents search results from including that term.

Dollar Sign ($) Add at the end of a tag to perform an exact tag search rather than displaying all elements that start with the term. Only matches tags regardless of search parameters and can be used as an exclusion to ignore misc tags in the search query.

startintegerOptional

From which archive in the total result count this enumeration should start. The total number of archives displayed depends on the server-side page size preference.

From 0.8.2 onwards, you can use "-1" here to get the full, unpaged data.

sortbystringOptional

Namespace by which you want to sort the results. There are specific sort keys you can use:

• title if you want to sort by title
• lastread if you want to sort by last read time. (If Server-side Progress Tracking is enabled)

(Default value is title. If you sort by lastread, IDs that have never been read will be removed from the search.)

orderstringOptional

Order of the sort, either asc or desc.

newonlybooleanOptional

Limit search to new archives only.

untaggedonlybooleanOptional

Limit search to untagged archives only.

groupby_tanksbooleanOptional

Enable or disable Tankoubon grouping. Defaults to true. When enabled, Tankoubons will show in search results, replacing all the archive IDs they contain.

Responses

200

Search results

application/json

204

Search engine is not initialized yet. Please wait a few seconds.

get

/search

HTTPcURLJavaScriptPython

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

{
  "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
    },
    {
      "arcid": "28697b96f0ac5858be2614ed10ca47742c9522fd",
      "isnew": false,
      "extension": "rar",
      "pagecount": 34,
      "progress": 3,
      "tags": "parody:jojo's bizarre adventure",
      "lastreadtime": 1337038281,
      "title": "Rohan Kishibe goes to Gucci",
      "filename": "Gucc",
      "summary": "cool summary"
    }
  ],
  "recordsFiltered": 2,
  "recordsTotal": 2
}

Search random Archives

get

Get randomly selected Archives from the given filter and/or category.

Query parameters

categorystring · min: 14 · max: 14Optional

ID of the category you want to restrict this search to.

filterstringOptional

Search query. This follows the same rules as the queries in /api/search.

countintegerOptional

How many archives you want to pull randomly. Defaults to 5.

If the search doesn't return enough data to match your count, you will get the full search shuffled randomly.

newonlybooleanOptional

Limit search to new archives only.

untaggedonlybooleanOptional

Limit search to untagged archives only.

groupby_tanksbooleanOptional

Enable or disable Tankoubon grouping. Defaults to true. When enabled, Tankoubons will show in search results, replacing all the archive IDs they contain.

Responses

200

Search results

application/json

get

/search/random

HTTPcURLJavaScriptPython

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

200

Search results

{
  "data": [
    {
      "arcid": "28697b96f0ac5858be2614ed10ca47742c9522fd",
      "isnew": false,
      "extension": "rar",
      "pagecount": 34,
      "progress": 3,
      "tags": "parody:jojo's bizarre adventure",
      "lastreadtime": 1337038281,
      "title": "Rohan Kishibe goes to Gucci",
      "filename": "Gucc",
      "summary": "cool summary"
    }
  ],
  "recordsTotal": 2
}

🔑 Discard Search Cache

delete

Discard the cache containing previous user searches.

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Responses

200

Success response

application/json

400

No archive ID response

application/json

delete

/search/cache

HTTPcURLJavaScriptPython

DELETE /api/search/cache HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

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