{ "openapi": "3.0.1", "info": { "title": "Amazon Keyword Research - Autocomplete & Search Volume Tool", "description": "Find Amazon keywords from autocomplete with A-Z expansion, result counts per keyword and reverse-ASIN page-1 rank checks across 22 Amazon marketplaces.", "version": "1.0", "x-build-id": "ddIz9KMR2ZmXIgFVc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/seemuapps~amazon-keyword-research/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-seemuapps-amazon-keyword-research", "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/seemuapps~amazon-keyword-research/runs": { "post": { "operationId": "runs-sync-seemuapps-amazon-keyword-research", "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/seemuapps~amazon-keyword-research/run-sync": { "post": { "operationId": "run-sync-seemuapps-amazon-keyword-research", "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, e.g. 'yoga mat'. Each seed is expanded into the long-tail phrases Amazon shoppers see in the search box.", "items": { "type": "string" } }, "marketplace": { "title": "Amazon store", "enum": [ "US", "CA", "MX", "BR", "UK", "DE", "FR", "IT", "ES", "NL", "SE", "PL", "BE", "IE", "TR", "AE", "SA", "EG", "IN", "JP", "SG", "AU" ], "type": "string", "description": "Amazon store to research. Suggestions and result counts come from that store, in its own language.", "default": "US" }, "shopperCountry": { "title": "Shopper country", "enum": [ "", "US", "CA", "MX", "BR", "GB", "DE", "FR", "IT", "ES", "NL", "SE", "PL", "BE", "IE", "TR", "AE", "SA", "EG", "IN", "JP", "SG", "AU", "NZ", "ZA", "CH", "AT", "DK", "NO", "FI", "PT", "KR" ], "type": "string", "description": "Optional. See results, ranks and result counts as a shopper located in this country would (e.g. amazon.com seen from Canada). Leave empty to use the store's own country.", "default": "" }, "expansion": { "title": "Keyword expansion", "enum": [ "none", "a-z", "a-z-0-9", "modifiers", "all" ], "type": "string", "description": "How far to expand each seed. A-Z types the seed followed by every letter ('yoga mat a', 'yoga mat b', ...). Modifiers add buyer-intent and question words in the marketplace language ('best', 'how to', 'for', 'with', ...). All combines everything, including letters before the seed.", "default": "a-z" }, "maxKeywords": { "title": "Max keywords per seed", "minimum": 0, "type": "integer", "description": "Maximum keyword rows returned for each seed, strongest suggestions first. 0 = no limit.", "default": 200 }, "includeResultCount": { "title": "Include search result count", "type": "boolean", "description": "Also look up how many products Amazon returns for each keyword (e.g. '1-48 of over 8,000 results', plus the exact count). This is a competition signal, not monthly search volume. Billed as a separate event per keyword looked up.", "default": false }, "asins": { "title": "ASINs to rank-check (reverse ASIN)", "type": "array", "description": "Optional. Up to 10 ASINs or product URLs. For every keyword the actor checks the top organic search results (see Rank depth) and reports where each ASIN ranks, organic and sponsored. All ASINs are checked on the same page, so a keyword costs one rank check however many ASINs you add. Turns on result counts automatically and is billed per keyword checked instead of the result-count event.", "items": { "type": "string" } }, "rankDepth": { "title": "Rank depth", "minimum": 1, "maximum": 48, "type": "integer", "description": "How many organic (non-sponsored) page-1 results to check for your ASINs. 20 covers the positions that get most clicks; 48 checks the whole first page. Sponsored slots seen above that depth are reported too.", "default": 20 }, "asinMatchesOnly": { "title": "Only keep keywords where an ASIN ranks", "type": "boolean", "description": "With ASINs set, drop keywords where none of your ASINs appear on page 1. Dropped keywords are not billed as keyword results, but the rank check itself still is.", "default": false }, "department": { "title": "Department code", "type": "string", "description": "Optional. Scope suggestions and searches to one department. 'aps' = All departments. amazon.com examples: stripbooks, electronics, fashion, beauty, hpc, kitchen, garden, lawngarden, sporting, toys-and-games, pets, baby-products, automotive, tools, office-products, grocery, videogames. Other stores use their own codes (e.g. 'sports', 'toys', 'baby' on amazon.co.uk). Unknown codes fall back to All departments.", "default": "aps" } } }, "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 } } } } } } } } } }