iSpionage API
With the API you can have our data in your own web sites or projects.

Below is a list with the API Functions we provide. Click on a function to expand/collapse the details.

APIs to perform queries based on publisher domain

GetPublisherAds(publisher, searchEngineId, startIndex, maxCount, apiKey, country)

Description: Gets the ad copies for the specified publisher.
Parameters:
Publisher The publisher for the query.
searchEngineId The Id of the search engine to get the ads from : Google = 1, Yahoo/Bing = 2.
startIndex The index of the first result in the data set. First item index is 0.
maxCount The maximum number of results to for the request. Must be between 0 and 20,000.
apiKey Your own API Key.
country The country to search results for. Available options: US, UK and CA. Optional and defaults to US.
Request Format:
JSON: http://api.ispionage.com/GetPublisherAds?publisher=[Publisher]&apiKey=[API Key]&searchEngineId=[Search Engine Id]&startIndex=[Start Index]&maxCount=[Max Count]&country=[Country]
Request Example:
JSON: http://api.ispionage.com/GetPublisherAds?publisher=godaddy.com&apiKey=1234&searchEngineId=1&startIndex=0&maxCount=5&country=us
Result:
Items A collection of result items (see bellow).
TotalRowsReturned Number of items in the result set.
TotalAvailableData Number of items available for the query.
Currency Currency used in the output result.
Country Country used for the output result.
Status Status of the current request.
Result Item:
DaysSeen The number of days the ad has been seen by our system.
AvgRank The ad's average rank.
Description The ad's description.
DisplayedUrl The ad's displayed Url.
FirstSeen The fist time the ad was seen by our system.
LastSeen The last time the ad was seen by our system.
Title The ad's title.
Url The ad's destination Url.
MonthlyTraffic The traffic the keywords that triggered this ad generated in the last month.
AvgCpc Average cost per click.
AEI Ad effectiveness index. Same principle as for KEI but for ads.
KeywordCount The number of keywords that trigger this ad.
Cost: 80 API units per each result item.

GetPublisherPPCKeywords(publisher, searchEngineId, startIndex, maxCount, apiKey, country)

Description: Gets the PPC keywords for the specified publisher.
Parameters:
Publisher The publisher for the query.
searchEngineId The Id of the search engine to get the ads from : Google = 1, Yahoo/Bing = 2.
startIndex The index of the first result in the data set. First item index is 0.
maxCount The maximum number of results to for the request. Must be between 0 and 20,000.
apiKey Your own API Key.
country The country to search results for. Available options: US, UK and CA. Optional and defaults to US.
Request Format:
JSON: http://api.ispionage.com/GetPublisherPPCKeywords?publisher=[Publisher]&apiKey=[API Key]&searchEngineId=[Search Engine Id]&startIndex=[Start Index]&maxCount=[Max Count]&country=[Country]
Request Example:
JSON: http://api.ispionage.com/GetPublisherPPCKeywords?publisher=godaddy.com&apiKey=1234&searchEngineId=1&startIndex=0&maxCount=5&country=us
Result:
Items A collection of result items (see bellow).
TotalRowsReturned Number of items in the result set.
TotalAvailableData Number of items available for the query.
Currency Currency used in the output result.
Country Country used for the output result.
Status Status of the current request.
Result Item:
DaysSeen The number of days between the first seen and last seen date.
AvgCpc Keyword average cost per click.
AvgPosition Average ad position for this keyword.
AvgSearchVolume Average search volume for this keyword.
FirstSeen The fist time this keyword triggered an ad for this advertiser.
LastSeen The last time this keyword triggered an ad for this advertiser.
KEI Keyword effectiveness index.
The higher the number is the greater chance that the keyword is a profitable one for the advertiser.
Keyword The keyword.
Cost: 40 API units per each result item.

GetPublisherSEOKeywords(publisher, startIndex, maxCount, apiKey, country)

Description: Gets the SEO keywords for the specified publisher.
Parameters:
Publisher The publisher for the query.
startIndex The index of the first result in the data set. First item index is 0.
maxCount The maximum number of results to for the request. Must be between 0 and 20,000.
apiKey Your own API Key.
country The country to search results for. Available options: US, UK and CA. Optional and defaults to US.
Request Format:
JSON: http://api.ispionage.com/GetPublisherSEOKeywords?publisher=[Publisher]&apiKey=[API Key]&startIndex=[Start Index]&maxCount=[Max Count]&country=[Country]
Request Example:
JSON: http://api.ispionage.com/GetPublisherSEOKeywords?publisher=godaddy.com&apiKey=1234&startIndex=0&maxCount=5&country=us
Result:
Items A collection of result items (see bellow).
TotalRowsReturned Number of items in the result set.
TotalAvailableData Number of items available for the query.
Currency Currency used in the output result.
Country Country used for the output result.
Status Status of the current request.
Result Item:
AvgCpc Keyword average cost per click.
GoogleAvgRank Average rank in Google for the advertiser/keyword pair.
BingYahooAvgRank Average rank in Bing/Yahoo for the advertiser/keyword pair.
AvgSearchVolume Average search volume for this keyword.
Keyword The keyword.
Cost: 20 API units per each result item.

GetPublisherPPCCompetitors(publisher, searchEngineId, startIndex, maxCount, apiKey, country)

Description: Gets the PPC competitors for the specified publisher.
Parameters:
Publisher The publisher for the query.
searchEngineId The Id of the search engine to get the ads from : Google = 1, Yahoo/Bing = 2.
startIndex The index of the first result in the data set. First item index is 0.
maxCount The maximum number of results to for the request. Must be between 0 and 20,000.
apiKey Your own API Key.
country The country to search results for. Available options: US, UK and CA. Optional and defaults to US.
Request Format:
JSON: http://api.ispionage.com/GetPublisherPPCCompetitors?publisher=[Publisher]&apiKey=[API Key]&searchEngineId=[Search Engine Id]&startIndex=[Start Index]&maxCount=[Max Count]&country=[Country]
Request Example:
JSON: http://api.ispionage.com/GetPublisherPPCCompetitors?publisher=godaddy.com&apiKey=1234&searchEngineId=1&startIndex=0&maxCount=5&country=us
Result:
Items A collection of result items (see bellow).
TotalRowsReturned Number of items in the result set.
TotalAvailableData Number of items available for the query.
Currency Currency used in the output result.
Country Country used for the output result.
Status Status of the current request.
Result Item:
Publisher The publisher name.
LowerBudget The advertiser's lower ad budget.
UpperBudget The advertiser's upper ad budget.
UniqueKeywordsCount Number of keywords that are not used by the advertiser in the query but are used by this advertiser.
OverlapKeywordsCount Number of keywords that are also used by both the advertiser in the query and this advertiser.
KeywordCount Total number of keywords for this advertiser.
AdCopyCount Number of ad copies by this advertiser.
AvgPosition Average ad position.
Cost: 50 API units per each result item.

GetPublisherSEOCompetitors(publisher, searchEngineId, startIndex, maxCount, apiKey, country)

Description: Gets the SEO competitors for the specified publisher.
Parameters:
Publisher The publisher for the query.
searchEngineId The Id of the search engine to get the ads from : Google = 1, Yahoo/Bing = 2.
startIndex The index of the first result in the data set. First item index is 0.
maxCount The maximum number of results to for the request. Must be between 0 and 20,000.
apiKey Your own API Key.
country The country to search results for. Available options: US, UK and CA. Optional and defaults to US.
Request Format:
JSON: http://api.ispionage.com/GetPublisherSEOCompetitors?publisher=[Publisher]&apiKey=[API Key]&searchEngineId=[Search Engine Id]&startIndex=[Start Index]&maxCount=[Max Count]&country=[Country]
Request Example:
JSON: http://api.ispionage.com/GetPublisherSEOCompetitors?publisher=godaddy.com&apiKey=1234&searchEngineId=1&startIndex=0&maxCount=5&country=us
Result:
Items A collection of result items (see bellow).
TotalRowsReturned Number of items in the result set.
TotalAvailableData Number of items available for the query.
Currency Currency used in the output result.
Country Country used for the output result.
Status Status of the current request.
Result Item:
Publisher The publisher name.
SEOTrafficValue SEO Traffic Value.
OverlapKeywordsCount Number of organic keywords that are also used by both the advertiser in the query and this advertiser.
KeywordsCount Number of organic keywords this website has on first result page.
Cost: 40 API units per each result item.

GetPublisherLastMonthStats(publisher, apiKey, country)

Description: Returns last month stats for the given publisher.
Parameters:
Publisher The publisher for the query.
apiKey Your own API Key.
country The country to search results for. Available options: US, UK and CA. Optional and defaults to US.
Request Format:
JSON: http://api.ispionage.com/GetPublisherLastMonthStats?publisher=[Publisher]&apiKey=[API Key]&country=[Country]
Request Example:
JSON: http://api.ispionage.com/GetPublisherLastMonthStats?publisher=godaddy.com&apiKey=1234
Result:
LowerAdBudget Publisher lower ad budget.
UpperAdBudget Publisher upper ad budget.
AvgAdPosition Advertiser average ad position.
LowerClicks Advertiser lower clicks.
UpperClicks Advertiser upper clicks.
GoogleKeywords Google keyword count for the advertiser.
BingYahooKeywords Bing/Yahoo keyword count for the advertiser.
GooglePageRank Advertiser page rank in Google.
SEOTrafficValue Advertiser SEO traffic value.
FirstPageGoogleSEOKeywords Number of first page Google SEO keyowrds.
FirstPageBingSEOKeywords Number of first page Bing/Yahoo SEO keyowrds.
Currency Currency used in the output result.
Country Country used for the output result.
Status Status of the current request.
Cost: 100 API units per call.

APIs to perform queries based on keyword

GetKeywordAds(keyword, searchEngineId, startIndex, maxCount, apiKey, country)

Description: Gets the PPC Ads for all competitors running on the specified keyword.
Parameters:
keyword The keyword for the query.
searchEngineId The Id of the search engine to get the ads from : Google = 1, Yahoo/Bing = 2.
startIndex The index of the first result in the data set. First item index is 0.
maxCount The maximum number of results to for the request. Must be between 0 and 20,000.
apiKey Your own API Key.
country The country to search results for. Available options: US, UK and CA. Optional and defaults to US.
Request Format:
JSON: http://api.ispionage.com/GetKeywordAds?keyword=[Keyword]&apiKey=[API Key]&searchEngineId=[Search Engine Id]&startIndex=[Start Index]&maxCount=[Max Count]&country=[Country]
Request Example:
JSON: http://api.ispionage.com/GetKeywordAds?keyword=hosting&apiKey=1234&searchEngineId=1&startIndex=0&maxCount=5&country=us
Result:
Items A collection of result items (see bellow).
TotalRowsReturned Number of items in the result set.
TotalAvailableData Number of items available for the query.
Country Country used for the output result.
Status Status of the current request.
Result Item:
DaysSeen The number of days the ad has been seen by our system.
AvgRank The ad's average rank.
Description The ad's description.
DisplayedUrl The ad's displayed Url.
FirstSeen The fist time the ad was seen by our system.
LastSeen The last time the ad was seen by our system.
Title The ad's title.
Url The ad's destination Url.
OtherKeywordsCount The number of other keywords that trigger this ad.
Cost: 80 API units per each result item.

GetKeywordPPCPublishers(keyword, searchEngineId, startIndex, maxCount, apiKey, country)

Description: Gets the PPC Publishers for the specified keyword.
Parameters:
keyword The keyword for the query.
searchEngineId The Id of the search engine to get the ads from : Google = 1, Yahoo/Bing = 2.
startIndex The index of the first result in the data set. First item index is 0.
maxCount The maximum number of results to for the request. Must be between 0 and 20,000.
apiKey Your own API Key.
country The country to search results for. Available options: US, UK and CA. Optional and defaults to US.
Request Format:
JSON: http://api.ispionage.com/GetKeywordPPCPublishers?keyword=[Keyword]&apiKey=[API Key]&searchEngineId=[Search Engine Id]&startIndex=[Start Index]&maxCount=[Max Count]&country=[Country]
Request Example:
JSON: http://api.ispionage.com/GetKeywordPPCPublishers?keyword=hosting&apiKey=1234&searchEngineId=1&startIndex=0&maxCount=5&country=us
Result:
Items A collection of result items (see bellow).
TotalRowsReturned Number of items in the result set.
TotalAvailableData Number of items available for the query.
Currency Currency used in the output result.
Country Country used for the output result.
Status Status of the current request.
Result Item:
Advertiser The advertiser name.
LowerBudget The advertiser's lower ad budget.
UpperBudget The advertiser's upper ad budget.
FirstSeen The fist time this keyword triggered an ad for this advertiser.
LastSeen The last time this keyword triggered an ad for this advertiser.
KeywordCount Number of paid keywords for this advertiser.
Cost: 30 API units per each result item.

GetKeywordSEOPublishers(keyword, startIndex, maxCount, apiKey, country)

Description: Gets the SEO Publishers for the specified keyword.
Parameters:
keyword The keyword for the query.
startIndex The index of the first result in the data set. First item index is 0.
maxCount The maximum number of results to for the request. Must be between 0 and 20,000.
apiKey Your own API Key.
country The country to search results for. Available options: US, UK and CA. Optional and defaults to US.
Request Format:
JSON: http://api.ispionage.com/GetKeywordSEOPublishers?keyword=[Keyword]&apiKey=[API Key]&startIndex=[Start Index]&maxCount=[Max Count]&country=[Country]
Request Example:
JSON: http://api.ispionage.com/GetKeywordSEOPublishers?keyword=hosting&apiKey=1234&startIndex=0&maxCount=5&country=us
Result:
Items A collection of result items (see bellow).
TotalRowsReturned Number of items in the result set.
TotalAvailableData Number of items available for the query.
Currency Currency used in the output result.
Country Country used for the output result.
Status Status of the current request.
Result Item:
CompetitorRootUrl The advertiser name.
Rank Rank of the advertiser sorted by ShareOfVoice descending.
ShareOfVoice It represents an overall potential organic traffic this URL gets for the keyword in question.
The calculation factors in the weight of each search engine.
i.e: Someone who ranks #1 in Google and #5 in Bing/Yahoo will have higher share of voice than someone who ranks #1 in Bing/Yahoo and #5 in Google.
GoogleRank Rank in Google for the given keyword.
BingYahooRank Rank in Bing/Yahoo for the given keyword.
GoogleBackLinks Number of backlinks in Google.
GoogleIndexedPages Number of indexed pages in Google.
SEOKeywordCount Number of SEO keywords for this advertiser.
PageRank The advertiser's page rank for the keyword.
Cost: 40 API units per each result item.

GetKeywordBasicStat(keyword, apiKey)

Description: Returns basic stats the specified keyword.
Parameters:
keyword The keyword for the query.
apiKey Your own API Key.
Request Format:
JSON: http://api.ispionage.com/GetKeywordBasicStat?keyword=[Keyword]&apiKey=[API Key]
Request Example:
JSON: http://api.ispionage.com/GetKeywordBasicStat?keyword=hosting&apiKey=1234
Result:
Keyword The keyword in the query.
AvgSearchVolume Average Search Volume for the given keyword.
CPC Cost Per Click for the given keyword.
Currency Currency used in the output result.
Status Status of the current request.
Cost: 10 API units per call.




If your account offer has API support you will find your API key and API unit balance info in Account -> API.

Competitive intelligence for
search engine marketers

Data Coverage

Last Refresh: 11/16/2016
92+ Million Keywords
136+ Million Ad Copy
19+ Million Domains
Google, Yahoo!, Bing
USA, UK, Canada
Resources

iSpionage Tutorials
PPC Articles
SEO Articles
CRO Articles
Company Intelligence Directory
Terms & Condition
Contact Us
FAQ
Top Blog Posts

The Essence of AdWords [Infographic]
39 Ways to Know You Make a Living from PPC [Infographic]
6 Excel Hacks for Better PPC Management
How One Marketer Generated 400,000+ Organic Visits with Long-Tail Content
Guide to a Successful Digital Marketing Footprint