{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper: Offers, Buy Box, BSR & Price Monitor", "description": "Amazon product data API by ASIN, URL, search or barcode in 22 marketplaces: price, Buy Box seller, every seller's offer, Best Sellers Rank at every level, bought-past-month, ratings, variants, specs and what changed since your last run. From $3 per 1,000 products.", "version": "0.1", "x-build-id": "lbzdyEmFHKSM9rkEB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cleanpull~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cleanpull-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/cleanpull~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-cleanpull-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/cleanpull~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-cleanpull-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 URLs", "type": "array", "description": "One per line: an ASIN (B0…, or ISBN-10 for books) or any Amazon product URL (…/dp/ASIN). A URL uses its own marketplace; an ASIN uses the marketplace below. A barcode here is looked up like the Barcodes field.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Optional. Amazon product URLs, from any marketplace. Same as putting them in ASINs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searches": { "title": "Searches", "type": "array", "description": "Optional. Search terms, one per line; the actor reads the products each search returns, in Amazon's order, up to the limit below.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Products per search", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many products to read from each search (Amazon shows about 48 per page; the actor follows the pages).", "default": 20 }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "Also read sponsored (ad) results of searches. Off: organic results only.", "default": false }, "barcodes": { "title": "Barcodes", "type": "array", "description": "Optional. UPC, EAN or ISBN-13, one per line. Each is looked up on Amazon and its product read.", "items": { "type": "string" } }, "datasetId": { "title": "Dataset of products", "type": "string", "description": "Optional. Another dataset (for example a previous run or another actor's results) whose rows hold ASINs or product URLs." }, "datasetField": { "title": "Dataset field", "type": "string", "description": "The field holding the ASIN or product URL in that dataset. \"asin\", \"url\" and \"productUrl\" are also tried.", "default": "asin" }, "marketplace": { "title": "Marketplace", "type": "string", "description": "For ASINs, searches, barcodes and dataset rows: a country code or domain. US, GB (or UK), DE, FR, IT, ES, CA, MX, BR, JP, IN, AU, NL, SE, PL, BE, TR, AE, SA, SG, EG, IE.", "default": "US" }, "includeOffers": { "title": "Every seller's offer", "type": "boolean", "description": "Also read the all-offers panel: every seller with price, condition, seller rating, FBA, delivery and Buy Box position, plus the lowest offer. Adds $1 per 1,000 products.", "default": false }, "maxOffers": { "title": "Offers per product", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many offers to read per product (about 10 per panel page).", "default": 10 }, "includeReviews": { "title": "Featured reviews", "type": "boolean", "description": "Keep the reviews the product page itself shows (up to about 13, where the page includes them). Full review lists need a sign-in, which this actor never uses.", "default": true }, "includeSearchSummary": { "title": "Search summary", "type": "boolean", "description": "Add one summary row per search (recordType search-summary): the monthly sales floor of the products read (the sum of their \"bought in past month\" badges, and that times their price) and their median Amazon fees. Free: summary rows are not charged and do not count toward Max items.", "default": false }, "changesOnly": { "title": "Changes only", "type": "boolean", "description": "Return only products that changed since the last run with the same monitor name (price, Buy Box, stock, rank, rating, sellers). Unchanged products cost $0.50 per 1,000. Every product row always lists its changes; the first run is the baseline. Schedule it daily or hourly.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Runs with the same name compare against each other. Use one name per product list you track.", "default": "default" }, "changeTypes": { "title": "Changes to report", "type": "array", "description": "Which changes count.", "items": { "type": "string", "enum": [ "price", "buy-box", "stock", "rank", "rating", "sellers" ], "enumTitles": [ "Price", "Buy Box seller or suppression", "In or out of stock", "Best Sellers Rank", "Rating", "Sellers joining or leaving (needs offers)" ] }, "default": [ "price", "buy-box", "stock", "rank", "rating", "sellers" ] }, "minPriceChangePercent": { "title": "Smallest price change (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Ignore price moves smaller than this percentage. 0 reports every change.", "default": 0 }, "minRankChangePercent": { "title": "Smallest rank change (%)", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Ignore rank moves smaller than this percentage (rank 1,000 → 1,080 is 8%).", "default": 10 }, "maxItems": { "title": "Max products", "minimum": 1, "type": "integer", "description": "Optional. Stop after this many product rows." }, "fields": { "title": "Only these fields", "type": "array", "description": "Optional. Keep only these fields, for example [\"asin\", \"title\", \"price\", \"buyBoxSeller\", \"rank\"].", "items": { "type": "string" } }, "maxConcurrency": { "title": "Products at a time", "minimum": 1, "maximum": 10, "type": "integer", "description": "Products read in parallel per marketplace. Amazon answers bursts with 503s, so keep this low.", "default": 3 }, "fullPageRetries": { "title": "Retries for half pages", "minimum": 0, "maximum": 5, "type": "integer", "description": "Amazon sometimes serves a product page without its lower half (details, Best Sellers Rank, review breakdown). The page is read again on a fresh session this many times, keeping the fullest. Each retry is another page load.", "default": 1 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. The actor picks proxies itself (direct, then datacenter, then residential only when Amazon blocks the others)." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional. Accepted for compatibility with other Amazon actors: product URLs, same as Product URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } } } }, "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 } } } } } } } } } }