通过您的应用、终端或 AI 代理查询 BuiltWith API。

安装

需要 Node.js >= 18（使用原生 fetch）。

v3的重大变革

• 仅支持 ESM - 不再支持 CommonJS/require()
• 命名导出 - import { createClient } from 'builtwith-api'（非默认/require）
• Zod 验证 - 无效输入会抛出 ZodError 而非手动错误消息
• 类型响应 - 方法返回带有类型化的响应对象（使用JSON格式时）

特色

响应格式

• 支持 JSON
• XML 支持
• CSV 支持
• TSV 支持（列表、关系）
• TXT支持（仅列表）

API

BuiltWith API

Query the BuiltWith API from your app, terminal, or AI agent.

Installation

# Homebrew (CLI only)
brew install zcaceres/tap/builtwith

# npm (library + CLI)
npm install builtwith-api

# MCP server (separate package)
npm install -g builtwith-mcp

Requires Node.js >= 18 (uses native fetch).

Breaking Changes in v3

• ESM-only - no more CommonJS/require() support
• Named export - import { createClient } from 'builtwith-api' (not default/require)
• Zod validation - invalid inputs throw ZodError instead of manual error messages
• Typed responses - methods return typed response objects (when using JSON format)

Features

Response Formats

• JSON support
• XML support
• CSV support
• TSV support (lists, relationships)
• TXT support (lists only)

APIs

Library Usage

import { createClient } from 'builtwith-api'

// Initialize with your API key
const builtwith = createClient(process.env.BUILTWITH_API_KEY, {
  responseFormat: 'json' // 'json' 'xml' 'csv' 'tsv' 'txt' (txt only for lists API)
})

const url = 'facebook.com'

// Free lookup - quick summary
await builtwith.free(url)

// Full domain analysis
await builtwith.domain(url, {
  // This will hide technology description, link, tag and category fields
  hideAll: false,
  // This will hide technology description and link fields (but keep tag and categories)
  hideDescriptionAndLinks: false,
  // This will only return technologies we consider to be live
  onlyLiveTechnologies: true,
  // No meta data (like address, names etc..) will be returned. Improves performance.
  noMetaData: true,
  // No attributes data will be returned
  noAttributeData: true,
  // No personally identifiable information will be returned
  noPII: true,
  // Filter by first detected date range (e.g. '2020-01-01-2024-12-31')
  firstDetectedRange: undefined,
  // Filter by last detected date range
  lastDetectedRange: undefined
})

// List sites using a technology
const technology = 'Shopify'
// The name of a technology. Spaces automatically replaced with dashes (-).
await builtwith.lists(technology, {
  // Brings back meta data with the results, which includes names, titles, social links, addresses, emails, telephone numbers, traffic ranks etc.
  includeMetaData: true,