search_apple {appler}R Documentation

Apple Store Search

Description

Using Apple's iTunes API, will find any content available from Apple based on a given search term.

Usage

search_apple(
  term,
  country = NULL,
  media = NULL,
  entity = NULL,
  attribute = NULL,
  limit = NULL,
  lang = c("en_us", "ja_jp"),
  explicit = c("Yes", "No")
)

Arguments

term

The URL-encoded text string you want to search for. For example: jack+johnson. If using a vector it will search for all terms in one search.

country

The two-letter country code for the store you want to search. For a list of country codes see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

media

Optional The media type you want to search for. For example: movie. The default is all.

entity

Optional The type of results you want returned, relative to the specified media type.

attribute

Optional The attribute you want to search for in the stores, relative to the specified media type. For example, if you want to search for an artist by name specify entity=allArtist&attribute=allArtistTerm. In this example, if you search for term=maroon, iTunes returns "Maroon 5" in the search results, instead of all artists who have ever recorded a song with the word "maroon" in the title.

limit

Optional The number of search results you want the iTunes Store to return between 1 and 200. The default is 50.

lang

Optional The language, English or Japanese, you want to use when returning search results.

explicit

Optional A flag indicating whether or not you want to include explicit content in your search results.

Value

A data.frame of any results that match the iTunes database.

If there were no successful results then it will return NULL.

See Also

https://performance-partners.apple.com/search-api

Examples


# Search for all Jack Johnson audio and video content
search_apple(term = "jack johnson")

# To search for all Jack Johnson audio and video content and return only the first 25 items
search_apple(term = "jack johnson", limit = 25)


[Package appler version 0.2.1 Index]