{ "openapi": "3.0.1", "info": { "title": "Ubersuggest Scraper", "description": "Scrape Ubersuggest SEO data from domains, URLs, and keywords. Export domain overviews, top pages, backlinks, and keyword suggestions without Ubersuggest cookies.", "version": "0.0", "x-build-id": "l5lnjcRfZFeBOgAiL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~ubersuggest-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-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/maximedupre~ubersuggest-scraper/runs": { "post": { "operationId": "runs-sync-maximedupre-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/maximedupre~ubersuggest-scraper/run-sync": { "post": { "operationId": "run-sync-maximedupre-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": { "domainsOrUrls": { "title": "Domains or URLs", "type": "array", "description": "Enter one domain or URL per line, such as example.com or https://apify.com. Each target can return overview, top page, backlink summary, and backlink items.", "items": { "type": "string", "minLength": 1 } }, "keywords": { "title": "Keyword seeds", "type": "array", "description": "Enter seed keywords for Ubersuggest keyword suggestions with volume, CPC, competition, SEO difficulty, paid difficulty, and intent.", "items": { "type": "string", "minLength": 1 } }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code for Ubersuggest locale data, such as us, ca, gb, de, fr, or au.", "default": "us" }, "language": { "title": "Language", "type": "string", "description": "Two-letter language code for Ubersuggest locale data, such as en, fr, de, es, or it.", "default": "en" }, "includeOverview": { "title": "Include domain overview?", "type": "boolean", "description": "Save one overview item per domain with authority, backlinks, organic and paid traffic, keyword ranking buckets, history, and country traffic.", "default": true }, "includeTopPages": { "title": "Include top pages?", "type": "boolean", "description": "Save ranked top-page items for each domain, including page URL, title, traffic, backlinks, referring domains, and social shares.", "default": true }, "includeBacklinksOverview": { "title": "Include backlink overview?", "type": "boolean", "description": "Save one backlink summary item per domain with authority, referring domains, backlink counts, and follow/nofollow counts.", "default": true }, "includeBacklinks": { "title": "Include backlinks?", "type": "boolean", "description": "Save individual backlink items for each domain. Enable this only when you need source URLs, anchors, authority metrics, and nofollow status.", "default": true }, "includeKeywordSuggestions": { "title": "Include keyword suggestions?", "type": "boolean", "description": "Save keyword suggestion items for submitted seeds, including volume, CPC, competition, SEO difficulty, paid difficulty, and intent.", "default": false }, "maxTopPages": { "title": "Top pages per domain", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum top-page items to save for each domain.", "default": 10 }, "maxBacklinks": { "title": "Backlinks per domain", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum individual backlink items to save for each domain when backlinks are enabled.", "default": 25 }, "maxKeywordSuggestions": { "title": "Suggestions per keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum keyword suggestion items to save for each keyword seed.", "default": 25 } } }, "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 } } } } } } } } } }