/spyfu/keywords

POST /api/spyfu/keywords

Price: 10 credits

Get a keyword's SpyFu profile: volume, cost per click, difficulty, the Google results and its ads

How to use it

Get the SpyFu profile of one keyword: search volume, click and cost-per-click estimates by match type, ranking difficulty, the organic Google results with their estimated clicks, the ads seen on it over time and the domains that advertise on it.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Keyword or SpyFu keyword URL (examples: "crm software", "https://www.spyfu.com/keyword/overview?query=crm+software"; minLength: 1)
• country_code string — Search market (UK, not GB) (default: "US"; one of: "AR", "AT", "AU", "BE", "BR", "CA", "CH", "CL", "CZ", "DE", "DK", "ES", "FI", "FR", "IE", "IN", "IT", "JP", "MX", "NL", "NO", "NZ", "PL", "PT", "SE", "SG", "TR", "UA", "UK", "US", "VE", "ZA")

Response

• @type string (default: "SpyfuKeywordProfile")
• id string required
• keyword string required
• search_volume integer nullable
• live_search_volume integer nullable
• ranking_difficulty integer nullable
• monthly_clicks integer nullable
• mobile_search_share number nullable
• desktop_search_share number nullable
• no_click_share number nullable
• paid_click_share number nullable
• organic_click_share number nullable
• broad_cost_per_click number nullable
• phrase_cost_per_click number nullable
• exact_cost_per_click number nullable
• broad_monthly_clicks number nullable
• phrase_monthly_clicks number nullable
• exact_monthly_clicks number nullable
• broad_monthly_cost number nullable
• phrase_monthly_cost number nullable
• exact_monthly_cost number nullable
• paid_competitor_count integer nullable
• ranking_homepage_count integer nullable
• serp_features array (default: [])
• serp_first_result string nullable
• is_question boolean nullable
• is_adult boolean nullable
• is_transactional boolean nullable
• serp_advertisers array (default: [])
  • @type string (default: "SpyfuAdvertiserRank")
  • rank integer nullable
  • month string nullable
  • domains array (default: [])
• broad_click_through_rate number nullable
• exact_global_search_volume integer nullable
• exact_local_search_volume integer nullable
• has_images boolean nullable
• has_map boolean nullable
• has_news boolean nullable
• has_shopping boolean nullable
• has_videos boolean nullable
• seo_difficulty integer nullable
• max_organic_monthly_clicks integer nullable
• max_organic_monthly_value number nullable
• top_100_homepage_count integer nullable
• top_100_gov_edu_mil_count integer nullable
• top_100_title_match_count integer nullable
• top_100_url_match_count integer nullable
• top_100_domain_diversity number nullable
• top_100_has_wikipedia boolean nullable
• top_100_has_facebook boolean nullable
• top_100_has_twitter boolean nullable
• top_100_has_youtube boolean nullable
• top_100_has_pinterest boolean nullable
• top_100_has_tumblr boolean nullable
• top_100_has_linkedin boolean nullable
• organic_results array (default: [])
  • @type string (default: "SpyfuOrganicResult")
  • position integer nullable
  • position_change integer nullable
  • domain string nullable
  • domain_id string nullable
  • url string nullable
  • url_id string nullable
  • domain_appearance_count integer nullable
  • estimated_monthly_clicks integer nullable
  • estimated_click_value number nullable
• paid_results array (default: [])
  • @type string (default: "SpyfuPaidResult")
  • position integer nullable
  • ad_count integer nullable
  • searched_at integer nullable
  • text string nullable
  • display_url string nullable
  • url string nullable
  • domain string nullable
  • domain_id string nullable
  • url_id string nullable
  • is_adult boolean nullable
• advertisers array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — SpyFu has no data for this keyword. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.