{ "openapi": "3.0.1", "info": { "title": "Keyword Research & Backlink API - SE Ranking SEO Data", "description": "Keyword research and backlink API for SE Ranking: search volume, CPC, keyword difficulty, intent and trends, similar, related and question keywords, domain traffic, ranking keywords, competitors, backlinks, referring domains, anchors and InLink Rank. Bring your own key.", "version": "0.1", "x-build-id": "FiC73UtfqEUqvAM1B" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~keyword-research-backlinks-seo-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-keyword-research-backlinks-seo-api", "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/nabeelbaghoor~keyword-research-backlinks-seo-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-keyword-research-backlinks-seo-api", "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/nabeelbaghoor~keyword-research-backlinks-seo-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-keyword-research-backlinks-seo-api", "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": { "mode": { "title": "What to get", "enum": [ "keywordMetrics", "similarKeywords", "relatedKeywords", "questionKeywords", "longtailKeywords", "domainOverview", "domainWorldwide", "domainKeywords", "domainCompetitors", "backlinkSummary", "backlinks", "referringDomains", "anchors", "authority" ], "type": "string", "description": "Keyword modes read SE Ranking's keyword database for a regional database: metrics for your own keyword list (search volume, CPC, competition, keyword difficulty, intent, 12 month trend), or similar, related, question and long-tail keyword ideas for each seed keyword. Domain modes read a domain's organic and paid traffic overview in one country or worldwide, the keywords it ranks for, and its competitors. Backlink modes read a target's backlink summary, backlinks, referring domains, anchor texts and InLink Rank authority.", "default": "keywordMetrics" }, "keywords": { "title": "Keywords", "type": "array", "description": "Keyword modes only. One keyword per line. Keyword metrics reads every keyword in the list (up to the maximum results); the idea modes use each line as a seed keyword.", "items": { "type": "string" } }, "domains": { "title": "Domains", "type": "array", "description": "Domain modes only. Domains such as seranking.com, one per line. The overview and ranking keyword modes also take a full page URL such as https://seranking.com/api.html.", "items": { "type": "string" } }, "targets": { "title": "Backlink targets", "type": "array", "description": "Backlink modes only. A domain, a host such as blog.example.com, or a full page URL, one per line.", "items": { "type": "string" } }, "source": { "title": "Regional database", "enum": [ "us", "af", "al", "dz", "as", "ao", "ai", "ag", "ar", "am", "aw", "au", "at", "az", "bs", "bh", "bd", "bb", "by", "be", "bz", "bj", "bt", "bo", "ba", "bw", "br", "vg", "bn", "bg", "bf", "bi", "cv", "kh", "cm", "ca", "ky", "cf", "td", "cl", "cn", "co", "cd", "cg", "ck", "cr", "ci", "hr", "cu", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "gq", "ee", "et", "fo", "fj", "fi", "fr", "gf", "pf", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gd", "gp", "gu", "gt", "gg", "gn", "gy", "ht", "hn", "hk", "hu", "is", "in", "id", "iq", "ie", "im", "il", "it", "jm", "jp", "je", "jo", "kz", "ke", "ki", "kw", "kg", "la", "lv", "lb", "ls", "ly", "li", "lt", "lu", "mg", "mw", "my", "mv", "ml", "mt", "mq", "mr", "mu", "yt", "mx", "fm", "md", "mc", "mn", "me", "ms", "ma", "mz", "mm", "na", "nr", "np", "nl", "nc", "nz", "ni", "ne", "ng", "nu", "mk", "no", "om", "pk", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "re", "ro", "ru", "rw", "sh", "kn", "lc", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sk", "si", "sb", "so", "za", "kr", "es", "lk", "ps", "sr", "se", "ch", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tr", "tm", "vi", "ug", "ua", "ae", "uk", "uy", "uz", "vu", "ve", "vn", "ye", "zm", "zw" ], "type": "string", "description": "Keyword modes and the domain overview, ranking keyword and competitor modes. The country keyword database SE Ranking reads (search volume, CPC and rankings are per country).", "default": "us" }, "keywordSortBy": { "title": "Sort keywords by", "enum": [ "default", "keyword", "volume", "cpc", "difficulty", "competition" ], "type": "string", "description": "Keyword metrics and the similar, related and question modes. Provider default sorts keyword metrics by CPC.", "default": "default" }, "sortOrder": { "title": "Sort order", "enum": [ "desc", "asc" ], "type": "string", "description": "Keyword metrics, the similar, related and question modes, and domain ranking keywords.", "default": "desc" }, "includeHistoryTrend": { "title": "Include monthly search volume trend", "type": "boolean", "description": "Similar, related and question modes only. Adds the 12 month search volume history to each keyword. Keyword metrics always includes it.", "default": false }, "minVolume": { "title": "Minimum search volume", "minimum": 0, "type": "integer", "description": "Similar, related and question modes, and domain ranking keywords. Only keywords with at least this monthly search volume." }, "maxVolume": { "title": "Maximum search volume", "minimum": 0, "type": "integer", "description": "Similar, related and question modes, and domain ranking keywords. Only keywords with at most this monthly search volume." }, "minDifficulty": { "title": "Minimum keyword difficulty", "minimum": 0, "maximum": 100, "type": "integer", "description": "Similar, related and question modes, and domain ranking keywords. Keyword difficulty 0 to 100." }, "maxDifficulty": { "title": "Maximum keyword difficulty", "minimum": 0, "maximum": 100, "type": "integer", "description": "Similar, related and question modes, and domain ranking keywords. Keyword difficulty 0 to 100." }, "minCpc": { "title": "Minimum CPC", "minimum": 0, "type": "number", "description": "Similar, related and question modes, and domain ranking keywords. Cost per click, such as 0.5." }, "maxCpc": { "title": "Maximum CPC", "minimum": 0, "type": "number", "description": "Similar, related and question modes, and domain ranking keywords. Cost per click, such as 3." }, "minCompetition": { "title": "Minimum competition", "minimum": 0, "maximum": 1, "type": "number", "description": "Similar, related and question modes, and domain ranking keywords. Paid search competition from 0 to 1." }, "maxCompetition": { "title": "Maximum competition", "minimum": 0, "maximum": 1, "type": "number", "description": "Similar, related and question modes, and domain ranking keywords. Paid search competition from 0 to 1." }, "minWords": { "title": "Minimum words in keyword", "minimum": 1, "maximum": 50, "type": "integer", "description": "Similar, related and question modes, and domain ranking keywords. Long-tail filter, such as 3." }, "maxWords": { "title": "Maximum words in keyword", "minimum": 1, "maximum": 50, "type": "integer", "description": "Similar, related and question modes, and domain ranking keywords." }, "intents": { "title": "Search intent", "type": "array", "description": "Similar, related and question modes, and domain ranking keywords. Only keywords with any of these intents. Leave empty for all.", "items": { "type": "string", "enum": [ "I", "N", "T", "C", "L" ], "enumTitles": [ "Informational", "Navigational", "Transactional", "Commercial", "Local" ] } }, "serpFeatures": { "title": "SERP features", "type": "array", "description": "Similar, related and question modes, and domain ranking keywords. Only keywords whose search results show these features, such as AI overview (sge), featured snippets or people also ask.", "items": { "type": "string", "enum": [ "reviews", "sitelinks", "featured_snippets", "people_also_ask", "related_searches", "sge", "no", "see_results_about", "refine_by", "find_results_on", "research", "local_pack", "maps", "location", "popular_times", "places_sites_products", "gmb", "destination", "things_to_do", "hotel_pack", "video", "image_in_block", "images", "videos_block", "carousel_results", "top_stories", "twitter", "amp", "podcasts", "knowledge_graph", "knowledge_card", "faq", "datasets", "stocks_block", "math_solve_block", "shopping_results", "shopping_results_side", "shopping_results_top", "shopping_results_main_block", "marketplace", "buying_guide", "trip_cards", "flights", "jobs", "events", "appbar_events", "sports_app", "questions", "discussions_and_forums", "digital_complaints", "calculator", "currency_converter", "units_converter", "recipes", "tads", "bads", "sads", "mads" ], "enumTitles": [ "Reviews", "Sitelinks", "Featured Snippets", "People Also Ask", "Related Searches", "AI overview", "No", "See Results About", "Refine By", "Find Results On", "Research", "Local Pack", "Maps", "Location", "Popular Times", "Places Sites Products", "Gmb", "Destination", "Things To Do", "Hotel Pack", "Video", "Image In Block", "Images", "Videos Block", "Carousel Results", "Top Stories", "Twitter", "Amp", "Podcasts", "Knowledge Graph", "Knowledge Card", "FAQ", "Datasets", "Stocks Block", "Math Solve Block", "Shopping Results", "Shopping Results Side", "Shopping Results Top", "Shopping Results Main Block", "Marketplace", "Buying Guide", "Trip Cards", "Flights", "Jobs", "Events", "Appbar Events", "Sports App", "Questions", "Discussions And Forums", "Digital Complaints", "Calculator", "Currency Converter", "Units Converter", "Recipes", "Tads", "Bads", "Sads", "Mads" ] } }, "searchType": { "title": "Search type", "enum": [ "organic", "adv" ], "type": "string", "description": "Domain ranking keywords and competitors. Organic rankings or paid search ads.", "default": "organic" }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "Domain overview and ranking keyword modes. Counts every subdomain of the domain. Ignored for a page URL.", "default": true }, "rankingSortBy": { "title": "Sort ranking keywords by", "enum": [ "traffic", "volume", "position", "cpc", "competition", "kei", "difficulty", "traffic_percent", "price" ], "type": "string", "description": "Domain ranking keywords only.", "default": "traffic" }, "minPosition": { "title": "Best position", "minimum": 1, "maximum": 100, "type": "integer", "description": "Domain ranking keywords only. Only keywords ranking at this position or lower, such as 1." }, "maxPosition": { "title": "Worst position", "minimum": 1, "maximum": 100, "type": "integer", "description": "Domain ranking keywords only. Only keywords ranking at this position or better, such as 10 for page one." }, "positionChange": { "title": "Position change", "enum": [ "any", "up", "down", "new", "lost", "diff", "same" ], "type": "string", "description": "Domain ranking keywords only. Keywords by how their position moved since the previous month.", "default": "any" }, "currency": { "title": "Currency", "type": "string", "description": "Worldwide domain overview only. ISO 4217 code for the traffic value, such as USD, EUR or GBP.", "default": "USD" }, "worldwideFields": { "title": "Worldwide overview fields", "type": "array", "description": "Worldwide domain overview only. Which statistics to include.", "items": { "type": "string", "enum": [ "price", "traffic", "keywords", "positions_diff", "positions_tops" ], "enumTitles": [ "Traffic value", "Traffic", "Keyword count", "Position changes", "Top position buckets" ] }, "default": [ "price", "traffic", "keywords" ] }, "showCountries": { "title": "Break down by country", "type": "boolean", "description": "Worldwide domain overview only. Adds per-country statistics after the worldwide totals in the organic and adv arrays.", "default": false }, "backlinkScope": { "title": "Backlink scope", "enum": [ "host", "domain", "url" ], "type": "string", "description": "Backlink modes except authority. Host reads links to the host as written, domain adds every subdomain, URL reads one exact page.", "default": "host" }, "linkSortBy": { "title": "Sort backlinks and referring domains by", "enum": [ "default", "newest", "domain_inlink_rank", "inlink_rank" ], "type": "string", "description": "Backlinks and referring domains only.", "default": "default" }, "anchorSortBy": { "title": "Sort anchors by", "enum": [ "backlinks", "refdomains" ], "type": "string", "description": "Anchor texts only.", "default": "backlinks" }, "linkType": { "title": "Link type", "enum": [ "any", "dofollow", "nofollow" ], "type": "string", "description": "Backlinks only.", "default": "any" }, "perDomain": { "title": "Backlinks per referring domain", "minimum": 1, "maximum": 100, "type": "integer", "description": "Backlinks only. At most this many backlinks from each referring domain; 1 gives one link per domain." }, "minDomainInlinkRank": { "title": "Minimum domain InLink Rank", "minimum": 0, "maximum": 100, "type": "integer", "description": "Backlinks only. Only links from domains with at least this authority (0 to 100)." }, "maxDomainInlinkRank": { "title": "Maximum domain InLink Rank", "minimum": 0, "maximum": 100, "type": "integer", "description": "Backlinks only. Only links from domains with at most this authority (0 to 100)." }, "anchorContains": { "title": "Anchor text contains", "type": "string", "description": "Backlinks only. Only links whose anchor text contains this text." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The most rows this run returns and charges for. Each page asks SE Ranking only for the rows still wanted, which also caps the Data API credits spent.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 600, "type": "integer", "description": "Pacing. The Data API allows 10 requests a second per key (1 a second on a trial key) and answers 429 above it, which the actor waits out and retries.", "default": 60 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own SE Ranking Data API key, created on the API Dashboard in your SE Ranking account. Stored as a secret and sent only in the Authorization header; it is never logged. You can instead set the DATA_API_KEY environment secret." } } }, "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 } } } } } } } } } }