Method: Book Charts

Returns book charts for a given time frame (i.e., top 10 audiobooks this month by "number of downloads"). Results are sorted and filtered.

Request URL

The object is book and the action is charts. The base request URL is:

http://api.emusic.com/book/charts?apiKey=myKey

Request Parameters

Following is a list of required and optional query string parameters for the Book Charts method. For more information about individual request parameters, see request parameters.
Name Required Default Description
apiKey YES none The developer API key. This is required for all methods.
filter no downloadedThisMonth The charts filter. Recommended values: downloadedThisMonth, downloadedThisWeek, downloadedToday
primarySort no bookDownloadsMonth The charts sort. Recommended values: bookDownloadsMonth, bookDownloadsWeek, bookDownloadsToday
primaryAscending no false The charts sort direction. Note that a "top 10" chart would use a primaryAscending value of "false" (largest to least number of downloads...).
page no 1 The starting page index of returned books. (Used for paginating through longer result lists.)
perPage no 20 The number of books to return per page.
format no XML The format of the response (XML, JSON, JSONP).
callback depends none The name of the JavaScript callback method for the JSONP format. (Required for JSONP responses only.)
fref no none The eMusic partner tag. If provided, the FREF value is automatically added to all appropriate eMusic links.
Example Requests

// Returns audiobook charts (all default values).
http://api.emusic.com/book/charts?apiKey=myKey

// Returns top audiobooks for the week.
http://api.emusic.com/book/charts?apiKey=myKey&primaryFilter=downloadedThisWeek&primarySort=bookDownloadsWeek

Response Format

Following is a list of returned elements for the Book Charts method. For more information about individual response elements, see Response Elements.
Name Type Returned Description
status status always Contains a result code.
messages list on error Contains one or more messages.
options options on ok Contains a list of method options.
browse browse on ok Contains the <browse> filters and sorts.
view view on ok Contains the paginate result counts.
tracks list on ok Contains a paged list of charted books, filtered and sorted by the given criteria. See the example response below for typical audiobook elements.
Example Response

(Only five elements are displayed in each list...)

<?xml version="1.0" encoding="UTF-8"?>
<response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status code="200">ok</status>
    <options format="xml"/>
    <browse country="US" primaryAscending="false" primarySort="bookDownloadsMonth" secondarySort="author" type="book"/>
    <view page="1" pages="255" perPage="20" total="5083"/>
    <books list="true" size="20">
        <book abridged="false" added="2008-10-07" editorsPick="true" exclusive="false" fiction="false" id="10022288" image="http://images.emusic-test.com/books/images/book/0/100/222/10022288/300x300.jpg" length="26079" name="The Wordy Shipmates" sample="http://www.emusic.com/samples/m3u/book/10022288/0.m3u" url="http://www.emusic.com/audiobooks/book/Tom-McCarthy-2-The-Wordy-Shipmates-MP3-Download/10022288.html">
            <genre id="1006" name="History" url="http://www.emusic.com/genre/1006.html"/>
            <author id="12168649" name="Tom McCarthy (2)" url="http://www.emusic.com/audiobooks/author/Tom-McCarthy-2-MP3-Download/12168649.html"/>
            <narrator id="11826607" name="Eric Bogosian" url="http://www.emusic.com/audiobooks/narrator/Eric-Bogosian-MP3-Download/11826607.html"/>
            <publisher id="341" name="Simon &amp; Schuster, Inc.">
                <imprint id="601" name="Audioworks"/>
            </publisher>
        </book>
        <book abridged="false" added="2008-06-12" editorsPick="true" exclusive="false" fiction="false" id="10018622" image="http://images.emusic-test.com/books/images/book/0/100/186/10018622/300x300.jpg" length="32551" name="When You Are Engulfed in Flames" sample="http://www.emusic.com/samples/m3u/book/10018622/0.m3u" url="http://www.emusic.com/audiobooks/book/David-Sedaris-When-You-Are-Engulfed-in-Flames-MP3-Download/10018622.html">
            <genre id="1085" name="Essays" url="http://www.emusic.com/genre/1085.html"/>
            <author id="11860957" name="David Sedaris" url="http://www.emusic.com/audiobooks/author/David-Sedaris-MP3-Download/11860957.html"/>
            <narrator id="11860957" name="David Sedaris" url="http://www.emusic.com/audiobooks/narrator/David-Sedaris-MP3-Download/11860957.html"/>
            <publisher id="101" name="Hachette Group">
                <imprint id="121" name="Hachette Audio"/>
            </publisher>
        </book>
        <book abridged="true" added="2008-07-01" editorsPick="false" exclusive="false" fiction="true" id="10017708" image="http://images.emusic-test.com/books/images/book/0/100/177/10017708/300x300.jpg" length="13353" name="The Hobbit" sample="http://www.emusic.com/samples/m3u/book/10017708/0.m3u" url="http://www.emusic.com/audiobooks/book/J-R-R-Tolkien-The-Hobbit-MP3-Download/10017708.html">
            <genre id="1026" name="20th Century Classics" url="http://www.emusic.com/genre/1026.html"/>
            <author id="11826830" name="J. R. R. Tolkien" url="http://www.emusic.com/audiobooks/author/J-R-R-Tolkien-MP3-Download/11826830.html"/>
            <narrator id="12004763" name="Full Cast - The Hobbit" url="http://www.emusic.com/audiobooks/narrator/Full-Cast-The-Hobbit-MP3-Download/12004763.html"/>
            <publisher id="241" name="BBC Audiobooks Ltd">
                <imprint id="501" name="BBC Audio"/>
            </publisher>
        </book>
        <book abridged="false" added="2007-09-17" editorsPick="true" exclusive="false" fiction="true" id="10001009" image="http://images.emusic-test.com/books/images/book/0/100/010/10001009/300x300.jpg" length="21071" name="The Hitchhiker's Guide To The Galaxy" sample="http://www.emusic.com/samples/m3u/book/10001009/0.m3u" url="http://www.emusic.com/audiobooks/book/Douglas-Adams-The-Hitchhiker-s-Guide-To-The-Galaxy-MP3-Download/10001009.html">
            <genre id="1036" name="Humor" url="http://www.emusic.com/genre/1036.html"/>
            <author id="11826661" name="Douglas Adams" url="http://www.emusic.com/audiobooks/author/Douglas-Adams-MP3-Download/11826661.html"/>
            <narrator id="11826835" name="Stephen Fry" url="http://www.emusic.com/audiobooks/narrator/Stephen-Fry-MP3-Download/11826835.html"/>
            <publisher id="41" name="Random House Inc.">
                <imprint id="41" name="Random House Audio"/>
            </publisher>
        </book>
        <book abridged="false" added="2008-07-11" editorsPick="false" exclusive="false" fiction="false" id="10021189" image="http://images.emusic-test.com/books/images/book/0/100/211/10021189/300x300.jpg" length="27030" name="The Now Habit" sample="http://www.emusic.com/samples/m3u/book/10021189/0.m3u" url="http://www.emusic.com/audiobooks/book/Neil-Fiore-The-Now-Habit-MP3-Download/10021189.html">
            <genre id="1002" name="Business &amp;amp; Economics" url="http://www.emusic.com/genre/1002.html"/>
            <author id="12030720" name="Neil Fiore" url="http://www.emusic.com/audiobooks/author/Neil-Fiore-MP3-Download/12030720.html"/>
            <narrator id="12030720" name="Neil Fiore" url="http://www.emusic.com/audiobooks/narrator/Neil-Fiore-MP3-Download/12030720.html"/>
            <publisher id="401" name="Gildan Media">
                <imprint id="721" name="Gildan Media"/>
            </publisher>
        </book>
    </books>
</response>    

version 2 as of 2 years ago by eMusic Admin

0 Comments

Please sign in to post a comment.