{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper", "description": "Scrape Amazon keyword searches, category pages, ASINs, and product URLs. Select among 11 marketplace domains; access is route-dependent and challenge pages fail cleanly. Live .com product fields include title, price, rating, review count, seller, availability, images, variants, and BSR.", "version": "0.1", "x-build-id": "1mo9EA9DnWvCjAqpd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/myagizm~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-myagizm-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/myagizm~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-myagizm-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/myagizm~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-myagizm-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", "required": [ "mode", "marketplace" ], "properties": { "mode": { "title": "Scrape mode", "enum": [ "search", "details" ], "type": "string", "description": "Choose search mode for a keyword or category URL, or details mode for ASINs and product URLs.", "default": "search" }, "keyword": { "title": "Search keyword", "type": "string", "description": "In search mode, scrape products matching this Amazon keyword. Use either a keyword or Category URL, not both.", "default": "wireless mouse" }, "categoryUrl": { "title": "Amazon category or search URL", "type": "string", "description": "In search mode, paste an Amazon category or search URL for the selected marketplace. Clear Search keyword when using this field.", "default": "" }, "asins": { "title": "Product ASINs", "type": "array", "description": "In details mode, scrape one or more 10-character Amazon Standard Identification Numbers from the selected marketplace.", "items": { "type": "string", "pattern": "^[A-Za-z0-9]{10}$" }, "default": [] }, "productUrls": { "title": "Product page URLs", "type": "array", "description": "In details mode, scrape Amazon product page URLs containing /dp/ASIN or /gp/product/ASIN. URLs must match the selected marketplace.", "items": { "type": "string" }, "default": [] }, "marketplace": { "title": "Amazon marketplace", "enum": [ "com", "de", "co.uk", "com.tr", "fr", "it", "es", "ca", "com.au", "co.jp", "in" ], "type": "string", "description": "Amazon marketplace domain to request: .com, .de, .co.uk, .com.tr, .fr, .it, .es, .ca, .com.au, .co.jp, or .in. Amazon can return a localized access interstitial; the Actor makes one bounded alternate-route attempt and fails rather than returning empty data. .com is the only marketplace verified in this release test.", "default": "com" }, "deliveryZipCode": { "title": "Delivery ZIP or postcode", "pattern": "^[A-Za-z0-9 -]{0,12}$", "type": "string", "description": "Optional delivery location for marketplace availability and pricing. Leave blank to use a marketplace-specific default postcode; a custom value must match the selected marketplace.", "default": "" }, "currency": { "title": "Preferred display currency", "enum": [ "", "USD", "EUR", "GBP", "TRY", "CAD", "AUD", "JPY", "INR", "MXN", "BRL", "AED", "SAR", "PLN", "SEK", "NOK", "DKK", "CHF" ], "type": "string", "description": "Optional ISO 4217 currency preference sent to Amazon. Leave blank to use the marketplace's native currency. The Actor reports Amazon's displayed currency and fails a priced result if Amazon returns a different currency; it never converts or relabels the price.", "default": "" }, "maxProducts": { "title": "Maximum products", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of detailed product results to return. Runs are sequential and capped at 10 products to keep requests bounded.", "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 }, "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 } } } } } } } } } }