README.md

In mpiccirilli/Rlinkedin: Access to the LinkedIn API via R

Rlinkedin

The current CRAN release (and GitHub version) is 0.2. ## May 12th API Changes On May 12th 2015 LinkedIn changed the availability for most of their API endpoints. In order to gain full access to the API, you must apply to their [Partnership Program](https://developer.linkedin.com/partner-programs). You can find detailed information regarding what endpoints are still openly available in their [Transition Guide](https://developer.linkedin.com/support/developer-program-transition). **Regarding this R package, the following lists cover which functions are and are not available for *non-partners*.** If I gain access to their partnership program I will update the package accordingly. ### Available: - [getProfile(token)](#profileapi) - [searchCompanies(token, ...)](#searchCompany) - [submitShare(token, ...)](#submitShare) ### Not available: - getMyConnections(token) - getProfile(token, connections = TRUE) - getProfile(token, id = ...) - searchPeople(token, ...) - getJobs(token, ...) - searchJobs(token, ...) - getCompany(token, ...) - getGroups(token, ...) - getGroupPosts(token, ...) - submitGroupPost(token, ...) This is a development version of an R package to access the LinkedIn API. I was motivated to create this after using and contributing to Pablo Barberá's awesome [Rfacebook](https://github.com/pablobarbera/Rfacebook) package. Contributions are welcomed, and if you come across any errors please don't hesitate to open a new issue. At the bottom of this readme is a list of the functions I would still like to add to the package. If you'd like to contribute or simply learn more about accessing the API, get started by visiting the [LinkedIn Developer](https://developer.linkedin.com/) page. Installation and Authentication ------- The current CRAN release is 0.1, however you can download the package with the most recent additions from GitHub. wzxhzdk:0 You can establish an authenticated connection to the LinkedIn API in one of two ways: 1) Use the default API and Secret Key information. 2) Create your own [LinkedIn Developer application](https://developer.linkedin.com/).

The default information is not approved to use the People Search API (searchPeople) or the Job Search API (searchJobs). If you would like to utilize these functions you must create your own application and [apply here](https://help.linkedin.com/app/ask/path/api-dvr) for the "Vetted API Access". If you use your own application name, API Key, and Secret Key, you must paste `http://localhost:1410/` into the *'OAuth 2.0 Redirect URLs'* input box and select all of the *'Scope'* parameters, both of which are in the **'OAuth User Agreement'** section. Otherwise, you will not be able to create an authorized connection and these functions will not work properly. For a step-by-step tutorial, check out this [fantastic blog post](http://thinktostart.com/analyze-linkedin-with-r/) by [JulianHi](https://twitter.com/JulianHi). wzxhzdk:1 Connections API ----- The [Connections API](https://developer-programs.linkedin.com/documents/connections-api) returns a list of 1st degree connections for a user who has granted access to his/her account. You cannot "browse connections." That is, you cannot get connections of your connections (2nd degree connections). Per LinkedIn: You may never store data returned from the Connections API. wzxhzdk:2 Profile API ------ The [Profile API](https://developer-programs.linkedin.com/documents/profile-api) returns a member's LinkedIn profile. This function can retrieve proflie information about to yourself, your connections, or an individual. To Do: 1/14: Include positions in results 1/22: Added positions into results, need to update example in readme (below). 3/19: Updated ReadMe, gave example to turn list into df wzxhzdk:3 People Search API ------- The [People Search API](https://developer-programs.linkedin.com/documents/people-search-api) returns information about people. It lets you implement most of what shows up when you do a search for "People" in the top right box on LinkedIn.com. People Search API is a part of their Vetted API Access Program. You must [apply here](https://help.linkedin.com/app/ask/path/api-dvr) and get LinkedIn's approval before using this API. The default token in the package is not approved for this use. Throttle limits: Up to 100 returns per search, 10 returns per page. Each page is one API call. The arguments available to be used in a search: - keywords - first name - last name - company name - current company (T/F) - title - current title - school name - current school (T/F) - country code - postal code - distance To Do: 1/14: Include positions in results 1/22: Added positions into results, need to update example in readme (below). Results are now a list, not a df. 3/19: Updated ReadMe, gave example to turn list into df wzxhzdk:4 Job Bookmarks & Suggestions -------- The API can be used to retrieve the current members [bookmarked and suggested jobs](https://developer-programs.linkedin.com/documents/job-bookmarks-and-suggestions). wzxhzdk:5 Job Search API -------- The [Job Search API](https://developer-programs.linkedin.com/documents/job-search-api#) enables search across LinkedIn's job postings. Job Search API is a part of their Vetted API Access Program. You must [apply here](https://help.linkedin.com/app/ask/path/api-dvr) and get LinkedIn's approval before using this API. The default token in the package is not approved for this use. Throttle limits: Up to 100 returns per search, 10 returns per page. Each page is one API call. The arguments available to be used in a search: - keywords - company name - job title - country code - postal code - distance wzxhzdk:6 Company APIs -------- #### Company Profile API Use the [Company Profile API](https://developer-programs.linkedin.com/documents/company-lookup-api-and-fields) to find companies using a company ID, a universal name, or an email domain. The universal name needs to be the exact name seen at the end of the URL on the company page on LinkedIn. In most cases this is simply the name of the company, but not always. For example, let's consider Coca-Cola. The company's LinkedIn page is: - https://www.linkedin.com/company/the-coca-cola-company Therefore, you would search "the coca cola company" or "the-coca-cola-company". The same principles apply to other companies. See example below. wzxhzdk:7 #### Company Search API Use the [Company Search API](https://developer-programs.linkedin.com/documents/company-search) to find companies using keywords, industry, location, or some other criteria. It returns a collection of matching companies. Each entry can contain much of the information available on the company page. 1/22: Added searchCompanies() to repo. Will add/update readme w/ example soon... 3/19: I will add this function to the ReadMe this weekend. wzxhzdk:8 Groups API --------- The [Groups API](https://developer-programs.linkedin.com/documents/groups-api) enables members to view and interact with groups off of LinkedIn.com with the same rules that apply on the LinkedIn site. Data available includes group profile information, discussion posts, comments on posts, and likes. #### Group Information wzxhzdk:9 #### Group Posts To Do: 1) Include functionality to retrieve information of people who have liked and commented on posts. 2) Currently this only returns the past 10 posts from each group. Build in functionality to retrieve more posts in each group. wzxhzdk:10 #### Create a group discussion There are two possible actions here: 1) Your post has been created and is visibile immediately. Most likely you posted to an unmoderated group. 2) Your post has been accepted by the API but is pending approval by the group moderator. wzxhzdk:11  Share API -------- You can share network updates through the [Share API](https://developer-programs.linkedin.com/documents/share-api). Note: If one of the content elements is specified you must also include include a url for the post wzxhzdk:12  To Do: -------- - Get Network Updates and Statistics API: The Get Network Updates API returns the users network updates, which is the LinkedIn term for the user's feed. This call returns most of what shows up in the middle column of the LinkedIn.com home page, either for the member or the member's connections.

mpiccirilli/Rlinkedin documentation built on May 23, 2019, 6:28 a.m.