Domain API Documentation
Parameters
The following GET parameters can be supplied for lookups
| Name |
Examples |
Required |
| KEY |
00000000-0000-0000-0000-000000000000
Sign up for Free or Login to get a key.
|
Yes |
| LOOKUP |
cnn.com
example.com%3Ftest
Escape paths and parameters for full urls
Multi-Lookup Option
When doing RAW domain lookups, you can parse up to 16 domains at once as a CSV. For example cnn.com,about.com,builtwith.com - this dramatically improves throughput.
|
Yes |
| HIDETEXT |
yes
This will hide technology description, link, tag and category fields. |
No |
| HIDEDL |
yes
This will hide technology description and link fields (but keep tag and categories). |
No |
| LIVEONLY |
yes
This will only return technologies we consider to be live. |
No |
| NOMETA |
yes
No meta data (like address, names etc..) will be returned. Improves performance. |
No |
Responses
The Domain API will respond with a document in the format -
Result->Paths[Path->Technologies[Technology]],Meta
Results
Results is the top level response that identifies the lookup.
| Name |
Example |
Description |
| Lookup |
hotelscombined.com |
The domain that was looked up. |
| Result |
The technology lookup |
Explained below. |
| Meta |
Meta object explained below. |
All of the meta data we have associated with this domain. |
| FirstIndexed |
2012-07-29T14:00:00Z (xml)
1378422000000 (json) |
The earliest index point for this entire domain. |
| LastIndexed |
2014-07-29T14:00:00Z (xml)
1378822000000 (json) |
The most recent index point for this entire domain. |
Result
Result contains technology lookup results.
| Name |
Example |
Description |
| IsDB |
true |
True/False value if this lookup came from our database or was a live lookup (we had to visit the website and get technology information because we do not have a live archive). |
| Spend |
6051 |
The accumulative average monthly spend based on premium technologies found on the website in USD. This figure is estimated as we don't always know the plan level a website is using for a technology. |
| Paths |
Path objects explained below. |
All of the path results for this lookup. |
Paths
Paths only contain Path objects, they do not have any properties.
Path
Path is a result from a URL or collection of sub-pages on a domain if the Url field is "dd".
| Name |
Example |
Description |
| Domain |
disney.com |
The root domain |
| Url |
dd |
A value of dd means this path technology data is built from multiple sub-pages
and is only relevant for domain only based lookups. |
| SubDomain |
blog |
A subdomain of the domain, for example a value of blog and a domain of disney.com is the profile for blog.disney.com |
| FirstIndexed |
2012-07-29T14:00:00Z (xml)
1378422000000 (json) |
The earliest index point for this particular path. |
| LastIndexed |
2014-07-29T14:00:00Z (xml)
1378822000000 (json) |
The most recent index point for this particular path. |
Technology
A technology is a web technology result found on the site.
| Name |
Example |
Description |
| Name |
Twitter Platform |
The name of the technology found. |
| Description |
This page embeds the twitter platform in one method or another |
A description of the technology found on the page |
| Link |
https://twitter.com/about/resources |
A link to the website for the technology |
| IsPremium |
no |
Is this a paid-for technology (does it cost money to use this technology - excluding hosting) values can be yes, no or maybe |
| Tag |
javascript |
The base category for the technology. See categories index data for all types. |
| Categories (Array) |
Social SDK |
An array of sub-categories for the tag as listed under main tags on BuiltWith Trends. |
| FirstDetected |
2012-07-29T14:00:00Z (xml)
1378422000000 (json) |
The date the technology was first detected on the site by BuiltWith. |
| LastDetected |
2017-05-29T14:00:00Z (xml)
1378422000000 (json) |
The date the technology was last detected on the site by BuiltWith. See the update endpoint for last data run. |
Meta
Meta data found on the lookup website - detailed lookups only will return meta data if found.
| Name |
Example |
Description |
| CompanyName |
Rodale Inc. |
A valid incorporated company name |
| City |
San Francisco |
A valid city name for supported countries |
| Postcode |
94105 |
A valid zip/postal code |
| State |
CA |
A valid state/country |
| Country |
US |
ISO 3166-1 alpha-2 country code for address |
| Vertical |
Technology and Computing |
One of these categories or blank. |
| [Telephones] |
+1-650-745-0728 |
Valid international telephone numbers |
| [Emails] |
support@site.com |
Valid domain emails |
| [Social] |
https://twitter.com/website |
Social presence |
| [Names] |
Name->Joe Bloggs
Type->0
Email->joe.bloggs@twitter.com |
Names, emails and job titles for people. See titles index for codes |
Additional Fields
Each result contains a "Lookup" property which is the lookup in your request.
Header Messages
The following variables will be passed in the response header.
| Name |
Example |
Description |
| X-API-CREDITS-AVAILABLE |
1000 |
The amount of lookup credits you have available under your ID. |
| X-API-CREDITS-USED |
400 |
The amount of lookup credits that you have used. |
Endpoints
Connection points for the BuiltWith Domain API.
https://api.builtwith.com/v11/api.xml
XML Response Endpoint
https://api.builtwith.com/v11/api.json
JSON Response Endpoint
https://api.builtwith.com/categoriesV4.xml
Technology Categories index (json version)
https://api.builtwith.com/v11/api.xml?VERTICALS=1
All potential website vertical values (json version)
https://api.builtwith.com/v11/api.xml?UPDATE=1
Last database update dates (json version)
https://api.builtwith.com/v11/api.json?KEY=00000000-0000-0000-0000-000000000000&USAGE=1
Current credits used/available (json version) - note this also comes back as header variables on Lookups as X-API-CREDITS-AVAILABLE & X-API-CREDITS-USED
https://api.builtwith.com/titles.xml
Job Title Codes
Profile Lookup vs. Detailed Lookup
If you provide a domain as the LOOKUP parameter (i.e. cnn.com) and the domain is in our database - you will get a detailed lookup Domain API response. This means the response will
contain multiple Paths covering sub-domains, pages on the site and the root domain, as well as meta information where available.
If you provide a sub-domain, an internal page or a domain we do not cover (i.e. blog.cnn.com / example.com%3Ftest) - you will get a standard profile lookup Domain API response which will include 1 Path object
covering the page you requested.
Examples
Example endpoint responses. These do not count towards your credits.
https://api.builtwith.com/v11/api.xml?KEY=00000000-0000-0000-0000-000000000000&LOOKUP=hotelscombined.com
XML Lookup for domain hotelscombined.com (detailed lookup)
https://api.builtwith.com/v11/api.json?KEY=00000000-0000-0000-0000-000000000000&LOOKUP=builtwith.com
JSON Lookup for domain builtwith.com
You can provide hotelscombined.com, builtwith.com or httpbin.org (except redirects) as lookup domains without affecting your Domain API credit.
Error Codes
Error codes are wrapped in result objects.
https://api.builtwith.com/v11/api.json?KEY=00000000-0000-0000-0000-000000000000&LOOKUP=httpbin.org/status/500
Server returns 500 internal server error example JSON response
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.
Code Examples
JSON/XML have integrations in all modern programming languages. Here's some StackOverflow topics for various languages - Python, C#, Java, PHP, C++, TSQL and Ruby.
Terms and Conditions of Use
Our standard terms cover the use of the BuiltWith Domain API.
In general, you can use the Domain API to enhance your product in many ways. The only limitation is your cannot resell the
data as-is or provide duplicate functionality to builtwith.com and its associated services.
