{ "openapi": "3.0.1", "info": { "title": "AmazonPageScraper", "description": "The best amazon page scraper!\nUse this scraper to get all the products on an Amazon page!", "version": "0.0", "x-build-id": "7WPB3yfM4EvPuFgr9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devlory~amazonpagescraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devlory-amazonpagescraper", "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/devlory~amazonpagescraper/runs": { "post": { "operationId": "runs-sync-devlory-amazonpagescraper", "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/devlory~amazonpagescraper/run-sync": { "post": { "operationId": "run-sync-devlory-amazonpagescraper", "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": { "start_urls": { "title": "Existing Amazon search/result URLs", "type": "array", "description": "Optional Amazon search/result page URLs. If provided, the scraper expands each URL using Number of pages to scrape, e.g. page 1 through page N.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "search_terms": { "title": "Search terms", "type": "array", "description": "Keywords to search on Amazon. One page JSON item is produced for every keyword/country/page combination.", "default": [ "phone" ], "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Amazon marketplaces by ISO country code. Supported: US, CA, MX, BR, GB, DE, FR, IT, ES, NL, SE, PL, TR, AE, SA, EG, IN, JP, SG, AU.", "default": [ "IT" ], "items": { "type": "string" } }, "number_of_pages": { "title": "Number of pages to scrape", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many Amazon result pages to request for each search term and country.", "default": 1 }, "sort_by": { "title": "Sort by", "enum": [ "relevance", "featured", "price_low_to_high", "price_high_to_low", "average_customer_review", "newest_arrivals", "best_sellers" ], "type": "string", "description": "Amazon search sort option. Raw Amazon sort values can be passed with extra_query if needed.", "default": "relevance" }, "department": { "title": "Department", "type": "string", "description": "Optional Amazon department/search index, for example electronics, fashion, computers, beauty, grocery. Availability varies by country.", "default": "" }, "min_price": { "title": "Minimum price", "type": "string", "description": "Optional Amazon low-price query value. Use the marketplace's visible price format, e.g. 10 or 10.50.", "default": "" }, "max_price": { "title": "Maximum price", "type": "string", "description": "Optional Amazon high-price query value. Use the marketplace's visible price format, e.g. 100 or 100.00.", "default": "" }, "rh": { "title": "Raw Amazon filter query (rh)", "type": "string", "description": "Optional raw Amazon rh filter, copied from a filtered Amazon URL. Useful for filters Amazon exposes only as marketplace-specific IDs.", "default": "" }, "extra_query": { "title": "Extra query parameters", "type": "object", "description": "Optional extra URL query parameters to add to generated search URLs, e.g. {\"p_72\":\"1318476031\"}. Use for Amazon filters that are possible but marketplace-specific.", "default": {} }, "use_proxy": { "title": "Use Apify residential proxy if available", "type": "boolean", "description": "Try to use Apify Residential Proxy for Amazon requests. If the run does not have proxy permission, the scraper continues without proxy unless Proxy required is enabled.", "default": false }, "proxy_required": { "title": "Proxy required", "type": "boolean", "description": "Fail/skip requests when Apify proxy is unavailable. Enable this only when you prefer no data over direct requests.", "default": false }, "proxy_country": { "title": "Proxy country override", "type": "string", "description": "Optional ISO country code for the Apify Residential Proxy. Leave empty to auto-select from each Amazon marketplace country.", "default": "" }, "max_retries": { "title": "Max retries", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum retries per Amazon page.", "default": 5 }, "max_concurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many Amazon pages to scrape in parallel.", "default": 3 } } }, "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 } } } } } } } } } }