SCapi_general: Return results from users, tracks, groups, comments.

Description Usage Arguments Details Author(s) See Also Examples

View source: R/SCapi_general.R

Description

A client ID is necessary to query results from the SoundCloud API. See loginDetails. The SCapi_general function differs from the SCapi_specific function in that it only queries "generic" results. To query e.g. the tracks of a specific user, or to get the results for a specific user, see SCapi_specific.

Usage

1
2
SCapi_general(client_id, type = c("users", "tracks", "groups", "comments"),
  limit = 50, verbose = FALSE, filter = NULL, offset = NULL)

Arguments

client_id

The soundcloud client id of your application. See loginDetails() for more information

type

What would you like to query? Must be one of "users", "tracks", "groups", "comments"

limit

how many results should be returned? Soundcloud allows you to query 200 results per query. If you want more results, this is possible by paginating (done automatically).

verbose

prints the url to query for every request.

filter

Use if you want to add filters to the query. See: http://bit.ly/1OwCaUC for more information. Filters must be added as a list, e.g. filter = list("q" = "the-bugle").

offset

determines at which result we start searching. For example, if we do a generic query for "users", which returns all users for the limit we set (e.g. 1000), and we use offset = 1000, then we begin our search at the 1001st user, thus returning the information of users between 1000 and 2000.

Details

For additional information about filters and the soundcloud API, see: http://bit.ly/1OwCaUC

Author(s)

Jasper Ginn

See Also

loginDetails

Examples

1
2
3
4
5
6
## Not run: 
Query up to 50 results of users that conform to the query "em-mcrae" or "the-bugle"
sc_res <- SCapi_general(client_id, type="users", limit=50,
                        filter=list("q" = "em-mcrae", "q" = "the-bugle"))

## End(Not run)

JasperHG90/RSoundCloud documentation built on May 7, 2019, 10:33 a.m.