Name: Similarweb API for Website Traffic and Domain Data
Brand: bon
SKU: api-bon-similarweb
Availability: InStock
Author: API Market

shoes feiyue

# Similarweb API

## Overview

The Similarweb API returns Similarweb domain overview data for a single website in one JSON response. It has 1 endpoint: you send a bare domain such as `github.com` to `/domain/overview` and get back the site's name, title and description, estimated monthly visits for the last three months, engagement figures (bounce rate, pages per visit, time on site), global, country and category ranks, the share of traffic from each source (direct, search, social, referrals, mail, display ads, AI chatbots and more), the top countries by traffic share, top organic keywords, AI referral traffic details, a screenshot URL and the `SnapshotDate` of the monthly data. Because everything comes back in one call, there is nothing to chain: one domain in, one overview out.

It is built for marketers and SEO teams comparing their site with competitors, sales and growth teams enriching leads with a traffic and rank estimate, investors and analysts sizing a website's audience, and developers adding traffic panels to dashboards or internal tools. The response is a flat JSON object with nested objects for ranks, engagement and traffic sources. Shares such as `TrafficSources` and `TopCountryShares.Value` are fractions between 0 and 1, the values inside `Engagments` are returned as strings, and `EstimatedMonthlyVisits` maps the first day of each month to a visit count. All traffic and engagement values are estimates, not audited first-party analytics, and fields can be missing or `null` for small, new or low-traffic sites.

## Features

*   **1 endpoint**: A single domain overview lookup that returns traffic, engagement, rankings, sources, geography and keywords together.
*   **Simple input**: One `domain` query parameter with a bare hostname such as `github.com`. No scheme, path, port or query string.
*   **Traffic estimates**: `EstimatedMonthlyVisits` for the last three monthly snapshots, plus the latest month's visits in `Engagments.Visits`.
*   **Engagement metrics**: Bounce rate, pages per visit and average time on site in seconds for the latest month.
*   **Rankings**: `GlobalRank`, `CountryRank` for the site's top country, and `CategoryRank` with the Similarweb category path.
*   **Traffic sources**: Shares for direct, organic and paid search, organic and paid social, referrals, mail, display ads, affiliate and generative AI.
*   **Geography**: `TopCountryShares` with the numeric country code, the two-letter `CountryCode` and the share of traffic for each leading country.
*   **Keywords and AI referrals**: `TopKeywords` with estimated value, volume and CPC, and `AiTrafficDetails` listing the AI chatbots that send traffic to the site, when available.
*   **Data source**: Similarweb domain overview data for the domain you request, with `SnapshotDate` showing which monthly snapshot you received. Responses carry an `X-Cache` header (`HIT` or `MISS`).
*   **Rate limit**: 1 request per second on the Free plan, 100 on PRO, 400 on ULTRA and 800 on MEGA.

## Use Cases

*   **Competitor analysis**: Compare visits, engagement and traffic source mix across a list of competing domains.
*   **SEO research**: See how much of a site's traffic comes from organic search and which keywords bring it in.
*   **Lead enrichment**: Add estimated monthly visits, global rank and category to company records in a CRM.
*   **Market and investment research**: Size a website's audience and see which countries it draws traffic from.
*   **Reporting dashboards**: Track a set of domains month by month using `EstimatedMonthlyVisits` and `SnapshotDate`.
*   **AI visibility checks**: See how much referral traffic a site gets from AI chatbots and which ones send it.

## API Documentation

### Base URL

All requests go through the API.market gateway at this base URL:

```
https://prod.api.market/api/v1/bon/similarweb
```

### Authentication

Every request needs your API.market key in the `x-api-market-key` header:

```
x-api-market-key: YOUR_API_KEY
```

Replace `YOUR_API_KEY` with your actual API key.

### Endpoints

#### 1. Get domain overview

Returns the Similarweb overview for one domain: site name, title and description, top country shares, engagement for the latest month, estimated monthly visits, global, country and category ranks, traffic sources, category, a large screenshot URL, a list of countries with their codes, competitors, top keywords, AI traffic details and the snapshot date. Field availability varies by domain.

Key response fields:

*   `SiteName`, `Title`, `Description`: The domain and the site's page title and description.
*   `TopCountryShares`: Leading countries, each with `Country` (numeric ISO code), `CountryCode` (two letters) and `Value` (share of traffic, 0 to 1).
*   `Engagments`: Spelled exactly this way. Holds `BounceRate`, `Month`, `Year`, `PagePerVisit`, `Visits` and `TimeOnSite` (seconds), all as strings.
*   `EstimatedMonthlyVisits`: An object that maps each month (`YYYY-MM-DD`) to estimated visits.
*   `GlobalRank`, `CountryRank`, `CategoryRank`: Rank objects. `CategoryRank.Rank` is a string, the others are numbers. `GlobalCategoryRank` can be `null`.
*   `TrafficSources`: Shares (0 to 1) for `SocialOrganic`, `SocialPaid`, `Mail`, `Referrals`, `SearchOrganic`, `SearchPaid`, `Direct`, `GenAi`, `Affiliate` and `DisplayAds`.
*   `Category`, `IsSmall`, `IsDataFromGa`, `Policy`, `Version`: Category path and flags about the data.
*   `LargeScreenshot`: URL of a screenshot of the site.
*   `Countries`: A reference list of countries with `Code`, `UrlCode` and `Name` (252 entries in the capture).
*   `Competitors.TopSimilarityCompetitors`: Similar sites, which can be an empty array.
*   `TopKeywords`: Keywords with `Name`, `EstimatedValue`, `Volume` and `Cpc` (`Cpc` can be `null`).
*   `AiTrafficDetails`: AI chatbots that refer traffic (`Traffic.Split`, `Traffic.Distribution`), `TotalVisits`, `ReferralTraffic` share and example `TopPrompts`.
*   `SnapshotDate`: The monthly snapshot the data comes from.

**Method:** `GET`

**Endpoint:** `/domain/overview`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `domain` | query | Bare hostname such as `github.com`, without `https://`, a path, port, query string or credentials. Minimum 3 characters. | string | Yes | - | 253 characters |

**Example Request:**

```bash
curl -X GET "https://prod.api.market/api/v1/bon/similarweb/domain/overview?domain=github.com" \
  -H "x-api-market-key: YOUR_API_KEY"
```

**Example Response (200 OK, abridged):**

The `Countries`, `TopKeywords` and `AiTrafficDetails` arrays are shortened to a few whole items. The full response for `github.com` was about 20 KB.

```json
{
  "Version": 1,
  "SiteName": "github.com",
  "Description": "Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.",
  "TopCountryShares": [
    {
      "Country": 840,
      "CountryCode": "US",
      "Value": 0.18729738163186363
    },
    {
      "Country": 156,
      "CountryCode": "CN",
      "Value": 0.11827030901050795
    },
    {
      "Country": 356,
      "CountryCode": "IN",
      "Value": 0.10321304595309633
    },
    {
      "Country": 643,
      "CountryCode": "RU",
      "Value": 0.07843613525091112
    },
    {
      "Country": 276,
      "CountryCode": "DE",
      "Value": 0.04146258706699903
    }
  ],
  "Title": "GitHub · Change is constant. GitHub keeps you ahead.",
  "Engagments": {
    "BounceRate": "0.36438292086747437",
    "Month": "9",
    "Year": "2026",
    "PagePerVisit": "5.693619515496066",
    "Visits": "645466516",
    "TimeOnSite": "387.34021758031724"
  },
  "EstimatedMonthlyVisits": {
    "2026-07-01": 637885711,
    "2026-08-01": 649321442,
    "2026-09-01": 645466516
  },
  "GlobalRank": {
    "Rank": 45
  },
  "CountryRank": {
    "Country": 840,
    "CountryCode": "US",
    "Rank": 77
  },
  "CategoryRank": {
    "Rank": "4",
    "Category": "Computers_Electronics_and_Technology/Programming_and_Developer_Software"
  },
  "GlobalCategoryRank": null,
  "IsSmall": false,
  "Policy": 0,
  "TrafficSources": {
    "SocialOrganic": 0.09415446782629765,
    "SocialPaid": 0.0012427357029428073,
    "Mail": 0.012168886561863202,
    "Referrals": 0.09321430140604392,
    "SearchOrganic": 0.2434187083320837,
    "SearchPaid": 0.0002220358540706299,
    "Direct": 0.5331173088458794,
    "GenAi": 0.01989890060163066,
    "Affiliate": 4.200441868769193e-05,
    "DisplayAds": 0.0025206504505002293
  },
  "Category": "computers_electronics_and_technology/programming_and_developer_software",
  "LargeScreenshot": "https://site-images.similarcdn.com/image?url=github.com&t=1&s=1&h=6525c30f1af9ea5ee8912788b611744e1debcba39a2d0dd3d410b2916169883b",
  "IsDataFromGa": false,
  "Countries": [
    {
      "Code": "AF",
      "UrlCode": "afghanistan",
      "Name": "Afghanistan"
    },
    {
      "Code": "AX",
      "UrlCode": "land-islands",
      "Name": "Åland Islands"
    }
  ],
  "Competitors": {
    "TopSimilarityCompetitors": []
  },
  "Notification": {
    "Content": null
  },
  "TopKeywords": [
    {
      "Name": "github",
      "EstimatedValue": 11461050,
      "Volume": 10089950,
      "Cpc": 1.62
    },
    {
      "Name": "github login",
      "EstimatedValue": 457620,
      "Volume": 367170,
      "Cpc": 0.5
    },
    {
      "Name": "dlss 5 swapper",
      "EstimatedValue": 446360,
      "Volume": 599340,
      "Cpc": null
    }
  ],
  "AiTrafficDetails": {
    "Traffic": {
      "Split": [
        {
          "Name": "chatgpt.com",
          "Rank": 1,
          "Icon": "/image?url=chatgpt.com&t=2&s=1&h=a31616ae3cdef12fcfc664127563e6092e7531e7b4c3cde7e0c8c5fd3310dfc0"
        },
        {
          "Name": "claude.ai",
          "Rank": 2,
          "Icon": "/image?url=claude.ai&t=2&s=1&h=a3b3778e02952b653132fb6d019ed0361cff7850429377787fbdc4c86ce1565e"
        }
      ],
      "Distribution": {
        "Boundary": "<100M",
        "Chart": [
          {
            "Name": "chatgpt.com",
            "Icon": "/image?url=chatgpt.com&t=2&s=1&h=a31616ae3cdef12fcfc664127563e6092e7531e7b4c3cde7e0c8c5fd3310dfc0",
            "History": [
              {
                "Date": "2026-09-01",
                "Value": 61.82275229737763
              },
              {
                "Date": "2026-08-01",
                "Value": 71.5486579684268
              },
              {
                "Date": "2026-07-01",
                "Value": 49.05721467654221
              }
            ]
          }
        ],
        "Chatbots": [
          {
            "Name": "chatgpt.com",
            "Icon": "/image?url=chatgpt.com&t=2&s=1&h=a31616ae3cdef12fcfc664127563e6092e7531e7b4c3cde7e0c8c5fd3310dfc0",
            "Value": 61.82275229737763
          },
          {
            "Name": "claude.ai",
            "Icon": "/image?url=claude.ai&t=2&s=1&h=a3b3778e02952b653132fb6d019ed0361cff7850429377787fbdc4c86ce1565e",
            "Value": 12.856019889911751
          }
        ]
      }
    },
    "TotalVisits": 12006520.332000002,
    "ReferralTraffic": 0.019108086777003975,
    "TopPrompts": {
      "Status": 0,
      "ErrorMessage": null,
      "Prompts": [
        "How do I create a new repository, push an existing local project to it, and manage basic access permissions using a web-based Git hosting service?"
      ]
    }
  },
  "SnapshotDate": "2026-09-01T00:00:00+00:00"
}
```

## Status Codes

| Code | Status | Description |
|---|---|---|
| 200 | OK | The overview was returned. Some fields can be `null` or empty arrays when the data is not available for the domain. |
| 400 | Bad Request | The `domain` parameter is missing or invalid, for example it includes `https://`, a path or a port, or is shorter than 3 characters. |
| 401 | Unauthorized | The `x-api-market-key` value is invalid or expired. |
| 403 | Forbidden | Your subscription does not include this endpoint. |
| 404 | Not Found | No overview data is available for the domain. This can happen for small, new or private sites. |
| 429 | Too Many Requests | You went over your plan's requests per second, or you have used all the calls on the Free plan. |
| 500 | Internal Server Error | Something failed while processing the request. Retry after a short delay. |
| 502 | Bad Gateway | The upstream data source returned an error. Retry with backoff. |
| 503 | Service Unavailable | The service is temporarily unavailable. Retry with backoff. |
| 504 | Gateway Timeout | The upstream lookup took too long. Retry with backoff. |

Error responses use the shape `{"error": {"code": "...", "message": "..."}}`.

## Rate Limits

The Free plan allows 1 request per second, PRO allows 100, ULTRA 400 and MEGA 800. Free includes 100 calls as a one-time 7-day trial with a hard limit, so calls stop when they are used up. PRO, ULTRA and MEGA include 40,000, 150,000 and 500,000 calls a month and allow overage, so calls continue past the quota and are billed per extra call. Requests above the per-second limit, or after the Free plan's calls are used up, return `429 Too Many Requests`. Back off before retrying, honour any `Retry-After` header, and add jitter when you retry `429`, `502`, `503` or `504` responses. In our tests the first call after a period of idle took about 15 seconds and later calls about 1 second, so set your client timeout to 30 seconds or more.

## FAQ

**What should I send in the `domain` parameter?**

A bare hostname such as `github.com`. Do not include `https://`, a path, a port, a query string or credentials. A value that is not a plain hostname returns `400 Bad Request`.

**Are these numbers exact?**

No. Visits, engagement, ranks and traffic shares are Similarweb estimates for the domain. Use them for comparison and trends, not as a replacement for the site's own analytics.

**Why is the field called `Engagments`?**

That is the field name the API returns, so read it with that exact spelling. Its values (`BounceRate`, `PagePerVisit`, `Visits`, `TimeOnSite` and so on) are strings, so convert them to numbers before doing math.

**How fresh is the data?**

The API returns the latest available monthly snapshot. Check `SnapshotDate` and the `Month` and `Year` inside `Engagments` to see which month you received. The day the monthly data updates can vary. The `X-Cache` header tells you whether the response came from cache (`HIT`) or a fresh lookup (`MISS`).

**Why are some fields `null` or empty for my domain?**

Field availability varies by domain. Small, new, private or low-traffic sites can return `null` values, empty arrays such as `Competitors.TopSimilarityCompetitors`, or no overview data at all.

**Why did my first request take so long?**

The first call after a period of idle took about 15 seconds in our tests, while repeat calls returned in about 1 second. Set a client timeout of at least 30 seconds and retry on `504`.

**How do I read the traffic source and country shares?**

They are fractions between 0 and 1. A `Direct` value of `0.533` means about 53.3% of visits came directly. Multiply a share by `Engagments.Visits` to estimate visits from that source or country.

## Contact Us

If you have any questions or need assistance, you can reach out to us through the embedded chat on the bottom right corner of the page or send an email to hello@magicapi.com.


Similarweb API that returns estimated monthly visits, bounce rate, global rank, traffic sources, top countries and keywords for any domain in one JSON call.

Similarweb API for Website Traffic and Domain Data