API Documentation

API Testing Tool

Overview

The Raven database contains search results for thousands of keywords, including the keywords you have added through your account. Each week the Raven engine captures 50 (100 for Bing) search results for these keywords from the major search engines (Google, Yahoo!, Bing, and several international versions of Google and Yahoo!) Raven also compiles a database of search engine rankings for the domains and keywords you have added to your account. This data is available through Raven's REST API, and can be returned in XML or JSON format.

Common Request Parameters

key

This is your assigned API key. It must be provided on every request.

format

This can be xml or json.

Domain Rank

This request will return a list of matches for a particular domain, keyword, search engine, and date range. You can only access results for domains and keywords that have been added to your account, including competitor domains.

method

rank

domain

The domain name you want results for. "www." prefixes are ignored.

keyword

The keyword you want results for.

start_date

The beginning of the date range.

end_date

The end of the date range.

engine

The search engine you want results for. Available values are "all", "google", "yahoo", "msn" (aka bing), "google-uk", "google-au", "google-ca", "google-dk", "google-de", "google-no", "google-se", "google-pl", "google-fi", "google-fr", "google-es", "google-nl", "yahoo-ca", "yahoo-uk", "yahoo-au".

Example:

http://raven-seo-tools.com/api?key=YOURAPIKEY&method=rank&keyword=nashville+seo&domain=sitening.com&start_date=2007-07-09&end_date=2007-08-09&engine=all&format=json

Domains

This request will return the available domains for the profile associated with your API key.

method

domains

Example:

http://raven-seo-tools.com/api?key=YOURAPIKEY&method=domains&format=xml

Engines

This request will return the available search engines for tracking keywords, to be used when adding or modifying domains.

method

engines

Example:

http://raven-seo-tools.com/api?key=YOURAPIKEY&method=engines&format=xml

Domain Info

This request will return the search engines for the domain provided.

method

domain_info

domain

The domain name you want results for. "www." prefixes are ignored.

Example:

http://raven-seo-tools.com/api?key=YOURAPIKEY&method=domain_info&domain=sitening.com&format=xml

Add Domain

This request will add the domain provided.

method

add_domain

domain

The domain name you want to add. "www." prefixes are ignored.

engine_id

Comma separate list of search engine ids that you want to track for this domain.

Example:

http://raven-seo-tools.com/api?key=YOURAPIKEY&method=add_domain&domain=sitening.com&engine_id=1,2,3&format=xml

Add Keyword

This request will add keyword to the domain provided.

method

add_keyword

domain

The domain name you want to add a keyword to. "www." prefixes are ignored.

keyword

The keyword name you want to add.

Example:

http://raven-seo-tools.com/api?key=YOURAPIKEY&method=add_keyword&domain=sitening.com&keyword=nashville+seo&format=xml

Remove Keyword

This request will remove a keyword from the domain provided.

method

remove_keyword

domain

The domain name you want to the keyword from. "www." prefixes are ignored.

keyword

The keyword name you want to remove.

Example:

http://raven-seo-tools.com/api?key=YOURAPIKEY&method=remove_keyword&domain=sitening.com&keyword=nashville+seo&format=xml

Return Values:

"success" or "not found"

Competitors

This request will return the available competitors for the domain provided.

method

competitors

domain

The domain name you want results for. "www." prefixes are ignored.

Example:

http://raven-seo-tools.com/api?key=YOURAPIKEY&method=competitors&domain=sitening.com&format=xml

Keywords

This request will return the available keywords for the domain provided.

method

keywords

domain

The domain name you want results for. "www." prefixes are ignored.

Example:

http://raven-seo-tools.com/api?key=YOURAPIKEY&method=keywords&domain=sitening.com&format=xml

API Testing Tool

To construct and test API requests, we've create the API Testing Tool. If you have questions about the API and it's usage, please contact us at support at ravenseo.com.