| Title: | R Interface to Echo Nest API |
|---|---|
| Description: | The 'Echo nest' <http://the.echonest.com> is the industry's leading music intelligence company, providing developer with deepest understanding of music content and music fans. This package can be used to access artist's data including songs, blogs, news, reviews etc. Song's data including audio summary, style, danceability, tempo etc can also be accessed. |
| Authors: | Mukul Chaware[aut,cre] |
| Maintainer: | Mukul Chaware <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 1.2 |
| Built: | 2025-03-10 03:48:28 UTC |
| Source: | https://github.com/mukul13/rechonest |
To return basic playlist
basic_playlist(api_key, type = NA, artist_id = NA, artist = NA, song_id = NA, genre = NA, track_id = NA, results = 15, partner = NA, tracks = F, limited_interactivity = NA)basic_playlist(api_key, type = NA, artist_id = NA, artist = NA, song_id = NA, genre = NA, track_id = NA, results = 15, partner = NA, tracks = F, limited_interactivity = NA)
api_key |
Echo Nest API key |
type |
the type of the playlist to be generated |
artist_id |
artist id |
artist |
artist name |
song_id |
song ID |
genre |
genre name |
track_id |
track ID |
results |
the number of results desired |
partner |
partner catalog |
tracks |
tracks info |
limited_interactivity |
interactivity limitation |
data frame giving basic playlist
## Not run: data=basic_playlist(api_key,type="artist-radio",artist=c("coldplay","adele")) ## End(Not run)## Not run: data=basic_playlist(api_key,type="artist-radio",artist=c("coldplay","adele")) ## End(Not run)
To extract artist names from text.
extract_artist_names(api_key, text, min_hotttnesss = NA, max_hotttnesss = NA, min_familiarity = NA, max_familiarity = NA, sort = NA, results = NA)extract_artist_names(api_key, text, min_hotttnesss = NA, max_hotttnesss = NA, min_familiarity = NA, max_familiarity = NA, sort = NA, results = NA)
api_key |
Echo Nest API key |
text |
text that contains artist names |
min_hotttnesss |
the minimum hotttnesss for returned artists |
max_hotttnesss |
the maximum hotttnesss for returned artists |
min_familiarity |
the minimum familiarity for returned artists |
max_familiarity |
the maximum familiarity for returned artists |
sort |
specified the sort order of the results |
results |
the number of results desired |
data frame giving artist's names
## Not run: data=extract_artist_names(api_key,text="I like adele and Maroon 5") ## End(Not run)## Not run: data=extract_artist_names(api_key,text="I like adele and Maroon 5") ## End(Not run)
To get a list of artist biographies
get_artist_biographies(api_key, name = NA, id = NA, start = NA, results = 15, license = "unknown")get_artist_biographies(api_key, name = NA, id = NA, start = NA, results = 15, license = "unknown")
api_key |
Echo Nest API key |
name |
artist name |
id |
Echo Nest ID |
start |
the desired index of the first result returned |
results |
the number of results desired |
license |
the desired licenses of the returned images |
data frame giving artist's biographies
## Not run: data=get_artist_biographies(api_key,name="coldplay") ## End(Not run)## Not run: data=get_artist_biographies(api_key,name="coldplay") ## End(Not run)
To get blogs about artist
get_artist_blogs(api_key, name = NA, start = NA, id = NA, results = 15, high_relevance = F)get_artist_blogs(api_key, name = NA, start = NA, id = NA, results = 15, high_relevance = F)
api_key |
Echo Nest API key |
name |
artist's name |
start |
the desired index of the first result returned |
id |
artist's id |
results |
maximum size |
high_relevance |
if true only items that are highly relevant for this artist will be returned |
data frame giving blogs about artist
## Not run: data=get_artist_blogs(api_key,name="coldplay",results=35) ## End(Not run)## Not run: data=get_artist_blogs(api_key,name="coldplay",results=35) ## End(Not run)
To get artist's data
get_artist_data(api_key, name = NA, id = NA, hotttnesss = T, terms = F, blogs = F, news = F, familiarity = F, audio = F, images = F, songs = F, reviews = F, discovery = F, partner = NA, biographies = F, doc_counts = F, artist_location = F, years_active = F, urls = F)get_artist_data(api_key, name = NA, id = NA, hotttnesss = T, terms = F, blogs = F, news = F, familiarity = F, audio = F, images = F, songs = F, reviews = F, discovery = F, partner = NA, biographies = F, doc_counts = F, artist_location = F, years_active = F, urls = F)
api_key |
Echo Nest API key |
name |
artist's name |
id |
artist's id |
hotttnesss |
artist's hotttnesss |
terms |
artist's terms |
blogs |
blogs about artist |
news |
news articles about artist |
familiarity |
artist's familiarity |
audio |
artist's audio details |
images |
artist's images details |
songs |
artist's songs details |
reviews |
reviews about artist |
discovery |
artist's discovery details |
partner |
partner catalog |
biographies |
artist's biographies |
doc_counts |
artist's doc_counts |
artist_location |
artist location |
years_active |
years active |
urls |
urls of artist websites |
data frame giving artist's hotttnesss
## Not run: data=get_artist_data(api_key,name="coldplay",terms=T,blogs=T) ## End(Not run)## Not run: data=get_artist_data(api_key,name="coldplay",terms=T,blogs=T) ## End(Not run)
To get artist's familiarity
get_artist_familiarity(api_key, name = NA, id = NA)get_artist_familiarity(api_key, name = NA, id = NA)
api_key |
Echo Nest API key |
name |
artist's name |
id |
artist's id |
data frame giving artist's familiarity
## Not run: data=get_artist_familiarity(api_key,name="coldplay") ## End(Not run)## Not run: data=get_artist_familiarity(api_key,name="coldplay") ## End(Not run)
To get artist's hotttnesss
get_artist_hotttnesss(api_key, name = NA, id = NA)get_artist_hotttnesss(api_key, name = NA, id = NA)
api_key |
Echo Nest API key |
name |
artist's name |
id |
artist's id |
data frame giving artist's hotttnesss
## Not run: data=get_artist_hotttnesss(api_key,name="coldplay") ## End(Not run)## Not run: data=get_artist_hotttnesss(api_key,name="coldplay") ## End(Not run)
To get artist's images
get_artist_images(api_key, name = NA, id = NA, start = NA, results = 15, license = "unknown")get_artist_images(api_key, name = NA, id = NA, start = NA, results = 15, license = "unknown")
api_key |
Echo Nest API key |
name |
artist name |
id |
Echo Nest ID |
start |
the desired index of the first result returned |
results |
the number of results desired |
license |
the desired licenses of the returned images |
data frame giving artist's images
## Not run: data=list_genres(api_key) ## End(Not run)## Not run: data=list_genres(api_key) ## End(Not run)
To get news about artist
get_artist_news(api_key, name = NA, id = NA, start = NA, results = 15, high_relevance = F)get_artist_news(api_key, name = NA, id = NA, start = NA, results = 15, high_relevance = F)
api_key |
Echo Nest API key |
name |
artist's name |
id |
artist's id |
start |
the desired index of the first result returned |
results |
maximum size |
high_relevance |
if true only items that are highly relevant for this artist will be returned |
data frame giving news about artist
## Not run: data=get_artist_news(api_key,name="coldplay",results=35) ## End(Not run)## Not run: data=get_artist_news(api_key,name="coldplay",results=35) ## End(Not run)
To get reviews about artist
get_artist_reviews(api_key, name = NA, id = NA, start = NA, results = 15)get_artist_reviews(api_key, name = NA, id = NA, start = NA, results = 15)
api_key |
Echo Nest API key |
name |
artist's name |
id |
artist's id |
start |
the desired index of the first result returned |
results |
maximum size |
data frame giving blogs about artist
## Not run: data=get_artist_reviews(api_key,name="coldplay",results=35) ## End(Not run)## Not run: data=get_artist_reviews(api_key,name="coldplay",results=35) ## End(Not run)
To get artist's songs
get_artist_songs(api_key, name = NA, id = NA, start = NA, results = 15)get_artist_songs(api_key, name = NA, id = NA, start = NA, results = 15)
api_key |
Echo Nest API key |
name |
artist's name |
id |
artist's id |
start |
the desired index of the first result returned |
results |
maximum size |
data frame giving artist's songs
## Not run: data=get_artist_songs(api_key,name="coldplay") ## End(Not run)## Not run: data=get_artist_songs(api_key,name="coldplay") ## End(Not run)
To get artist's terms
get_artist_terms(api_key, name = NA, id = NA)get_artist_terms(api_key, name = NA, id = NA)
api_key |
Echo Nest API key |
name |
artist's name |
id |
artist's id |
data frame giving artist's terms
## Not run: data=get_artist_terms(api_key,name="coldplay") ## End(Not run)## Not run: data=get_artist_terms(api_key,name="coldplay") ## End(Not run)
To get a list of video documents found on the web related to an artist
get_artist_videos(api_key, name = NA, id = NA, start = NA, results = 15)get_artist_videos(api_key, name = NA, id = NA, start = NA, results = 15)
api_key |
Echo Nest API key |
name |
artist name |
id |
Echo Nest ID |
start |
the desired index of the first result returned |
results |
the number of results desired |
data frame giving artist's videos
## Not run: data=get_artist_videos(api_key,name="coldplay") ## End(Not run)## Not run: data=get_artist_videos(api_key,name="coldplay") ## End(Not run)
To get basic information about a genre
get_genre_info(api_key, genre, description = T, urls = T)get_genre_info(api_key, genre, description = T, urls = T)
api_key |
Echo Nest API key |
genre |
the genre name |
description |
genre's description |
urls |
genre's urls |
data frame giving basic info about a genre
## Not run: data=get_genre_info(api_key,genre="post rock") ## End(Not run)## Not run: data=get_genre_info(api_key,genre="post rock") ## End(Not run)
To Return the top artists for the given genre
get_top_genre_artists(api_key, genre)get_top_genre_artists(api_key, genre)
api_key |
Echo Nest API key |
genre |
the genre name |
data frame top artist of the given genre
## Not run: data=get_top_genre_artists(api_key,genre="pop") ## End(Not run)## Not run: data=get_top_genre_artists(api_key,genre="pop") ## End(Not run)
To return a list of the top hottt artists
get_top_hottt(api_key, genre = NA, start = NA, results = 15)get_top_hottt(api_key, genre = NA, start = NA, results = 15)
api_key |
Echo Nest API key |
genre |
the set of genres of interest |
start |
the desired index of the first result returned |
results |
the number of results desired |
data frame giving top hottt artists
## Not run: data=get_top_hottt(api_key) ## End(Not run)## Not run: data=get_top_hottt(api_key) ## End(Not run)
To returns a list of the overall top terms
get_top_terms(api_key, results = NA)get_top_terms(api_key, results = NA)
api_key |
Echo Nest API key |
results |
the number of results desired |
data frame giving top terms
## Not run: data=get_top_terms(api_key) ## End(Not run)## Not run: data=get_top_terms(api_key) ## End(Not run)
To get the twitter handle for an artist
get_twitter_handle(api_key, name = NA, id = NA)get_twitter_handle(api_key, name = NA, id = NA)
api_key |
Echo Nest API key |
name |
artist name |
id |
Echo Nest ID |
data frame giving twitter handle
## Not run: data=get_twitter_handle(api_key,name="coldplay") ## End(Not run)## Not run: data=get_twitter_handle(api_key,name="coldplay") ## End(Not run)
To get genre's list
list_genres(api_key)list_genres(api_key)
api_key |
Echo Nest API key |
data frame giving genre's list
## Not run: data=list_genres(api_key) ## End(Not run)## Not run: data=list_genres(api_key) ## End(Not run)
To get a list of the best typed descriptive terms
list_terms(api_key, type = "style")list_terms(api_key, type = "style")
api_key |
Echo Nest API key |
type |
term type |
data frame giving best typed descriptive terms
## Not run: data=list_terms(api_key) ## End(Not run)## Not run: data=list_terms(api_key) ## End(Not run)
To search artist by using name
search_artist(api_key, name = NA, style = NA, hotttnesss = T, description = NA, start = NA, results = 15, sort = NA, partner = NA, artist_location = NA, genre = NA, mood = NA, rank_type = "relevance", fuzzy_match = F, max_familiarity = NA, min_familiarity = NA, max_hotttnesss = NA, min_hotttnesss = NA, artist_start_year_before = NA, artist_start_year_after = NA, artist_end_year_before = NA, artist_end_year_after = NA)search_artist(api_key, name = NA, style = NA, hotttnesss = T, description = NA, start = NA, results = 15, sort = NA, partner = NA, artist_location = NA, genre = NA, mood = NA, rank_type = "relevance", fuzzy_match = F, max_familiarity = NA, min_familiarity = NA, max_hotttnesss = NA, min_hotttnesss = NA, artist_start_year_before = NA, artist_start_year_after = NA, artist_end_year_before = NA, artist_end_year_after = NA)
api_key |
Echo Nest API key |
name |
artist's name |
style |
artist's style |
hotttnesss |
artist's hotttnesss (Default is true) |
description |
artist's description |
start |
the desired index of the first result returned |
results |
maximum size |
sort |
to sort ascending or descending |
partner |
partner catalog |
artist_location |
artist location |
genre |
genre name |
mood |
mood like happy or sad |
rank_type |
For search by description, style or mood indicates whether results should be ranked by query relevance or by artist familiarity |
fuzzy_match |
if true, a fuzzy search is performed |
max_familiarity |
maximum familiarity |
min_familiarity |
minimum familiarity |
max_hotttnesss |
maximum hotttnesss |
min_hotttnesss |
minimum hotttnesss |
artist_start_year_before |
Matches artists that have an earliest start year before the given value |
artist_start_year_after |
Matches artists that have an earliest start year after the given value |
artist_end_year_before |
Matches artists that have a latest end year before the given value |
artist_end_year_after |
Matches artists that have a latest end year after the given value |
data frame giving artist's data
## Not run: data=search_artist(api_key,"coldplay",sort="hotttnesss-desc",results=50) ## End(Not run)## Not run: data=search_artist(api_key,"coldplay",sort="hotttnesss-desc",results=50) ## End(Not run)
To search for genres by name
search_genre(api_key, genre = NA, description = T, urls = T, results = 15)search_genre(api_key, genre = NA, description = T, urls = T, results = 15)
api_key |
Echo Nest API key |
genre |
the genre name |
description |
genre's description |
urls |
genre's urls |
results |
the number of results desired |
data frame giving searched genres
## Not run: data=search_genre(api_key,genre="rock")\ ## End(Not run)## Not run: data=search_genre(api_key,genre="rock")\ ## End(Not run)
To search song
search_songs(api_key, artist = NA, artist_id = NA, title = NA, hotttnesss = T, style = NA, artist_location = T, combined = NA, sort = NA, audio_summary = F, partner = NA, min_name = NA, discovery = T, max_name = NA, min_val = NA, max_val = NA, start = NA, results = 15, mode = NA, key = NA, currency = T, description = NA, rank_type = "relevance", mood = NA, familiarity = T, song_type = NA, artist_start_year_before = NA, artist_start_year_after = NA, artist_end_year_before = NA, artist_end_year_after = NA)search_songs(api_key, artist = NA, artist_id = NA, title = NA, hotttnesss = T, style = NA, artist_location = T, combined = NA, sort = NA, audio_summary = F, partner = NA, min_name = NA, discovery = T, max_name = NA, min_val = NA, max_val = NA, start = NA, results = 15, mode = NA, key = NA, currency = T, description = NA, rank_type = "relevance", mood = NA, familiarity = T, song_type = NA, artist_start_year_before = NA, artist_start_year_after = NA, artist_end_year_before = NA, artist_end_year_after = NA)
api_key |
Echo Nest API key |
artist |
artist's name |
artist_id |
artist's id |
title |
song's title |
hotttnesss |
song's hotttnesss |
style |
artist's style |
artist_location |
artist location |
combined |
query both artist and title fields |
sort |
to sort ascending or descending |
audio_summary |
song's audio summary |
partner |
partner catalog |
min_name |
features' minimum value settings |
discovery |
artist's discovery measure |
max_name |
features' maximum value settings |
min_val |
features' minimum value settings |
max_val |
features' maximum value settings |
start |
the desired index of the first result returned |
results |
maximum size |
mode |
the mode of songs |
key |
the key of songs in the playlist |
currency |
song currency |
description |
song's description |
rank_type |
For search by description, style or mood indicates whether results should be ranked by query relevance or by artist familiarity |
mood |
a mood like happy or sad |
familiarity |
song's familiarity |
song_type |
controls the type of songs returned |
artist_start_year_before |
Matches artists that have an earliest start year before the given value |
artist_start_year_after |
Matches artists that have an earliest start year after the given value |
artist_end_year_before |
Matches artists that have a latest end year before the given value |
artist_end_year_after |
Matches artists that have a latest end year after the given value |
data frame giving artist's familiarity
## Not run: data=search_songs(api_key,style="pop",results=31) ## End(Not run)## Not run: data=search_songs(api_key,style="pop",results=31) ## End(Not run)
To search similar artists by using names or IDs
similar_artists(api_key, name = NA, id = NA, seed_catalog = NA, hotttnesss = T, start = 0, results = 15, max_familiarity = NA, min_familiarity = NA, max_hotttnesss = NA, min_hotttnesss = NA, artist_start_year_before = NA, artist_start_year_after = NA, artist_end_year_before = NA, artist_end_year_after = NA)similar_artists(api_key, name = NA, id = NA, seed_catalog = NA, hotttnesss = T, start = 0, results = 15, max_familiarity = NA, min_familiarity = NA, max_hotttnesss = NA, min_hotttnesss = NA, artist_start_year_before = NA, artist_start_year_after = NA, artist_end_year_before = NA, artist_end_year_after = NA)
api_key |
Echo Nest API key |
name |
artists' name (maximum upto 5 names) |
id |
Echo Nest IDs (maximum upto 5 IDs) |
seed_catalog |
seed catalog |
hotttnesss |
artist's hotttnesss |
start |
the desired index of the first result returned |
results |
maximum size |
max_familiarity |
maximum familiarity |
min_familiarity |
minimum familiarity |
max_hotttnesss |
maximum hotttnesss |
min_hotttnesss |
minimum hotttnesss |
artist_start_year_before |
Matches artists that have an earliest start year before the given value |
artist_start_year_after |
Matches artists that have an earliest start year after the given value |
artist_end_year_before |
Matches artists that have a latest end year before the given value |
artist_end_year_after |
Matches artists that have a latest end year after the given value |
data frame giving similar artists' data
## Not run: data=similar_artists(api_key,name=c("coldplay","adele","maroon 5"),results=35 ) ## End(Not run)## Not run: data=similar_artists(api_key,name=c("coldplay","adele","maroon 5"),results=35 ) ## End(Not run)
To return similar genres to a given genre
similar_genres(api_key, genre = NA, description = T, urls = T, start = NA, results = 15)similar_genres(api_key, genre = NA, description = T, urls = T, start = NA, results = 15)
api_key |
Echo Nest API key |
genre |
the genre name |
description |
genre's description |
urls |
genre's urls |
start |
the desired index of the first result returned |
results |
the number of results desired |
data frame giving similar genres
## Not run: data=similar_genres(api_key,genre="rock") ## End(Not run)## Not run: data=similar_genres(api_key,genre="rock") ## End(Not run)
To return standard static playlist
standard_static_playlist(api_key, type = NA, artist_id = NA, artist = NA, song_id = NA, genre = NA, track_id = NA, results = 15, partner = NA, tracks = F, limited_interactivity = NA, song_selection = NA, variety = NA, distribution = NA, adventurousness = NA, seed_catalog = NA, sort = NA, song_type = NA)standard_static_playlist(api_key, type = NA, artist_id = NA, artist = NA, song_id = NA, genre = NA, track_id = NA, results = 15, partner = NA, tracks = F, limited_interactivity = NA, song_selection = NA, variety = NA, distribution = NA, adventurousness = NA, seed_catalog = NA, sort = NA, song_type = NA)
api_key |
Echo Nest API key |
type |
the type of the playlist to be generated |
artist_id |
artist id |
artist |
artist name |
song_id |
song ID |
genre |
genre name |
track_id |
track ID |
results |
the number of results desired |
partner |
partner catalog |
tracks |
tracks info |
limited_interactivity |
interactivity limitation |
song_selection |
to determine how songs are selected from each artist in artist-type playlists |
variety |
the maximum variety of artists to be represented in the playlist |
distribution |
controls the distribution of artists in the playlist |
adventurousness |
controls the trade between known music and unknown music |
seed_catalog |
ID of seed catalog for the playlist |
sort |
sorting parameter |
song_type |
controls the type of songs returned |
data frame giving standard static playlist
## Not run: data= standard_static_playlist(api_key,type="artist-radio",artist=c("coldplay","adele")) ## End(Not run)## Not run: data= standard_static_playlist(api_key,type="artist-radio",artist=c("coldplay","adele")) ## End(Not run)
To suggest artists based upon partial names
suggest_artist_names(api_key, name, results = NA)suggest_artist_names(api_key, name, results = NA)
api_key |
Echo Nest API key |
name |
a partial artist name |
results |
the number of results desired (maximum 15) |
data frame giving artist's names
## Not run: data=suggest_artist_names(api_key,"cold") ## End(Not run)## Not run: data=suggest_artist_names(api_key,"cold") ## End(Not run)