Introduction
The BuiltWith Product API lets you find products for sale across the entire internet in a JSON feed. The Product API uses Product Credits, not API credits providing efficent cost savings.
The general access method is as follows -
https://api.builtwith.com/productv1/api.json?KEY=[YOUR KEY]&QUERY=Adidas Yeezy
Product Credits
Product API uses Product Credits not API credits, because 1 lookup can bring back 5000 products.
Authentication
You must provide your API key in each lookup.
Signup or Login to access your API key.
Product Query Example
JSON Query for Celine Sunglasses
https://api.builtwith.com/productv1/api.json?KEY=[YOUR KEY]&QUERY=Celine%20Sunglasses
JSON Query for Celine Sunglasses, limiting to 1 Store
https://api.builtwith.com/productv1/api.json?KEY=[YOUR KEY]&QUERY=Celine%20Sunglasses&LIMIT=1
JSON Query for Celine Sunglasses, limiting to 10 Stores, getting page 5
https://api.builtwith.com/productv1/api.json?KEY=[YOUR KEY]&QUERY=Celine%20Sunglasses&LIMIT=10&PAGE=5
Domain Query Example
JSON Query for All Products sold at jbhifi.com.au
https://api.builtwith.com/productv1/api.json?KEY=[YOUR KEY]&QUERY=dom%3Ajbhifi.com.au
Reference
GET Request Parameters
| Name |
Examples |
Required |
| KEY |
[YOUR API KEY WHEN LOGGED IN]
|
Yes |
| QUERY |
celine%20sunglasses
dom:jbhifi.com.au |
Yes |
| LIMIT |
50
The amount of shops to bring back |
No
Defaults to 50, cannot be more than 500. |
| PAGE |
3
The page of results to bring back |
No
Defaults to 0 (first page) |
Response Object
A JSON Object - object->shops[products[]]
| Name |
Examples |
Description |
| query |
celine sunglasses |
What you searched for. |
| is_more | true | true or false - use PAGE request to get more pages |
| page | 0 | Current data page (0 is first page) |
| limit | 50 | Current page limit of shops (max 500) use LIMIT request to modify |
| results | 50 | The amount of products in the result set |
| shop_count | 10 | The amount of shops in the result set |
| credits | 1000 | The amount of credits you have |
| used | 10 | The amount of credits you have used |
| remaining | 990 | The amount of credits you have remaining |
| used_this_query | 50 | The amount of product credits used for the query |
| next_page | /productv1/api... | Path to the next page of results |
| shops[] |
Explained below |
The array of shop and product results for your query. |
shop and products
| Name |
Examples |
Description |
| Domain |
jbhifi.com.au |
The domain and or subdomain of the result |
| Products[] |
| Title |
Bronzer Booster |
The title of the product. |
| Url |
bronze-bootser |
Relative URL of the product. |
| Indexed |
2024-09-15T00:00:00 |
Date the product was last detected |
| Indexed | 2023-09-15T00:00:00 | Date the product was first detected |
| Price | 122.33 | Price of the product in the Shop default currency |
Terms of Use
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.