Core Competitor Keyword Research API Documentation (v1)

This API does a lot: Search for a competitor. Download their keywords. Get stats like Ad Budget for domains. Get keyword stats like CPC and search volume.

Authentication

Basic Auth Token

Security scheme type:	HTTP
HTTP Authorization Scheme	basic

api_key

Secret Key Authentication

Security scheme type:	API Key
Query parameter name:	api_key

DomainApi

Search for a domain and get back all the keywords that domain ranks on. In addition, we add in as many relevant stats on those keywords as we can.

Get US metrics from domain

get /get_domain_metrics_us

https://www.spyfu.com:80/apis/core_api/get_domain_metrics_us

query Parameters

domain required	string Domain query
api_key	string User's secret key

Responses

200

204

Domain does not exist

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_metrics_us?domain=spyfu.com&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"avg_ad_position": 2,
"number_of_advertisers": 5,
"num_paid_keywords": 4721,
"paid_clicks_per_month": 5447,
"num_organic_keywords": 10645,
"organic_clicks_per_month": 1114117,
"daily_adwords_budget": 421,
"monthly_adwords_budget": 12630,
"daily_organic_traffic_value": 771499,
"organic_domain_ranking": 0,
"paid_domain_ranking": 0

}

Get UK metrics from domain

get /get_domain_metrics_uk

https://www.spyfu.com:80/apis/core_api/get_domain_metrics_uk

query Parameters

domain required	string Domain query
api_key	string User's secret key

Responses

200

204

Domain does not exist

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_metrics_uk?domain=spyfu.com&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"avg_ad_position": 2,
"number_of_advertisers": 5,
"num_paid_keywords": 4587,
"paid_clicks_per_month": 12178,
"num_organic_keywords": 6860,
"organic_clicks_per_month": 23418,
"daily_adwords_budget": 7,
"monthly_adwords_budget": 238,
"daily_organic_traffic_value": 5569,
"organic_domain_ranking": 0,
"paid_domain_ranking": 0

}

Get US competitors from domain Deprecated

get /get_domain_competitors_us

https://www.spyfu.com:80/apis/core_api/get_domain_competitors_us

query Parameters

domain required	string Domain query
isOrganic required	boolean Flag for SEO vs PPC competitors
r required	integer <int32> Maximum number of rows
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_competitors_us?domain=spyfu.com&isOrganic=true&r=10&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "domainId": "-8280301796433908807",
- "domainName": "spyfu.com",
- "overlap": 37.2072211721609,
- "commonKeywords": 0
}

]

Get UK competitors from domain Deprecated

get /get_domain_competitors_uk

https://www.spyfu.com:80/apis/core_api/get_domain_competitors_uk

query Parameters

domain required	string Domain query
isOrganic required	boolean Flag for SEO vs PPC competitors
r required	integer <int32> Maximum number of rows
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_competitors_uk?domain=spyfu.com&isOrganic=true&r=10&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "domainId": "-8280301796433908807",
- "domainName": "spyfu.com",
- "overlap": 30.964780443639658,
- "commonKeywords": 0
}

]

TermApi

Find in-depth metrics and advanced insights into each keyword along with every URL that ranks on that search. This is your launch pad toward building stronger SEO through keyword targeting, backlink discovery, and learning from competitors'content that ranks. Start here to build a ranking strategy and grow inspired for new content.

Get US term metrics in bulk

get /get_term_metrics_bulk_us

https://www.spyfu.com:80/apis/core_api/get_term_metrics_bulk_us

query Parameters

termCSV required	string Comma separated list of terms. For keywords with special characters, you can Base64 encode the entire CSV before sending it over.
api_key	string User's secret key

Responses

200

204

No valid terms

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_term_metrics_bulk_us?termCSV=bunny slippers,fuzzy bunny slippers,fluffy bunny slippers&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"termList":
[
- {
  - "broadClicksPerDay": "2.61",
  - "broadCostPerClick": "$0.44",
  - "broadCostPerDay": "$1.15",
  - "broadCostPerMonth": "$34.50",
  - "broadCTR": "1.00%",
  - "broadGlobalDailySearchVolume": "",
  - "broadGlobalMonthlySearchVolume": "",
  - "broadLocalDailySearchVolume": "",
  - "broadLocalMonthlySearchVolume": "",
  - "exactClicksPerDay": "8.19",
  - "exactCostPerClick": "$0.25",
  - "exactCostPerDay": "$2.08",
  - "exactCostPerMonth": "$62.40",
  - "exactCTR": "3.00%",
  - "exactGlobalDailySearchVolume": "270",
  - "exactGlobalMonthlySearchVolume": "8.10k",
  - "exactLocalDailySearchVolume": "180",
  - "exactLocalMonthlySearchVolume": "5.40k",
  - "hasImages": "True",
  - "hasMap": "False",
  - "hasNews": "False",
  - "hasShopping": "True",
  - "hasVideos": "False",
  - "isSerpBacked": false,
  - "keywordSEODifficulty": "57",
  - "maxOrganicMonthlyClicks": "0.00",
  - "maxOrganicMonthlyValue": "$0.00",
  - "numberOfAdvertisers": "10",
  - "phraseClicksPerDay": "25.4",
  - "phraseCostPerClick": "$0.16",
  - "phraseCostPerDay": "$4.07",
  - "phraseCostPerMonth": "$122",
  - "phraseCTR": "4.00%",
  - "phraseGlobalDailySearchVolume": "",
  - "phraseGlobalMonthlySearchVolume": "",
  - "phraseLocalDailySearchVolume": "",
  - "phraseLocalMonthlySearchVolume": "",
  - "rawBroadClicksPerDay": 2.61,
  - "rawBroadCostPerClick": 0.44,
  - "rawBroadCostPerDay": 1.15,
  - "rawBroadCostPerMonth": 34.5,
  - "rawBroadCTR": 0.01,
  - "rawBroadGlobalDailySearchVolume": 0,
  - "rawBroadGlobalMonthlySearchVolume": 0,
  - "rawBroadLocalDailySearchVolume": 0,
  - "rawBroadLocalMonthlySearchVolume": 0,
  - "rawExactClicksPerDay": 8.19,
  - "rawExactCostPerClick": 0.25,
  - "rawExactCostPerDay": 2.08,
  - "rawExactCostPerMonth": 62.4,
  - "rawExactCTR": 0.03,
  - "rawExactGlobalDailySearchVolume": 270,
  - "rawExactGlobalMonthlySearchVolume": 8100,
  - "rawExactLocalDailySearchVolume": 180,
  - "rawExactLocalMonthlySearchVolume": 5400,
  - "rawHasImages": true,
  - "rawHasMap": false,
  - "rawHasNews": false,
  - "rawHasShopping": true,
  - "rawHasVideos": false,
  - "rawKeywordSEODifficulty": 57,
  - "rawMaxOrganicMonthlyClicks": 0,
  - "rawMaxOrganicMonthlyValue": 0,
  - "rawNumberOfAdvertisers": 10,
  - "rawPhraseClicksPerDay": 25.41,
  - "rawPhraseCostPerClick": 0.16,
  - "rawPhraseCostPerDay": 4.07,
  - "rawPhraseCostPerMonth": 122.1,
  - "rawPhraseCTR": 0.04,
  - "rawPhraseGlobalDailySearchVolume": 0,
  - "rawPhraseGlobalMonthlySearchVolume": 0,
  - "rawPhraseLocalDailySearchVolume": 0,
  - "rawPhraseLocalMonthlySearchVolume": 0,
  - "rawResultCount": 8870000,
  - "rawTerm": "bunny slippers",
  - "rawTermId": 2300426,
  - "resultCount": "8.87m",
  - "term": "bunny slippers",
  - "termId": "2300426"
  }
],
"message": null,
"success": true,
"redirect_url": null,
"resultCount": 19

}

Get UK term metrics in bulk

get /get_term_metrics_bulk_uk

https://www.spyfu.com:80/apis/core_api/get_term_metrics_bulk_uk

query Parameters

termCSV required	string Comma separated list of terms. For keywords with special characters, you can Base64 encode the entire CSV before sending it over.
api_key	string User's secret key

Responses

200

204

No valid terms

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_term_metrics_bulk_uk?termCSV=bunny slippers,fuzzy bunny slippers,fluffy bunny slippers&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"termList":
[
- {
  - "broadClicksPerDay": "2.61",
  - "broadCostPerClick": "$0.44",
  - "broadCostPerDay": "$1.15",
  - "broadCostPerMonth": "$34.50",
  - "broadCTR": "1.00%",
  - "broadGlobalDailySearchVolume": "",
  - "broadGlobalMonthlySearchVolume": "",
  - "broadLocalDailySearchVolume": "",
  - "broadLocalMonthlySearchVolume": "",
  - "exactClicksPerDay": "8.19",
  - "exactCostPerClick": "$0.25",
  - "exactCostPerDay": "$2.08",
  - "exactCostPerMonth": "$62.40",
  - "exactCTR": "3.00%",
  - "exactGlobalDailySearchVolume": "270",
  - "exactGlobalMonthlySearchVolume": "8.10k",
  - "exactLocalDailySearchVolume": "180",
  - "exactLocalMonthlySearchVolume": "5.40k",
  - "hasImages": "True",
  - "hasMap": "False",
  - "hasNews": "True",
  - "hasShopping": "False",
  - "hasVideos": "False",
  - "isSerpBacked": false,
  - "keywordSEODifficulty": "57",
  - "maxOrganicMonthlyClicks": "0.00",
  - "maxOrganicMonthlyValue": "$0.00",
  - "numberOfAdvertisers": "10",
  - "phraseClicksPerDay": "25.4",
  - "phraseCostPerClick": "$0.16",
  - "phraseCostPerDay": "$4.07",
  - "phraseCostPerMonth": "$122",
  - "phraseCTR": "4.00%",
  - "phraseGlobalDailySearchVolume": "",
  - "phraseGlobalMonthlySearchVolume": "",
  - "phraseLocalDailySearchVolume": "",
  - "phraseLocalMonthlySearchVolume": "",
  - "rawBroadClicksPerDay": 2.61,
  - "rawBroadCostPerClick": 0.44,
  - "rawBroadCostPerDay": 1.15,
  - "rawBroadCostPerMonth": 34.5,
  - "rawBroadCTR": 0.01,
  - "rawBroadGlobalDailySearchVolume": 0,
  - "rawBroadGlobalMonthlySearchVolume": 0,
  - "rawBroadLocalDailySearchVolume": 0,
  - "rawBroadLocalMonthlySearchVolume": 0,
  - "rawExactClicksPerDay": 8.19,
  - "rawExactCostPerClick": 0.25,
  - "rawExactCostPerDay": 2.08,
  - "rawExactCostPerMonth": 62.4,
  - "rawExactCTR": 0.03,
  - "rawExactGlobalDailySearchVolume": 270,
  - "rawExactGlobalMonthlySearchVolume": 8100,
  - "rawExactLocalDailySearchVolume": 180,
  - "rawExactLocalMonthlySearchVolume": 5400,
  - "rawHasImages": true,
  - "rawHasMap": false,
  - "rawHasNews": true,
  - "rawHasShopping": false,
  - "rawHasVideos": false,
  - "rawKeywordSEODifficulty": 57,
  - "rawMaxOrganicMonthlyClicks": 0,
  - "rawMaxOrganicMonthlyValue": 0,
  - "rawNumberOfAdvertisers": 10,
  - "rawPhraseClicksPerDay": 25.41,
  - "rawPhraseCostPerClick": 0.16,
  - "rawPhraseCostPerDay": 4.07,
  - "rawPhraseCostPerMonth": 122.1,
  - "rawPhraseCTR": 0.04,
  - "rawPhraseGlobalDailySearchVolume": 0,
  - "rawPhraseGlobalMonthlySearchVolume": 0,
  - "rawPhraseLocalDailySearchVolume": 0,
  - "rawPhraseLocalMonthlySearchVolume": 0,
  - "rawResultCount": 8870000,
  - "rawTerm": "bunny slippers",
  - "rawTermId": 2300426,
  - "resultCount": "8.87m",
  - "term": "bunny slippers",
  - "termId": "2300426"
  }
],
"message": null,
"success": true,
"redirect_url": null,
"resultCount": 19

}

Get US metrics from term

get /get_term_metrics_us

https://www.spyfu.com:80/apis/core_api/get_term_metrics_us

query Parameters

term required	string Term query
searchDateId	integer <int32> Search date (YYYYMMDD)
api_key	string User's secret key

Responses

200

204

Term does not exist

400

This combination of term and searchDateId does not exist

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_term_metrics_us?term=bunny slippers&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"broadClicksPerDay": "2.61",
"broadCostPerClick": "$0.44",
"broadCostPerDay": "$1.15",
"broadCostPerMonth": "$34.50",
"broadCTR": "1.00%",
"broadGlobalDailySearchVolume": "",
"broadGlobalMonthlySearchVolume": "",
"broadLocalDailySearchVolume": "",
"broadLocalMonthlySearchVolume": "",
"exactClicksPerDay": "8.19",
"exactCostPerClick": "$0.25",
"exactCostPerDay": "$2.08",
"exactCostPerMonth": "$62.40",
"exactCTR": "3.00%",
"exactGlobalDailySearchVolume": "270",
"exactGlobalMonthlySearchVolume": "8.10k",
"exactLocalDailySearchVolume": "180",
"exactLocalMonthlySearchVolume": "5.40k",
"hasImages": "True",
"hasMap": "False",
"hasNews": "True",
"hasShopping": "False",
"hasVideos": "False",
"isSerpBacked": false,
"keywordSEODifficulty": "57",
"maxOrganicMonthlyClicks": "0.00",
"maxOrganicMonthlyValue": "$0.00",
"numberOfAdvertisers": "10",
"phraseClicksPerDay": "25.4",
"phraseCostPerClick": "$0.16",
"phraseCostPerDay": "$4.07",
"phraseCostPerMonth": "$122",
"phraseCTR": "4.00%",
"phraseGlobalDailySearchVolume": "",
"phraseGlobalMonthlySearchVolume": "",
"phraseLocalDailySearchVolume": "",
"phraseLocalMonthlySearchVolume": "",
"rawBroadClicksPerDay": 2.61,
"rawBroadCostPerClick": 0.44,
"rawBroadCostPerDay": 1.15,
"rawBroadCostPerMonth": 34.5,
"rawBroadCTR": 0.01,
"rawBroadGlobalDailySearchVolume": 0,
"rawBroadGlobalMonthlySearchVolume": 0,
"rawBroadLocalDailySearchVolume": 0,
"rawBroadLocalMonthlySearchVolume": 0,
"rawExactClicksPerDay": 8.19,
"rawExactCostPerClick": 0.25,
"rawExactCostPerDay": 2.08,
"rawExactCostPerMonth": 62.4,
"rawExactCTR": 0.03,
"rawExactGlobalDailySearchVolume": 270,
"rawExactGlobalMonthlySearchVolume": 8100,
"rawExactLocalDailySearchVolume": 180,
"rawExactLocalMonthlySearchVolume": 5400,
"rawHasImages": true,
"rawHasMap": false,
"rawHasNews": true,
"rawHasShopping": false,
"rawHasVideos": false,
"rawKeywordSEODifficulty": 57,
"rawMaxOrganicMonthlyClicks": 0,
"rawMaxOrganicMonthlyValue": 0,
"rawNumberOfAdvertisers": 10,
"rawPhraseClicksPerDay": 25.41,
"rawPhraseCostPerClick": 0.16,
"rawPhraseCostPerDay": 4.07,
"rawPhraseCostPerMonth": 122.1,
"rawPhraseCTR": 0.04,
"rawPhraseGlobalDailySearchVolume": 0,
"rawPhraseGlobalMonthlySearchVolume": 0,
"rawPhraseLocalDailySearchVolume": 0,
"rawPhraseLocalMonthlySearchVolume": 0,
"rawResultCount": 8870000,
"rawTerm": "bunny slippers",
"rawTermId": 2300426,
"rawTop10DomainDiversity": 0.75,
"rawTop10Facebook": false,
"rawTop10GovEduMilDomains": 0,
"rawTop10LinkedIn": false,
"rawTop10NumberOfHomepages": 0,
"rawTop10Pinterest": true,
"rawTop10TitleContainsKeyword": 8,
"rawTop10Tumblr": false,
"rawTop10Twitter": false,
"rawTop10UrlContainsKeyword": 5,
"rawTop10Wiki": false,
"rawTop10YouTube": false,
"rawTop50DomainDiversity": 0.9375,
"rawTop50Facebook": true,
"rawTop50GovEduMilDomains": 0,
"rawTop50LinkedIn": false,
"rawTop50NumberOfHomepages": 1,
"rawTop50Pinterest": true,
"rawTop50TitleContainsKeyword": 47,
"rawTop50Tumblr": false,
"rawTop50Twitter": true,
"rawTop50UrlContainsKeyword": 33,
"rawTop50Wiki": true,
"rawTop50YouTube": false,
"resultCount": "8.87m",
"term": "bunny slippers",
"termId": "2300426",
"top10DomainDiversity": "75.0%",
"top10Facebook": "False",
"top10GovEduMilDomains": "0",
"top10LinkedIn": "False",
"top10NumberOfHomepages": "0",
"top10Pinterest": "True",
"top10TitleContainsKeyword": "8",
"top10Tumblr": "False",
"top10Twitter": "False",
"top10UrlContainsKeyword": "5",
"top10Wiki": "False",
"top10YouTube": "False",
"top50DomainDiversity": "93.8%",
"top50Facebook": "True",
"top50GovEduMilDomains": "0",
"top50LinkedIn": "False",
"top50NumberOfHomepages": "1",
"top50Pinterest": "True",
"top50TitleContainsKeyword": "47",
"top50Tumblr": "False",
"top50Twitter": "True",
"top50UrlContainsKeyword": "33",
"top50Wiki": "True",
"top50YouTube": "False"

}

Get UK metrics from term

get /get_term_metrics_uk

https://www.spyfu.com:80/apis/core_api/get_term_metrics_uk

query Parameters

term required	string Term query
searchDateId	integer <int32> Search date (YYYYMMDD)
api_key	string User's secret key

Responses

200

204

Term does not exist

400

This combination of term and searchDateId does not exist

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_term_metrics_uk?term=bunny slippers&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"broadClicksPerDay": "2.61",
"broadCostPerClick": "$0.44",
"broadCostPerDay": "$1.15",
"broadCostPerMonth": "$34.50",
"broadCTR": "1.00%",
"broadGlobalDailySearchVolume": "",
"broadGlobalMonthlySearchVolume": "",
"broadLocalDailySearchVolume": "",
"broadLocalMonthlySearchVolume": "",
"exactClicksPerDay": "8.19",
"exactCostPerClick": "$0.25",
"exactCostPerDay": "$2.08",
"exactCostPerMonth": "$62.40",
"exactCTR": "3.00%",
"exactGlobalDailySearchVolume": "270",
"exactGlobalMonthlySearchVolume": "8.10k",
"exactLocalDailySearchVolume": "180",
"exactLocalMonthlySearchVolume": "5.40k",
"hasImages": "True",
"hasMap": "False",
"hasNews": "True",
"hasShopping": "False",
"hasVideos": "False",
"isSerpBacked": false,
"keywordSEODifficulty": "57",
"maxOrganicMonthlyClicks": "0.00",
"maxOrganicMonthlyValue": "$0.00",
"numberOfAdvertisers": "10",
"phraseClicksPerDay": "25.4",
"phraseCostPerClick": "$0.16",
"phraseCostPerDay": "$4.07",
"phraseCostPerMonth": "$122",
"phraseCTR": "4.00%",
"phraseGlobalDailySearchVolume": "",
"phraseGlobalMonthlySearchVolume": "",
"phraseLocalDailySearchVolume": "",
"phraseLocalMonthlySearchVolume": "",
"rawBroadClicksPerDay": 2.61,
"rawBroadCostPerClick": 0.44,
"rawBroadCostPerDay": 1.15,
"rawBroadCostPerMonth": 34.5,
"rawBroadCTR": 0.01,
"rawBroadGlobalDailySearchVolume": 0,
"rawBroadGlobalMonthlySearchVolume": 0,
"rawBroadLocalDailySearchVolume": 0,
"rawBroadLocalMonthlySearchVolume": 0,
"rawExactClicksPerDay": 8.19,
"rawExactCostPerClick": 0.25,
"rawExactCostPerDay": 2.08,
"rawExactCostPerMonth": 62.4,
"rawExactCTR": 0.03,
"rawExactGlobalDailySearchVolume": 270,
"rawExactGlobalMonthlySearchVolume": 8100,
"rawExactLocalDailySearchVolume": 180,
"rawExactLocalMonthlySearchVolume": 5400,
"rawHasImages": true,
"rawHasMap": false,
"rawHasNews": true,
"rawHasShopping": false,
"rawHasVideos": false,
"rawKeywordSEODifficulty": 57,
"rawMaxOrganicMonthlyClicks": 0,
"rawMaxOrganicMonthlyValue": 0,
"rawNumberOfAdvertisers": 10,
"rawPhraseClicksPerDay": 25.41,
"rawPhraseCostPerClick": 0.16,
"rawPhraseCostPerDay": 4.07,
"rawPhraseCostPerMonth": 122.1,
"rawPhraseCTR": 0.04,
"rawPhraseGlobalDailySearchVolume": 0,
"rawPhraseGlobalMonthlySearchVolume": 0,
"rawPhraseLocalDailySearchVolume": 0,
"rawPhraseLocalMonthlySearchVolume": 0,
"rawResultCount": 8870000,
"rawTerm": "bunny slippers",
"rawTermId": 2300426,
"rawTop10DomainDiversity": 0.75,
"rawTop10Facebook": false,
"rawTop10GovEduMilDomains": 0,
"rawTop10LinkedIn": false,
"rawTop10NumberOfHomepages": 0,
"rawTop10Pinterest": true,
"rawTop10TitleContainsKeyword": 8,
"rawTop10Tumblr": false,
"rawTop10Twitter": false,
"rawTop10UrlContainsKeyword": 5,
"rawTop10Wiki": false,
"rawTop10YouTube": false,
"rawTop50DomainDiversity": 0.9375,
"rawTop50Facebook": true,
"rawTop50GovEduMilDomains": 0,
"rawTop50LinkedIn": false,
"rawTop50NumberOfHomepages": 1,
"rawTop50Pinterest": true,
"rawTop50TitleContainsKeyword": 47,
"rawTop50Tumblr": false,
"rawTop50Twitter": true,
"rawTop50UrlContainsKeyword": 33,
"rawTop50Wiki": true,
"rawTop50YouTube": false,
"resultCount": "8.87m",
"term": "bunny slippers",
"termId": "2300426",
"top10DomainDiversity": "75.0%",
"top10Facebook": "False",
"top10GovEduMilDomains": "0",
"top10LinkedIn": "False",
"top10NumberOfHomepages": "0",
"top10Pinterest": "True",
"top10TitleContainsKeyword": "8",
"top10Tumblr": "False",
"top10Twitter": "False",
"top10UrlContainsKeyword": "5",
"top10Wiki": "False",
"top10YouTube": "False",
"top50DomainDiversity": "93.8%",
"top50Facebook": "True",
"top50GovEduMilDomains": "0",
"top50LinkedIn": "False",
"top50NumberOfHomepages": "1",
"top50Pinterest": "True",
"top50TitleContainsKeyword": "47",
"top50Tumblr": "False",
"top50Twitter": "True",
"top50UrlContainsKeyword": "33",
"top50Wiki": "True",
"top50YouTube": "False"

}

Get US urls ranking on a term

get /get_term_ranking_urls_us

https://www.spyfu.com:80/apis/core_api/get_term_ranking_urls_us

query Parameters

term required	string Term query
api_key	string User's secret key

Responses

200

204

Term does not exist

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_term_ranking_urls_us?term=bunny slippers&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"organicGrid":
[
- {
 - "domainAppearances": "1",
 - "domainId": "8290935754279865328",
 - "domainName": "bunnyslippers.com",
 - "domainStrength": "40",
 - "estimatedOrganicMonthlyClicks": "138",
 - "fullUrl": "https://www.bunnyslippers.com/",
 - "isAdvertiser": "True",
 - "position": "2",
 - "rawDomainAppearances": 1,
 - "rawDomainId": 8290935754279865000,
 - "rawDomainName": "bunnyslippers.com",
 - "rawDomainStrength": 40,
 - "rawEstimatedOrganicMonthlyClicks": 137.836636970471,
 - "rawFullUrl": "https://www.bunnyslippers.com/",
 - "rawIsAdvertiser": true,
 - "rawPosition": 2,
 - "rawTerm": "bunny slippers",
 - "rawTitle": "Bunny Slippers | Animal Slippers & Novelty Slippers | BunnySlippers ...",
 - "rawUrlId": -1165290331469794000,
 - "rawUrlPositionChange": 0,
 - "title": "Bunny Slippers | Animal Slippers & Novelty Slippers | BunnySlippers ...",
 - "urlId": "-1165290331469794164",
 - "urlPositionChange": "0"
 }
],
"resultCount": 49

}

Get UK urls ranking on a term

get /get_term_ranking_urls_uk

https://www.spyfu.com:80/apis/core_api/get_term_ranking_urls_uk

query Parameters

term required	string Term query
api_key	string User's secret key

Responses

200

204

Term does not exist

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_term_ranking_urls_uk?term=bunny slippers&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"organicGrid":
[
- {
 - "domainAppearances": "1",
 - "domainId": "8290935754279865328",
 - "domainName": "bunnyslippers.com",
 - "domainStrength": "40",
 - "estimatedOrganicMonthlyClicks": "138",
 - "fullUrl": "https://www.bunnyslippers.com/",
 - "isAdvertiser": "True",
 - "position": "2",
 - "rawDomainAppearances": 1,
 - "rawDomainId": 8290935754279865000,
 - "rawDomainName": "bunnyslippers.com",
 - "rawDomainStrength": 40,
 - "rawEstimatedOrganicMonthlyClicks": 137.836636970471,
 - "rawFullUrl": "https://www.bunnyslippers.com/",
 - "rawIsAdvertiser": true,
 - "rawPosition": 2,
 - "rawTerm": "bunny slippers",
 - "rawTitle": "Bunny Slippers | Animal Slippers & Novelty Slippers | BunnySlippers ...",
 - "rawUrlId": -1165290331469794000,
 - "rawUrlPositionChange": 0,
 - "title": "Bunny Slippers | Animal Slippers & Novelty Slippers | BunnySlippers ...",
 - "urlId": "-1165290331469794164",
 - "urlPositionChange": "0"
 }
],
"resultCount": 49

}

HistoricApi

Find in-depth historical data on a domain. Including position history, organic and paid keywords and value over time. This can help you find out not only how the domain is doing but also track the changes in the domain over time.

Get history of US domain's budget

get /get_domain_budget_history_us

https://www.spyfu.com:80/apis/core_api/get_domain_budget_history_us

query Parameters

domain required	string Domain query
months	integer <int32> How many months of historic data to get
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_budget_history_us?domain=spyfu.com&months=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "date": "Apr '12",
- "estimatedMonthlyBudget": "13444.50"
}

]

Get history of UK domain's budget

get /get_domain_budget_history_uk

https://www.spyfu.com:80/apis/core_api/get_domain_budget_history_uk

query Parameters

domain required	string Domain query
months	integer <int32> How many months of historic data to get
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_budget_history_uk?domain=spyfu.com&months=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "date": "Mar '12",
- "estimatedMonthlyBudget": "0.00"
}

]

Get history of US domain's organic value

get /get_domain_organic_history_us

https://www.spyfu.com:80/apis/core_api/get_domain_organic_history_us

query Parameters

domain required	string Domain query
months	integer <int32> How many months of historic data to get
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_organic_history_us?domain=spyfu.com&months=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "date": "Apr '12",
- "estimatedOrganicValue": "23444.50"
}

]

Get history of UK domain's organic value

get /get_domain_organic_history_uk

https://www.spyfu.com:80/apis/core_api/get_domain_organic_history_uk

query Parameters

domain required	string Domain query
months	integer <int32> How many months of historic data to get
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_organic_history_uk?domain=spyfu.com&months=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "date": "Apr '12",
- "estimatedOrganicValue": "23444.50"
}

]

Get history of US domain's clicks

get /get_domain_clicks_history_us

https://www.spyfu.com:80/apis/core_api/get_domain_clicks_history_us

query Parameters

domain required	string Domain query
months	integer <int32> How many months of historic data to get
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_clicks_history_us?domain=spyfu.com&months=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "date": "Apr '12",
- "organicClicks": "23444",
- "paidClicks": "234445"
}

]

Get history of UK domain's clicks

get /get_domain_clicks_history_uk

https://www.spyfu.com:80/apis/core_api/get_domain_clicks_history_uk

query Parameters

domain required	string Domain query
months	integer <int32> How many months of historic data to get
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_clicks_history_uk?domain=spyfu.com&months=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "date": "Apr '12",
- "organicClicks": "23444",
- "paidClicks": "234445"
}

]

Get history of US domain's total ads and keywords

get /get_domain_totals_history_us

https://www.spyfu.com:80/apis/core_api/get_domain_totals_history_us

query Parameters

domain required	string Domain query
months	integer <int32> How many months of historic data to get
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_totals_history_us?domain=spyfu.com&months=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "date": "Apr '12",
- "totalOrganicResults": 19999999,
- "totalAdsPurchased": 23445
}

]

Get history of UK domain's total ads and keywords

get /get_domain_totals_history_uk

https://www.spyfu.com:80/apis/core_api/get_domain_totals_history_uk

query Parameters

domain required	string Domain query
months	integer <int32> How many months of historic data to get
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_totals_history_uk?domain=spyfu.com&months=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "date": "Apr '12",
- "totalOrganicResults": 18999999,
- "totalAdsPurchased": 13445
}

]

Get history of US domain's positions

get /get_domain_ranks_history_us

https://www.spyfu.com:80/apis/core_api/get_domain_ranks_history_us

query Parameters

domain required	string Domain query
months	integer <int32> How many months of historic data to get
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_ranks_history_us?domain=spyfu.com&months=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "date": "Apr '12",
- "totalInverseRankTop50": 5434321,
- "totalInverseRankTop20": 22811,
- "totalInverseRankTop10": 5971
}

]

Get history of UK domain's positions

get /get_domain_ranks_history_uk

https://www.spyfu.com:80/apis/core_api/get_domain_ranks_history_uk

query Parameters

domain required	string Domain query
months	integer <int32> How many months of historic data to get
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_domain_ranks_history_uk?domain=spyfu.com&months=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "date": "Apr '12",
- "totalInverseRankTop50": 5434321,
- "totalInverseRankTop20": 22811,
- "totalInverseRankTop10": 5971
}

]

AdvancedBulkApi

A helper call to allow you to call other APIs in bulk.

Calls to return a list of JSON objects from repeated calls to a different api. This is a Beta API for advanced users.

get /get_bulk_api

https://www.spyfu.com:80/apis/core_api/get_bulk_api

query Parameters

baseApi required	string Base api to call. Must start with https://www.spyfu.com/apis/ (https%3A%2F%2Fwww.spyfu.com%2Fapis%2Fcore_api%2Fget_term_metrics_us for example). Make sure to URL encode this parameter.
requestParameters required	string parameters to pass in. everything to the right of the ? in the query. For the parameter you want to loop over, and URL Encode it. use \| to separate each part of a multiple request, and make sure to URL encode each part of the request. For instance, to call get_term_metrics_us for "newegg com", "Best Candle Scents", and "what does ? and = and & mean?", you would get this: term=newegg+com\|Best+Candle+Scents\|what%20does%20%3F%20and%20%3D%20and%20%26%20mean%3F&api_key=SECRET_KEY which you then URL encode to get: requestParameters=term%3Dnewegg%2Bcom%7CBest%2BCandle%2BScents%7Cwhat%2520does%2520%253F%2520and%2520%253D%2520and%2520%2526%2520mean%253F%26api_key%3DSECRET_KEY so the final URL you request would look like: https://www.spyfu.com/apis/core_api/get_bulk_api?baseApi=https%3A%2F%2Fwww.spyfu.com%2Fapis%2Fcore_api%2Fget_term_metrics_us&requestParameters=term%3Dnewegg%2Bcom%7CBest%2BCandle%2BScents%7Cwhat%2520does%2520%253F%2520and%2520%253D%2520and%2520%2526%2520mean%253F%26api_key%3DSECRET_KEY&api_key=SECRET_KEY
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/core_api/get_bulk_api?baseApi=https%3A%2F%2Fwww.spyfu.com%2Fapis%2Fcore_api%2Fget_domain_budget_history_us&requestParameters=domain%3Dspyfu.com%7Cnewegg.com%7Cbestbuy.com%26months%3D2%26api_key%3DSECRET_KEY&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "url": "https://www.spyfu.com/apis/core_api/get_domain_budget_history_us?domain=spyfu.com&months=2&api_key=API_KEY",
- "result":
  [
  - {
    "date": "Jan '20",
    "estimatedMonthlyBudget": "18352.50"
    },
  - {
    "date": "Feb '20",
    "estimatedMonthlyBudget": "18249.00"
    }
  ],
- "exceptionType": null,
- "exceptionMessage": null
},
{
- "url": "https://www.spyfu.com/apis/core_api/get_domain_budget_history_us?domain=newegg.com&months=2&api_key=API_KEY",
- "result":
  [
  - {
    "date": "Jan '20",
    "estimatedMonthlyBudget": "162914.40"
    },
  - {
    "date": "Feb '20",
    "estimatedMonthlyBudget": "158577.90"
    }
  ],
- "exceptionType": null,
- "exceptionMessage": null
},
{
- "url": "https://www.spyfu.com/apis/core_api/get_domain_budget_history_us?domain=bestbuy.com&months=2&api_key=API_KEY",
- "result":
  [
  - {
    "date": "Jan '20",
    "estimatedMonthlyBudget": "1691160.90"
    },
  - {
    "date": "Feb '20",
    "estimatedMonthlyBudget": "1707463.80"
    }
  ],
- "exceptionType": null,
- "exceptionMessage": null
}

]

Calls to return a list of JSON objects from repeated calls to a different api. This is a Beta API for advanced users.

post /get_bulk_api

https://www.spyfu.com:80/apis/core_api/get_bulk_api

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

Can use this to post both the requestParameters and baseApi so they don't need to be sent via an http Get. Example: { "baseApi": "https://www.spyfu.com/apis/core_api/get_domain_budget_history_us" ,"requestParameters": "domain=spyfu.com|newegg.com|bestbuy.com&months=2&api_key=APIKEY"}. inside the requestParameter part of the object, on the parameter you are looping over, make sure to UrlEncode each option and then use the | symbol. Also make sure to send as Json, using Content-Type: application/json

baseApi	string
requestParameters	string

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"baseApi": "string",
"requestParameters": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "url": "https://www.spyfu.com/apis/core_api/get_domain_budget_history_us?domain=spyfu.com&months=2&api_key=API_KEY",
- "result":
  [
  - {
    "date": "Jan '20",
    "estimatedMonthlyBudget": "18352.50"
    },
  - {
    "date": "Feb '20",
    "estimatedMonthlyBudget": "18249.00"
    }
  ],
- "exceptionType": null,
- "exceptionMessage": null
},
{
- "url": "https://www.spyfu.com/apis/core_api/get_domain_budget_history_us?domain=newegg.com&months=2&api_key=API_KEY",
- "result":
  [
  - {
    "date": "Jan '20",
    "estimatedMonthlyBudget": "162914.40"
    },
  - {
    "date": "Feb '20",
    "estimatedMonthlyBudget": "158577.90"
    }
  ],
- "exceptionType": null,
- "exceptionMessage": null
},
{
- "url": "https://www.spyfu.com/apis/core_api/get_domain_budget_history_us?domain=bestbuy.com&months=2&api_key=API_KEY",
- "result":
  [
  - {
    "date": "Jan '20",
    "estimatedMonthlyBudget": "1691160.90"
    },
  - {
    "date": "Feb '20",
    "estimatedMonthlyBudget": "1707463.80"
    }
  ],
- "exceptionType": null,
- "exceptionMessage": null
}

]