{ "openapi": "3.0.1", "info": { "title": "Ubersuggest Scraper", "description": "Scrape Ubersuggest SEO data — keyword volume, CPC, difficulty, intent & global breakdown, SERP results, keyword suggestions, domain ranking keywords, backlinks (overview + full list), top pages, and organic traffic history. Bulk keywords & domains, any country. No account needed. JSON/CSV.", "version": "0.0", "x-build-id": "jn5NLWgcK2x18xvQI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~ubersuggest-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-ubersuggest-scraper", "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/memo23~ubersuggest-scraper/runs": { "post": { "operationId": "runs-sync-memo23-ubersuggest-scraper", "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/memo23~ubersuggest-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-ubersuggest-scraper", "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": "Keywords", "type": "array", "description": "Seed keywords — each returns search volume, CPC, competition, SEO & paid difficulty, search intent, and a 12-month volume trend.", "items": { "type": "string" } }, "domains": { "title": "Domains / URLs", "type": "array", "description": "Domains or URLs (e.g. `apify.com`) — each returns its organic ranking keywords, a backlinks/Domain-Authority overview, and top traffic pages.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code for keyword metrics, e.g. `US`, `GB`, `DE`.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Two-letter language code, e.g. `en`, `de`, `fr`.", "default": "en" }, "locId": { "title": "Ubersuggest location id", "type": "integer", "description": "Ubersuggest's internal location id (2840 = United States). Leave default unless you know the specific id you need.", "default": 2840 }, "includeSerp": { "title": "SERP results (per keyword)", "type": "boolean", "description": "For each keyword, also pull the live SERP breakdown — every ranking URL with its position, result type (organic / AI overview / people-also-ask / etc.), estimated monthly clicks, domain authority, and social shares. Adds one extra request per keyword.", "default": false }, "includeKeywordSuggestions": { "title": "Keyword suggestions (per keyword)", "type": "boolean", "description": "For each seed keyword, also pull related keyword suggestions — each with its own search volume, CPC, competition, SEO/paid difficulty, and search intent. Great for keyword expansion. Adds one or more requests per keyword.", "default": false }, "maxKeywordSuggestions": { "title": "Max keyword suggestions per keyword", "minimum": 1, "type": "integer", "description": "Cap on keyword-suggestion rows collected per seed keyword (when suggestions are enabled).", "default": 100 }, "includeDomainKeywords": { "title": "Ranking keywords", "type": "boolean", "description": "Pull the domain's organic ranking keywords (position, CPC, volume, difficulty, landing URL).", "default": true }, "includeBacklinks": { "title": "Backlinks overview", "type": "boolean", "description": "Pull the domain's Domain Authority, total backlinks, referring domains, and follow/nofollow counts.", "default": true }, "includeBacklinksList": { "title": "Backlinks list (individual)", "type": "boolean", "description": "Pull the domain's individual backlinks — each with its source page URL, target URL, anchor text, follow/nofollow, page & domain authority, spam score, and first-seen / last-visited dates.", "default": false }, "maxBacklinks": { "title": "Max backlinks per domain", "minimum": 1, "type": "integer", "description": "Cap on individual backlink rows collected per domain (when the backlinks list is enabled).", "default": 100 }, "includeTopPages": { "title": "Top pages", "type": "boolean", "description": "Pull the domain's highest-traffic pages (URL, title, estimated traffic, social shares).", "default": true }, "includeTrafficOverview": { "title": "Traffic overview (premium, on-demand)", "type": "boolean", "description": "Pull the domain's traffic overview — estimated organic traffic, organic/paid keyword counts, ranking buckets (top 1-3 / 4-10 / 11-50 / 51-100), and 12-month traffic history. Premium data billed as a separate event; off by default. Subject to a fair-use daily limit — if reached, the rest of your data still returns.", "default": false }, "maxDomainKeywords": { "title": "Max ranking keywords per domain", "minimum": 1, "type": "integer", "description": "Cap on ranking-keyword rows collected per domain.", "default": 100 }, "maxItems": { "title": "Maximum output rows", "minimum": 1, "type": "integer", "description": "Hard cap on the total number of rows across all keywords and domains.", "default": 10000 }, "maxConcurrency": { "title": "Parallel sessions", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many residential sessions run in parallel. Each session has a per-IP daily report budget, so the actor rotates exits automatically.", "default": 3 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Sticky residential proxies are required (the access token is bound to the exit IP). Defaults to Apify Residential, US.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }