# SimilarSites

**API:** Data API

**Endpoint:** `GET /v1/beta/similarweb/website/similar-sites`

**Tags:** Website Analytics

SimilarSites. Ответ следует конверту SimilarWeb v5 (meta + data). Ограничение по датам (требование upstream SimilarWeb): start_date и end_date должны охватывать РОВНО 3 последовательных месяца — диапазон в 1 или 2 месяца отклоняется с ошибкой upstream 120 ('must span exactly 3 month(s)'). Этот диапазон также должен быть самым последним поддерживаемым окном SimilarWeb, которое сдвигается вперёд каждый месяц; более старый или выходящий за пределы диапазон отклоняется с ошибкой 101 ('Dates not in range'). На практике запрашивайте три последних завершённых месяца (например, если последний опубликованный месяц — 2026-07, используйте start_date=2026-05 и end_date=2026-07). Чтобы узнать точный текущий поддерживаемый диапазон, вызовите эндпоинт /describe SimilarWeb для этого API.

### Справочная информация о ценах

- Тарификация: тарифицируемое количество результатов.
- Справочная оценка запроса: USD 0.375.
- Базовая стоимость единицы: USD 0.075.
- Единица ресурса: `similarweb_credit`.
- Справочный множитель для клиента: 1.0. Не применяйте его повторно к уже рассчитанной сумме клиента.
- Базовые стоимости не определяют итоговую цену для клиента, в том числе когда они равны нулю.

Только справочные метаданные, а не котировка для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `country` | query | no | string, enum: "ww", default: "ww" |  |
| `domain` | query | yes | string |  |
| `end_date` | query | yes | string |  |
| `granularity` | query | no | string, enum: "monthly" |  |
| `limit` | query | yes | integer |  |
| `main_domain_only` | query | no | boolean |  |
| `offset` | query | no | integer |  |
| `start_date` | query | yes | string |  |
| `traffic_source` | query | no | string |  |
| `web_source` | query | no | string, enum: "desktop", "mobile_web", "total" |  |

## Responses

### 200 — Конверт SimilarWeb v5 (meta + data).

Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.

**application/json**

Schema: object

```json
{
  "type": "object",
  "properties": {
    "meta": {
      "$ref": "#/components/schemas/Response7B51F63Afd06_SimilarWebMeta"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "rank": {
            "type": "integer"
          },
          "affinity": {
            "type": "number"
          },
          "has_adsense": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

Example:

```json
{
  "meta": {
    "query": {
      "limit": 5,
      "offset": 0,
      "asc": null,
      "sort": null
    },
    "request": {
      "format": "json",
      "domain": "cnn.com",
      "granularity": "monthly",
      "start_date": "2026-05-01",
      "end_date": "2026-07-31",
      "metrics": [
        "rank",
        "affinity",
        "has_adsense"
      ],
      "category": null
    },
    "status": "success",
    "last_updated": "2026-07-31"
  },
  "data": [
    {
      "domain": "bbc.com",
      "category": "News_and_Media",
      "rank": 95,
      "affinity": 1,
      "has_adsense": true
    }
  ]
}
```

### 400 — Запрос не удалось обработать. Проверьте параметры запроса.

### 401 — Требуется действительный API-ключ Felo.

### 402 — Запрос не может быть выполнен: не выполнено требование биллинга.

### 403 — Аккаунту не разрешено выполнять эту операцию.

### 429 — Достигнут лимит запросов или расходов.

### 502 — Сервис не смог выполнить запрос.

### 503 — API или сервис биллинга временно недоступны.

### 504 — Истекло время ожидания обработки запроса.

### default — Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response7B51F63Afd06_SimilarWebMeta

`#/components/schemas/Response7B51F63Afd06_SimilarWebMeta`

```json
{
  "type": "object",
  "description": "Метаданные конверта ответа SimilarWeb v5.",
  "properties": {
    "status": {
      "type": "string",
      "description": "Статус upstream; 'success' при успешном вызове.",
      "example": "success"
    },
    "last_updated": {
      "type": "string",
      "description": "Дата последней доступной в upstream точки данных (YYYY-MM-DD).",
      "example": "2026-06-30"
    },
    "request": {
      "type": "object",
      "description": "Полное эхо нормализованного upstream-запроса (параметры в том виде, в котором они получены)."
    },
    "query": {
      "type": "object",
      "description": "Эхо пагинации/сортировки, если применимо (limit, offset, asc, sort)."
    }
  },
  "required": [
    "status"
  ]
}
```
