> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrapeunblocker.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a website's Similarweb traffic overview

> Returns Similarweb's public traffic overview for `domain` as JSON: `globalRank`, `countryRank` (with `country`), `categoryRank` (with `category`) and their month-over-month changes; `totalVisits` for the latest month with `visitsChangePercent`; `bounceRate`, `pagesPerVisit`, `avgVisitDuration`/`avgVisitDurationSeconds`; `visitsHistory` (the last 3 months - earlier months are derived from Similarweb's own month-over-month change) and `rankHistory`; `trafficSources` (channel shares - Similarweb's free page reveals only some, the rest are null); `topCountries`; `demographics` (gender, age groups); `competitors` (similar sites with affinity); `search` (organic/paid split and top keywords); `socialNetworks`, `referrals`, `outgoingLinks`, `displayAds`; `technologies`; `audienceInterests`; and the `company` profile. `snapshotDate` is the month the data describes. A domain Similarweb has no page for returns `found: false` with the same keys set to null/empty; a known domain too small to estimate returns `hasTrafficData: false`.



## OpenAPI

````yaml /api-reference/openapi.json post /seo/similarweb
openapi: 3.1.0
info:
  title: ScrapeUnblocker API
  description: >-
    Public API for the ScrapeUnblocker proxy/anti-bot service. Authenticate
    every request with the `x-scrapeunblocker-key` header. Documented here:
    page-source extraction, Google SERP scraping, image fetch, and the dedicated
    plugin endpoints (search engines, marketplaces, reviews, travel, social and
    more). All other paths exist for internal operations and are intentionally
    hidden from this spec.
  version: 3.0.0
servers:
  - url: https://api.scrapeunblocker.com
    description: Production
security: []
paths:
  /seo/similarweb:
    post:
      tags:
        - Plugins
      summary: Get a website's Similarweb traffic overview
      description: >-
        Returns Similarweb's public traffic overview for `domain` as JSON:
        `globalRank`, `countryRank` (with `country`), `categoryRank` (with
        `category`) and their month-over-month changes; `totalVisits` for the
        latest month with `visitsChangePercent`; `bounceRate`, `pagesPerVisit`,
        `avgVisitDuration`/`avgVisitDurationSeconds`; `visitsHistory` (the last
        3 months - earlier months are derived from Similarweb's own
        month-over-month change) and `rankHistory`; `trafficSources` (channel
        shares - Similarweb's free page reveals only some, the rest are null);
        `topCountries`; `demographics` (gender, age groups); `competitors`
        (similar sites with affinity); `search` (organic/paid split and top
        keywords); `socialNetworks`, `referrals`, `outgoingLinks`, `displayAds`;
        `technologies`; `audienceInterests`; and the `company` profile.
        `snapshotDate` is the month the data describes. A domain Similarweb has
        no page for returns `found: false` with the same keys set to null/empty;
        a known domain too small to estimate returns `hasTrafficData: false`.
      operationId: similarweb_overview_seo_similarweb_post
      parameters:
        - name: domain
          in: query
          required: true
          schema:
            type: string
            description: >-
              Website to look up: a bare domain ('github.com'), a URL
              ('https://www.github.com/about'), or a Similarweb page URL. A
              leading 'www.' is dropped; other subdomains ('docs.python.org')
              are kept.
            title: Domain
          description: >-
            Website to look up: a bare domain ('github.com'), a URL
            ('https://www.github.com/about'), or a Similarweb page URL. A
            leading 'www.' is dropped; other subdomains ('docs.python.org') are
            kept.
        - name: proxy_country
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Exit-IP country (ISO-2, e.g. 'US', 'DE'). Optional.
            title: Proxy Country
          description: Exit-IP country (ISO-2, e.g. 'US', 'DE'). Optional.
      responses:
        '200':
          description: >-
            JSON website overview (`found: false` when Similarweb has no data
            for the domain).
          content:
            application/json:
              schema: {}
        '400':
          description: Missing or malformed domain / proxy_country.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '502':
          description: >-
            Blocked by Similarweb, or its free-view allowance was exhausted on
            every exit tried - retry.
        '504':
          description: Fetch timed out.
      security:
        - ScrapeUnblockerKey: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ScrapeUnblockerKey:
      type: apiKey
      in: header
      name: x-scrapeunblocker-key
      description: Your ScrapeUnblocker API key. Apply on every request.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.