/spyfu/domains

POST /api/spyfu/domains

Price: 5 credits

Get a domain's SpyFu profile: organic and paid search metrics, top competitors and monthly history

How to use it

Get the SpyFu overview of one domain: organic keyword count, clicks and value, paid keyword count and ad budget for the latest month, its top organic and paid competitors, its best-performing ads, and the month-by-month history of those metrics.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• 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")

Response

• @type string (default: "SpyfuDomain")
• id string required
• domain string required
• month string nullable
• organic_keyword_count integer nullable
• monthly_organic_clicks number nullable
• monthly_organic_value number nullable
• average_organic_rank number nullable
• paid_keyword_count integer nullable
• monthly_paid_clicks number nullable
• monthly_ad_budget number nullable
• average_ad_rank number nullable
• strength integer nullable
• newly_ranked_keyword_count integer nullable
• gained_rank_keyword_count integer nullable
• lost_rank_keyword_count integer nullable
• organic_competitors array (default: [])
  • @type string (default: "SpyfuTopCompetitor")
  • domain string required
  • common_keyword_count integer nullable
  • overlap_score number nullable
• paid_competitors array (default: [])
  • @type string (default: "SpyfuTopCompetitor")
  • domain string required
  • common_keyword_count integer nullable
  • overlap_score number nullable
• ad_keyword_count integer nullable
• top_ads array (default: [])
  • @type string (default: "SpyfuTopAd")
  • id string required
  • text string nullable
  • url string nullable
  • average_position number nullable
  • average_ad_count number nullable
  • leaderboard_count integer nullable
  • leaderboard_share number nullable
  • ads_served_share number nullable
• history array (default: [])
  • @type string (default: "SpyfuDomainMonth")
  • month string required
  • organic_keyword_count integer nullable
  • monthly_organic_clicks number nullable
  • monthly_organic_value number nullable
  • average_organic_rank number nullable
  • paid_keyword_count integer nullable
  • monthly_paid_clicks number nullable
  • monthly_ad_budget number nullable
  • average_ad_rank number nullable
  • strength integer nullable
  • total_inverse_rank integer nullable
  • has_data boolean 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 — SpyFu has no data for this domain. 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.