Skip to content

API.md

Latest commit

 

History

History
76 lines (55 loc) · 2.54 KB

API.md

File metadata and controls

76 lines (55 loc) · 2.54 KB

iTunes Search API

Overview

The Search API allows you to place search fields in your website to search for content within the iTunes Store, App Store, iBooks Store and Mac App Store. You can search for a variety of content; including apps, iBooks, movies, podcasts, music, music videos, audiobooks, and TV shows.

Searching

A fully-qualified URL to search must have the following format:

https://itunes.apple.com/search?parameterkeyvalue

Where parameterkeyvalue can be one or more parameter key and value pairs indicating the details of your query.

To construct a parameter key and value pair, you must concatenate each parameter key with an equal sign (=) and a value string. For example: key1=value1. To create a string of parameter key and value pairs, you must concatenate each pair using an ampersand (&). For example:

key1=value1&key2=value2&key3=value3

Parameters

The following table defines the parameter keys and values you can specify to search for content within the iTunes Store, App Store, iBooks Store and Mac App Store:

<tr>
    <td>term</td>
    <td>The URL-encoded text string you want to search for.<br><br>
        For example : 'jack+johnson'</td>
    <td>Y</td>
    <td>Any URL-encoded text string.

Note: URL encoding replaces spaces with the plus (+) character and all characters except the following are encoded: letters, numbers, periods (.), dashes (-), underscores (_), and asterisks (*). 

<tr>
    <td>country</td>
    <td>The two-letter country code for the store you want to search. The search uses the default store front for the specified country. <br><br>
    For example : 'US'<br>
    The default is 'US'</td>
    <td>N</td>
    <td>See http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for a list of ISO Country Codes.</td>
</tr>

<tr>
    <td>media</td>
    <td>The media type you want to search for.<br><br> 
        For example : 'movie'<br>
        The default is 'all'</td>
    <td>N</td>
    <td>movie, podcast, music, musicVideo, audiobook, shortFilm, tvShow, software, ebook, all</td>
</tr>

<tr>
    <td>limit</td>
    <td>The number of search results you want the iTunes Store to return.<br><br> 
        For example : 25<br>
        The default is 50</td>
    <td>N</td>
    <td>1 to 200</td>
</tr>
Parameter Key Description Required Values