{ "openapi": "3.0.1", "info": { "title": "Ubersuggest Keyword Suggestions by Country & Language", "description": "Returns related keyword suggestions for a seed keyword or domain, scoped to a chosen country and language, from a public no-login suggestion feed.", "version": "1.1", "x-build-id": "nhx6wb2iZUAMRMRky" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~ubersuggest-keyword-suggestions-by-country/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-ubersuggest-keyword-suggestions-by-country", "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/dataspryva~ubersuggest-keyword-suggestions-by-country/runs": { "post": { "operationId": "runs-sync-dataspryva-ubersuggest-keyword-suggestions-by-country", "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/dataspryva~ubersuggest-keyword-suggestions-by-country/run-sync": { "post": { "operationId": "run-sync-dataspryva-ubersuggest-keyword-suggestions-by-country", "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": "Seed keywords", "type": "array", "description": "Keywords to expand. Each seed returns its own suggestions. Add several to research a topic.", "items": { "type": "string" } }, "urls": { "title": "Domains as seeds (legacy)", "type": "array", "description": "Optional domains or URLs converted into rough keyword seeds (make.com becomes make). This is not a domain keyword report; use the keywords field for real research.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Market for the suggestions. `worldwide` returns the global list. Russia and Belarus are not available from the source.", "default": "us" }, "language": { "title": "Language", "enum": [ "en", "af", "ak", "sq", "ach", "am", "ar", "hy", "az", "ban", "lt", "eu", "bn", "bs", "bg", "my", "ca", "ceb", "km", "zh", "zh_cn", "zh_tw", "hr", "cs", "da", "nl", "et", "ee", "fo", "fil", "fi", "fr", "fy", "gaa", "gl", "lg", "ka", "de", "el", "gu", "ht", "ha", "he", "iw", "hi", "hu", "is", "bem", "ig", "id", "ga", "it", "ja", "kn", "kk", "rw", "kg", "ko", "mfe", "crs", "kri", "ckb", "ky", "lo", "lv", "mk", "mg", "tum", "ms", "ml", "mt", "mi", "mr", "mn", "ne", "nso", "nb", "ny", "nyn", "om", "pa", "fa", "pcm", "pl", "pt", "ps", "qu", "ro", "rm", "rn", "ru", "sr", "sn", "loz", "sd", "si", "sk", "sl", "so", "st", "es", "sw", "sv", "tg", "ta", "te", "th", "ti", "tl", "to", "lua", "tn", "tr", "tk", "uk", "ur", "uz", "vi", "wo", "xh", "yo", "zu" ], "type": "string", "description": "Language of the suggestions. Leave English with auto-match on to use the market's main language automatically.", "default": "en" }, "autoMatchLanguageToCountry": { "title": "Auto-match language to country", "type": "boolean", "description": "When language is English and the chosen market has another main language, switch to it automatically (Germany to German, Japan to Japanese). Turn off to keep English.", "default": true }, "sortBy": { "title": "Sort suggestions by", "enum": [ "-searchVolume", "+searchVolume", "-cpc", "+cpc", "-sd", "+sd", "-pd", "+pd", "-keyword", "+keyword" ], "type": "string", "description": "Order of the suggestion list.", "default": "-searchVolume" }, "maxSuggestionsPerSeed": { "title": "Max suggestions per seed", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum suggestions returned for each seed. The default keeps runs fast; raise it for deep keyword lists.", "default": 100 }, "maxItems": { "title": "Max suggestions in total", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum suggestions across all seeds in one run.", "default": 1000 }, "includeSeedOverview": { "title": "Include seed metrics", "type": "boolean", "description": "Fetch each seed's own metrics: search volume, CPC, competition, difficulty, intent, 4-month trend, global volume and device shares. Adds one request per seed.", "default": true }, "outputFormat": { "title": "Output format", "enum": [ "perSeed", "perSuggestion" ], "type": "string", "description": "One record per seed with nested suggestions (legacy), or one flat record per suggestion.", "default": "perSeed" } } }, "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 } } } } } } } } } }