{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper - Best Sellers, ASIN, Prices, Ratings", "description": "Amazon API alternative: search products by keyword, list a category or pull Best Sellers rankings on 24 marketplaces. Get ASIN, title, price and list price, rating and rating count, Prime and badges, bought-past-month volume. No login or cookies needed. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "9LM0JjkASpbvl2KNS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clover_folktale~amazon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clover_folktale-amazon-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/clover_folktale~amazon-scraper/runs": { "post": { "operationId": "runs-sync-clover_folktale-amazon-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/clover_folktale~amazon-scraper/run-sync": { "post": { "operationId": "run-sync-clover_folktale-amazon-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": { "mode": { "title": "Mode", "enum": [ "search", "category", "bestSellers" ], "type": "string", "description": "What to scrape: products by keyword, the products of a category, or a Best Sellers ranking.", "default": "search" }, "country": { "title": "Marketplace", "enum": [ "US", "GB", "DE", "FR", "IT", "ES", "NL", "SE", "PL", "BE", "IE", "TR", "AE", "SA", "EG", "ZA", "IN", "JP", "SG", "AU", "CA", "MX", "BR", "CN" ], "type": "string", "description": "The Amazon marketplace to read (US = amazon.com, DE = amazon.de, JP = amazon.co.jp ...).", "default": "US" }, "keywords": { "title": "Keywords (mode: search)", "type": "array", "description": "Search keywords or ASINs. Results are collected keyword by keyword until Max results is reached. Falls back to \"wireless earbuds\" when empty.", "items": { "type": "string" } }, "categoryIds": { "title": "Category IDs (mode: category)", "type": "array", "description": "Numeric Amazon category IDs (for example 172282 for Electronics), or category links that contain node=. Required in this mode.", "items": { "type": "string" } }, "bestSellerCategories": { "title": "Best Sellers categories (mode: bestSellers)", "type": "array", "description": "Category paths as they appear in an Amazon Best Sellers link after /zgbs/ (for example electronics or electronics/172282), or the full link. Falls back to electronics when empty. A ranking holds up to 100 products.", "items": { "type": "string" } }, "sort": { "title": "Sort (modes: search, category)", "enum": [ "relevance", "priceLowToHigh", "priceHighToLow", "reviews", "newest", "bestSellers" ], "type": "string", "description": "Order of the results. Best Sellers rankings are always in rank order.", "default": "relevance" }, "condition": { "title": "Condition (mode: search)", "enum": [ "all", "new", "used", "renewed", "collectible" ], "type": "string", "description": "Only products in this condition.", "default": "all" }, "deals": { "title": "Deals (mode: search)", "enum": [ "any", "discounted", "todaysDeals" ], "type": "string", "description": "Only discounted products, or only today's deals.", "default": "any" }, "primeOnly": { "title": "Prime only (mode: search)", "type": "boolean", "description": "Only products eligible for Prime.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of products to return in total for this run. You are charged per product returned. On the free Apify plan a run returns at most 10 results in total; any paid Apify plan removes the limit.", "default": 20 } } }, "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 } } } } } } } } } }