SERP Scan API

SERP Scan tracks your website's search engine position for the keywords that matter to you.

The serpscan gem is a ruby wrapper for interacting with the SERP Scan API. Before you can use the gem you'll need a SERP Scan account (https://serpscan.com), and an api key which can be found on the accounts page.

Installation

Add this line to your application's Gemfile:

gem 'serpscan'

And then execute:

$ bundle

Or install it yourself as:

$ gem install serpscan

Usage

Set your API key. If you're using Rails you may want to place the code below in a file at config/initializers/serpscan.rb.

Serpscan.api_key = 'YOUR API KEY'

Alternatively you can set your API key as an environment variable:

ENV['SERPSCAN_API_KEY'] = 'YOUR API KEY'

Websites

To create a website:

Serpscan::Website.create(url: 'example.com')

To get a list of the websites currently in your account:

Serpscan::Website.all

To get a particular website:

Serpscan::Website.find(id)

To get a list of keywords for a website:

website = Serpscan::Website.find(1)
website.keywords

Keywords

To create a keyword:

website = Serpscan::Website.find(1)
website.create_keyword('example keyword')

To get a particular keyword:

Serpscan::Keyword.find(id)

Ranking history:

Serpscan::Keyword.find(id).history #> [['2015-01-01', 2], ['2015-01-02', 1]]

Attributes

Each of these attributes can be called directly on the object. Example:

website = Serpscan::Website.find(1)
website.id # => 1

Websites:

[:id, :url] 

Keywords:

[:id, :phrase, :current_rank, :initial_rank, :day_change, :week_change, :month_change, :alltime_change, :search_volume, :search_engine_country_id, :website_id]