Vector Search API

Introduction

Search technologies and categories by text query using vector similarity. Find relevant technologies and categories by describing what you are looking for.

The general access method is as follows -
https://api.builtwith.com/vector/v1/api.[xml|json|csv]?KEY=00000000-0000-0000-0000-000000000000&QUERY=<search term>

Vector Search API uses 1 API credit per search, regardless of result size.

🤖 AI Agent Prompt

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

Example

The following examples show how to call the Vector Search 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

Reference

Parameters

The following GET parameters can be supplied for lookups

Name	Examples	Required
`KEY`	`00000000-0000-0000-0000-000000000000` This is your key, use this for lookups.	Yes
`QUERY`	`react framework` The search term to find matching technologies and categories.	Yes
`TYPE`	`json` / `xml` / `csv` The response format. Specified as the file extension in the URL.	Yes
`LIMIT`	`10` Number of results to return. Default is 10, maximum is 100.	No

Responses

The top-level response contains a Query string echoing the search term, a Results array, and an Errors array.

All Results

These fields are present on every result regardless of type.

Name	Example	Description
`Type`	`tech` / `category`	Whether this is a technology or category match.
`Name`	`Google Analytics`	Name of the matched technology or category.
`Tag`	`analytics`	Top-level technology category tag.
`Score`	`0.9812`	Similarity score between 0 and 1 to 4 decimal places. Higher values indicate a better match.

Technology Results Type: tech

These additional fields are present when the result is a technology.

Name	Example	Description
`Icon`	`https://favicon.builtwith.com/google.com`	Favicon URL for the technology's website.
`Description`	`Web analytics service offered by Google`	Short description of the technology.
`Categories`	`["Web Analytics", "Tag Management"]`	Array of sub-category names the technology belongs to.
`IsPremium`	`true` / `false`	Whether this is a premium / paid technology.
`Link`	`https://analytics.google.com`	The technology's official website URL.
`TrendsLink`	`https://trends.builtwith.com/analytics/Google-Analytics`	Link to the BuiltWith trends page for this technology.

Category Results Type: category

These additional fields are present when the result is a category.

Name	Example	Description
`TrendsLink`	`//trends.builtwith.com/analytics/web-analytics`	Link to the BuiltWith trends page for this category.

Code Examples

curl

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

Special Domains

We maintain two lists of use for you when looking up domains. Ignore lists and BuiltWith Suffix lists.

Ignore List
This is our own internal list of domains we do not index. They are either blocked, contains too many misleading technologies or too many subdomains with user generated content.

BuiltWith Suffix List
This is based on the Public Suffix List but includes many additional entries for companies with subdomains that should be considered top level domains. This list provides us with better visibility for internal websites for example it brings northernbeaches.nsw.gov.au to the top level over nsw.gov.au.

Ignore Domains (XML, JSON or TXT)

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

Suffix Domains (XML, JSON or TXT)

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

Error Codes

Note error messages in this format cannot be guaranteed, your implementation should also consider non-200 response codes as errors. The Lookup property will be null (json) or not provided (xml) if the error is server related. View all potential well-formed error codes.

Our standard terms cover the use all of our APIs.

In general, you can use the API to enhance your product in many ways. The only limitation is you cannot resell the data as-is or provide duplicate functionality to builtwith.com and its associated services.