Deals

4min

Deals Parameters
﻿GET  /request
The Deals Parameters are applicable when making a request with  type=deals  to retrieve Lightning Deal / Daily Deals results from Amazon's Today's Deals page. The category of deals and Amazon domain are specified using the  category_id  and  amazon_domain  parameter. The parameters should be appended as querystring parameters to the Product Data API GET HTTP request.
Deals results are retrieved from the deals listing page on Amazon.
Category IDs
You can retrieve category IDs for each  amazon_domain  using the Categories API. Category IDs are also returned in the  categories  array in each  type=deals  response.
Multiple category IDs can be supplied, comma seperated, in the  category_id  parameter. For example, to request deals for Beauty ( 3760911 ) and Electronics ( 172282 ) categories on  amazon.com  the parameters would be  category_id=3760911,172282&amazon_domain=amazon.com .
If you wish to retrieve Deals from the deals homepage for a given  amazon_domain , simply omit the  category_id  parameter entirely.
Deals Page
﻿
For example, to request deals results for Electronics category ID of  172282  on  amazon.com  the request would be:
HTTP
Curl
Node.js
Python
PHP
https://api.rainforestapi.com/request?api_key=demo&type=deals&category_id=15684181&amazon_domain=amazon.com
https://api.rainforestapi.com/request?api_key=demo&type=deals&category_id=15684181&amazon_domain=amazon.com
﻿
﻿
Deals Parameters
The following parameters are available for all requests made when  type=deals .
Note  that the common  include_html=true ,  output=html ,  customer_zipcode  and  customer_location  parameters cannot be used when making Deals requests.
Parameter
Required
Description
category_id
optional
A comma-seperated list of Deals category IDs to retrieve deals results from, as returned by the Categories API . Category IDs are also returned in the categories array in each type=deals response .  
Multiple category IDs can be supplied, comma seperated, in the category_id parameter. For example, to request deals for Beauty ( 3760911 ) and Electronics ( 172282 ) categories on amazon.com the parameters would be category_id=3760911,172282&amazon_domain=amazon.com .  
If you wish to retrieve Deals from the deals homepage for a given amazon_domain , simply omit the category_id parameter entirely.
amazon_domain
optional
The Amazon domain to retrieve Deals from for the category ID(s) specified in the category_id parameter. For a full list of supported Amazon domains see Supported Amazon Domains .
deal_types
optional
The types of deal to include. If you omit the deal_types parameter then all deal types are included.  
Note multiple deal types can be specified, comma-separated.  
Valid values are:
lightning_deal
Include lightning deals.
﻿
﻿
price_range
optional
Only includes deals for products within a specified price range If you omit the price_range parameter then all deals are included.  
Note Price tiers will vary based on amazon_domain but for amazon.com the current price tiers are: 
1
Under $25
﻿
2
$25 to $50
﻿
3
$50 - $100
﻿
4
$100 - $1=200
﻿
5
$200 & Above
﻿
﻿
﻿
discount
optional
Only include deals for products with with a discount range. If you omit the discount discount parameter deals for products with any discount are included.
 Valid values are:
10_percent_off
Includes 10% off or more deals.
﻿
25_percent_off
Includes all 25% off or more deals.
﻿
50_percent_off
Includes all 50% off or more deals.
﻿
70_percent_off
Includes all 70% off or more deals.
﻿
﻿
prime_early_access
optional
Determines whether to filter to only Prime Early Access deals:  
Valid values are:
true
Filter to only Prime Early Access deals.
﻿
﻿
prime_exclusive
optional
Determines whether to filter to only Prime Exclusive deals:  
Valid values are:
true
Filter to only Prime Exclusive deals.
minimum_rating
optional
Only include deals for products with a customer rating meeting the specified criteria. If you omit the minimum_rating parameter deals for products with any rating are included. Valid values are:
1_and_up
Include deals for products with a 1-star customer rating and upwards.
﻿
2_and_up
Include deals for products with a 2-star customer rating and upwards.
﻿
3_and_up
Include deals for products with a 3-star customer rating and upwards.
﻿
4_and_up
Include deals for products with a 4-star customer rating and upwards.
﻿
﻿
page
optional
The current page of deals results to retrieve. Inspect the pagination.total_pages property in the Deals results to see how many pages of deal 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.
﻿
Next Steps
     Deals Results﻿

Parameter	Required	Description
category_id	optional	A comma-seperated list of Deals category IDs to retrieve deals results from, as returned by the Categories API . Category IDs are also returned in the categories array in each type=deals response . Multiple category IDs can be supplied, comma seperated, in the category_id parameter. For example, to request deals for Beauty ( 3760911 ) and Electronics ( 172282 ) categories on amazon.com the parameters would be category_id=3760911,172282&amazon_domain=amazon.com . If you wish to retrieve Deals from the deals homepage for a given amazon_domain , simply omit the category_id parameter entirely.
amazon_domain	optional	The Amazon domain to retrieve Deals from for the category ID(s) specified in the category_id parameter. For a full list of supported Amazon domains see Supported Amazon Domains .
deal_types	optional	The types of deal to include. If you omit the deal_types parameter then all deal types are included. Note multiple deal types can be specified, comma-separated. Valid values are: lightning_deal Include lightning deals.
price_range	optional	Only includes deals for products within a specified price range If you omit the price_range parameter then all deals are included. Note Price tiers will vary based on amazon_domain but for amazon.com the current price tiers are: 1 Under $25 2 $25 to $50 3 $50 - $100 4 $100 - $1=200 5 $200 & Above
discount	optional	Only include deals for products with with a discount range. If you omit the discount discount parameter deals for products with any discount are included. Valid values are: 10_percent_off Includes 10% off or more deals. 25_percent_off Includes all 25% off or more deals. 50_percent_off Includes all 50% off or more deals. 70_percent_off Includes all 70% off or more deals.
prime_early_access	optional	Determines whether to filter to only Prime Early Access deals: Valid values are: true Filter to only Prime Early Access deals.
prime_exclusive	optional	Determines whether to filter to only Prime Exclusive deals: Valid values are: true Filter to only Prime Exclusive deals.
minimum_rating	optional	Only include deals for products with a customer rating meeting the specified criteria. If you omit the minimum_rating parameter deals for products with any rating are included. Valid values are: 1_and_up Include deals for products with a 1-star customer rating and upwards. 2_and_up Include deals for products with a 2-star customer rating and upwards. 3_and_up Include deals for products with a 3-star customer rating and upwards. 4_and_up Include deals for products with a 4-star customer rating and upwards.
page	optional	The current page of deals results to retrieve. Inspect the pagination.total_pages property in the Deals results to see how many pages of deal 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.

Updated 06 Sep 2024

Did this page help you?

Sales Estimation

Bestsellers