https://github.com/beverlyroadgoose/itunessearch

A Java wrapper for the Itunes search API
https://github.com/beverlyroadgoose/itunessearch

apple itunes itunes-api itunes-podcast-feed itunes-search itunes-store java-wrapper side-project

Last synced: 4 days ago
JSON representation

A Java wrapper for the Itunes search API

• Host: GitHub
• URL: https://github.com/beverlyroadgoose/itunessearch
• Owner: beverlyRoadGoose
• License: apache-2.0
• Created: 2017-10-15T11:46:33.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-05-09T17:56:01.000Z (over 1 year ago)
• Last Synced: 2024-05-28T11:52:59.638Z (6 months ago)
• Topics: apple, itunes, itunes-api, itunes-podcast-feed, itunes-search, itunes-store, java-wrapper, side-project
• Language: Java
• Homepage: https://beverlyroadgoose.github.io/ItunesSearch/
• Size: 1.08 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: license.txt

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/beverlyRoadGoose/ItunesSearch.svg?branch=master&maxAge=1)](https://travis-ci.org/beverlyRoadGoose/ItunesSearch)

[![Coverage Status](https://coveralls.io/repos/github/beverlyRoadGoose/ItunesSearch/badge.svg?branch=master&maxAge=1)](https://coveralls.io/github/beverlyRoadGoose/ItunesSearch?branch=master)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/6139acc8bc4c44dd91d73fa2456ec52d)](https://www.codacy.com/app/beverlyRoadGoose/ItunesSearch?utm_source=github.com&utm_medium=referral&utm_content=beverlyRoadGoose/ItunesSearch&utm_campaign=Badge_Grade)

[![GitHub version](https://badge.fury.io/gh/beverlyRoadGoose%2FItunesSearch.svg)](https://github.com/beverlyRoadGoose/ItunesSearch/releases)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?maxAge=1)](https://opensource.org/licenses/Apache-2.0)

## About

This is a Java wrapper for the [iTunes Search API](https://affiliate.itunes.apple.com/resources/documentation/itunes-store-web-service-search-api/).

## Usage

**Adding the library to your project**

**Gradle**

```Gradle

compile group: 'me.tobiadeyinka', name: 'iTunesSearch', version: '1.5.3'

```

**Maven**

```xml

    me.tobiadeyinka

    iTunesSearch

    1.5.3

```

      

**Making calls to the API**

Using Podcast's search as an example, to search for "Radiolab" and leaving all other parameters set to default, it's as simple as:

```java

new PodcastSearch()

    .with("radiolab")

    .execute();

```

To compare your search term with only a particular attribute, for example the genre of podcasts, you can specify that this way:

```java

new PodcastSearch()

    .with("radiolab")

    .inAttribute(PodcastAttribute.GENRE);

    .execute();

```

To run your search in only one itunes store, just pass the [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) 

for that country, this example uses Nigeria:

```java

new PodcastSearch()

    .with("radiolab")

    .inCountry(CountryCode.NG)

    .execute();

```

Searching other media types follow the same method. To search every media type in one call, use [MediaSearch](https://beverlyRoadGoose.github.io/ItunesSearch/docs/):

```java

new MediaSearch()

    .with("something")

    .execute();

```

There are much more configurations available all of which are detailed in the [wiki](https://github.com/beverlyRoadGoose/ItunesSearch/wiki).

To lookup up lists or items from the store, use the lookup API's. For example, to get the top songs in the store:

```java

MusicLookup.topSongs();

```

To get the top _n_ songs:

```java

MusicLookup.topSongs(n);

```

The javadoc is also available [here](https://beverlyRoadGoose.github.io/ItunesSearch/docs/).

All searches and lookups return a [JSON object](https://stleary.github.io/JSON-java/).

## Disclaimer

iTunes is a trademark of Apple Inc., registered in the U.S. and other countries.

This library has not been authorized, sponsored, or otherwise approved by Apple Inc.

## License

```

   Copyright 2018 Oluwatobi Adeyinka

   

   Licensed under the Apache License, Version 2.0 (the "License");

   you may not use this file except in compliance with the License.

   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software

   distributed under the License is distributed on an "AS IS" BASIS,

   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   See the License for the specific language governing permissions and

   limitations under the License.

```