Rank checker API v2.0

rank-checker-api-v2.0

=====
Usage
=====

Basic request:

curl --insecure --silent -H "X-API-Key: the-api-key" https://the-host/rankings

# => {"error":"Either a keyword, brand or competitor param is required."}
You need to include either a keyword, competitor or both params, which are detailed below.

Mandatory params are [at least] one of:

1- Filter by competitor, e.g. alliedelec.com

curl --insecure --silent -H "X-API-Key: the-api-key" https://the-host/rankings?competitor=alliedelec.com

Returns all keyword rankings for alliedelec.com

2- Filter by keyword, e.g. ZY9GH8-1-15/16

curl --insecure --silent -H "X-API-Key: the-api-key" https://the-host/rankings?keyword=UCNFL205MZ2RFW

3- Filter by brand, e.g. ACME%20Electric

curl --insecure --silent -H "X-API-Key: the-api-key" https://the-host/rankings?brand=ACME%20Electric

4- Competitor, keyword and brand may be used at the same time, e.g.

curl --insecure --silent -H "X-API-Key: the-api-key" "https://the-host/rankings?competitor=alliedelec.com&keyword=UCNFL205MZ2RFW&brand=AMI%20Bearings"

# => [{"keyword":"UCNFL205MZ2RFW","brand":"AMI Bearings","competitor":"alliedelec.com","ranking":0,"date":"2015-02-09"}]

===========
Competitors
===========

curl --insecure --silent -H "X-API-Key: the-api-key" https://the-host/competitors

# => ["alliedelec.com","digikey.com","drillspot.com","electricmotorwholesale.com","globalindustrial.com","kscdirect.com",
"motionindustries.com","motoragents.com","mrosupply.com","newark.com","plccenter.com","sqone.com","temcoindustrialpower.com",
"transcat.com","walkeremd.com","wbds.com"]

======
Brands
======

curl --insecure --silent -H "X-API-Key: the-api-key" https://the-host/brands

# => ["ACME Electric","ACTech-Lenze","AMI Bearings","Baldor Electric Motors","Bando","Boston Gear","Bussmann","Cementex","Champion Cutting Tool Corp","Contrinex Sensors","Diamond Chain","Dixon Valve & Coupling","Dodge","EDT Bearing","FAG Bearing","Flexco","Fulham Lighting","Gates Rubber","HubCity","IDC Select","Ideal-Tridon","IKO Bearing","INA Bearing","IPTCI Bearing","Jason Industrial","Koyo Bearing","Leeson","Linn Gear","LittelFuse","LoveJoy","LubeSite","MagPowr","Martin Sprocket","Maska","MRC Bearing","Nachi Bearing","North American Electric","Red Lion Controls","Rexnord","Screw Conveyor Corp","Silverthin Bearing Group","SKF Bearing","SKF Seals","Smith Bearings","SPX power team","Stearns","TB Woods","Telco Sensors","Vacon VFD","WEG","ZKL Bearing Corp."]

--

What does the ranking field actually mean?

ranking = 0 -> the competitor's domain was not present in the first search results page
ranking = 1 -> the competitor's domain showed up first in the first search results page
ranking = 2 -> the competitor's domain showed up second in the first search results page
...
ranking = 9 or 10  -> the competitor's domain showed up last in the first search results page (some searches return 9 or 10 search results on the first page)