Search
GET /request
The Search Parameters are applicable when making a request with type=search to retrieve search results for an Amazon domain - the Amazon domain is specified using the amazon_domain parameter and the search term is specified in the search_term parameter. The parameters should be appended as querystring parameters to the Product Data API GET HTTP request.
Search results are retrieved from the search results page on Amazon.
For example, to request search results for the search term "highlighter pens" sorted by "average customer review", on amazon.com , the request would be:
The following parameters are available for all requests made when type=search .
Parameter | Required | Description |
|---|---|---|
amazon_domain | optional | The Amazon domain to retrieve search results from. For a full list of supported Amazon domains see Supported Amazon Domains . |
search_term | optional | A search term to use to search products.
|
refinements | optional | A comma-seperated list of refinement values to filter the search results by. These allow you to refine your search by values such as "Reviews rating 4 and over", "price range" and "brand". Refinement values are returned in the refinements array of each type=search result. Refinement values are dynamic and change by category area or search term used. If you wish to use refinements you should first issue a type=search request without specifying any refinements to retrieve a master list of the avaialble refinements for the given category area/search term. You can then cache these refinement values for use on subsequent requests. For example, to run a type=search request specifying two refinements with values p_85/2470955011 and p_36/2421886011 the value of the refinements parameter would be refinements=p_85/2470955011,p_36/2421886011
|
category_id | optional | A category ID to limit search results to. ASIN Data API will use the category_id in the following form: https:// amazon_domain /s?node= category_id . Note that pagination for top-level categories is not supported by the Amazon sites. If you wish to iterate the contents of a category the recommended approach is to pick the lowest level categories to perform your iteration / pagination on. |
sort_by | optional | Determines the sort order of search results to return. Valid values are:
|
exclude_sponsored | optional | Whether to exclude sponsored search results (when set to exclude_sponsored=true ) from the search results returned, or not. Defaults to false . |
page | optional | The current page of search results to retrieve. Inspect the pagination.total_pages property in the Search results to see how many pages of search results are 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 docs for more information. |
url | optional | The Amazon search results page URL to retrieve search results from. Be sure to URL-encode the url parameter. Note the url parameter is supplied, the search_term parameter cannot be used (as the url itself defines the search term used). |
direct_search | optional | By default Amazon will, if a spelling mistake is suspected in the search_term , show search results for the corrected search term. To disable this behaviour and search for the value in search_term directly, without auto-correcting it, set direct_search=true . |
Next Steps Search Results