Common

4min

Common Parameters
﻿GET  /request
The following parameters are used to configure your request to the Product Data API. They should be appended as querystring parameters to a  GET HTTP request to the  /request  endpoint.
For example, to request Prime offers, for the ASIN  B07WJJF8PB  on  amazon.com  the request would be:
HTTP
Curl
Node.js
Python
PHP
https://api.asindataapi.com/request?api_key=demo&type=offers&amazon_domain=amazon.com&asin=B07WJJF8PB&offers_prime=true
https://api.asindataapi.com/request?api_key=demo&type=offers&amazon_domain=amazon.com&asin=B07WJJF8PB&offers_prime=true
﻿
Request-Specific Parameters
Additional parameters are available depending on the type of request being made (as-determined by the  type  parameter). For example, if you make a request with  type=reviews  then additional Reviews Parameters, specific to  type=reviews  requests, are available.
﻿
Common Parameters
The following common parameters are required for all requests to the Product Data API.
Parameter
Required
Description
api_key
required
The API key for your ASIN Data API account.
type
required
The type of Amazon data to retrieve. The value of the type parameter determines which additional parameters are available. For example, if you make a request with type=reviews then additional Reviews Parameters , specific to reviews requests, are available.  
Valid values for type are:
product
Request data from the product page for an asin or Amazon product page url . See additional Product Parameters .
﻿
search
Request search results data for a given keywords on specific Amazon sites. See additional Search Parameters .
﻿
offers
Request product offers for an asin or Amazon product page url . See additional Offers Parameters .
﻿
reviews
Request customer reviews for an asin or Amazon product page url . See additional Reviews Parameters .
﻿
category
Request data for a given Amazon category. See additional Category Parameters .
include_html
optional
Determines whether raw HTML is included in the response (this can increase the size of the response). Can be set to true or false (the default).  
Note When adding requests with include_html=true to a Collection the maximum number of requests is lower (100) because including the HTML within the response makes the Collection Result Sets much larger. The limit is in place to ensure Result Set files are of a manageable size. If you have need to run a large number of requests all with include_html=true then simply split the requests across multiple 100-request Collections.
output
optional
Determines the format in which results are returned. Can be set to json (default) to get the results as structured JSON, html to get the raw html retrieved or csv to return the results in CSV format. When using csv you can also use the csv_fields parameter to specify which fields to return in the CSV.
csv_fields
optional
Determines the fields that are returned when returning in csv mode (i.e. when the output parameter is set to csv ). Should be specified as a comma seperated list of fields (in nested field, dot notation, format). For more information on the csv_fields parameter please see the CSV Fields Reference .
skip_on_incident
optional
Instructs the API to not serve requests when a parsing incident is detected. Valid values are all (where the API will not serve a response if a "degraded" or "major" parsing incident is live) and major_only (where the API will not serve a response is a "major" parsing incident is live, but will if a "degraded service" parsing incident is live).  
You can view service status via the status page .  
Using skip_on_incident can be desirable if your system is making unsupervised requests to the API that you would like to gracefully fail in the event of an incident.
include_fields
optional
A comma-seperated list JSON field names to include in the JSON object the API returns. You can specify the field names in dot notation - i.e. include_fields=pagination will only include the the pagination property in the response JSON. Use include_fields if you only want to include specific fields in the API's JSON response.
exclude_fields
optional
A comma-seperated list of JSON field names to exclude from the JSON object the API returns. You can specify the field names in dot notation - i.e. exclude_fields=pagination will remove the pagination property from the response JSON. Use exclude_fields if there are specific fields you wish to exclude from the API's JSON response.
﻿
Next Steps
     Product Parameters
     Search Parameters
     Offers Parameters
     Reviews Parameters
     Category Parameters﻿

Parameter	Required	Description
api_key	required	The API key for your ASIN Data API account.
type	required	The type of Amazon data to retrieve. The value of the type parameter determines which additional parameters are available. For example, if you make a request with type=reviews then additional Reviews Parameters , specific to reviews requests, are available. Valid values for type are: product Request data from the product page for an asin or Amazon product page url . See additional Product Parameters . search Request search results data for a given keywords on specific Amazon sites. See additional Search Parameters . offers Request product offers for an asin or Amazon product page url . See additional Offers Parameters . reviews Request customer reviews for an asin or Amazon product page url . See additional Reviews Parameters . category Request data for a given Amazon category. See additional Category Parameters .
include_html	optional	Determines whether raw HTML is included in the response (this can increase the size of the response). Can be set to true or false (the default). Note When adding requests with include_html=true to a Collection the maximum number of requests is lower (100) because including the HTML within the response makes the Collection Result Sets much larger. The limit is in place to ensure Result Set files are of a manageable size. If you have need to run a large number of requests all with include_html=true then simply split the requests across multiple 100-request Collections.
output	optional	Determines the format in which results are returned. Can be set to json (default) to get the results as structured JSON, html to get the raw html retrieved or csv to return the results in CSV format. When using csv you can also use the csv_fields parameter to specify which fields to return in the CSV.
csv_fields	optional	Determines the fields that are returned when returning in csv mode (i.e. when the output parameter is set to csv ). Should be specified as a comma seperated list of fields (in nested field, dot notation, format). For more information on the csv_fields parameter please see the CSV Fields Reference .
skip_on_incident	optional	Instructs the API to not serve requests when a parsing incident is detected. Valid values are all (where the API will not serve a response if a "degraded" or "major" parsing incident is live) and major_only (where the API will not serve a response is a "major" parsing incident is live, but will if a "degraded service" parsing incident is live). You can view service status via the status page . Using skip_on_incident can be desirable if your system is making unsupervised requests to the API that you would like to gracefully fail in the event of an incident.
include_fields	optional	A comma-seperated list JSON field names to include in the JSON object the API returns. You can specify the field names in dot notation - i.e. include_fields=pagination will only include the the pagination property in the response JSON. Use include_fields if you only want to include specific fields in the API's JSON response.
exclude_fields	optional	A comma-seperated list of JSON field names to exclude from the JSON object the API returns. You can specify the field names in dot notation - i.e. exclude_fields=pagination will remove the pagination property from the response JSON. Use exclude_fields if there are specific fields you wish to exclude from the API's JSON response.

Updated 11 Aug 2024

Did this page help you?

Pagination

Product