---
title: Search
slug: bigboxapi/homedepot-product-data-api/parameters/search
docTags:
createdAt: 2024-07-22T08:01:06.003Z
---
# Search Parameters
`GET` `/request`
The Search Parameters are applicable when making a request with `type=search` to retrieve search results from Home Depot. The search term is specified in the `search_term` parameter. The parameters should be appended as querystring parameters to the Home Depot Product Data API `GET` HTTP request.
Search results are retrieved from the [Search results page](https://www.homedepot.com/s/lawn+mower) on Home Depot.
For example, to request search results for the search term `lawn mower` , sorted by "best selling products", the request would be:
:::CodeblockTabs
HTTP
```HTTP
https://api.bigboxapi.com/request?api_key=demo&type=search&search_term=lawn+mower&sort_by=best_seller
```
```curl
curl -L --get https://api.bigboxapi.com/request
-d api_key="demo"
-d type="search"
-d search_term="lawn mower"
-d sort_by="best_seller"
```
```nodejs
const axios = require('axios');
// set up the request parameters
const params = {
api_key: "demo",
type: "search",
search_term: "lawn mower",
sort_by: "best_seller"
}
// make the http GET request to BigBox API
axios.get('https://api.bigboxapi.com/request', { params })
.then(response => {
// print the JSON response from BigBox API
console.log(JSON.stringify(response.data, 0, 2));
}).catch(error => {
// catch and print the error
console.log(error);
})
```
```python
import requests
import json
# set up the request parameters
params = {
'api_key': 'demo',
'type': 'search',
'search_term': 'lawn mower',
'sort_by': 'best_seller'
}
# make the http GET request to BigBox API
api_result = requests.get('https://api.bigboxapi.com/request', params)
# print the JSON response from BigBox API
print(json.dumps(api_result.json()))
```
```php
'demo',
'type': 'search',
'search_term': 'lawn mower',
'sort_by': 'best_seller'
]);
# make the http GET request to BigBox API
$ch = curl_init(sprintf('%s?%s', 'https://api.bigboxapi.com/request', $queryString));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
# the following options are required if you're using an outdated OpenSSL version
# more details: https://www.openssl.org/blog/blog/2021/09/13/LetsEncryptRootCertExpire/
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_TIMEOUT, 180);
$api_result = curl_exec($ch);
curl_close($ch);
# print the JSON response from BigBox API
echo $api_result;
?>
```
:::
***
### Search Parameters
The following parameters are available for all requests made when `type=search` .
| `Parameter` | `Required` | `Description` |
| ------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `search_term`
| `required`
| search term to use to search for Home Depot items.
Either the `search_term` or `url` parameter must be supplied.
|
| `sort_by`
| `optional`
| Determines how the results are sorted. Valid values are:
1) `best_seller`
2) Sort results by best selling products first.
1) `most_popular`
2) Sort results by most popular products first.
1) `price_high_to_low`
2) Sort results by highest to lowest priced.
1) `price_low_to_high`
2) Sort results by lowest to highest priced.
1) `highest_rating`
2) Sort results by highest rated first.
::Image[]{src="https://apiimages.imgix.net/bigboxapi/images/png/docs/sort_by.png?auto=format&ixlib=react-9.5.1-beta.1&w=150" size="100" width="150" height="143" position="center" showCaption="false" indent="2"} |
| `min_price`
| `optional`
| Determines the minimum price of results to return, expressed in dollars and cents (i.e. `min_price=2.99` for $2.99). |
| `max_price`
| `optional`
| Determines the maximum price of results to return, expressed in dollars and cents (i.e. `min_price=39.99` for $39.99). |
| `page`
| `optional`
| The current page of results to retrieve. Inspect the `pagination` results property for details on the number of pages available. |
| `max_page`
| `optional`
| Use the `max_page` parameter to get multiple pages of results in one request. The API will automatically paginate through pages and concatenate the results into one response.
See the [Pagination](https://docs.trajectdata.com/bigboxapi/homedepot-product-data-api/pagination) docs for more information. |
| `url`
| `optional`
| The Home Depot search results page to retrieve results from.
**Note** : If the `url` parameter is supplied then all other parameters are ignored as they are overriden be those specified in the `url` parameter. |
***
**Next Steps**
[Search Results](https://docs.trajectdata.com/bigboxapi/homedepot-product-data-api/results/search)