README.md

In ShaulAb/similarwebr: R client for Similarweb API

SimilarwebR

A minimalistic R client for the similarweb API

Functions Overview:

Retrieval functions:

• get_visits() - retrieves traffic info about the domain link
• get_category_rank() - retrieves the category rank of the domain link
• get_similar_websites() - retrieves 40 most similar websites link

Formatting functions:

• format_visits() - formatting for the get_visits() response
• format_category_rank() - formatting for the get_category_rank() response
• format_similar_websites() - formatting for the get_similar_websites() response

get_visits

Total Traffic API input for "cnn.com"

get_visits(api_key = "my_api_key", domain = "cnn.com", start = "2016-01", end = "2016-03", gr = "monthly")

JSON output should be similar to this:

{  
   "meta":{  
      "request":{  
         "granularity":"Monthly",
         "main_domain_only":false,
         "domain":"cnn.com",
         "start_date":"2016-01-01",
         "end_date":"2016-03-01",
         "country":"world"
      },
      "status":"Success",
      "last_updated":"2016-05-01"
   },
   "visits":[  
      {  
         "date":"2016-01-01",
         "visits":419183781.12128651
      },
      {  
         "date":"2016-02-01",
         "visits":430178882.01417673
      },
      {  
         "date":"2016-03-01",
         "visits":490074660.2565304
      }
   ]
}

get_category_rank

Note: One request to this API is worth 3 hits

Category rank API for "facebook.com"

get_category_rank(api_key = "my_api_key", domain = "facebook.com")

JSON output should be similar to this:

{
 "category":"Internet_and_Telecom/Social_Network",
 "rank":1
}

get_similar_websites

Similar Websites API input for "google.com"

get_similar_websites(api_key = "my_api_key", domain = "google.com", start_month = "2016-11", end_month = "2016-12")

JSON output should be similar to this:

{
 "similar_sites":[
  {
  "url":"googleblog.blogspot.com",
  "score":0.99995037171524026
  },
  {
  "url":"yahoo.com",
  "score":0.999742882067614
  },
  {
  "url":"technorati.com",
  "score":0.97864855460955635
  },
...
...
...

}

Read more about Similarweb here

ShaulAb/similarwebr documentation built on May 15, 2019, 1:58 a.m.