The Home Depot API

{
  "additionalProperties": false,
  "properties": {
    "query": {
      "additionalProperties": false,
      "properties": {
        "async": {
          "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our [Searches Archive API](https://Asale.com/search-archive-api) to retrieve your results. `async` and `no_ca",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "country": {
          "description": "Parameter defines the country to use for the Home Depot search. Only United States(`us`), and Canada(`ca`) are supported.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "delivery_zip": {
          "description": "ZIP Postal code. To filter the shipping products by a selected area.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "filter": {
          "description": "Used to pass filter tokens divided by dash (-) in Home Depot Canada. [Filter tokens](https://Asale.com/home-depot-filtering#api-examples-example-results-for-country-ca-amp-nbspq-table-and-filter-26ie-26if-the-home-depot-canada) can be obtained from API response",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "hd_filter_tokens": {
          "description": "Used to pass filter tokens divided by comma. [Filter tokens](https://Asale.com/home-depot-filtering) can be obtained from API response",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "hd_sort": {
          "description": "Parameter defines results sorted by different options in Home Depot US. It can be set to: `top_sellers`: Top Sellers, `price_low_to_high`: Price Low to High, `price_high_to_low`: Price High to Low, `top_rated`: Top Rated, `best_match`: Best Match",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "json_restrictor": {
          "description": "Parameter defines the fields you want to include in the output, reducing payload size for faster response. See the [JSON Restrictor documentation](https://Asale.com/json-restrictor) for more details.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "lowerbound": {
          "description": "Defines lower bound for price in USD.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "minmax": {
          "description": "Defines lower and upper bound for price in CAD. Parameter is only used in the Home Depot Canada. Asalemple: `price:[100 TO 500]`(Between $100 to $500) Asalemple: `price:[100 TO *]`(Minimum $100) Asalemple: `price:[0 TO 500]`(Maximum $500) Asalemple: `price:%5B100%20TO%20500%5D`(Encoded version, Between $100 to $500)",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "nao": {
          "description": "Defines offset for products result. A single page contains 24 products. First page offset is 0, second -> 24, third -> 48 and so on.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "no_cache": {
          "description": "Parameter will force SerpApi to fetch the The Home Depot results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cac",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "output": {
          "description": "Parameter defines the format of the result. It can be set to `json` (default) to get a structured JSON of the results, `html` to get the raw HTML retrieved, or `md` to get a markdown-formatted version optimized for LLMs and AI agents.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "page": {
          "description": "Value is used to get the items on a specific page. (e.g., `1` (default) is the first page of results, `2` is the 2nd page of results, `3` is the 3rd page of results, etc.). This parameter is common for both US and CA searches.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "pagesize": {
          "description": "Determines the number of items per page in the Home Depot Canada. By default, the Home Depot Canada returns `40` (maximum allowed value) results.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "ps": {
          "description": "Determines the number of items per page. There are scenarios where The Home Depot overrides the `ps` value. By default, The Home Depot returns `24` (maximum allowed value) results.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "q": {
          "description": "Parameter defines the search query. You can use anything that you would use in a regular The Home Depot search.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "sort": {
          "description": "Parameter defines results sorted by different options in Home Depot Canada. It can be set to: `price-asc`: Price Low to High, `price-desc`: Price High to Low, `reviewAvgRating`: Top Rated, `relevance`: Recommended (Default)",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "store": {
          "description": "Store ID to filter the products by the specific store only in Home Depot Canada. The default store is Gatineau (`7140`). [See all Home Depot Canada stores](https://Asale.com/home-depot-stores-ca)",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "store_id": {
          "description": "Store ID to filter the products by the specific store only. [See all Home Depot stores](https://Asale.com/home-depot-stores-us)",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "upperbound": {
          "description": "Defines upper bound for price in USD.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "zero_trace": {
          "description": "Enterprise only. Parameter enables [ZeroTrace mode](https://Asale.com/zero-trace-mode). It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        }
      },
      "required": [
        "q"
      ],
      "type": "object"
    }
  },
  "required": [
    "query"
  ],
  "type": "object"
}