{ "openapi": "3.0.1", "info": { "title": "Real-Time Amazon Data API", "description": "Fast, reliable, and extensive Amazon data API - get products & ASIN data, reviews, offers, best sellers & deals, seller data, influencers, and more from Amazon in real-time.", "version": "1.0", "x-build-id": "wNSOgb7cTNHhFpNuH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/openweb-ninja~real-time-amazon-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-openweb-ninja-real-time-amazon-data", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/openweb-ninja~real-time-amazon-data/runs": { "post": { "operationId": "runs-sync-openweb-ninja-real-time-amazon-data", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/openweb-ninja~real-time-amazon-data/run-sync": { "post": { "operationId": "run-sync-openweb-ninja-real-time-amazon-data", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "endpoint" ], "properties": { "endpoint": { "title": "Endpoint", "enum": [ "/search", "/products-by-category", "/product-details", "/product-offers", "/product-reviews", "/product-review-details", "/top-product-reviews", "/scrape-by-url", "/seller-profile", "/seller-reviews", "/seller-products", "/best-sellers", "/deals-v2", "/deal-products", "/promo-code-details", "/influencer-profile", "/influencer-posts", "/influencer-post-products", "/asin-to-gtin", "/gtin-to-asin", "/product-category-list" ], "type": "string", "description": "Which endpoint of the API to call. Each endpoint uses the parameters listed in its section below; parameters of other endpoints are ignored.", "default": "/search" }, "query": { "title": "Query", "type": "string", "description": "Search query (supports both free-form text queries or a product asin).

Used by: Product Search, Product Reviews, Influencer Posts. Required for Product Search.", "default": "Phone" }, "page": { "title": "Page", "type": "integer", "description": "Results page to return.

Used by: Product Search, Products by Category, Product Offers, Seller Reviews, Seller Products, Best Sellers, Deal Products." }, "country": { "title": "Country", "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "description": "Sets the Amazon domain, marketplace country, language and currency.

Used by: Product Search, Products by Category, Product Details, Product Offers, Product Reviews, Product Review Details, Top Product Reviews, Scrape By URL, Seller Profile, Seller Reviews, Seller Products, Best Sellers, Deals, Deal Products, Promo Code Details, Influencer Profile, Influencer Posts, ASIN to GTIN, GTIN to ASIN, Product Category List.", "default": "US" }, "delivery_country": { "title": "Delivery country", "type": "string", "description": "Delivery destination country (ISO 3166-1 alpha-2 code, e.g. NL). When set, delivery dates, shipping costs, availability and offers reflect delivery to this country instead of the marketplace's domestic delivery. Defaults to the marketplace country.
Only specific country / delivery_country combinations are supported. Currently supported: country = DE with delivery_country = NL or DK, and country = FR, IT or ES with delivery_country = NL.
Other combinations return a 400 error. If you need another combination, contact us at support@openwebninja.com and we will look into adding it.

Used by: Product Search, Products by Category, Product Details, Product Offers, Scrape By URL, Seller Products, Best Sellers, Deals, Deal Products, Promo Code Details." }, "delivery_zipcode": { "title": "Delivery zipcode", "type": "string", "description": "Postal / ZIP code within the country marketplace, in its usual format, used as the delivery address so delivery dates, costs, availability and offers reflect it. An invalid zip code returns a 400 error. Cannot be combined with a different delivery_country.

Used by: Product Search, Products by Category, Product Details, Product Offers, Scrape By URL, Seller Products, Best Sellers, Deals, Deal Products, Promo Code Details." }, "sort_by": { "title": "Sort by", "enum": [ "RELEVANCE", "LOWEST_PRICE", "HIGHEST_PRICE", "REVIEWS", "NEWEST", "BEST_SELLERS" ], "type": "string", "description": "Return the results in a specific sort order.

Used by: Product Search, Products by Category, Product Reviews, Seller Products, Deal Products.", "default": "RELEVANCE" }, "category_id": { "title": "Category id", "type": "string", "description": "Find products in a specific category / department (e.g. computers-intl-ship).
Use the Product Category List endpoint to get a list of valid categories and their ids for the country specified in the request.
For numeric Amazon category IDs, use the category parameter instead.

Used by: Product Search, Products by Category. Required for Products by Category." }, "category": { "title": "Category", "type": "string", "description": "Filter by specific numeric Amazon category.
The category ID can be obtained from the Amazon category results URL, for example:
https://amazon.com/s?node=2858778013 - the Amazon Category ID is 2858778013.
Multiple category values can be separated by comma (e.g. categoryId1,categoryId2).

Used by: Product Search, Best Sellers. Required for Best Sellers." }, "min_price": { "title": "Min price", "type": "integer", "description": "Only return product offers with price greater than a certain value.
Specified in the currency of the selected country.
For example, in case country=US, a value of 105.34 means $105.34.

Used by: Product Search, Products by Category." }, "max_price": { "title": "Max price", "type": "integer", "description": "Only return product offers with price lower than a certain value.
Specified in the currency of the selected country. For example, in case country=US, a value of 105.34 means $105.34.

Used by: Product Search, Products by Category." }, "product_condition": { "title": "Product condition", "enum": [ "ALL", "NEW", "USED", "RENEWED", "COLLECTIBLE" ], "type": "string", "description": "Return products in a specific condition.

Used by: Product Search, Products by Category, Product Offers.", "default": "ALL" }, "brand": { "title": "Brand", "type": "string", "description": "Find products with a specific brand.
Multiple brands can be specified as a comma (,) separated list.
The brand values can be seen from Amazon's search left filters panel, as seen here.

Used by: Product Search, Products by Category." }, "seller_id": { "title": "Seller id", "type": "string", "description": "Find products sold by a specific seller (merchant). Multiple sellers can be specified as a comma (,) separated list.

Used by: Product Search, Seller Profile, Seller Reviews, Seller Products. Required for Seller Profile, Seller Reviews, Seller Products." }, "is_prime": { "title": "Is prime", "type": "boolean", "description": "Only return prime products.

Used by: Product Search, Products by Category.", "default": false }, "deals_and_discounts": { "title": "Deals and discounts", "enum": [ "NONE", "ALL_DISCOUNTS", "TODAYS_DEALS" ], "type": "string", "description": "Return deals and discounts in a specific condition.

Used by: Product Search, Products by Category.", "default": "NONE" }, "four_stars_and_up": { "title": "Four stars and up", "type": "boolean", "description": "Return product listings with ratings of 4 stars & up.

Used by: Product Search, Products by Category." }, "language": { "title": "Language", "type": "string", "description": "The language of the results. In case not specified, results will be returned in the default domain language.
Supported languages per country:
US: en_US, es_US
AU: en_AU
BR: pt_BR
CA: en_CA, fr_CA
FR: fr_FR, en_GB
DE: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK
IN: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN
IT: it_IT, en_GB
MX: es_MX
NL: nl_NL, en_GB
SG: en_SG
ES: es_ES, pt_PT, en_GB
TR: tr_TR
AE: en_AE, ar_AE
GB: en_GB
JP: ja_JP, en_US, zh_CN
SA: ar_AE, en_AE
PL: pl_PL
SE: sv_SE, en_GB
BE: fr_BE, nl_BE, en_GB
EG: ar_AE, en_AE
ZA: en_ZA IE: en_IE

Used by: Product Search, Products by Category, Product Details, Product Offers, Product Reviews, Product Review Details, Top Product Reviews, Scrape By URL, Seller Profile, Seller Reviews, Seller Products, Best Sellers, Deals, Deal Products, Promo Code Details, Influencer Profile, Influencer Posts, Influencer Post Products." }, "additional_filters": { "title": "Additional filters", "type": "string", "description": "Any filters available on the Amazon page but not part of this endpoint's parameters.
The filter values can be extracted from the rh parameter in the Amazon search URL after applying the filter of interest on the Amazon search results page.
Multiple filters are supported and can be separated by comma (,).
For example, when searching for science books with the Paperback book format filter selected, the Amazon URL is:
https://www.amazon.com/s?k=science+books&rh=p_n_feature_browse-bin%3A2656022011
and the rh parameter value is:
p_n_feature_browse-bin%3A2656022011
To filter for Paperback books, set the value of additional_parameters=p_n_feature_browse-bin%3A2656022011.

Used by: Product Search, Products by Category." }, "fields": { "title": "Fields", "type": "string", "description": "A comma separated list of product fields to include in the response (field projection).
By default all fields are returned.

Used by: Product Search, Products by Category, Product Details, Product Offers, Product Reviews, Product Review Details, Top Product Reviews, Seller Profile, Seller Reviews, Seller Products, Best Sellers, Deals, Deal Products, Influencer Profile, Influencer Posts." }, "asin": { "title": "Asin", "type": "string", "description": "Product ASIN for which to get details.
Supports batching of up to 10 ASINs in a single request, separated by comma.

Billing: each ASIN is billed as a separate request, so a batch of 10 ASINs counts as 10 requests against the plan quota.

Used by: Product Details, Product Offers, Product Reviews, Top Product Reviews, ASIN to GTIN. Required for Product Details, Product Offers, Product Reviews, Top Product Reviews, ASIN to GTIN." }, "more_info_query": { "title": "More info query", "type": "string", "description": "A query to search and get more info about the product as part of Product Information, Customer Q&As, and Customer Reviews.

Used by: Product Details." }, "include_offers": { "title": "Include offers", "type": "boolean", "description": "Also return the product's offers from all sellers as product_offers, with the same offer fields as the Product Offers endpoint (first page of offers, all conditions). When set, each ASIN is billed as 2 requests.

Used by: Product Details.", "default": false }, "delivery": { "title": "Delivery", "type": "array", "description": "Find products with specific delivery option, specified as a comma delimited list of the following values:

Used by: Product Offers.", "items": { "type": "string", "enum": [ "PRIME_ELIGIBLE", "FREE_DELIVERY" ] } }, "limit": { "title": "Limit", "type": "integer", "description": "Maximum number of offers to return.

Used by: Product Offers, Influencer Posts." }, "cookie": { "title": "Cookie", "type": "string", "description": "A logged-in user cookie to use for fetching product reviews. Include the following cookies for country=US: session-id, ubid-main, x-main, and at-main. For any other country: session-id, ubid-acb{country code}, x-acb{country code}, at-acb{country code}

Used by: Product Reviews, Product Review Details, Scrape By URL. Required for Product Reviews, Product Review Details." }, "cursor": { "title": "Cursor", "type": "string", "description": "A cursor used to retrieve the next set of results for pagination. The value for the next page is returned in the \"cursor\" response field.

Used by: Product Reviews, Influencer Posts, Influencer Post Products." }, "star_rating": { "title": "Star rating", "enum": [ "ALL", "5_STARS", "4_STARS", "3_STARS", "2_STARS", "1_STARS", "POSITIVE", "CRITICAL" ], "type": "string", "description": "Only return reviews with a specific star rating or positive / negative sentiment.

Used by: Product Reviews, Seller Reviews.", "default": "ALL" }, "verified_purchases_only": { "title": "Verified purchases only", "type": "boolean", "description": "Only return reviews by reviewers who made a verified purchase.

Used by: Product Reviews." }, "images_or_videos_only": { "title": "Images or videos only", "type": "boolean", "description": "Only return reviews containing images and / or videos.

Used by: Product Reviews." }, "current_format_only": { "title": "Current format only", "type": "boolean", "description": "Only return reviews of the current format (product variant - e.g. Color).
By default reviews are returned for all product variants

Used by: Product Reviews." }, "review_id": { "title": "Review id", "type": "string", "description": "The id of the product review for which to get details.

Used by: Product Review Details. Required for Product Review Details." }, "url": { "title": "Url", "type": "string", "description": "The full Amazon URL to scrape. The API automatically detects the page type and returns the appropriate parsed data.

Supported page types: - Product details (e.g. https://www.amazon.com/dp/B0D1XD1ZV3) - Product reviews (e.g. https://www.amazon.com/product-reviews/B0D1XD1ZV3) - Deals (e.g. https://www.amazon.com/deals) - Best sellers (e.g. https://www.amazon.com/Best-Sellers/zgbs) - Seller profile (e.g. https://www.amazon.com/sp?seller=A1D09S7Q0OD6TH) - Seller products - Search results - Amazon Haul

Used by: Scrape By URL. Required for Scrape By URL." }, "return_html": { "title": "Return html", "enum": [ "true", "false" ], "type": "string", "description": "Include the raw HTML of the scraped page in the response. Default: false

Used by: Scrape By URL.", "default": "false" }, "type": { "title": "Type", "enum": [ "BEST_SELLERS", "GIFT_IDEAS", "MOST_WISHED_FOR", "MOVERS_AND_SHAKERS", "NEW_RELEASES" ], "type": "string", "description": "Type of Best Seller list to return.

Used by: Best Sellers.", "default": "BEST_SELLERS" }, "offset": { "title": "Offset", "type": "string", "description": "Number of results to skip / index to start from (for pagination). Works with multiples of 30 (like on Amazons deals page) - 0, 30, 60, 90, etc.

Used by: Deals." }, "categories": { "title": "Categories", "type": "string", "description": "Return deals with products in specific categories / departments.
Multiple categories can be specified as a comma (,) separated list.
Numeric category id's can be found in the URL after selecting a specific category on https://www.amazon.com/deals.

Used by: Deals." }, "min_product_star_rating": { "title": "Min product star rating", "enum": [ "ALL", "1", "2", "3", "4" ], "type": "string", "description": "Return deals with products star rating greater than a specific value

Used by: Deals.", "default": "ALL" }, "price_range": { "title": "Price range", "enum": [ "ALL", "1", "2", "3", "4", "5" ], "type": "string", "description": "Return deals with price within a specific price range.
1 is lowest price range shown on Amazon (e.g. Under $25) while 5 is the highest price range (e.g. $200 & Above).

Used by: Deals.", "default": "ALL" }, "discount_range": { "title": "Discount range", "enum": [ "ALL", "1", "2", "3", "4", "5" ], "type": "string", "description": "Return deals with discount within a specific discount range.
1 is lowest discount range shown on Amazon (e.g. 10% off or more) while 5 is the highest discount range (e.g. 70% off or more).

Used by: Deals.", "default": "ALL" }, "brands": { "title": "Brands", "type": "string", "description": "Return deals with products by specific brands.
Multiple brands can be specified separated by comma (,).
In addition, brand names can be found under the Brand filter on the filter/refinements panel on https://www.amazon.com/deals (when applicable).

Used by: Deals." }, "prime_early_access": { "title": "Prime early access", "type": "boolean", "description": "Only return prime early access deals.

Used by: Deals." }, "prime_exclusive": { "title": "Prime exclusive", "type": "boolean", "description": "Only return prime exclusive deals.

Used by: Deals." }, "lightning_deals": { "title": "Lightning deals", "type": "boolean", "description": "Only return lightning deals

Used by: Deals." }, "deal_id": { "title": "Deal id", "type": "string", "description": "Deal ID of the deal to fetch

Used by: Deal Products. Required for Deal Products." }, "promo_code": { "title": "Promo code", "type": "string", "description": "Promo code for which to get products.
The promo code can be extracted from the /promocode Amazon URL.
For example the promo code for https://www.amazon.com/promocode/A31M10S4V50SOU is A31M10S4V50SOU.

Used by: Promo Code Details. Required for Promo Code Details." }, "influencer_name": { "title": "Influencer name", "type": "string", "description": "The Amazon Influencer name for which to get profile details

Used by: Influencer Profile, Influencer Posts, Influencer Post Products. Required for Influencer Profile, Influencer Posts, Influencer Post Products." }, "scope": { "title": "Scope", "enum": [ "ALL", "IDEA_LISTS", "PHOTOS", "VIDEOS" ], "type": "string", "description": "Return the results in a specific scope.

Used by: Influencer Posts.", "default": "ALL" }, "post_id": { "title": "Post id", "type": "string", "description": "Influencer Post ID (e.g. amzn1.ideas.1N84PQ3CI4NW0) of the list post for which to get product items (only posts with post_type=List are allowed).

Used by: Influencer Post Products. Required for Influencer Post Products." }, "product_identifier": { "title": "Product identifier", "type": "string", "description": "Product identifier to look up on Amazon. Supports GTIN, EAN-13, UPC, or ISBN.

Used by: GTIN to ASIN. Required for GTIN to ASIN." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }