{ "openapi": "3.0.1", "info": { "title": "Amazon Autocomplete Keyword Expander", "description": "Turn seed keywords into Amazon's own search-box autocomplete suggestions across 23 marketplaces. Expand past the usual per-query cap with A-Z/0-9/custom suffixes and recursive re-querying of newly found suggestions.", "version": "1.1", "x-build-id": "Lh0Nho79lKMarONeP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~amazon-autocomplete-keyword-expander/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-amazon-autocomplete-keyword-expander", "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/vexaloom-labs~amazon-autocomplete-keyword-expander/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-amazon-autocomplete-keyword-expander", "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/vexaloom-labs~amazon-autocomplete-keyword-expander/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-amazon-autocomplete-keyword-expander", "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": [ "keywords" ], "properties": { "keywords": { "title": "Seed keywords", "type": "array", "description": "One or more seed keywords or phrases to expand into Amazon autocomplete suggestions.", "default": [], "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "US", "CA", "MX", "BR", "IE", "ES", "GB", "FR", "BE", "NL", "DE", "IT", "SE", "ZA", "PL", "EG", "TR", "SA", "AE", "IN", "SG", "AU", "JP" ], "type": "string", "description": "Single Amazon marketplace to query. Used when `marketplaces` is empty.", "default": "US" }, "marketplaces": { "title": "Multiple marketplaces", "type": "array", "description": "Optional multi-market sweep, e.g. [\"US\", \"GB\", \"DE\"]. Leave empty to use the single `marketplace` value. Codes are the same as the marketplace dropdown.", "default": [], "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Amazon department aliases to scope suggestions, e.g. [\"aps\", \"kitchen\"]. Leave empty for the all-departments default (`aps`). Common aliases: aps, electronics, computers, fashion, kitchen, stripbooks, beauty, hpc, pet-supplies, toys-and-games, home-improvement, automotive, grocery, office-products, watches, shoes, luggage, digital-text, audible, amazon-devices, instant-video, todays-deals.", "default": [], "items": { "type": "string" } }, "expandAlphabet": { "title": "Expand with suffix A-Z", "type": "boolean", "description": "Append each letter a-z to every query (e.g. `yoga mat a`) to surface more than the per-query cap.", "default": false }, "expandPrefixAlphabet": { "title": "Expand with prefix A-Z", "type": "boolean", "description": "Prepend each letter a-z to every query (e.g. `a yoga mat`). Returns a different suggestion set from suffix expansion.", "default": false }, "expandNumbers": { "title": "Expand with digits 0-9", "type": "boolean", "description": "Append each digit 0-9 to every query, useful for sizes, models and quantities.", "default": false }, "expandQuestions": { "title": "Expand with questions", "type": "boolean", "description": "Query locale-aware question stems such as `how to`, `what is` and `where to buy` in front of each seed.", "default": false }, "expandComparisons": { "title": "Expand with comparisons", "type": "boolean", "description": "Query comparison tokens such as `vs`, `or`, `versus` and `and` after each seed.", "default": false }, "expandPrepositions": { "title": "Expand with prepositions", "type": "boolean", "description": "Query preposition tokens such as `for`, `with`, `without`, `under` and `over` after each seed.", "default": false }, "expandBuyerModifiers": { "title": "Expand with buyer modifiers", "type": "boolean", "description": "Query locale-aware buyer-intent modifiers such as `best`, `cheap`, `for men`, `for women` and `waterproof`.", "default": false }, "customSuffixes": { "title": "Custom suffixes", "type": "array", "description": "Additional suffixes to append to every query, e.g. [\"for men\", \"waterproof\", \"iphone 15\"].", "default": [], "items": { "type": "string" } }, "maxDepth": { "title": "Max recursion depth", "minimum": 0, "maximum": 3, "type": "integer", "description": "Recursively re-query newly discovered suggestions as fresh seeds, up to this depth (0 = original seeds only; 3 = three hops).", "default": 0 }, "queryMode": { "title": "Suggestion endpoint dialect", "enum": [ "enhanced", "organic", "both" ], "type": "string", "description": "`enhanced` returns thumbnails, widgets and predictive text when Amazon provides them; `organic` is the plain keyword response; `both` requests both and unions the results.", "default": "enhanced" }, "includeWidgets": { "title": "Include widget rows", "type": "boolean", "description": "Emit Amazon's optional widget suggestions (carousels, refinements, entity cards) when the enhanced endpoint returns them.", "default": false }, "includeSeed": { "title": "Include seed as a record", "type": "boolean", "description": "Emit one `SEED` record per seed keyword in addition to Amazon's suggestions.", "default": false }, "dedupe": { "title": "Deduplicate suggestions", "type": "boolean", "description": "Merge repeated suggestions into one record per seed, marketplace and department, with a relative volume proxy and provenance. Turn off to emit every occurrence.", "default": true }, "resultOrder": { "title": "Result order", "enum": [ "source", "alphabetical", "volume" ], "type": "string", "description": "Order within each seed, marketplace and department group. `volume` sorts by the relative query-count score (requires dedupe).", "default": "source" }, "mustContainSeed": { "title": "Must contain the seed", "type": "boolean", "description": "Drop suggestions that do not contain the original seed keyword.", "default": false }, "includeTerms": { "title": "Must contain any of these terms", "type": "array", "description": "Keep only suggestions containing at least one of these terms. Leave empty to keep all.", "default": [], "items": { "type": "string" } }, "excludeTerms": { "title": "Exclude these terms", "type": "array", "description": "Drop suggestions containing any of these terms.", "default": [], "items": { "type": "string" } }, "onlyQuestions": { "title": "Questions only", "type": "boolean", "description": "Keep only question-shaped suggestions (question word or trailing question mark).", "default": false }, "onlyLongTail": { "title": "Long-tail only", "type": "boolean", "description": "Keep only suggestions with three or more words.", "default": false }, "minWordCount": { "title": "Minimum word count", "minimum": 0, "maximum": 20, "type": "integer", "description": "Drop suggestions with fewer words than this value.", "default": 0 }, "maxSuggestions": { "title": "Max suggestions", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on total records emitted in this run.", "default": 500 }, "maxSuggestionsPerKeyword": { "title": "Max suggestions per seed", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Cap emitted records per seed, marketplace and department. 0 means no per-seed cap.", "default": 0 }, "maxQueries": { "title": "Max queries", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Hard cap on HTTP requests across the whole run. The run status message says when this cap stopped it.", "default": 400 }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel requests. Values above 8 give little extra speed and are more likely to be rate-limited.", "default": 4 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Pause per worker between requests. 0 is fastest; 100-250 is gentler.", "default": 100 } } }, "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 } } } } } } } } } }