builtwith-api is a utility wrapper for the BuiltWith API suite. Find out what any website is built with! 🚀
yarn add builtwith-api
or
npm install builtwith-api
⚡ Requires Node.js >= 18 (uses native fetch).
- 🟢 JSON support
- 🟡 XML support
- 🔵 CSV support
- 🟣 TSV support (lists, relationships)
- ⚪ TXT support (lists only)
const BuiltWith = require('builtwith-api')
// 🔐 Initialize with your API key
const builtwith = BuiltWith(process.env.YOUR_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
})
// 🔄 Technology changes since a natural-language date
await builtwith.change(url)
await builtwith.change(['shopify.com', 'builtwith.com'], { since: 'last month' })
// 📋 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,
// Require each result to also use these comma-separated technologies, maximum 16.
otherTechs: 'Google-Analytics,Meta-Pixel',
// Gets the next page of results - use the exact value from NextOffset in response. If the value of NextOffset is END there are no more results.
offset: 'oQEwEnH2FJuIzeXOEk2T',
// Gets live sites using the technology since a certain time, accepts dates and queries i.e. 30 Days Ago or Last January for example.
since: '2016-01-20',
// Attribute filters use number|operator. Operators: EQ, LT, LTE, GT, GTE. Filters are combined with AND.
filters: {
REVENUE: '100000|GT',
SPEND: '100|GTE',
EMPLOYEES: '50|GTE'
}
})
// 🔗 Find related domains
await builtwith.relationships(url)
// 🔑 Multi-domain keyword lookup (up to 16 domains!)
const urls = ['hotelscombined.com', 'builtwith.com']
await builtwith.keywords(urls)
// 📈 Technology trends over time
await builtwith.trends(technology, {
// Totals will be the closest to this date - providing the ability to get historical totals
date: '2016-01-20'
})
// 🏢 Find a company's website
const companyName = 'Shell'
await builtwith.companyToUrl(companyName, {
// Bring back domains in order of priority - the first result is generally the one we think the website is
amount: 1,
// Set the priority extension - if you know the country of the company supply the most likely TLD. i.e. for United Kingdom use 'uk'
tld: 'com'
})
// ⚡ Live domain detection
await builtwith.domainLive(url)
// 🛡️ Trust & fraud detection
await builtwith.trust(url, {
// If the words specified here are in the HTML of the website the result will have Stopwords set to true for LIVE lookups.
words: 'medicine,masks',
// Performs a live lookup of the website in question. This slows down the response. A result with a status of 'needLive' requires the LIVE option to determine if the website is suspect or not.
live: false
})
// 🏷️ Get domains related to IPs and site attributes. Use 'IP-1.2.3.4' format for IP lookups.
await builtwith.tags(url)
// 💡 Get technology recommendations for a domain
await builtwith.recommendations(url)
// ↪️ Get live and historical redirect data for a domain
await builtwith.redirects(url)
// 🛒 Search for e-commerce sites selling specific products
await builtwith.product('shoes')
// 🔎 Semantic vector search for technologies and categories
await builtwith.vectorSearch('react framework')
await builtwith.vectorSearch('ecommerce platform', { limit: 20 })
// 💬 Natural language website list lookup
await builtwith.ask('Magento websites in Spain')
// Full report (up to 1000 results)
const result = await builtwith.ask('Shopify stores in the US', { commit: true })
// Paginate using NextOffset from previous response
await builtwith.ask('Shopify stores in the US', { commit: true, nextOffset: result.NextOffset })Agents can obtain a temporary bw- prefixed API token without the user pasting their key. These are module-level static functions — no API key needed to call them.
const BuiltWith = require('builtwith-api');
// Step 1: start the flow
const start = await BuiltWith.agentAuthStart();
// start.data => { device_code, verification_uri }
console.log(`Open in browser: ${start.data.verification_uri}`);
// Step 2: poll every 5 seconds until approved or denied
const token = await BuiltWith.agentAuthToken(start.data.device_code);
// token.data => { status: 'pending' | 'approved' | 'denied', access_token? }
if (token.data.status === 'approved') {
const builtwith = BuiltWith(token.data.access_token);
// use normally
}Check out the full API docs at api.builtwith.com 🎉