Project

similarweb

0.01
No commit activity in last 3 years
No release in over 3 years
Ruby wrapper for SimilarWeb API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.5
>= 0
>= 0
>= 0
>= 0

Runtime

 Project Readme

SimilarWeb

Ruby client for SimilarWeb API

Installation

Add this line to your application's Gemfile:

gem 'similarweb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install similarweb

Usage

client = SimilarWeb::Client.new(api_key: key)
traffic = client.traffic('disney.com')

Also Visited

Returns a list of websites frequently visited by users of the given domain.

client = SimilarWeb::Client.new(api_key: key)
also_visited = client.also_visited('disney.com')

Category

Will return a domain’s category and its global rank within its given category.

client = SimilarWeb::Client.new(api_key: key)
category = client.category('disney.com')

Category Rank

Will return a domain’s category and its global rank within its given category.

client = SimilarWeb::Client.new(api_key: key)
category_rank = client.category_rank('disney.com')

Destinations

Returns the 10 leading sites that receive direct clicks from the given domain.

client = SimilarWeb::Client.new(api_key: key)
destinations = client.destinations('disney.com')

Engagement

Provides three web engagement metrics: average page views, average time on site and bounce rate.

client = SimilarWeb::Client.new(api_key: key)
engagement = client.engagement('disney.com')

Estimated Visits

Returns the estimated number of visitors per domain.

client = SimilarWeb::Client.new(api_key: key)
visits = client.estimated_visits('disney.com')

Keywords

Access three search metrics: paid/organic search distribution, 10 paid keywords, and 10 organic keywords.

client = SimilarWeb::Client.new(api_key: key)
keywords = client.keywords('disney.com')

Referrals

Returns the 10 leading sites that direct clicks to the given domain.

client = SimilarWeb::Client.new(api_key: key)
referrals = client.referrals('disney.com')

Similar Sites

Input a domain and receive an output of 20 similar websites and their similarity score.

client = SimilarWeb::Client.new(api_key: key)
similar = client.similar_sites('disney.com')

Social Referrals

Access the five leading social networks sending traffic to the given domain.

client = SimilarWeb::Client.new(api_key: key)
social = client.social_referrals('disney.com')

Tags

Returns 10 tags per domain based on semantic analysis, meta-data, anchor text and more.

client = SimilarWeb::Client.new(api_key: key)
tags = client.tags('disney.com')

Traffic

Will return four web traffic metrics: global rank, country rank/traffic geography, traffic reach and traffic sources distribution.

client = SimilarWeb::Client.new(api_key: key)
traffic = client.traffic('disney.com')

Author

John McLaughlin & Steven Lai

Contributing

  1. Fork it ( http://github.com/johnmcl/similarweb/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Copyright

Copyright (c) 2014 John McLaughlin, Steven Lai. See LICENSE for details.