LibriVoxAPI: Difference between revisions

From Librivox wiki
Jump to navigationJump to search
(Removed old API info (but saved locally if needed) and added link to new API)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The following API exist for software integration with the LibriVox Catalog
September 11, 2013: The new API is under development, and information on the new API is available at [http://librivox.org/api/info http://librivox.org/api/info].
 
 
== Downloading the whole catalog ==
 
The most friendly way to get at the whole catalog is to page your way through it. The preferred API for doing this is:
 
<code>http://librivox.org/newcatalog/latestworks.xml?offset=0&limit=50</code>
 
<code>offset</code> and <code>limit</code> are optional parameters, defaulting to 0 and 50 respectively, and work like the SQL search parameters of the same names. The list of latest works is ordered from the most recent.
 
Most integrators have walked their way once through the back catalog with this API, and then periodically call it with <code>offset=0</code> to get new works. If you do this, it's worth knowing that the id parameter in the book tag uniquely identifies a work.
 
If you prefer OPML, there is a much less data-rich option that will give you the whole catalog in one hit.
 
<code>http://librivox.org/newcatalog/latestworks.opml?v=2</code>
 
== Searching the catalog ==
 
By far the most integration-friendly way to search the catalog is:
 
<code>http://librivox.org/newcatalog/search_xml.php?extended=1&simple=Austen</code>
 
The <code>simple</code> parameter can take multiple terms (logical AND), and is used to search Author, Title, language, genre, category and maybe some other stuff.
 
If you know the id of a work you can also use <code>id=xxxx</code> in place of <code>simple</code>.
 
== Accessing individual audio files ==
 
All of the above ways of finding works provide you with an RssURL. Use it!
 
== MARC21 ==
 
This is really experimental at the moment, but you can try
 
<code>http://librivox.org/newcatalog/MARC21/marc.pl?pid=xxxx</code>
 
where xxxx is a project ID (probably extracted from the xml calls above) to get a machine readable MARC21 record. Alternatively, add <code>&human=1</code> to get a human readable form.
 
== Finding out more ==
 
These APIs have been developed in response to particular requests. If you'd like more information, or have a particular request we might be able to help with, email info@librivox.org.

Latest revision as of 18:51, 11 September 2013

September 11, 2013: The new API is under development, and information on the new API is available at http://librivox.org/api/info.