/spyfu/lists

POST /api/spyfu/lists

Price: 1 credit

Get SpyFu's curated top lists of domains and keywords with their leading entries

How to use it

Get SpyFu's curated leaderboards: domains that spend the most on Google Ads or get the most organic traffic, lead lists by contact channel, and the most expensive or most clicked keywords overall and by industry. Each list comes with its top five entries.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• list_type string — Domain lists, keyword lists or both (default: "all"; one of: "all", "domains", "keywords")
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "SpyfuList")
• id string required
• name string nullable
• list_type string required
• description string nullable
• metric_name string nullable
• metric_type string nullable
• ad_budget_range string nullable
• seo_clicks_range string nullable
• contact_details string nullable
• technologies string nullable
• industries string nullable
• is_sorted_by_budget boolean nullable
• view_order integer nullable
• domains array (default: [])
  • @type string (default: "SpyfuListDomain")
  • id string nullable
  • domain string required
  • ad_budget number nullable
  • seo_clicks number nullable
  • has_email boolean nullable
  • has_phone boolean nullable
  • has_location boolean nullable
  • has_facebook boolean nullable
  • has_twitter boolean nullable
  • has_linkedin boolean nullable
  • has_youtube boolean nullable
  • has_pinterest boolean nullable
  • has_google_plus boolean nullable
• keywords array (default: [])
  • @type string (default: "SpyfuListKeyword")
  • id string nullable
  • keyword string required
  • rank number nullable
  • metric_value number nullable
  • date string 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.