{ "openapi": "3.0.1", "info": { "title": "Amazon Product & Listing Intelligence", "description": "Scrape Amazon product data by ASIN: Best Sellers Rank in every category, buy-box seller, price, stock, variants, and listing-quality signals like A+ content and image count. The fields Jungle Scout charges a monthly seat for — no API key, no browser.", "version": "0.0", "x-build-id": "mmvwa0dpdTcK4kq2I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/eiv~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-eiv-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/eiv~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-eiv-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/eiv~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-eiv-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. Accepts a bare ASIN ('B00FLYWNYQ') or any Amazon product URL. A URL that names a marketplace wins over the marketplace list below, so an amazon.co.uk link is read as a UK listing.", "items": { "type": "string" } }, "bestSellerCategories": { "title": "Best Sellers categories", "type": "array", "description": "Category slugs to harvest ASINs from, e.g. 'electronics', 'home-garden', 'toys-and-games'. Take the slug from a Best Sellers URL: amazon.com/gp/bestsellers//. Amazon's keyword search is not scrapeable, so this is the discovery route.", "items": { "type": "string" } }, "maxProductsPerCategory": { "title": "Max products per category", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cap on ASINs taken from each category, per marketplace. Amazon serves about 30 per page and paginates to two, so 50 covers a full category list. This is your billing guard when using categories.", "default": 50 }, "startUrls": { "title": "Start URLs (for chaining)", "type": "array", "description": "Alternative to ASINs, for feeding output from another Actor straight into this one.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sourceDatasetId": { "title": "Source dataset ID", "type": "string", "description": "Read ASINs from an existing dataset instead of typing them." }, "sourceDatasetField": { "title": "Source dataset field", "type": "string", "description": "Which field on the source dataset holds the ASIN or product URL.", "default": "asin" }, "countries": { "title": "Marketplaces", "type": "array", "description": "Two-letter codes: us, uk, de, fr, it, es, nl, se, pl, ca, mx, br, au, jp, in, ae, sg, tr. One record is produced per ASIN per marketplace, and each is billed. The same ASIN is often a different price — or absent entirely — in another country.", "default": [ "us" ], "items": { "type": "string" } }, "includeBullets": { "title": "Include bullet points", "type": "boolean", "description": "Store the listing's feature bullets. A count is always included regardless.", "default": true }, "includeDescription": { "title": "Include full description", "type": "boolean", "description": "Store the long product description. Off by default because it dominates dataset size; a 300-character snippet is always included.", "default": false }, "includeImages": { "title": "Include image URLs", "type": "boolean", "description": "Store the gallery image URLs. A count is always included regardless.", "default": false }, "includeVariants": { "title": "Include variant ASINs", "type": "boolean", "description": "Store the sibling ASINs of the same parent product — the other sizes and colours. A count is always included regardless.", "default": true }, "flattenOutput": { "title": "Flatten output for CSV", "type": "boolean", "description": "Emit flat dot-notation columns with arrays joined by ' | '. Use for spreadsheets; leave off for warehouses.", "default": false }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 30, "type": "integer", "description": "Listings fetched in parallel. Amazon product pages average 2.4 MB, so raise memory alongside this. Lower it if you start seeing bot checks.", "default": 8 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Per-request timeout. Amazon pages are large and can be slow to serialise.", "default": 45 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for connection resets and 5xx responses. A 404 is not retried, because an ASIN missing from a marketplace stays missing.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Strongly recommended. Amazon geolocates the request: a US listing read from a European address shows no buy box at all, so price, seller and stock come back empty. Enable the Apify proxy without choosing a country and the Actor reads each marketplace from an IP in that country automatically.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }