DEVELOPER API

This page is for software developers who want to integrate the SerpExplorer API into their own software or service!
Integrating our API into Your products will only benefit You and Your customers for even more Automation,
time saving and ease of use!
The SerpExplorer API provides an easy interface for programmers to embed SerpExplorer functions in their
own programs or online services directly. The SerpExplorer API is very easy to use - it uses
HTTP Requests to receive Your commands, process them and return a result.
In case You are in need of a test API Key to test Your code implementations and integration simply register Yourself
an account (it is absolutely free to register) and subscribe to the Free Trial plan.
API URL - http://www.serpexplorer.com/api.php
The
API URL is the address which You must use to communicate with our API
POST Method Only
You Must use
HTTP POST Method only when communicating with our API
RESPONSES
Our API returns responses associative arrays encoded in JSON / JSONP format. In PHP you may use the built-in
json_decode()
function to parse the response. In C#,C++,VB.. You may use
NewtonSoft.Json
package
ALWAYS REQUIRED VARIABLES
The following variables are always required, no matter what API queries You intend to run!
apikey - This is an API Authentication Key generated by our system for each single client.
It is used to authenticate as the corresponding user. Every our customer can find his API Key on top of this page (if you are logged in into your account)
cmd - Command to execute. Possible values and functions to execute are:
cmd=user_details - Retrieve User account details such as available and remaining slots, expiry date and etc..
cmd=add_item - Add Item to track ranks for
cmd=delete_item - Delete an item
cmd=list_groups - Retrieve a list of all User's Groups
cmd=group_ranks - Retrieve the ranks for all items of a particular Group
cmd=item_ranks - Retrieve the ranks for a particular item only
RETRIEVE USER DETAILS
API Query:
http://www.serpexplorer.com/api.php?apikey=YOUR_API_KEY_HERE&cmd=user_details
Sample Response (After JSON decoding)
Array
(
[username] => testuser
[status] => Active
[plan] => Basic
[expirydate] => 2013-07-18
[totalslots] => 50
[usedslots] => 27
[availableslots] => 23
[timezone] => America/Chicago
)
ADD ITEM
Additional Required Variables
type - Specify the type of the item You will be adding -
searchengine or
youtube
group - Put the new item into the specified group. If the group name doesn't exist a new one will be created
url - Domain or Page URL if You will be tracking Search Engine type item. Youtube Video URL or Youtube Video ID if You will be tracking Youtube type item.
exactmatch - Only for Search Engine type items. Specifies if our system should be looking for exacth match of the URL as provided. Possible values: 0 or 1
If omitted or left blank it defaults to 0
keyword - Specify the search keyword to track ranks for
googleregion - Specify the Google Region to track rankings at. Example: google.co.uk , google.co.jp ...
Full list can be found
here.
If omitted or left blank it defaults to google.com
googlelang - Specify the language used for searching. Example : en-us, en-uk... If omitted or left
blank it defaults to "en"

Upon successful addition of the item its
Shared Key is returned as well
API Query: (Adding Search Engine Item)
http://www.serpexplorer.com/api.php?apikey=YOUR_API_KEY_HERE&cmd=add_item&type=searchengine&group=Some_Group&url=domain.com&keyword=my keyword
API Query: (Adding Youtube Item)
http://www.serpexplorer.com/api.php?apikey=YOUR_API_KEY_HERE&cmd=add_item&type=youtube&group=Some_Group&url=http://www.youtube.com/watch?v=zEHo58wXAv4&keyword=my keyword
Sample Response (After JSON decoding)
Array
(
[status] => OK
[sharedkey] => 1-7788774c69d534546ydghd2e9fa479-96594213525555
)
DELETE ITEM
Additional Required Variables
sharedkey - To delete particular item You need to know its
Shared Key first!
That Shared Key can be obtained from the
GROUP RANKS command or by the response returned of
a
ADD ITEM command
API Query:
http://www.serpexplorer.com/api.php?apikey=YOUR_API_KEY_HERE&cmd=delete_item&sharedkey=1-5f0a386d755136ad2679a53c19b27daa-462385951d7e
Sample Response (After JSON decoding)
Array
(
[status] => OK
)
LIST GROUPS
API Query:
http://www.serpexplorer.com/api.php?apikey=YOUR_API_KEY_HERE&cmd=list_groups
Sample Response (After JSON decoding)
Array
(
[0] => Array
(
[name] => Default
[sharedkey] => 1-5f0a386d755136ad2679a53c19b27daa-462385951d7e
[items_searchengine] => 6
[items_youtube] => 4
)
[1] => Array
(
[name] => Some Group Name
[sharedkey] => 1-5f634f3d0a356d5b1cf56b828c949592-09858821351d
[items_searchengine] => 0
[items_youtube] => 0
)
[2] => Array
(
[name] => Another Group Name
[sharedkey] => 1-fa178e14852687c2b1530348a1433bca-7642753151d9
[items_searchengine] => 10
[items_youtube] => 0
)
[3] => Array
(
[name] => Yet Another Group
[sharedkey] => 1-41d9f7db4e9e8453c0601k5933ff62d3-1366461251ec
[items_searchengine] => 7
[items_youtube] => 0
)
)
GROUP RANKS
Additional Required Variables
sharedkey - To obtain the rankings of all items of a particular group You need to know its
Shared Key first!
That Shared Key can be obtained from the
LIST GROUPS command
type - Specify the items` type You wish to retrieve results for -
searchengine or
youtube
API Query:
http://www.serpexplorer.com/api.php?apikey=YOUR_API_KEY_HERE&cmd=group_ranks&sharedkey=1-5f0a386d755136ad2679a53c19b27daa-462385951d7e&type=searchengine
Sample Response (After JSON decoding)
Array
(
[0] => Array
(
[type] => searchengine
[url] => domain.com
[keyword] => search keyword
[exactmatch] => 0
[sharedkey] => 1-e44c4cf5d38f59d357856eb393393e30-23966427851d7e
[lastupdated] => 2013-10-08
[ranks] => Array
(
[backlinks] => 2736
[google] => 7
[googleurl] => http://www.domain.com/
)
[rankchanges] => Array
(
[day] => Array
(
[google] => 2
[backlinks] => 0
)
[3day] => Array
(
[google] => 2
[backlinks] => -31
)
[week] => Array
(
[google] => 2
[backlinks] => 190
)
[month] => Array
(
[google] => 4
[backlinks] => 1531
)
)
)
[1] => Array
(
[type] => searchengine
[url] => somedomain.com
[keyword] => some keyword
[exactmatch] => 0
[sharedkey] => 1-a03fb4c4ebb8b731sef75e67ebbdf56f7-50183019451d7e
[lastupdated] => 2013-10-08
[ranks] => Array
(
[google] => 1
[googleurl] => http://www.somedomain.com/
[backlinks] => 2736
)
[rankchanges] => Array
(
[day] => Array
(
[google] => 0
[backlinks] => 0
)
[3day] => Array
(
[google] => 0
[backlinks] => -31
)
[week] => Array
(
[google] => 0
[backlinks] => 190
)
[month] => Array
(
[google] => 0
[backlinks] => 1531
)
)
)
)
ITEM RANKS
Additional Required Variables
sharedkey - To obtain the rankings of a particular item You need to know its
Shared Key first!
That Shared Key can be obtained from the
GROUP RANKS command or by the response returned of
a
ADD ITEM command
API Query:
http://www.serpexplorer.com/api.php?apikey=YOUR_API_KEY_HERE&cmd=item_ranks&sharedkey=1-5f0a386d755136ad2679a53c19b27daa-462385951d7e
Sample Response (After JSON decoding)
Array
(
[type] => searchengine
[url] => domain.com
[keyword] => search keyword
[exactmatch] => 0
[sharedkey] => 1-5f0a386d755136ad2679a53c19b27daa-462385951d7e
[lastupdated] => 2013-10-08
[ranks] => Array
(
[google] => 1
[googleurl] => http://www.domain.com/
[backlinks] => 2736
)
[rankchanges] => Array
(
[day] => Array
(
[google] => 0
[backlinks] => 0
)
[3day] => Array
(
[google] => 0
[backlinks] => -31
)
[week] => Array
(
[google] => 0
[backlinks] => 190
)
[month] => Array
(
[google] => 0
[backlinks] => 1531
)
)
)