# SimilarWeb Domain

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/similarweb/domain` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/similarweb-domain |

## Description

Retrieve website traffic and engagement metrics for any domain from SimilarWeb, including visits, bounce rate, top keywords, and traffic sources.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/similarweb/domain' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Get SimilarWeb metrics for google.com

```json
{
  "title": "",
  "category": "computers_electronics_and_technology/search_engines",
  "site_name": "google.com",
  "engagments": {
    "year": "2024",
    "month": "5",
    "visits": "86249524745",
    "bounce_rate": "0.28024037791407225",
    "time_on_site": "641.4282025756406",
    "page_per_visit": "8.752416969603086"
  },
  "global_rank": {
    "rank": 1
  },
  "country_rank": {
    "rank": 1,
    "country": 840,
    "country_code": "US"
  },
  "top_keywords": [
    {
      "cpc": 1.08870175,
      "name": "gmail",
      "volume": 107944750,
      "estimated_value": 16490414
    },
    {
      "cpc": 0.7102735625,
      "name": "google",
      "volume": 69586760,
      "estimated_value": 6776722
    },
    {
      "cpc": 0.40845490625,
      "name": "google maps",
      "volume": 59602370,
      "estimated_value": 4539415
    }
  ],
  "category_rank": {
    "rank": "1",
    "category": "Computers_Electronics_and_Technology/Search_Engines"
  },
  "snapshot_date": "2024-05-01T00:00:00+00:00",
  "traffic_sources": {
    "mail": 0.0017641,
    "direct": 0.9503452,
    "search": 0.00488378,
    "social": 0.0209163,
    "referrals": 0.0214876,
    "paid_referrals": 0.000602931
  },
  "large_screenshot": "https://site-images.similarcdn.com/image?url=google.com&t=1&s=1&h=eb35e0fbafa3eb290132ffdfe47187d950d68daaa659ec1bd4b4e834b8f16461",
  "top_country_shares": [
    {
      "value": 0.2648986,
      "country": 840,
      "country_code": "US"
    },
    {
      "value": 0.045608,
      "country": 356,
      "country_code": "IN"
    }
  ]
}
```

## Documentation

## Overview
The SimilarWeb Domain endpoint retrieves comprehensive web analytics for any domain, including visits, bounce rate, rankings, and traffic sources.

## Quickstart
```
GET https://api.piloterr.com/v2/similarweb/domain?query=google.com
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Domain name |

## Response fields
| Field | Type | Description |
|---|---|---|
| `engagments.visits` | string | Monthly visit count |
| `engagments.bounce_rate` | string | Bounce rate |
| `global_rank.rank` | number | Global traffic rank |
| `top_keywords` | array | Top organic keywords |
| `traffic_sources` | object | Traffic by channel |

## Notes
- Data may have 1–2 month delay.
- Provide bare domain without protocol.

## Main use cases
- Research competitors by traffic volume and engagement metrics
- Qualify leads by assessing website traffic and audience size
- Conduct market sizing across industry domains
- Enrich sales intelligence with web visibility data