/similarweb/websites

POST /api/similarweb/websites

Price: 1 credit

Website traffic report: monthly visits with history, engagement, global, country and category ranks, traffic sources, top countries, top keywords and AI chatbot referrals

How to use it

Looks up one website by domain or URL and returns its latest reported month with the previous months of visits. Shares and bounce rate are percentages. A subdomain is reported on its own.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• domain string required — Website domain or URL (examples: "dealroom.co", "docs.github.com", "https://www.notion.so/product", "https://www.similarweb.com/website/apify.com/"; minLength: 1)

Response

• @type string (default: "SimilarwebWebsite")
• domain string required
• url string required
• description string nullable
• image string nullable
• category string nullable
• is_small_site boolean nullable
• month_date integer nullable
• monthly_visits integer nullable
• visits_history array (default: [])
  • @type string (default: "SimilarwebWebsiteMonth")
  • month_date integer required
  • visits integer nullable
• bounce_rate number nullable
• pages_per_visit number nullable
• avg_visit_duration integer nullable
• global_rank integer nullable
• country_rank integer nullable
• country_rank_country_code string nullable
• category_rank integer nullable
• global_category_rank integer nullable
• traffic_sources object nullable
  • @type string (default: "SimilarwebWebsiteTrafficSources")
  • direct number nullable
  • search number nullable
  • organic_search number nullable
  • paid_search number nullable
  • social number nullable
  • organic_social number nullable
  • paid_social number nullable
  • referrals number nullable
  • email number nullable
  • display_ads number nullable
  • affiliate number nullable
  • ai_chatbots number nullable
• top_countries array (default: [])
  • @type string (default: "SimilarwebWebsiteCountryShare")
  • country_code string required
  • share number nullable
• top_keywords array (default: [])
  • @type string (default: "SimilarwebWebsiteKeyword")
  • keyword string required
  • search_volume integer nullable
  • cpc number nullable
  • estimated_value number nullable
• ai_visits integer nullable
• ai_visits_share number nullable
• ai_chatbot_referrers array (default: [])
  • @type string (default: "SimilarwebWebsiteChatbot")
  • domain string required
  • rank integer nullable
  • share number nullable
  • share_history array (default: [])
    • @type string (default: "SimilarwebWebsiteChatbotMonth")
    • month_date integer required
    • share number nullable
• ai_prompts 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 source has no traffic 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.