API прямой трансляции

Введение

API BuiltWith WebSocket Live Feed предоставляет уведомления об обнаружении новых технологий в режиме реального времени через соединения WebSocket. Подпишитесь на каналы, посвященные технологиям, и получайте мгновенные обновления, когда веб-сайты внедряют или меняют технологии.

Подключитесь к конечной точке WebSocket.:
wss://sync.builtwith.com/wss/new?KEY=00000000-0000-0000-0000-000000000000

Или подключитесь и автоматически подпишитесь на канал, посвященный технологиям.:
wss://sync.builtwith.com/wss/channel/Shopify?KEY=00000000-0000-0000-0000-000000000000

Основные характеристики:

Уведомления об обнаружении технологий в режиме реального времени
Подпишитесь на обновления для конкретных технологий (например, Shopify, WordPress) или на канал «новые» для совершенно новых веб-сайтов.
Пользователи пробной/предварительной версии получают отредактированные доменные имена для просмотра ленты новостей.
Поддержка автоматического переподключения

Требования к плану:

Для использования API прямых трансляций вам необходим действующий тарифный план.
Базовый тариф: до 2 технологических подписок на один API-ключ.
Плюсы: до 50 технологических подписок на один API-ключ.
Пробные и просроченные учетные записи получают зашифрованные данные.

Посмотреть планы

🤖 Подсказка от ИИ-агента

Reference https://api.builtwith.com/llms.txt and
https://raw.githubusercontent.com/builtwith/builtwith-ai-sdk/refs/heads/main/README.md
Add builtwith AI api to my app as a client. Connect to the WebSocket live feed API and subscribe to the Shopify technology channel

Аутентификация

Для подключения по протоколу WebSocket требуется ваш API-ключ в качестве параметра запроса.

Параметр	Описание	Необходимый
`KEY`	`00000000-0000-0000-0000-000000000000` Ваш API-ключ BuiltWith (в формате GUID)	Да
`SUBSCRIBE`	`Shopify` или `new` Дополнительно: Автоматическая подписка на канал при подключении (используется с конечной точкой /wss/channel/{tech})	Нет

Режимы просмотра:

Полный доступ: Активные платные подписчики получают полные доменные имена.
Отредактировано/Предварительный просмотр: Пользователи пробной версии и пользователи с истекшим сроком подписки получают измененные домены (например, 'great.com' становится 'grxxt.cxm').

Конечные точки WebSocket

Конечная точка	Описание
`wss://sync.builtwith.com/wss/new`	Подключитесь к прямой трансляции. После подключения отправьте команды подписки, чтобы присоединиться к каналам.
`wss://sync.builtwith.com/wss/channel/{tech}`	Подключитесь и автоматически подпишитесь на определенный технологический канал (например, /wss/channel/Shopify).

Команды клиента

Отправьте эти JSON-команды после подключения, чтобы управлять своими подписками.

Командование	Описание
`{"action":"subscribe","channel":"Shopify"}`	Подпишитесь на технологический канал. Используйте названия технологических сайтов, например, «Shopify», «WordPress», или каналы правил доменов, такие как «new», «new-historical» и «premium».
`{"action":"subscribe","channel":"new"}`	Подпишитесь на домены, классифицированные по правилу «новый»: домен создан впервые в этом конвейере, и все обнаруженные технологии были впервые обнаружены в течение последнего дня.
`{"action":"subscribe","channel":"new-historical"}`	Подпишитесь на домены, классифицированные по правилу «новый-исторический»: домен создан впервые в этом конвейере, и у всех обнаруженных технологий дата обнаружения FirstDetected больше или равна 1 дню.
`{"action":"subscribe","channel":"premium"}`	Подписывайтесь на домены, классифицированные по правилу «премиум»: домен недавно создан, содержит хотя бы одну технологию с приоритетом > 0, и все обнаруженные технологии были впервые обнаружены в течение последнего дня.
`{"action":"unsubscribe","channel":"Shopify"}`	Отписаться от канала.
`{"action":"list_subscriptions"}`	Перечислите ваши текущие подписки на каналы.

Типы каналов

Канал	Описание
`new`	Канал правил. Домен является новым для конвейера обработки данных, и все технологии были обнаружены совсем недавно (в течение 1 дня).
`new-historical`	Канал правил. Домен является новым для конвейера обработки, и все технологии были обнаружены впервые в истории (старше или равны 1 дню).
`premium`	Канал правил. Домен новый, содержит как минимум одну технологию с приоритетом > 0, и все технологии были обнаружены впервые недавно (в течение 1 дня).
`{technology_name}`	Подпишитесь на конкретную технологию по названию (например, «Shopify», «WordPress», «Google Analytics»). Используйте названия с дефисом вместо пробелов.

Форматы сообщений

Сообщения сервера

Сообщения, полученные от WebSocket-сервера

Соединение подтверждено

{
  "type": "connected",
  "message": "Connected successfully...",
  "available_commands": ["subscribe", "unsubscribe", "list_subscriptions"],
  "view_mode": "full"
}

Подписка подтверждена

{
  "type": "subscribed",
  "channel": "Shopify",
  "channel_id": "a1b2c3d4-..."
}

Сообщение об обнаружении технологии

{
  "type": "message",
  "channel": "Shopify",
  "channel_id": "a1b2c3d4-...",
  "data": {
    "channel_name": "Shopify",
    "website_domain": "example.com",
    "epoch_secs": 1770508800
  }
}

Изменение статуса (изменение уровня подписки)

{
  "type": "status_change",
  "view_mode": "full",
  "message": "Your subscription has been upgraded. You now have full data access."
}

Сообщение об ошибке

{
  "type": "error",
  "message": "Technology 'unknown-tech' not found"
}

Поля сообщений

Поле	Описание
`type`	Тип сообщения: подключено, подписано, отписано, сообщение, изменение статуса, ошибка, информация
`channel`	Удобное для пользователя название канала (например, «Shopify», «новый»).
`channel_id`	Внутренний идентификатор канала (GUID технологии или «новый»)
`data`	Полезная нагрузка обнаружения, содержащая channel_name, website_domain и epoch_secs.
`website_domain`	Область, где была обнаружена технология (информация скрыта для пользователей пробной версии).
`epoch_secs`	Временная метка Unix epoch (в секундах), указывающая на момент постановки обнаружения в очередь.
`view_mode`	«Полная версия» для платных подписчиков, «Засекречено (пробная/предварительная версия)» для пользователей пробной версии.

Специальные домены

Мы ведём два списка, которые пригодятся вам при поиске доменов: списки игнорирования и списки BuiltWith Suffix.

Список игнорирования
TЭто наш внутренний список доменов, которые мы не индексируем. Они либо заблокированы, либо содержат слишком много вводящих в заблуждение технологий, либо слишком много поддоменов с пользовательским контентом.

BuiltWith Список суффиксов
Это основано на Список публичных суффиксов но включает множество дополнительных записей для компаний с поддоменами, которые следует считать доменами верхнего уровня. Этот список обеспечивает лучшую видимость внутренних веб-сайтов, например, он выводит northernbeaches.nsw.gov.au на верхний уровень по сравнению с nsw.gov.au.

Игнорировать домены (XML, JSON or TXT)

https://api.builtwith.com/ignoresv1/api.json

Суффиксные домены (XML, JSON or TXT)

https://api.builtwith.com/suffixv1/api.json

Коды ошибок

Обратите внимание, что отправка сообщений об ошибках в этом формате не может быть гарантирована, ваша реализация должна также рассматрив��ть коды ответа, отличные от 200, как ошибки. Свойство Lookup будет иметь значение null (json) или не будет предоставлено (xml), если ошибка связана с сервером. Просмотреть все возможные правильно сформированные коды ошибок.

Условия эксплуатации

Наш стандартные условия распространяется на использование всех наших API.

В целом, вы можете использовать API для улучшения своего продукта различными способами. Единственное ограничение — вы не можете перепродавать данные в их исходном виде или предоставлять дублирующий функционал builtwith.com и связанным с ним сервисам.