/spyfu/keywords/related

POST /api/spyfu/keywords/related

Price: 20 credits

Get keywords related to a keyword, with volume, cost per click and difficulty

How to use it

List keywords related to a keyword: phrase matches containing it, buying-intent variants, questions, keywords the same sites also rank for, or keywords the same advertisers also buy. Filter by terms, volume, difficulty or cost per click.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• include_terms array nullable — Keep only keywords containing any of these terms (examples: ["crm","sales"])
• search_volume_min integer nullable — Minimum monthly search volume (min: 0)
• search_volume_max integer nullable — Maximum monthly search volume (min: 0)
• ranking_difficulty_min integer nullable — Minimum ranking difficulty (min: 0; max: 100)
• ranking_difficulty_max integer nullable — Maximum ranking difficulty (min: 0; max: 100)
• cost_per_click_min number nullable — Minimum broad-match cost per click, USD (min: 0)
• cost_per_click_max number nullable — Maximum broad-match cost per click, USD (min: 0)
• 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")
• related_type string — How the returned keywords relate to the input (default: "similar"; one of: "similar", "transactional", "questions", "also_ranks_for", "also_buys_ads_for")
• offset integer — Number of rows to skip (default: 0; min: 0; max: 9995)
• count integer required — Max number of results (min: 1; max: 1000)

Response

• @type string (default: "SpyfuKeyword")
• 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: [])

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 — The entity was not found, or a precondition failed 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.