back to index
GET portal/browse
Parameters
The parameters are:
The search API will return an Atom formatted XML file, as mimetype 'application/atom+xml.' This feed will contain links to previous and next pages, if the results are paginated. Results will appear as Atom entry elements with two links: one as a link element specifying a ReadIt URL (jumps right into book), and the other as an id element containing a permalink to the book's detail page. To get the id of a book from the link element, take the numeral after the last forward slash in the url. The book id can then be used in combination with other API features.
Caveat
You may access this URL from anywhere on the Web, as long as you don't make an excessive number of requests in a given time period (no more than one request every 3 seconds). Any IP address violating these limits will be permanently blacklisted from our server.
Disclaimer
This API is provided as a free service, with no guarantees or liability.
The search API is for anyone developing applications that would like access to the BookGlutton catalog.
API Details
EndpointGET portal/browse
Parameters
The parameters are:
- q (REQUIRED): Search term. This can be any word or phrase.
- fmt: Format to receive results. Currently defaults to Atom XML. For best results with future versions, specify 'atom' for this parameter.
- page: Page number, for paged results. The Atom feed itself will contain links with this parameter in them, so including it in initial requests is not necessary
The search API will return an Atom formatted XML file, as mimetype 'application/atom+xml.' This feed will contain links to previous and next pages, if the results are paginated. Results will appear as Atom entry elements with two links: one as a link element specifying a ReadIt URL (jumps right into book), and the other as an id element containing a permalink to the book's detail page. To get the id of a book from the link element, take the numeral after the last forward slash in the url. The book id can then be used in combination with other API features.
Caveat
You may access this URL from anywhere on the Web, as long as you don't make an excessive number of requests in a given time period (no more than one request every 3 seconds). Any IP address violating these limits will be permanently blacklisted from our server.
Disclaimer
This API is provided as a free service, with no guarantees or liability.
