EVOLUTION-MANAGER
Edit File: search_spotify.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Search for an Item</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for search_spotify {spotifyr}"><tr><td>search_spotify {spotifyr}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>Search for an Item</h2> <h3>Description</h3> <p>Get Spotify Catalog information about artists, albums, tracks or playlists that match a keyword string. For more information see the official <a href="https://developer.spotify.com/documentation/web-api/reference/#category-search">documentation</a>. </p> <h3>Usage</h3> <pre> search_spotify( q, type = c("album", "artist", "playlist", "track"), market = NULL, limit = 20, offset = 0, include_external = NULL, authorization = get_spotify_access_token(), include_meta_info = FALSE ) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>q</code></td> <td> <p>Required. <br /> Search query keywords and optional field filters and operators.</p> </td></tr> <tr valign="top"><td><code>type</code></td> <td> <p>A character vector of item types to search across. <br /> Valid types are <code>album</code>, <code>artist</code>, <code>playlist</code>, and <code>track</code>. <br /> Search results include hits from all the specified item types. <br /> For example: <code>q = "name:abacab"</code> and <code>type =c("album", "track")</code> returns both albums and tracks with <code>"abacab"</code> included in their name.</p> </td></tr> <tr valign="top"><td><code>market</code></td> <td> <p>Optional. <br /> An ISO 3166-1 alpha-2 country code or the string <code>"from_token"</code>. <br /> If a country code is specified, only artists, albums, and tracks with content that is playable in that market is returned. <br /> Note: <br /> - Playlist results are not affected by the market parameter. <br /> - If market is set to <code>"from_token"</code>, and a valid access token is specified in the request header, only content playable in the country associated with the user account, is returned. <br /> - Users can view the country that is associated with their account in the account settings. A user must grant access to the user-read-private scope prior to when the access token is issued.</p> </td></tr> <tr valign="top"><td><code>limit</code></td> <td> <p>Optional. <br /> Maximum number of results to return. <br /> Default: 20 <br /> Minimum: 1 <br /> Maximum: 50 <br /> Note: The limit is applied within each type, not on the total response. <br /> For example, if the limit value is 3 and the type is <code>c("artist", "album")</code>, the response contains 3 artists and 3 albums.</p> </td></tr> <tr valign="top"><td><code>offset</code></td> <td> <p>Optional. <br /> The index of the first result to return. <br /> Default: 0 (the first result). <br /> Maximum offset (including limit): 10,000. <br /> Use with limit to get the next page of search results.</p> </td></tr> <tr valign="top"><td><code>include_external</code></td> <td> <p>Optional. <br /> Possible values: audio <br /> If <code>include_external = "audio"</code> is specified the response will include any relevant audio content that is hosted externally. <br /> By default external content is filtered out from responses.</p> </td></tr> <tr valign="top"><td><code>authorization</code></td> <td> <p>Required. A valid access token from the Spotify Accounts service. See the <a href="https://developer.spotify.com/documentation/general/guides/authorization-guide/">Web API authorization guide</a> for more details. Defaults to <code>spotifyr::get_spotify_access_token()</code></p> </td></tr> <tr valign="top"><td><code>include_meta_info</code></td> <td> <p>Optional. Boolean indicating whether to include full result, with meta information such as <code>"total"</code>, and <code>"limit"</code>. Defaults to <code>FALSE</code>.</p> </td></tr> </table> <h3>Value</h3> <p>A tibble with detailed information about the searched album, artist, playlist, track or their combination. </p> <h3>Examples</h3> <pre> search_spotify('radiohead', 'artist') </pre> <hr /><div style="text-align: center;">[Package <em>spotifyr</em> version 2.2.3 <a href="00Index.html">Index</a>]</div> </body></html>