/spyfu/domains/ranking_history

POST /api/spyfu/domains/ranking_history

Price: 20 credits

Get how a domain's Google rankings moved between two months, keyword by keyword

How to use it

List a domain's organic keywords by how their Google position changed between two months: new or lost rankings, keywords that entered or left the top 10, gained or lost positions or clicks. Each keyword carries its start and end rank and the monthly rank snapshots in between.

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)
• domain string required — Domain name or SpyFu URL (examples: "hubspot.com", "https://www.spyfu.com/overview/domain?query=hubspot.com"; 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")
• change_type string — Which ranking movement to list (default: "most_valuable"; one of: "most_valuable", "new_keywords", "no_longer_ranks", "made_the_top_10", "fell_from_top_10", "gained_ranks", "lost_ranks", "gained_clicks", "lost_clicks")
• start_month string nullable — First month, YYYY-MM; a year before end_month when omitted (examples: "2025-09"; pattern: ^\d{4}-(0[1-9]|1[0-2])$)
• end_month string nullable — Last month, YYYY-MM; the current month when omitted (examples: "2026-09"; pattern: ^\d{4}-(0[1-9]|1[0-2])$)
• 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: "SpyfuRankingKeyword")
• id string required
• keyword string required
• search_volume integer nullable
• start_rank integer nullable
• end_rank integer nullable
• rank_change integer nullable
• end_clicks integer nullable
• clicks_change integer nullable
• snapshots array (default: [])
  • @type string (default: "SpyfuRankSnapshot")
  • month string required
  • rank integer nullable

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.