Search API
Perform searches.
Search the Archive Index
GET
http://lrr.tvc-16.science/api/search
Search for Archives. You can use the IDs of this JSON with the other endpoints.
Query Parameters
category
string
ID of the category you want to restrict this search to.
filter
string
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.
start
string
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.
sortby
string
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.)
order
string
Order of the sort, either asc
or desc
.
Get Random Archives out of the Index
GET
http://lrr.tvc-16.science/api/search/random
Get randomly selected Archives from the given filter and/or category.
Query Parameters
category
string
ID of the category you want to restrict this search to.
filter
string
Search query. This follows the same rules as the queries in /api/search
.
count
int
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.
🔑 Discard Search Cache
DELETE
http://lrr.tvc-16.science/api/search/cache
Discard the cache containing previous user searches.
Last updated