{ "openapi": "3.0.1", "info": { "title": "Amazon Keyword Discovery Scraper", "description": "Discover source-backed public Amazon autocomplete suggestions for seed keywords with marketplace, locale, filtering, serialized pacing, and provenance controls.", "version": "2.0", "x-build-id": "GsCahzXX76l6oDYCu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/searchapi~amazon-keywords-discovery-tool/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-searchapi-amazon-keywords-discovery-tool", "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/searchapi~amazon-keywords-discovery-tool/runs": { "post": { "operationId": "runs-sync-searchapi-amazon-keywords-discovery-tool", "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/searchapi~amazon-keywords-discovery-tool/run-sync": { "post": { "operationId": "run-sync-searchapi-amazon-keywords-discovery-tool", "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": { "seedKeyword": { "title": "Seed keyword", "minLength": 1, "maxLength": 200, "type": "string", "description": "Single phrase to enter in Amazon search.", "default": "wireless earbuds" }, "seedKeywords": { "title": "Seed keywords", "minItems": 1, "maxItems": 100, "type": "array", "description": "Optional seed list; takes precedence over seedKeyword.", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "marketplace": { "title": "Marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.ca", "amazon.in", "amazon.co.jp", "amazon.es", "amazon.it", "amazon.com.au", "amazon.com.mx", "amazon.com.br" ], "type": "string", "description": "Amazon marketplace and public completion market ID.", "default": "amazon.com" }, "locale": { "title": "Locale", "enum": [ "auto", "en-US", "en-GB", "de-DE", "fr-FR", "en-CA", "en-IN", "ja-JP", "es-ES", "it-IT", "en-AU", "es-MX", "pt-BR" ], "type": "string", "description": "Request and normalization locale; auto follows marketplace.", "default": "auto" }, "expansionMode": { "title": "Expansion mode", "enum": [ "seed", "letters", "lettersAndNumbers" ], "type": "string", "description": "Seed only, A-Z suffixes, or A-Z plus 0-9 suffixes.", "default": "lettersAndNumbers" }, "alphabetExpansion": { "title": "Legacy alphabet expansion", "type": "boolean", "description": "Backward-compatible boolean expansion setting." }, "suggestionLimit": { "title": "Suggestions per query", "minimum": 1, "maximum": 20, "type": "integer", "description": "Hard per-query result limit.", "default": 12 }, "maxItems": { "title": "Maximum keywords", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard global result limit.", "default": 500 }, "maxKeywords": { "title": "Legacy maximum keywords", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Backward-compatible alias for maxItems." }, "maxQueriesPerSeed": { "title": "Maximum queries per seed", "minimum": 1, "maximum": 37, "type": "integer", "description": "Hard request limit per seed, including the base query.", "default": 37 }, "includeKeywords": { "title": "Include filters", "type": "array", "description": "Suggestion must contain one of these substrings when provided.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude filters", "type": "array", "description": "Suggestions containing any of these substrings are omitted.", "items": { "type": "string" } }, "requestDelayMs": { "title": "Request delay", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Delay between completion queries in milliseconds.", "default": 300 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum seconds for one completion request.", "default": 12 }, "maxRequestRetries": { "title": "Request retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for temporary network, rate-limit, and server failures.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional authorized Apify or custom proxy configuration; credentials are never logged." } } }, "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 } } } } } } } } } }