Miscellaneous other API

Other APIs that don't fit a dedicated theme.

Get Server Information

GET http://lrr.tvc-16.science/api/info

Returns some basic information about the LRR instance this server is running.

{
    "name":"LANraragi",
    "motd":"Welcome to this Library running LANraragi !",
    "version":"0.7.0",
    "version_name":"Cat People (Putting Out Fire)",
    "version_desc":"aye lads time to read some manga",
    "total_pages_read":"13",
    "has_password": "1",
    "debug_mode":"1",
    "nofun_mode":"0",
    "archives_per_page":"100",
    "server_resizes_images":"0",
    "server_tracks_progress":"1",
    "cache_last_cleared":"1601474241"
}

Get the OPDS Catalog

GET http://lrr.tvc-16.science/api/opds

Get the Archive Index as an OPDS 1.2 Catalog with PSE 1.1 compatibility.

Path Parameters

Name Type Description

Name	Type	Description
id	string	ID of an archive. Passing this will show only one `<entry\>` for the given ID in the result, instead of all the archives.

string

ID of an archive. Passing this will show only one <entry\> for the given ID in the result, instead of all the archives.

Query Parameters

Name	Type	Description
category	string	Category ID. If passed, the OPDS catalog will be filtered to only show archives from this category.

Name

Type

Description

category

string

Category ID. If passed, the OPDS catalog will be filtered to only show archives from this category.

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" 
    xmlns:dcterms="http://purl.org/dc/terms/"
    xmlns:opds="http://opds-spec.org/2010/catalog" 
    xmlns:pse="http://vaemendis.net/opds-pse/ns">

    <id>urn:lrr:0</id>

    <link rel="self" href="/api/opds" type="application/atom+xml;profile=opds-catalog;kind=acquisition" />
    <link rel="start" href="/api/opds" type="application/atom+xml;profile=opds-catalog;kind=acquisition" />

    <title>LANraragi</title>
    <updated>2010-01-10T10:03:10Z</updated>
    <subtitle>Welcome to this Library running LANraragi!</subtitle>
    <icon>/favicon.ico</icon>
    <author>
        <name>9.9.9</name>
        <uri>http://github.org/Difegue/LANraragi</uri>
    </author>

    <link rel="http://opds-spec.org/facet" 
        href="/api/opds" 
        title="All Archives" 
        opds:facetGroup="Categories" 
        opds:activeFacet="true" />

    
    <link rel="http://opds-spec.org/facet" 
        href="/api/opds?category=SET_1589138380" 
        title="AMERICA ONRY"  
        opds:facetGroup="Categories" 
        />
    
    <link rel="http://opds-spec.org/facet" 
        href="/api/opds?category=SET_1589141306" 
        title="Segata Sanshiro"  
        opds:facetGroup="Categories" 
        thr:count="2" />
    

    
    <entry>
        <title>Fate GO MEMO</title>
        <id>urn:lrr:28697b96f0ac5858be2614ed10ca47742c9522fd</id>
        <updated>2010-01-10T10:01:11Z</updated>
        <published>2010-01-10T10:01:11Z</published>
        <author>
            <name>wada rco</name>
        </author>
        <rights></rights>
        <dcterms:language></dcterms:language>
        <dcterms:publisher>wadamemo</dcterms:publisher>
        <dcterms:issued></dcterms:issued>
        
        <category term="Archive" />
        
        <summary>parody:fate grand order,  group:wadamemo,  artist:wada rco,  artbook,  full color, male:very cool too</summary>

        <link rel="alternate" href="/api/opds/28697b96f0ac5858be2614ed10ca47742c9522fd"
            type="application/atom+xml;type=entry;profile=opds-catalog" />

        <link rel="http://opds-spec.org/image" href="/api/archives/28697b96f0ac5858be2614ed10ca47742c9522fd/thumbnail" type="image/jpeg" />
        <link rel="http://opds-spec.org/image/thumbnail" href="/api/archives/28697b96f0ac5858be2614ed10ca47742c9522fd/thumbnail"
            type="image/jpeg" />
        <link rel="http://opds-spec.org/acquisition" href="/api/archives/28697b96f0ac5858be2614ed10ca47742c9522fd/download" title="Download/Read"
            type="application/x-cbz" />
        <link rel="http://vaemendis.net/opds-pse/stream" type="image/jpeg"
            href="/api/opds/28697b96f0ac5858be2614ed10ca47742c9522fd/pse?page={pageNumber}" pse:count="1" />
        <link type="text/html" rel="alternate" title="Open in LANraragi" href="/reader?id=28697b96f0ac5858be2614ed10ca47742c9522fd" />
    </entry>
    
    <entry>
        <title>Fate GO MEMO 2</title>
        <id>urn:lrr:2810d5e0a8d027ecefebca6237031a0fa7b91eb3</id>
        <updated>2010-01-10T10:01:11Z</updated>
        <published>2010-01-10T10:01:11Z</published>
        <author>
            <name>wada rco</name>
        </author>
        <rights></rights>
        <dcterms:language></dcterms:language>
        <dcterms:publisher>wadamemo</dcterms:publisher>
        <dcterms:issued></dcterms:issued>
        
        <category term="Archive" />
        
        <summary>parody:fate grand order,  character:abigail williams,  character:artoria pendragon alter,  character:asterios,  character:ereshkigal,  character:gilgamesh,  character:hans christian andersen,  character:hassan of serenity,  character:hector,  character:helena blavatsky,  character:irisviel von einzbern,  character:jeanne alter,  character:jeanne darc,  character:kiara sessyoin,  character:kiyohime,  character:lancer,  character:martha,  character:minamoto no raikou,  character:mochizuki chiyome,  character:mordred pendragon,  character:nitocris,  character:oda nobunaga,  character:osakabehime,  character:penthesilea,  character:queen of sheba,  character:rin tosaka,  character:saber,  character:sakata kintoki,  character:scheherazade,  character:sherlock holmes,  character:suzuka gozen,  character:tamamo no mae,  character:ushiwakamaru,  character:waver velvet,  character:xuanzang,  character:zhuge liang,  group:wadamemo,  artist:wada rco,  artbook,  full color</summary>

        <link rel="alternate" href="/api/opds/2810d5e0a8d027ecefebca6237031a0fa7b91eb3"
            type="application/atom+xml;type=entry;profile=opds-catalog" />

        <link rel="http://opds-spec.org/image" href="/api/archives/2810d5e0a8d027ecefebca6237031a0fa7b91eb3/thumbnail" type="image/jpeg" />
        <link rel="http://opds-spec.org/image/thumbnail" href="/api/archives/2810d5e0a8d027ecefebca6237031a0fa7b91eb3/thumbnail"
            type="image/jpeg" />
        <link rel="http://opds-spec.org/acquisition" href="/api/archives/2810d5e0a8d027ecefebca6237031a0fa7b91eb3/download" title="Download/Read"
            type="application/x-cbz" />
        <link rel="http://vaemendis.net/opds-pse/stream" type="image/jpeg"
            href="/api/opds/2810d5e0a8d027ecefebca6237031a0fa7b91eb3/pse?page={pageNumber}" pse:count="34"  pse:lastRead="34" />
        <link type="text/html" rel="alternate" title="Open in LANraragi" href="/reader?id=2810d5e0a8d027ecefebca6237031a0fa7b91eb3" />
    </entry>
    
    <entry>
        <title>Ghost in the Shell 1.5 - Human-Error Processor vol01ch01</title>
        <id>urn:lrr:4857fd2e7c00db8b0af0337b94055d8445118630</id>
        <updated>2010-01-10T10:01:11Z</updated>
        <published>2010-01-10T10:01:11Z</published>
        <author>
            <name>shirow masamune</name>
        </author>
        <rights></rights>
        <dcterms:language></dcterms:language>
        <dcterms:publisher></dcterms:publisher>
        <dcterms:issued></dcterms:issued>
        
        <category term="Archive" />
        
        <summary>artist:shirow masamune</summary>

        <link rel="alternate" href="/api/opds/4857fd2e7c00db8b0af0337b94055d8445118630"
            type="application/atom+xml;type=entry;profile=opds-catalog" />

        <link rel="http://opds-spec.org/image" href="/api/archives/4857fd2e7c00db8b0af0337b94055d8445118630/thumbnail" type="image/jpeg" />
        <link rel="http://opds-spec.org/image/thumbnail" href="/api/archives/4857fd2e7c00db8b0af0337b94055d8445118630/thumbnail"
            type="image/jpeg" />
        <link rel="http://opds-spec.org/acquisition" href="/api/archives/4857fd2e7c00db8b0af0337b94055d8445118630/download" title="Download/Read"
            type="application/x-cbz" />
        <link rel="http://vaemendis.net/opds-pse/stream" type="image/jpeg"
            href="/api/opds/4857fd2e7c00db8b0af0337b94055d8445118630/pse?page={pageNumber}" pse:count="34"  pse:lastRead="34" />
        <link type="text/html" rel="alternate" title="Open in LANraragi" href="/reader?id=4857fd2e7c00db8b0af0337b94055d8445118630" />
    </entry>
    
    <entry>
        <title>Rohan Kishibe goes to Gucci</title>
        <id>urn:lrr:e4c422fd10943dc169e3489a38cdbf57101a5f7e</id>
        <updated>2010-01-10T10:01:11Z</updated>
        <published>2010-01-10T10:01:11Z</published>
        <author>
            <name></name>
        </author>
        <rights></rights>
        <dcterms:language></dcterms:language>
        <dcterms:publisher></dcterms:publisher>
        <dcterms:issued></dcterms:issued>
        
        <category term="New Archive" />
        
        <summary>parody: jojo&#39;s bizarre adventure</summary>

        <link rel="alternate" href="/api/opds/e4c422fd10943dc169e3489a38cdbf57101a5f7e"
            type="application/atom+xml;type=entry;profile=opds-catalog" />

        <link rel="http://opds-spec.org/image" href="/api/archives/e4c422fd10943dc169e3489a38cdbf57101a5f7e/thumbnail" type="image/jpeg" />
        <link rel="http://opds-spec.org/image/thumbnail" href="/api/archives/e4c422fd10943dc169e3489a38cdbf57101a5f7e/thumbnail"
            type="image/jpeg" />
        <link rel="http://opds-spec.org/acquisition" href="/api/archives/e4c422fd10943dc169e3489a38cdbf57101a5f7e/download" title="Download/Read"
            type="application/x-cbz" />
        <link rel="http://vaemendis.net/opds-pse/stream" type="image/jpeg"
            href="/api/opds/e4c422fd10943dc169e3489a38cdbf57101a5f7e/pse?page={pageNumber}" pse:count="10" />
        <link type="text/html" rel="alternate" title="Open in LANraragi" href="/reader?id=e4c422fd10943dc169e3489a38cdbf57101a5f7e" />
    </entry>
    
    <entry>
        <title>Saturn Backup Cartridge - American Manual</title>
        <id>urn:lrr:e69e43e1355267f7d32a4f9b7f2fe108d2401ebg</id>
        <updated>2010-01-10T10:01:11Z</updated>
        <published>2010-01-10T10:01:11Z</published>
        <author>
            <name></name>
        </author>
        <rights></rights>
        <dcterms:language></dcterms:language>
        <dcterms:publisher></dcterms:publisher>
        <dcterms:issued></dcterms:issued>
        
        <category term="Archive" />
        
        <summary>character:segata, female:very cool too</summary>

        <link rel="alternate" href="/api/opds/e69e43e1355267f7d32a4f9b7f2fe108d2401ebg"
            type="application/atom+xml;type=entry;profile=opds-catalog" />

        <link rel="http://opds-spec.org/image" href="/api/archives/e69e43e1355267f7d32a4f9b7f2fe108d2401ebg/thumbnail" type="image/jpeg" />
        <link rel="http://opds-spec.org/image/thumbnail" href="/api/archives/e69e43e1355267f7d32a4f9b7f2fe108d2401ebg/thumbnail"
            type="image/jpeg" />
        <link rel="http://opds-spec.org/acquisition" href="/api/archives/e69e43e1355267f7d32a4f9b7f2fe108d2401ebg/download" title="Download/Read"
            type="application/x-cbz" />
        <link rel="http://vaemendis.net/opds-pse/stream" type="image/jpeg"
            href="/api/opds/e69e43e1355267f7d32a4f9b7f2fe108d2401ebg/pse?page={pageNumber}" pse:count="200"  pse:lastRead="34" />
        <link type="text/html" rel="alternate" title="Open in LANraragi" href="/reader?id=e69e43e1355267f7d32a4f9b7f2fe108d2401ebg" />
    </entry>
    
    <entry>
        <title>Saturn Backup Cartridge - Japanese Manual</title>
        <id>urn:lrr:e69e43e1355267f7d32a4f9b7f2fe108d2401ebf</id>
        <updated>2010-01-10T10:01:11Z</updated>
        <published>2010-01-10T10:01:11Z</published>
        <author>
            <name></name>
        </author>
        <rights></rights>
        <dcterms:language></dcterms:language>
        <dcterms:publisher></dcterms:publisher>
        <dcterms:issued></dcterms:issued>
        
        <category term="Archive" />
        
        <summary>character:segata sanshiro, male:very cool</summary>

        <link rel="alternate" href="/api/opds/e69e43e1355267f7d32a4f9b7f2fe108d2401ebf"
            type="application/atom+xml;type=entry;profile=opds-catalog" />

        <link rel="http://opds-spec.org/image" href="/api/archives/e69e43e1355267f7d32a4f9b7f2fe108d2401ebf/thumbnail" type="image/jpeg" />
        <link rel="http://opds-spec.org/image/thumbnail" href="/api/archives/e69e43e1355267f7d32a4f9b7f2fe108d2401ebf/thumbnail"
            type="image/jpeg" />
        <link rel="http://opds-spec.org/acquisition" href="/api/archives/e69e43e1355267f7d32a4f9b7f2fe108d2401ebf/download" title="Download/Read"
            type="application/x-cbz" />
        <link rel="http://vaemendis.net/opds-pse/stream" type="image/jpeg"
            href="/api/opds/e69e43e1355267f7d32a4f9b7f2fe108d2401ebf/pse?page={pageNumber}" pse:count="2"  pse:lastRead="10" />
        <link type="text/html" rel="alternate" title="Open in LANraragi" href="/reader?id=e69e43e1355267f7d32a4f9b7f2fe108d2401ebf" />
    </entry>
    

</feed>

🔑Get available plugins

GET http://lrr.tvc-16.science/api/plugins/:type

Get a list of the available plugins on the server, filtered by type.

Path Parameters

Name Type Description

Name	Type	Description
type*	string	Type of plugins you want to list. You can either use `login`, `metadata`, `script`, or `all` to get all previous types at once.

type*

string

Type of plugins you want to list. You can either use login, metadata, script, or all to get all previous types at once.

[
  {
    "author": "Difegue",
    "description": "Searches chaika.moe for tags matching your archive.",
    "icon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAACXBIWXMAAAsTAAALEwEAmpwYAAAA\nB3RJTUUH4wYCFQocjU4r+QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUH\nAAAEZElEQVQ4y42T3WtTdxzGn/M7J+fk5SRpTk7TxMZkXU84tTbVNrUT3YxO7HA4pdtQZDe7cgx2\ns8vBRvEPsOwFYTDYGJUpbDI2wV04cGXCGFLonIu1L2ptmtrmxeb1JDkvv121ZKVze66f74eH7/f5\nMmjRwMCAwrt4/9KDpflMJpPHvyiR2DPcJklJ3TRDDa0xk36cvrm8vDwHAAwAqKrqjjwXecPG205w\nHBuqa9rk77/d/qJYLD7cCht5deQIIczbgiAEKLVAKXWUiqVV06Tf35q8dYVJJBJem2A7Kwi2nQzD\nZig1CG93+PO5/KN6tf5NKpVqbsBUVVVFUUxwHJc1TXNBoxojS7IbhrnLMMx9pVJlBqFQKBKPxwcB\nkJYgjKIo3QCE1nSKoghbfJuKRqN2RVXexMaQzWaLezyeEUEQDjscjk78PxFFUYRkMsltJgGA3t7e\nyMLCwie6rr8iCILVbDbvMgwzYRjGxe0o4XC4s1AoHPP5fMP5/NNOyzLKAO6Ew+HrDADBbre/Ryk9\nnzx81FXJNlEpVpF+OqtpWu2MpmnXWmH9/f2umZmZi4cOHXnLbILLzOchhz1YerJAs9m1GwRAg2GY\nh7GYah488BJYzYW+2BD61AFBlmX/1nSNRqN9//792ujoaIPVRMjOKHoie3DytVGmp2fXCAEAjuMm\nu7u7Umosho6gjL/u/QHeEgvJZHJ2K/D+/fuL4+PjXyvPd5ldkShy1UXcmb4DnjgQj/fd5gDA6/XS\nYCAwTwh9oT3QzrS1+VDVi+vd3Tsy26yQVoFF3dAXJVmK96p9EJ0iLNOwKKU3CQCk0+lSOpP5WLDz\nF9Q9kZqyO0SloOs6gMfbHSU5NLRiUOuax2/HyZPHEOsLw2SbP83eu/fLxrkNp9P554XxCzVa16MC\n7+BPnTk9cfmH74KJE8nmga7Xy5JkZ8VKifGIHpoBb1VX8hNTd3/t/7lQ3OeXfFPvf/jBRw8ezD/a\n7M/aWq91cGgnJaZ2VcgSdnV1XRNNd3vAoBVVYusmnEQS65hfgSG6c+zy3Kre7nF/KrukcMW0Zg8O\nD08DoJutDxxOEb5IPUymwrq8ft1gLKfkFojkkRxemERCAQUACPFWRazYLJcrFGwQhyufbQQ7rFpy\nLMkCwGZC34qPIuwp+XPOjBFwazQ/txrdFS2GGS/Xuj+pUKLGk1Kjvlded3s72lyGW+PLbGVcmrAA\ngN0wTk1NWYODg9XOKltGtpazi5GigzroUnHN5nUHG1ylRsG7rDXHmnEpu4CeEtEKkqNc6QqlLc/M\n8uT5lLH5eq0aGxsju1O7GQB498a5s/0x9dRALPaQEDZnYwnhWJtMCCNrjeb0UP34Z6e/PW22zjPP\n+vwXBwfPvbw38XnXjk7GsiwKAIQQhjAMMrlsam45d+zLH6/8o6vkWcBcrXbVKQhf6bpucCwLjmUB\nSmmhXC419eblrbD/TAgAkUjE987xE0c7ZDmk66ajUCnq+cL63fErl25s5/8baQPaWLhx6goAAAAA\nSUVORK5CYII=",
    "name": "Chaika.moe",
    "namespace": "trabant",
    "oneshot_arg": "Chaika Gallery or Archive URL (Will attach matching tags to your archive)",
    "parameters": [
      {
        "desc": "Save archive title",
        "type": "bool"
      }
    ],
    "type": "metadata",
    "version": "2.1"
  },
  {
    "author": "Difegue",
    "description": "Apply custom tag modifications.",
    "name": "Tag Copier",
    "namespace": "copytags",
    "parameters": [
      {
        "desc": "Tags to copy, separated by commas.",
        "type": "string"
      }
    ],
    "type": "metadata",
    "version": "2.1"
  },
  {
    "author": "Utazukin",
    "description": "Adds the unix time stamp of the date the archive was added as a tag under the \"date_added\" namespace.",
    "name": "Date Added",
    "namespace": "DateAddedPlugin",
    "oneshot_arg": "Use file modified time (yes/true), or use current time (no/false). <br/>Leaving blank uses the global setting (default: current time)",
    "parameters": [
      {
        "desc": "Use file modified time instead of current time.",
        "type": "bool"
      }
    ],
    "type": "metadata",
    "version": "0.3"
  },
  {
    "author": "Difegue",
    "description": "Collects metadata embedded into your archives by the eze userscript. (info.json files)",
    "name": "eze",
    "namespace": "ezeplugin",
    "parameters": [
      {
        "desc": "Save archive title",
        "type": "bool"
      },
      {
        "desc": "Save the original title when available instead of the English or romanised title",
        "type": "bool"
      },
      {
        "desc": "Fetch additional timestamp (time posted) and uploader metadata",
        "type": "bool"
      }
    ],
    "type": "metadata",
    "version": "2.3"
  },
  {
    "author": "Pao",
    "description": "Collects metadata embedded into your archives by HDoujin Downloader's json or txt files.",
    "name": "Hdoujin",
    "namespace": "Hdoujinplugin",
    "parameters": [],
    "type": "metadata",
    "version": "0.5"
  },
  {
    "author": "CirnoT",
    "description": "Collects metadata embedded into your archives by the Koromo Copy downloader. (Info.json files)",
    "name": "koromo",
    "namespace": "koromoplugin",
    "parameters": [],
    "type": "metadata",
    "version": "1.1"
  },
  {
    "author": "Difegue",
    "description": "Searches nHentai for tags matching your archive."
    "name": "nHentai",
    "namespace": "nhplugin",
    "oneshot_arg": "nHentai Gallery URL (Will attach tags matching this exact gallery to your archive)",
    "parameters": [
      {
        "desc": "Save archive title",
        "type": "bool"
      }
    ],
    "type": "metadata",
    "version": "1.6"
  }
]

🔑Use a Plugin

POST http://lrr.tvc-16.science/api/plugins/use

Uses a Plugin and returns the result. If using a metadata plugin, the matching archive will not be modified in the database. See more info on Plugins in the matching section of the Docs.

Query Parameters

Name	Type	Description
key*	string	API Key, mandatory for this method.
plugin*	string	Namespace of the plugin to use.
id	string	ID of the archive to use the Plugin on. This is only mandatory for metadata plugins.
arg	string	Optional One-Shot argument to use when executing this Plugin.

Name

Type

Description

key*

string

API Key, mandatory for this method.

plugin*

string

Namespace of the plugin to use.

string

ID of the archive to use the Plugin on. This is only mandatory for metadata plugins.

arg

string

Optional One-Shot argument to use when executing this Plugin.

{
    "data":{
        "new_tags":" zawarudo"
        },
    "operation":"use_plugin",
    "success":1,
    "type":"metadata"
}

🔑Use a Plugin Asynchronously

POST http://lrr.tvc-16.science/api/plugins/queue

Uses a Plugin and returns a Minion Job ID matching the Plugin run. This endpoint is useful if you want to run longer-lived plugins which might timeout if ran with the standard endpoint.

Query Parameters

Name	Type	Description
key*	string	API Key, mandatory for this method.
plugin*	string	Namespace of the plugin to use.
id	string	ID of the archive to use the Plugin on. This is only mandatory for metadata plugins.
arg	string	Optional One-Shot argument to use when executing this Plugin.

Name

Type

Description

key*

string

API Key, mandatory for this method.

plugin*

string

Namespace of the plugin to use.

string

ID of the archive to use the Plugin on. This is only mandatory for metadata plugins.

arg

string

Optional One-Shot argument to use when executing this Plugin.

{
  "job": 86,
  "operation": "queue_plugin_exec",
  "success": 1,
}

🔑Clean the Temporary Folder

DELETE http://lrr.tvc-16.science/api/tempfolder

Cleans the server's temporary folder.

{
  "error": "",
  "newsize": 0.0,
  "operation": "cleantemp",
  "success": 1
}

🔑Queue a URL download

POST http://lrr.tvc-16.science/api/download_url

Add a URL to be downloaded by the server and added to its library.

Query Parameters

Name	Type	Description
url*	string	URL to download
catid	string	Category ID to add the downloaded URL to.

Name

Type

Description

url*

string

URL to download

catid

string

Category ID to add the downloaded URL to.

{
  "job": 86,
  "operation": "download_url",
  "success": 1,
  "url": "https:\/\/example.com"
}

🔑Regenerate Thumbnails

POST http://lrr.tvc-16.science/api/regen_thumbs

Queue a Minion job to regenerate missing/all thumbnails on the server.

Query Parameters

Name	Type	Description
force	boolean	Whether to generate all thumbnails, or only the missing ones.

Name

Type

Description

force

boolean

Whether to generate all thumbnails, or only the missing ones.

{
  "job": 3,
  "operation": "regen_thumbnails",
  "success": 1,
}

PreviousMinion API NextGetting started

Last updated 1 year ago