{ "openapi": "3.0.1", "info": { "title": "Keyword Research Tool: Ideas + Amazon Reverse ASIN", "description": "Keyword research tool: turn one seed into hundreds of keyword ideas (Google suggestions, related searches, A-Z autocomplete, Amazon related) or get the Amazon keywords any ASIN ranks for. Search volume, CPC, difficulty and a USPTO trademark flag. For SEO, Amazon, Etsy and POD sellers.", "version": "1.0", "x-build-id": "zbigyT1fXhVyVeXik" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vncntlabs~keyword-ideas/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vncntlabs-keyword-ideas", "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/vncntlabs~keyword-ideas/runs": { "post": { "operationId": "runs-sync-vncntlabs-keyword-ideas", "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/vncntlabs~keyword-ideas/run-sync": { "post": { "operationId": "run-sync-vncntlabs-keyword-ideas", "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": [ "seeds" ], "properties": { "mode": { "title": "What to find", "enum": [ "google_suggestions", "google_related", "amazon_related", "reverse_asin", "autocomplete" ], "type": "string", "description": "Google suggestions: long-tail keywords that contain your seed. Google related: keywords Google shows as related searches (\"people also search\"), up to 4 levels deep. Amazon related: related searches from Amazon, for Merch/KDP. Reverse ASIN: the Amazon search keywords a product ranks for (enter ASINs or Amazon URLs). Google autocomplete: what Google suggests as you type the seed, optionally seed + a..z and question words.", "default": "google_suggestions" }, "seeds": { "title": "Seed keywords or ASINs", "type": "array", "description": "One seed keyword per item (up to 200). In Reverse ASIN mode, enter ASINs, ISBN-10s or Amazon product URLs. Invalid entries are reported as skipped and never charged.", "items": { "type": "string" } }, "maxResultsPerSeed": { "title": "Max ideas per seed", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Most keyword ideas returned for each seed (1-1000). You pay only for ideas you get.", "default": 100 }, "minSearchVolume": { "title": "Minimum monthly search volume", "minimum": 0, "type": "integer", "description": "Drop ideas below this volume. Default 1 removes zero-volume long-tail (most reverse-ASIN keywords have 0 or unknown volume). Set 0 to keep every keyword. Autocomplete defaults to 0." }, "sortBy": { "title": "Sort ideas by", "enum": [ "searchVolume", "relevance", "cpc", "keywordDifficulty", "alphabetical" ], "type": "string", "description": "Search volume (default) puts the biggest keywords first. Relevance keeps the provider's order: depth for related keywords, the product's Amazon rank for reverse ASIN, suggestion order for autocomplete (autocomplete default). CPC and difficulty are Google-only." }, "includeWords": { "title": "Must contain any of these words", "type": "array", "description": "Keep only ideas containing at least one of these whole words, e.g. shirt, tee, hoodie.", "items": { "type": "string" } }, "excludeWords": { "title": "Exclude ideas containing", "type": "array", "description": "Drop ideas containing any of these whole words, e.g. free, printable, svg, amazon.", "items": { "type": "string" } }, "location": { "title": "Country", "type": "string", "description": "Country name, 2-letter code or DataForSEO location code. Amazon modes support United States, Egypt, Saudi Arabia and UAE.", "default": "United States" }, "language": { "title": "Language", "type": "string", "description": "Language code, e.g. en, de. Leave empty for the market default." }, "depth": { "title": "Related-keyword depth", "minimum": 1, "maximum": 4, "type": "integer", "description": "Google/Amazon related modes only. 1 = direct related searches; each level adds the related searches of the previous level (much larger, less on-topic). Default 2 for Google and 3 for Amazon." }, "autocompleteExpansion": { "title": "Autocomplete expansion", "enum": [ "none", "alphabet", "questions", "alphabet_and_questions" ], "type": "string", "description": "Autocomplete mode only. Each lookup is one charged autocomplete-query event. None = 1 lookup per seed; A-Z = 27 lookups (seed, seed a ... seed z); questions = 11 (how/what/why/best... + seed); both = 37.", "default": "alphabet" }, "autocompleteSearchVolume": { "title": "Add search volume to autocomplete ideas", "type": "boolean", "description": "Autocomplete mode only. Look up Google search volume, CPC and difficulty for suggestions (no extra event). Turn off for suggestions only.", "default": true }, "trademarkCheck": { "title": "Trademark-risk flag (USPTO)", "type": "boolean", "description": "Screen every idea against live US federal trademarks in print-on-demand classes, using the same engine as our POD & KDP Trademark Checker. Adds high/medium/low risk, matched marks, owners and TSDR links. Automated screening, not legal advice.", "default": true }, "excludeTrademarkRisk": { "title": "Drop risky ideas", "enum": [ "none", "high", "medium_and_high" ], "type": "string", "description": "Remove ideas flagged by the trademark check before delivery (they are not charged).", "default": "none" }, "trademarkClasses": { "title": "Trademark classes (Nice / IC)", "type": "array", "description": "USPTO classes to screen. Empty = POD default (025, 021, 016, 009, 014, 018, 020, 024, 028).", "items": { "type": "string" } }, "ignoreSynonyms": { "title": "Ignore close variants", "type": "boolean", "description": "Google suggestions/related only: drop near-duplicate variants (plurals, word order) that share the same Google volume.", "default": false }, "trendMonths": { "title": "Trend window (months)", "minimum": 0, "maximum": 12, "type": "integer", "description": "Google modes: months used for the trend percentage (0 = off).", "default": 12 }, "maxTotalChargeUsd": { "title": "Max total charge (USD)", "type": "string", "description": "Optional spending limit for this run, on top of Apify's own limit. The run stops cleanly when reached; seeds not reached are listed and never charged." } } }, "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 } } } } } } } } } }