Package instar. November 10, 2015

Transcription

1 Title Access to Instagram API via R Package instar November 10, 2015 Provides an interface to the Instagram API < which allows R users to download public pictures filtered by hashtag, popularity, user or location, and to access public users' profile data. Version Date Author Pablo Barbera [aut, cre], Tiago Dantas [ctb], Jonne Guyt [ctb] Maintainer URL BugReports Depends R (>= ), httr, rjson License GPL-2 Collate 'getfollowers.r' 'getfollows.r' 'getuser.r' 'getusermedia.r' 'instaoauth.r' 'searchinstagram.r' 'utils.r' 'gettagcount.r' 'getcomments.r' 'getlikes.r' 'getpopular.r' 'getlocation.r' NeedsCompilation no Repository CRAN Date/Publication :41:27 R topics documented: getcomments getfollowers getfollows getlikes getlocation getpopular gettagcount getuser getusermedia instaoauth searchinstagram

2 2 getfollowers Index 11 getcomments Returns up to 150 comments on an instagram post getcomments retrieves up to 150 recent comments on an instagram post, including text, author and date. getcomments(id,, = TRUE) id String, id of instagram post. An OAuth created with instaoauth. ## Downloading list of followers obama <- getusermedia( username="barackobama", =my_oauth ) comments <- getcomments( obama$id[1], =my_oauth ) getfollowers Get the list of users this user is followed by. getfollowers retrieves the list of users that follow a given user, as well as basic information about all of them. getfollowers(username,, userid = NULL, = TRUE)

3 getfollows 3 username userid String, screen name of user. An OAuth created with instaoauth. Numeric ID of user. ## Downloading list of followers mccain <- getfollowers( username="senjohnmccain", =my_oauth ) getfollows Get the list of users a user follows. getfollows retrieves the list of users that a given user follows, as well as basic information about all of them. getfollows(username,, userid = NULL, = TRUE) username userid String, screen name of user. An OAuth created with instaoauth. Numeric ID of user.

4 4 getlikes ## Downloading list of users follows mccain <- getfollows( username="senjohnmccain", =my_oauth ) getlikes Get the list of users who liked a photo. getlikes retrieves the list of users who liked a photo. getlikes(id,, = TRUE) id Numeric ID of photo. An OAuth created with instaoauth. Tiago Dantas <[email protected]> ## Downloading list of users who s most recent photo obama <- getusermedia( username="barackobama", =my_oauth, n=1) likes <- getlikes(obama$id[1], =my_oauth)

5 getlocation 5 getlocation Get basic information about a location using a location ID getlocation retrieves location information getlocation(location_id, ) location_id numeric, location id. An OAuth created with instaoauth. Jonne Guyt <[email protected]> ## Capturing information about a location loc_id_info <- getlocation( location_id=423423, =my_oauth,) getpopular Returns 24 popular instagram posts information getpopular retrieves up to 24 popular instagram posts getpopular(, = TRUE) An OAuth created with instaoauth.

6 6 gettagcount Jonne Guyt ## Downloading list of popular instagram posts popular_posts <- getpopular(=my_oauth ) gettagcount Get number of times a tag has been used gettagcount retrieves a count of the number of times a tag has been used in comments to a picture or video. gettagcount(tag, ) tag Hashtag used to filter media. An OAuth created with instaoauth. ## Capturing information about #nofilter gettagcount( tag="nofilter, =my_oauth,)

7 getuser 7 getuser Get basic information about a user getuser retrieves public information about Instagram user getuser(username,, userid = NULL) username userid String, screen name of user. An OAuth created with instaoauth. Numeric ID of user. ## Capturing information obama <- getuser( username="barackobama", =my_oauth,) getusermedia Extract recent media published by a user. getusermedia retrieves public media from a given user and, optionally, downloads recent pictures to a specified folder. getusermedia(username,, n = 30, folder = NULL, userid = NULL, = TRUE)

8 8 instaoauth username n folder userid String, screen name of user. An OAuth created with instaoauth. Maximum number of media to return. If different than NULL, will download all pictures to this folder. Numeric ID of user. ## Capturing information about 50 most recent pictures obama <- getusermedia( username="barackobama", =my_oauth, n=50, folder="barackobama") instaoauth Create OAuth to Intagram R session instaoauth creates an OAuth access that enables R to make authenticated calls to the Instagram API. The can be saved as a file in disk to be re-used in future sessions. This function relies on the httr package to create the OAuth, and is a simplified version of one of its examples. instaoauth(app_id, app_secret, scope = "basic") app_id app_secret scope numeric, Client ID of application to be used to create OAUth. Available at string, Client Secret of application to be used to create OAUth. Available at string, specifies scope of access to the authenticated user data. See instagram.com/developer/authentication/#scope for available options.

9 searchinstagram 9 Details To obtan your app_id and app_secret, do the following steps. First, go to com/developer/ and register your application with any name. Then, run the instaoauth function with your "Client ID" and "Client Secret" as arguments. It will return a URL, which you will need to paste into the field "OAuth redirect_uri" in your application settings on Instagram. After changing it, press Enter in R. A new browser window will open and sign the. If everything works works well, you will get a message that says you can return to R. See Also searchinstagram ## an example of an authenticated request after creating the OAuth ## where app_id and app_secret are fictitious, and is saved for ## future sessions my_oauth <- instaoauth(app_id=" ", app_secret="1a2b3c4d") save(my_oauth, file="my_oauth") obama <- searchinstagram(tag="obama", =my_oauth) searchinstagram Search public media that mention a specific hashtag, or that were sent from a given area searchinstagram retrieves public pictures and video whose caption mentions a given hashtag, or that were sent within a given area, delimited by a set of coordinates and a radius. It returns a data frame with information about each picture or video, and optionally will download all pictures to a specific folder searchinstagram(tag = NULL,, n = 100, lat = NULL, lng = NULL, distance = NULL, folder = NULL, mindate = NULL, maxdate = NULL, = TRUE, sleep = 0)

10 10 searchinstagram tag n lat lng Details distance folder mindate maxdate Hashtag used to filter media. It is only possible for a single hashtag. An OAuth created with instaoauth. Maximum number of media to return. Latitude of the center search coordinate Longitude of the center search coordinate Default is 1km (distance=1000), max distance is 5km. If different than NULL, will download all pictures to this folder. Minimum date for search period Maximum date for search period sleep Number of seconds between API calls (default is 0). It is only possible to apply one filter at a time: either search by hashtag OR search by coordinates. The mindate and maxdata search parameters only work when searching by location, not when searching by tag. See Also instaoauth ## Searching and downloading 100 public media that mention #obama obama <- searchinstagram( tag="obama", =my_oauth, n=100, folder="obama") ## Searching and downloading pictures sent from Times Square with a minimum date ## of and a maximum date of tsq <- searchinstagram( lat= , lng= , distance=500, =my_oauth, n=500, folder="timessquare", mindate=" ", maxdate=" ")

11 Index getcomments, 2 getfollowers, 2 getfollows, 3 getlikes, 4 getlocation, 5 getpopular, 5 gettagcount, 6 getuser, 7 getusermedia, 7 instaoauth, 8, 10 searchinstagram, 9, 9 11