Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.25 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.25 KB
Raw

R wrapper to the SharedCount API.

Installation

# install.packages("devtools")
devtools::install_github("news-r/sharedcount")

Functions

Functions that directly call API:

  • sc_set - Setup your session.
  • sc_status - Check API status.
  • sc_quota - Check quota allocation.
  • sc_usage - Check historical usage.
  • sc_domains and sc_whitelist - Retrieve whitelisted domains.
  • sc_count - Get share count of URL.
  • sc_bulk_p and sc_bulk_g - POST bulk URLs and GET their counts.

Convenience funtions:

Since bulk requests (sc_bulk_p and sc_bulk_g) are not part of the free plan, there is a convinience function for free users to call multiple urls in one function but multiple calls.

  • sc_count_n

Setup

Get a free key from the sharedcount.com website.

sharedcount_key(key = "xxXXxxXxxXXxX")

Note that you can specify the SHAREDCOUNT_API_KEY key as an environment variable in your .Renviron for convenience.

Example

All functions start with sc_, at the exception of the one to setup your session sharedcount_key.

sharedcount_key(key = "xxXXxxXxxXXxX")

sc_count("https://cran.r-project.org/")