--- title: Search slug: redcircleapi/target-product-data-api/parameters/search docTags: createdAt: 2024-07-27T14:22:43.825Z --- # Search Parameters `GET` `/request` The Search Parameters are applicable when making a request with `type=search` to retrieve search results from Target. The search term is specified in the `search_term` parameter. The parameters should be appended as querystring parameters to the Target Product Data API `GET` HTTP request. Search results are retrieved from the [Search results page](https://www.target.com/s?searchTerm=highlighter+pens) on Target. ![](https://apiimages.imgix.net/redcircleapi/images/png/docs/search.png?auto=format\&ixlib=react-9.5.1-beta.1\&w=600 "Search Results Page") For example, to request search results for the search term `highlighter pens` , sorted by "best selling products", the request would be: :::CodeblockTabs HTTP ```HTTP https://api.redcircleapi.com/request?api_key=demo&type=search&search_term=highlighter+pens&sort_by=best_seller ``` ```curl curl -L --get https://api.redcircleapi.com/request \ -d api_key="demo" \ -d type="search" \ -d search_term="highlighter+pens" \ -d sort_by="best_seller" ``` ```nodejs const axios = require('axios'); // set up the request parameters const params = { api_key: "demo", type: "search", search_term: "highlighter pens", sort_by: "best_seller" } // make the http GET request to RedCircle API axios.get('https://api.redcircleapi.com/request', { params }) .then(response => { // print the JSON response from RedCircle 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': 'highlighter pens', 'sort_by': 'best_seller' } # make the http GET request to RedCircle API api_result = requests.get('https://api.redcircleapi.com/request', params) # print the JSON response from RedCircle API print(json.dumps(api_result.json())) ``` ```php 'demo', 'type' => 'search', 'search_term' => 'highlighter pens', 'sort_by' => 'best_seller' ]); # make the http GET request to RedCircle API $ch = curl_init(sprintf('%s?%s', 'https://api.redcircleapi.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 RedCircle API echo $api_result; ?> ``` ::: *** ### Search Parameters The following parameters are available for all requests made when `type=search` . | *`Parameter`* | *`Required`* | *`Description`* | | ------------------------ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *`search_term`* | *`required`* | A search term to use to search for Target items. Either the `search_term` or `url` parameter must be supplied. | | *`category_id`* | *`optional`* | A category ID to retrieve results from. You may supply any arbitary value in the `category_id` parameter however we recommend using a category ID returned from the [Categories API ](https://docs.trajectdata.com/redcircleapi/categories-api/overview)as these are known-good category IDs from Target.
Category IDs can also be retrieved from any Target URL in the `category` Target URL querystring parameter. | | *`sort_by`* | *`optional`* | Determines how the results are sorted. Valid values are:
1. `best_seller`
2. Sort results by best selling 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. `best_match`
2. Sort results by best match.

1. `highest_rating`
2. Sort results by highest rated products first.

1. `newly_listed`
2. Sort results by newest products first

1. `featured`
2. Sort results by featured products first
-
:inlineImage[]{src="https://apiimages.imgix.net/redcircleapi/images/png/docs/search_sort_by.png?auto=format&ixlib=react-9.5.1-beta.1&w=150" alt caption} | | *`delivery_type`* | *`optional`* | Determines whether results are filtered to just those matching the given delivery type. Valid values are:
1. `in_store_pickup`
2. Filter results to products available in store (use the `customer_zipcode` parameter to specify the store).

1. `same_day_delivery`
2. Filter results to products available via same-day delivery.

1. `buy_at_store`
2. Filter results to products available via "Buy it at the Store" (use the `customer_zipcode` parameter to specify the store).

1. `ship_to_home`
2. Filter results to products available via ship-to-home delivery.
-
:inlineImage[]{src="https://apiimages.imgix.net/redcircleapi/images/png/docs/search_delivery_type.png?auto=format&ixlib=react-9.5.1-beta.1&w=150" alt caption} | | *`rating`* | *`optional`* | Determines whether results are filtered to just those matching the given customer star rating. Valid values are:
1. `one_star`
2. Filter results to products with a 1 to 1.9 star customer rating.

1. `two_star`
2. Filter results to products with a 2 to 2.9 star customer rating.

1. `three_star`
2. Filter results to products with a 3 to 3.9 star customer rating.

1. `four_star`
2. Filter results to products with a 4 to 5 star customer rating.

1. `five_star`
2. Filter results to products with a 5 star customer rating.
-
:inlineImage[]{src="https://apiimages.imgix.net/redcircleapi/images/png/docs/search_rating.png?auto=format&ixlib=react-9.5.1-beta.1&w=150" alt caption} | | *`include_out_of_stock`* | *`optional`* | Set to `true` to include out of stock products or `false` (the default) to exclude them. | | *`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/redcircleapi/target-product-data-api/pagination)docs for more information. | | *`facets`* | *`optional`* | A free-form set of filter facet IDs to use with the request. Available facet IDs are returned from `type=search` requests in the `id` property of the `facets` array. Facet IDs can also be retrieved from any Target URL in the `facetedValue` Target URL querystring parameter.
Facet IDs should be expressed in comma seperated notation, with each facet ID delimited by a comma (",") character.
For example, to set the `Sold By` facet to the value `Target` (facet ID `dq4mn` ), and the `Color` facet to the value `Blue` (facet ID `5y70h` ), the `facets` request parameter would be `facets=dq4mn,5y70h` | | *`url`* | *`optional`* | The Target 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/redcircleapi/target-product-data-api/results/search)