{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper: Price, Buy Box, Offers & BSR", "description": "Amazon product data by ASIN, product link or keyword: price, list price, Buy Box seller and seller ID, offer list with seller ratings, Best Sellers Rank in every category, ratings, bought last month, variations. amazon.com, .co.uk, .de, .com.tr in local currency; fast mode: 48 ASINs per request.", "version": "0.1", "x-build-id": "h2MDX3eTEKr052y8G" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/foxlabs~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-foxlabs-amazon-product-scraper", "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/foxlabs~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-foxlabs-amazon-product-scraper", "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/foxlabs~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-foxlabs-amazon-product-scraper", "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", "properties": { "asins": { "title": "ASINs or product links", "type": "array", "description": "One per line: an ASIN (10 letters and digits, such as B07CMS5Q6P) or an Amazon product link (…/dp/ASIN). A link's own marketplace is used (an amazon.de link is read on amazon.de); a bare ASIN uses the Marketplace below. Each product is delivered once per run. Lines that are not a product (or a marketplace that is not supported yet) come back as free rows with the reason.", "items": { "type": "string" } }, "searchQueries": { "title": "Search keywords or search links", "type": "array", "description": "Optional. One per line: a keyword as you would type it into Amazon (\"coffee beans\"), or an Amazon search results link with its filters (…/s?k=…&rh=…). Organic results are returned in Amazon's order; sponsored results are left out. A link's own marketplace is used.", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.com.tr" ], "type": "string", "description": "Amazon store for bare ASINs and keywords. Prices come in the store's own currency and for a delivery address in its country.", "default": "amazon.com" }, "detailLevel": { "title": "Detail level", "enum": [ "full", "fast" ], "type": "string", "description": "Full product page: price, list price, Buy Box seller and seller ID, ships from, offer count, Best Sellers Rank in every category, rating, reviews, bought last month, variations, images, bullet points, specifications (one page per product). Fast list data: price, list price, rating, reviews, bought last month, image and other offers from Amazon's search results, up to 48 ASINs per request; much faster and cheaper, without seller, rank or variations.", "default": "full" }, "includeOffers": { "title": "Offer list (all sellers)", "type": "boolean", "description": "For each product, also read Amazon's offer list: the Buy Box offer and the first page of other offers (about 10), each with price, condition, seller, seller ID, ships from, seller rating and delivery. One extra request per product, charged as a separate event only when offers are returned.", "default": false }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 1, "maximum": 500, "type": "integer", "description": "Products to take from each search (Amazon shows about 16-60 per page; the Actor follows the result pages).", "default": 50 }, "maxItems": { "title": "Max products in total (optional)", "minimum": 0, "type": "integer", "description": "Stop after this many products in the whole run, to control cost. Empty or 0 = no limit. Your ASIN list is read in order." }, "zipCode": { "title": "Delivery postcode (optional)", "type": "string", "description": "Prices, stock and offers depend on the delivery address. Give a postcode in the marketplace's country (10001, SW1A 1AA, 10115). Empty: London SW1A 1AA on amazon.co.uk, Berlin 10115 on amazon.de; on amazon.com and amazon.com.tr the location Amazon guesses from the request's IP (shown in deliverTo)." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave the default (Apify Proxy). Requests start on Apify datacenter proxy; a blocked request is retried on up to three new datacenter sessions and then through Apify residential proxy in the marketplace's country.", "default": { "useApifyProxy": true } }, "residentialFallback": { "title": "Retry blocked requests through residential proxy", "type": "boolean", "description": "On by default. Off: blocked requests are retried on datacenter sessions only.", "default": true } } }, "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 } } } } } } } } } }