{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper", "description": "Scrape product listings from Amazon.in based on search term, ASINs, product URLs, or category URLs with detailed product information.", "version": "1.1", "x-build-id": "YuK5ZuOyhxf4aQkIO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codingfrontend~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codingfrontend-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/codingfrontend~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-codingfrontend-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/codingfrontend~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-codingfrontend-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": { "mode": { "title": "Scraping Mode", "enum": [ "search", "productUrl", "searchUrl", "categoryUrl", "asin" ], "type": "string", "description": "search, productUrl, searchUrl, categoryUrl, or asin.", "default": "search" }, "asins": { "title": "ASINs", "type": "array", "description": "Amazon product ASINs used when mode is asin.", "items": { "type": "string", "pattern": "^[A-Za-z0-9]{10}$" } }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Search phrase used when mode is search.", "default": "laptop" }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Public Amazon.in product URLs used when mode is productUrl.", "items": { "type": "string" } }, "searchUrl": { "title": "Search URL", "type": "string", "description": "Full public Amazon.in search URL used when mode is searchUrl." }, "categoryUrl": { "title": "Category URL", "type": "string", "description": "Public Amazon.in category or bestseller URL used when mode is categoryUrl." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum source-backed product records, from 1 through 100.", "default": 10 }, "deepProductScraping": { "title": "Deep Product Scraping", "type": "boolean", "description": "Compatibility flag retained for older inputs; direct mode always fetches public product pages to verify rich fields.", "default": true }, "productReviews": { "title": "Product Reviews", "type": "boolean", "description": "Extract up to 10 public review cards when present in the fetched HTML.", "default": false }, "requestDelayMs": { "title": "Request Delay (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Delay between serialized listing/detail requests.", "default": 600 }, "requestTimeoutMs": { "title": "Request Timeout (ms)", "minimum": 5000, "maximum": 120000, "type": "integer", "description": "Timeout for each direct public HTTP request.", "default": 60000 }, "maxRetries": { "title": "Request Retries", "minimum": 0, "maximum": 2, "type": "integer", "description": "Bounded retries for denied, challenged, failed, or timed-out HTTP requests.", "default": 1 }, "headless": { "title": "Legacy Headless Flag", "type": "boolean", "description": "Compatibility field retained for older inputs; the HTTP runner does not launch a browser.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional Apify or custom proxy configuration. When supplied, every HTTP request uses it." } } }, "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 } } } } } } } } } }