API векторного поиска

Введение

Поиск технологий и категорий по текстовому запросу с использованием векторного сходства. Находите релевантные технологии и категории, описывая то, что вы ищете.

Общий метод доступа следующий: -
https://api.builtwith.com/vector/v1/api.[xml|json|csv]?KEY=00000000-0000-0000-0000-000000000000&QUERY=<search term>

API векторного поиска использует 1 кредит 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. Make a call to the vector search API to find technologies related to the query hotel booking

Пример

Следующие примеры демонстрируют, как вызывать API векторного поиска.

JSON

https://api.builtwith.com/vector/v1/api.json?KEY=00000000-0000-0000-0000-000000000000&QUERY=react+framework

XML

https://api.builtwith.com/vector/v1/api.xml?KEY=00000000-0000-0000-0000-000000000000&QUERY=google+analytics

CSV

https://api.builtwith.com/vector/v1/api.csv?KEY=00000000-0000-0000-0000-000000000000&QUERY=ecommerce+platform&LIMIT=25

Ссылка

Параметры

Для поиска могут быть предоставлены следующие параметры GET:

Имя	Примеры	Необходимый
`KEY`	`00000000-0000-0000-0000-000000000000` Это ваш ключ, используйте его для поиска.	Да
`QUERY`	`react framework` Поисковый запрос для поиска соответствующих технологий и категорий.	Да
`TYPE`	`json` / `xml` / `csv` Формат ответа. Указывается в URL-адресе в виде расширения файла.	Да
`LIMIT`	`10` Количество возвращаемых результатов. По умолчанию — 10, максимальное — 100.	Нет

Ответы

Ответ верхнего уровня содержит Query строка, отражающая поисковый запрос, a Results массив и Errors множество.

Все результаты

Эти поля присутствуют в каждом результате независимо от его типа.

Имя	Пример	Описание
`Type`	`tech` / `category`	Будь то соответствие технологиям или категории.
`Name`	`Google Analytics`	Название соответствующей технологии или категории.
`Tag`	`analytics`	Метка категории технологий верхнего уровня.
`Score`	`0.9812`	Показатель сходства от 0 до 1 с точностью до 4 знаков после запятой. Более высокие значения указывают на лучшее совпадение.

Результаты применения технологий Type: tech

Эти дополнительные поля присутствуют, когда результатом является технология.

Имя	Пример	Описание
`Icon`	`https://favicon.builtwith.com/google.com`	URL-адрес значка сайта (Favicon) для данного технологического продукта.
`Description`	`Web analytics service offered by Google`	Краткое описание технологии.
`Categories`	`["Web Analytics", "Tag Management"]`	Массив названий подкатегорий, к которым относится данная технология.
`IsPremium`	`true` / `false`	Является ли это премиальной/платной технологией.
`Link`	`https://analytics.google.com`	URL официального сайта данной технологии.
`TrendsLink`	`https://trends.builtwith.com/analytics/Google-Analytics`	Ссылка на страницу трендов BuiltWith, посвященную этой технологии.

Результаты по категориям Type: category

Эти дополнительные поля присутствуют, когда результатом является категория.

Имя	Пример	Описание
`TrendsLink`	`//trends.builtwith.com/analytics/web-analytics`	Ссылка на страницу трендов BuiltWith для этой категории.

Примеры кода

curl

curl "https://api.builtwith.com/vector/v1/api.json?KEY=YOUR_KEY&QUERY=react+framework"

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

Мы ведём два списка, которые пригодятся вам при поиске доменов: списки игнорирования и списки 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 и связанным с ним сервисам.