{ "openapi": "3.0.1", "info": { "title": "Amazon Search Scraper: Full Depth & ASIN Position", "description": "Amazon Search Scraper with Full Depth & ASIN Position extracts detailed search results, ASINs, product titles, prices, ratings, reviews, sellers, and exact organic rankings. Track keyword positions, analyze competitors, monitor products, and optimize Amazon SEO.", "version": "0.1", "x-build-id": "aC4Of7IXtUUa5k2hr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapio~amazon-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapio-amazon-search-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/scrapio~amazon-search-scraper/runs": { "post": { "operationId": "runs-sync-scrapio-amazon-search-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/scrapio~amazon-search-scraper/run-sync": { "post": { "operationId": "run-sync-scrapio-amazon-search-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": { "keywords": { "title": "šŸ”¤ Keywords or Amazon search page addresses", "type": "array", "description": "One or more search terms. A plain keyword is scanned on amazon.com; paste a country search page address to scan that marketplace instead (amazon.com, .co.uk, .de, .fr, .it, .es, .ca).\n\nExamples:\n ā€¢ `laptop`\n ā€¢ `protein powder`\n ā€¢ `https://www.amazon.co.uk/s?k=running+shoes`\n\nDefault: laptop and protein powder.", "items": { "type": "string" } }, "crawlDepth": { "title": "šŸ“š How deep to scan", "enum": [ "firstPage", "firstNPages", "everyPage" ], "type": "string", "description": "Choose how much of each keyword's result set to walk.\n\nā€¢ First page only - the top results, fastest.\nā€¢ First N pages - stops after the number set below, or at the last available page, whichever comes first.\nā€¢ Every page available - walks to the last page the result set actually offers.\n\nDefault: first N pages.", "default": "firstNPages" }, "pagesToScan": { "title": "šŸ”¢ Number of pages (when \"First N pages\" is chosen)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Used only when the depth above is set to \"First N pages\". If a keyword offers fewer pages than this, the scan stops at its real last page and the coverage row says so.\n\nExample: 3 on a keyword that lists 16 products per page returns positions 1-48. Default is 3.", "default": 3 }, "resultsPerKeyword": { "title": "šŸ“¦ Products per keyword", "minimum": 0, "maximum": 10000, "type": "integer", "description": "A quota applied to EACH keyword separately, not to the run as a whole - every keyword you enter is always scanned.\n\nSet 0 for no quota, in which case the depth setting above is the only limit. Default is 50." }, "skipDuplicateAsins": { "title": "šŸ§¹ Skip repeated products within a keyword", "type": "boolean", "description": "Amazon can repeat the same product across pages of one keyword. Leave on to keep one row per product and count the rest in `duplicateAsinsSkipped` on the coverage row. Turn off to keep every occurrence.\n\nDefault is on.", "default": true }, "trackAsins": { "title": "šŸŽÆ ASINs to locate", "type": "array", "description": "Product IDs to look for inside each keyword's scanned positions. An ASIN that is not in range comes back as `found: false` with `foundAtRank: null` - never a made-up zero.\n\nExample: `B0FS1V6XZD`. Leave empty to skip ASIN tracking.", "items": { "type": "string" } }, "trackTerms": { "title": "šŸ”  Brand or product words to locate", "type": "array", "description": "Whole words matched against each product title, case-insensitively. Every match is listed in `matchedAsins`, with the best position in `bestRank`.\n\nExamples: `hp`, `whey`. Default: hp and whey.", "items": { "type": "string" } }, "emitPositionRows": { "title": "šŸ§¾ Write watchlist rows", "type": "boolean", "description": "Leave on to add one `position` row per keyword and tracked value to the output, also mirrored into a `-positions` dataset. Turn off to keep only product and coverage rows.\n\nDefault is on.", "default": true }, "rankingOrder": { "title": "ā†•ļø Result ordering", "enum": [ "relevanceblender", "price-asc-rank", "price-desc-rank", "review-rank", "date-desc-rank", "exact-aware-popularity-rank" ], "type": "string", "description": "Pick the ordering to scan. All six are the orderings the search results themselves offer.\n\nDefault: featured." }, "urls": { "title": "šŸ§© urls (older name for Keywords)", "type": "array", "description": "Older name for the keyword list. Used only when the keyword field above is empty.", "items": { "type": "string" } }, "maxResults": { "title": "šŸ§© maxResults (older name for Products per keyword)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Older name for the product quota. Used only when \"Products per keyword\" is left empty. Note the quota is now applied per keyword, so no keyword is ever silently skipped." }, "sortBy": { "title": "šŸ§© sortBy (older name for Result ordering)", "type": "string", "description": "Older name for the ordering. Used only when \"Result ordering\" is left empty. The older value `recent` is honoured as newest arrivals instead of being ignored." }, "proxyConfiguration": { "title": "šŸŒ Connection configuration", "type": "object", "description": "Leave as it comes for the recommended setup. Advanced users can override it here." } } }, "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 } } } } } } } } } }