---
updatedAt: 2025-07-23T22:11:19.000Z
agentTools:
projectIndex: https://developer.spyfu.com/llms.txt
---
# Post Keyword Information Bulk
Returns comprehensive keyword metrics and intelligence for a large list of exact keywords via POST request. This endpoint supports larger keyword lists and provides search volume, competition data, cost estimates, and performance insights for bulk keyword analysis.
[Visualize this API live on SpyFu](https://www.spyfu.com/keyword/overview?query=running+shoes)
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Keyword API",
"version": "v2",
"description": "Expand your keyword portfolio through semantic keyword discovery, related term analysis, and comprehensive keyword intelligence to uncover hidden opportunities and optimize content strategy. Powered by SpyFu's extensive keyword database spanning 18 years of search intelligence across global markets.\n\nSpyFu's Related Keywords API analyzes **8 billion keywords** with comprehensive semantic relationships and performance metrics, built on a foundation of **1.6 trillion search results** and **1.6 billion keywords** tracked live in SERPs globally. Our database provides **20x more paid keywords per domain** and **2x more organic keywords per domain** than SEMRush or Ahrefs. **Every keyword relationship updates every 15 seconds**, ensuring you have real-time semantic intelligence across all 28 supported countries.\n\nWhile competitors provide basic related keyword suggestions, SpyFu delivers comprehensive semantic keyword analysis with 18 years of historical data and live updates every 15 seconds. Our advanced algorithms identify question keywords, transactional intent terms, and competitive keyword relationships to reveal complete keyword ecosystems.\n\nWith this API, you can discover semantically related keywords with performance insights, identify question-based keywords for content optimization, uncover transactional intent keywords for conversion optimization, find keywords that competitors rank for and advertise on, access comprehensive keyword information including search volume and competition metrics, and expand keyword portfolios through intelligent semantic analysis. Build comprehensive keyword strategies based on real search behavior and competitive intelligence.\n\nThe Related Keywords API integrates seamlessly with SpyFu's SEO Research, Ad History, and Competitors APIs to provide complete keyword intelligence, enabling you to combine semantic discovery with competitive analysis and performance tracking.\n\nGet started with comprehensive API documentation and interactive examples at [SpyFu Developer Portal](https://developer.spyfu.com)."
},
"servers": [
{
"url": "https://api.spyfu.com/apis/keyword_api"
}
],
"paths": {
"/v2/related/getKeywordInformation": {
"post": {
"operationId": "RelatedKeywordsV2Api_GetKeywordsByBulkSearchPost_POST",
"summary": "Post Keyword Information Bulk",
"description": "Returns comprehensive keyword metrics and intelligence for a large list of exact keywords via POST request. This endpoint supports larger keyword lists and provides search volume, competition data, cost estimates, and performance insights for bulk keyword analysis.\n\n[Visualize this API live on SpyFu](https://www.spyfu.com/keyword/overview?query=running+shoes)",
"requestBody": {
"description": "Bulk keyword analysis request containing the list of keywords and country settings.",
"required": true,
"content": {
"application/*+json": {
"schema": {
"description": "Input for getting bulk keywords for the public API",
"type": "object",
"properties": {
"countryCode": {
"description": "Country to get results for.",
"type": "string",
"examples": [
"US"
],
"default": "US",
"enum": [
"AR",
"AT",
"AU",
"BE",
"BR",
"CA",
"CH",
"DE",
"DK",
"ES",
"FR",
"IE",
"IN",
"IT",
"JP",
"MX",
"NL",
"NO",
"NZ",
"PL",
"PT",
"SE",
"SG",
"TR",
"UA",
"UK",
"US",
"ZA"
]
},
"searchVolume": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"liveSearchVolume": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"keywordDifficulty": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"wordCount": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"clicks": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"costPerClickOption": {
"description": "Cost per click keyword matching option to filter results by.",
"type": [
"string",
"null"
],
"examples": [
"Broad"
],
"enum": [
"Broad",
"Exact",
"Phrase"
]
},
"costPerClick": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"mobileSearchesPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"desktopSearchesPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"notClickedSearchesPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"paidClickSearchPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"organicClicksSearchPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"monthlyCostOption": {
"description": "Monthly Cost keyword matching option to filter results by.",
"type": [
"string",
"null"
],
"examples": [
"Broad"
],
"enum": [
"Broad",
"Exact",
"Phrase"
]
},
"monthlyCost": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"adCount": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"rankingHomepages": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"adultFilter": {
"description": "Exclude adult keywords considered unsafe for work.",
"type": [
"boolean",
"null"
],
"examples": [
true
],
"default": true
},
"onlyAdultKeywords": {
"description": "Only include adult keywords considered unsafe for work.",
"type": [
"boolean",
"null"
],
"examples": [
false
],
"default": false
},
"isQuestion": {
"description": "Filter on if the keyword is a question.",
"type": "boolean",
"examples": [
false
],
"default": false
},
"isTransactionalIntent": {
"description": "Filter on if the keyword has transactional intent.",
"type": "boolean",
"examples": [
false
],
"default": false
},
"keywords": {
"description": "CSV of keywords",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"keywords"
]
}
},
"application/json": {
"schema": {
"description": "Input for getting bulk keywords for the public API",
"type": "object",
"properties": {
"countryCode": {
"description": "Country to get results for.",
"type": "string",
"examples": [
"US"
],
"default": "US",
"enum": [
"AR",
"AT",
"AU",
"BE",
"BR",
"CA",
"CH",
"DE",
"DK",
"ES",
"FR",
"IE",
"IN",
"IT",
"JP",
"MX",
"NL",
"NO",
"NZ",
"PL",
"PT",
"SE",
"SG",
"TR",
"UA",
"UK",
"US",
"ZA"
]
},
"searchVolume": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"liveSearchVolume": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"keywordDifficulty": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"wordCount": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"clicks": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"costPerClickOption": {
"description": "Cost per click keyword matching option to filter results by.",
"type": [
"string",
"null"
],
"examples": [
"Broad"
],
"enum": [
"Broad",
"Exact",
"Phrase"
]
},
"costPerClick": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"mobileSearchesPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"desktopSearchesPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"notClickedSearchesPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"paidClickSearchPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"organicClicksSearchPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"monthlyCostOption": {
"description": "Monthly Cost keyword matching option to filter results by.",
"type": [
"string",
"null"
],
"examples": [
"Broad"
],
"enum": [
"Broad",
"Exact",
"Phrase"
]
},
"monthlyCost": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"adCount": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"rankingHomepages": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"adultFilter": {
"description": "Exclude adult keywords considered unsafe for work.",
"type": [
"boolean",
"null"
],
"examples": [
true
],
"default": true
},
"onlyAdultKeywords": {
"description": "Only include adult keywords considered unsafe for work.",
"type": [
"boolean",
"null"
],
"examples": [
false
],
"default": false
},
"isQuestion": {
"description": "Filter on if the keyword is a question.",
"type": "boolean",
"examples": [
false
],
"default": false
},
"isTransactionalIntent": {
"description": "Filter on if the keyword has transactional intent.",
"type": "boolean",
"examples": [
false
],
"default": false
},
"keywords": {
"description": "CSV of keywords",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"keywords"
]
}
},
"text/json": {
"schema": {
"description": "Input for getting bulk keywords for the public API",
"type": "object",
"properties": {
"countryCode": {
"description": "Country to get results for.",
"type": "string",
"examples": [
"US"
],
"default": "US",
"enum": [
"AR",
"AT",
"AU",
"BE",
"BR",
"CA",
"CH",
"DE",
"DK",
"ES",
"FR",
"IE",
"IN",
"IT",
"JP",
"MX",
"NL",
"NO",
"NZ",
"PL",
"PT",
"SE",
"SG",
"TR",
"UA",
"UK",
"US",
"ZA"
]
},
"searchVolume": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"liveSearchVolume": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"keywordDifficulty": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"wordCount": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"clicks": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"costPerClickOption": {
"description": "Cost per click keyword matching option to filter results by.",
"type": [
"string",
"null"
],
"examples": [
"Broad"
],
"enum": [
"Broad",
"Exact",
"Phrase"
]
},
"costPerClick": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"mobileSearchesPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"desktopSearchesPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"notClickedSearchesPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"paidClickSearchPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"organicClicksSearchPercentage": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"monthlyCostOption": {
"description": "Monthly Cost keyword matching option to filter results by.",
"type": [
"string",
"null"
],
"examples": [
"Broad"
],
"enum": [
"Broad",
"Exact",
"Phrase"
]
},
"monthlyCost": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"adCount": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"rankingHomepages": {
"type": "object",
"additionalProperties": false,
"properties": {
"min": {
"type": [
"number",
"null"
],
"format": "float"
},
"max": {
"type": [
"number",
"null"
],
"format": "float"
}
}
},
"adultFilter": {
"description": "Exclude adult keywords considered unsafe for work.",
"type": [
"boolean",
"null"
],
"examples": [
true
],
"default": true
},
"onlyAdultKeywords": {
"description": "Only include adult keywords considered unsafe for work.",
"type": [
"boolean",
"null"
],
"examples": [
false
],
"default": false
},
"isQuestion": {
"description": "Filter on if the keyword is a question.",
"type": "boolean",
"examples": [
false
],
"default": false
},
"isTransactionalIntent": {
"description": "Filter on if the keyword has transactional intent.",
"type": "boolean",
"examples": [
false
],
"default": false
},
"keywords": {
"description": "CSV of keywords",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"keywords"
]
}
}
}
},
"responses": {
"200": {
"description": "Successfully retrieved bulk keyword information. Returns comprehensive metrics including search volume, competition levels, cost estimates, and performance data for each requested keyword in the payload.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resultCount": {
"description": "Number of results returned",
"type": "integer",
"format": "int32",
"examples": [
100
],
"readOnly": true
},
"totalMatchingResults": {
"description": "The total number of results available that matches the query including\r\nitems that might not be included in the returned results/page.",
"type": "integer",
"format": "int64",
"readOnly": true
},
"results": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"keyword": {
"description": "By looking at strong competitors in this niche and their most trusted keywords over time, we suggest similar keywords here that we found to be profitable for your competition.",
"type": [
"string",
"null"
],
"examples": [
"red shoes"
]
},
"searchVolume": {
"description": "This is the estimated number of times this past month that people have searched this keyword. The numbers reflect searches done in the US on Google.com (or in the UK on Google.co.uk if you are looking at UK data). We blend data from multiple sources to give a truer snapshot of activity on this keyword.",
"type": [
"integer",
"null"
],
"format": "int64",
"examples": [
266000
]
},
"liveSearchVolume": {
"description": "This metric displays a more likely SV based on recent trends or out-of-date estimates. The original volume remains unchanged in any domain's rolled-up metrics.",
"type": [
"integer",
"null"
],
"format": "int64",
"examples": [
82000
]
},
"rankingDifficulty": {
"description": "We've calculated how difficult it would be to rank on this keyword. The score is based on a scale of 0-100 (with 100 being the most difficult to rank for). Compare this number to other keywords you're targeting to get an idea of how to prioritize your SEO campaign.",
"type": [
"integer",
"null"
],
"format": "int32",
"examples": [
98
]
},
"totalMonthlyClicks": {
"description": "This is the total number of all clicks (organic and paid) made on the SERP over the past month.",
"type": [
"integer",
"null"
],
"format": "int64",
"examples": [
219000
]
},
"percentMobileSearches": {
"description": "When we have a breakdown of how many of the searches for this keyword come from mobile vs desktop, we will show it here.",
"type": [
"number",
"null"
],
"format": "double",
"examples": [
0.52009505
]
},
"percentDesktopSearches": {
"description": "When we have a breakdown of how many of the searches for this keyword come from desktop vs mobile, we will show it here.",
"type": [
"number",
"null"
],
"format": "double",
"examples": [
0.47990492
]
},
"percentSearchesNotClicked": {
"description": "Some SERPs return enough information that the user does not have to click any results. There might also be unexpected results that cause the user to abandon the SERP without any clicks. This is the rate that searchers leave the page without clicking any result.",
"type": [
"number",
"null"
],
"format": "double",
"examples": [
0.1792681
]
},
"percentPaidClicks": {
"description": "Of all clicks made to this keyword's SERP, this percentage measures how many went to the paid ads.",
"type": [
"number",
"null"
],
"format": "double",
"examples": [
0.52188635
]
},
"percentOrganicClicks": {
"description": "Of all clicks made to this keyword's SERP, this percentage measures how many went to organic results.",
"type": [
"number",
"null"
],
"format": "double",
"examples": [
0.47811362
]
},
"broadCostPerClick": {
"description": "This is the average amount an advertiser pays Google anytime someone clicks their ad on this keyword. These costs fluctuate depending on many factors, so keep that in mind when you are estimating larger budgets.\r\nThese costs can vary depending on how specific (exact match vs. phrase match vs. broad match) the search is.
",
"type": [
"number",
"null"
],
"format": "double",
"examples": [
0.73
]
},
"phraseCostPerClick": {
"description": "This is the average amount an advertiser pays Google anytime someone clicks their ad on this keyword. These costs fluctuate depending on many factors, so keep that in mind when you are estimating larger budgets.\r\nThese costs can vary depending on how specific (exact match vs. phrase match vs. broad match) the search is.
",
"type": [
"number",
"null"
],
"format": "double",
"examples": [
0.67
]
},
"exactCostPerClick": {
"description": "This is the average amount an advertiser pays Google anytime someone clicks their ad on this keyword. These costs fluctuate depending on many factors, so keep that in mind when you are estimating larger budgets.\r\nThese costs can vary depending on how specific (exact match vs. phrase match vs. broad match) the search is.
",
"type": [
"number",
"null"
],
"format": "double",
"examples": [
0.65
]
},
"broadMonthlyClicks": {
"description": "Estimated monthly clicks for broad match advertising on this keyword, calculated from search volume and expected click-through rates.",
"type": [
"number",
"null"
],
"format": "float",
"examples": [
57019.8
]
},
"phraseMonthlyClicks": {
"description": "Estimated monthly clicks for phrase match advertising on this keyword, calculated from search volume and expected click-through rates.",
"type": [
"number",
"null"
],
"format": "float",
"examples": [
42150.3
]
},
"exactMonthlyClicks": {
"description": "Estimated monthly clicks for exact match advertising on this keyword, calculated from search volume and expected click-through rates.",
"type": [
"number",
"null"
],
"format": "float",
"examples": [
29094.6
]
},
"broadMonthlyCost": {
"description": "Our estimate of what an advertiser would spend, on average, to advertise on this keyword each month.\r\nThese costs can vary depending on how specific (exact match vs. phrase match vs. broad match) the search is.
",
"type": [
"number",
"null"
],
"format": "double",
"examples": [
41604.9
]
},
"phraseMonthlyCost": {
"description": "Our estimate of what an advertiser would spend, on average, to advertise on this keyword each month.\r\nThese costs can vary depending on how specific (exact match vs. phrase match vs. broad match) the search is.
",
"type": [
"number",
"null"
],
"format": "double",
"examples": [
25542
]
},
"exactMonthlyCost": {
"description": "Our estimate of what an advertiser would spend, on average, to advertise on this keyword each month.\r\nThese costs can vary depending on how specific (exact match vs. phrase match vs. broad match) the search is.
",
"type": [
"number",
"null"
],
"format": "double",
"examples": [
19041.6
]
},
"paidCompetitors": {
"description": "This is the total number of advertisers we've seen over the last 14 months for this keyword. It's helpful to know how competitive the field is and how many advertisers have tested this keyword over time.",
"type": [
"integer",
"null"
],
"format": "int32",
"examples": [
15
]
},
"distinctCompetitors": {
"description": "This is the list of distinct advertisers we've seen over the last 14 months for this keyword.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"rankingHomepages": {
"description": "We roll up the number of home pages that rank within the first 50 results for this keyword. (It doesn't count ads, only organic results.) A homepage might be \"https://webmd.com\" vs a longer path like \"https://www.webmd.com/fitness-exercise\".",
"type": [
"integer",
"null"
],
"format": "int32",
"examples": [
8
]
},
"serpFeaturesCsv": {
"description": "Comma-separated list of SERP features present for this keyword (e.g., Images, Videos, Maps, Shopping), indicating competition for organic real estate.",
"type": [
"string",
"null"
],
"examples": [
"Images,Maps"
]
},
"serpFirstResult": {
"description": "Domain name of the top-ranking organic result for this keyword, useful for identifying category leaders.",
"type": [
"string",
"null"
],
"examples": [
"example.com"
]
},
"isQuestion": {
"description": "Indicates whether this keyword is phrased as a question (who, what, when, where, why, how).",
"type": "boolean",
"examples": [
false
]
},
"isNotSafeForWork": {
"description": "Indicates whether this keyword is flagged as containing adult or inappropriate content.",
"type": "boolean",
"examples": [
false
]
}
},
"additionalProperties": false
},
"readOnly": true
}
},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad Request - Invalid request body or parameters provided (e.g., malformed keyword list or invalid country code)"
},
"401": {
"description": "Unauthorized - Invalid API credentials or insufficient permissions to access keyword research data"
},
"500": {
"description": "Internal Server Error - A server-side error occurred while processing the request"
}
},
"tags": [
"Keyword Research API"
]
}
}
},
"components": {
"securitySchemes": {
"Basic_Authentication_Token": {
"type": "http",
"description": "Basic Authentication is a standard that involves encoding your SPYFU_API_ID:SECRET_KEY into a Base64 string. Your SpyFu API ID and Secret Key can both be found under the Account Settings -> API Usage page. Additionally, you can find the Base64 string has been pre-generated on the same page under Base 64 Key. Finally, this encoded string is sent in the \"Authorization\" header prefixed with the keyword \"Basic\":
For example, to authorize as 00000000-0000-0000-0000-000000000000:AB12WXYZ the client would send
Authorization: Basic MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwOkFCMTJXWFla
",
"scheme": "basic"
},
"Query_Parameter_Token": {
"type": "apiKey",
"description": "An API key can be added as a query parameter. Your API key is listed as \"Secret Key\" found under the Account Settings -> API Usage page
For example, to authorize with the API key AB12WXY
/apis/example_api/GetExample?domain=spyfu.com&api_key=AB12WXYZ
",
"name": "api_key",
"in": "query"
},
"HMAC_Authentication_Header": {
"type": "apiKey",
"description": "For even more security, each request can be individually authenticated with a timestamped HMAC (Hash Message Authentication Code) signature. Composed of your secret key, a valid timestamp, the API request path, and all request parameters. Creating the signature:
Combine the pieces that will be converted into the signature.
StringToSign =
HTTP-Verb + \"\\n\" +
Timestamp + \"\\n\" +
UrlPath + \"\\n\"
QueryParameters;
Create UTF-8 encodings of the above string and of your secret key.
byte[] SecretKeyBytes = UTF-8-Encoding-Of( Upper-Case-Of( SECRET_KEY ) );
byte[] StringToSignBytes = UTF-8-Encoding-Of( StringToSign );
Use an implementation of HMAC256 using your UTF-8 secret key to encode the combined string of your request. This should then be converted to Base64 to finish creating your signature.
Signature = Base64( HMAC-SHA256( SecretKeyBytes, StringToSignBytes ) );
Using the signature:
This signature is then sent in through an Authentication header with your username.
Authentication: UserName:Signature
",
"name": "Authentication",
"in": "header"
}
}
},
"security": [
{
"Basic_Authentication_Token": []
},
{
"Query_Parameter_Token": []
},
{
"HMAC_Authentication_Header": []
}
]
}
```