{ "openapi": "3.0.1", "info": { "title": "Ahrefs Scraper", "description": "Extract key SEO data from Ahrefs including keyword rankings, backlink profiles, organic traffic, competitor analysis & domain authority. Supports bulk domain analysis across 180+ countries. Download as CSV, JSON, Excel, XML & more formats.", "version": "0.0", "x-build-id": "NtFDCVPRf4oEvDNKV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/radeance~ahrefs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-radeance-ahrefs-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/radeance~ahrefs-scraper/runs": { "post": { "operationId": "runs-sync-radeance-ahrefs-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/radeance~ahrefs-scraper/run-sync": { "post": { "operationId": "run-sync-radeance-ahrefs-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": { "keyword": { "title": "Keyword or Brand", "type": "string", "description": "The keyword or brand to search for on Ahrefs." }, "url": { "title": "URL or Domain", "type": "string", "description": "The URL or Domain of the web page to search for on Ahrefs." }, "country": { "title": "Country", "enum": [ "af", "al", "dz", "as", "ad", "ao", "ai", "ag", "ar", "am", "au", "at", "az", "bs", "bh", "bd", "by", "be", "bz", "bj", "bt", "bo", "ba", "bw", "br", "bn", "bg", "bf", "bi", "kh", "cm", "ca", "cv", "cf", "td", "cl", "co", "cg", "cd", "ck", "cr", "ci", "hr", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "ee", "et", "fj", "fi", "fr", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gp", "gt", "gg", "gy", "ht", "hn", "hk", "hu", "is", "in", "id", "iq", "ie", "il", "it", "jm", "jp", "je", "jo", "kz", "ke", "ki", "kr", "kw", "kg", "la", "lv", "lb", "ls", "ly", "li", "lt", "lu", "mk", "mg", "mw", "my", "mv", "ml", "mt", "mu", "mx", "fm", "md", "mn", "me", "ms", "ma", "mz", "mm", "na", "nr", "np", "nl", "nz", "ni", "ne", "ng", "nu", "no", "om", "pk", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "ro", "ru", "rw", "sh", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sk", "si", "sb", "so", "za", "es", "lk", "sr", "se", "ch", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tr", "tm", "ug", "ua", "ae", "gb", "us", "uy", "uz", "vu", "ve", "vn", "vg", "vi", "zm", "zw" ], "type": "string", "description": "Select the country for the search on Ahrefs.", "default": "us" }, "mode": { "title": "Mode", "enum": [ "exact", "subdomains" ], "type": "string", "description": "Select the mode for the search on Ahrefs.", "default": "subdomains" }, "urls": { "title": "Multiple URLs or Domains (Bulk)", "type": "array", "description": "A list of URLs or Domains to search for on Ahrefs. You can specify multiple URLs by clicking on the Add button or in bulk by clicking on the Bulk edit button. Maximum Allowed URLs is 100 at a time for paying users and 3 for free users, others will be disregarded. ⚠️ Warning, by using this field the url parameter above will be ignored.", "items": { "type": "string" } }, "include_web_authority": { "title": "Include Domain Overview / Website Authority Search", "type": "boolean", "description": "Needs Domain / Website. If checked, the search will include domain overview / web authority data from Ahrefs.", "default": true }, "include_traffic": { "title": "Include Web-Traffic Search", "type": "boolean", "description": "Needs Domain / Website. If checked, the search will include web-traffic data from Ahrefs & from AhrefsTop.com if available.", "default": true }, "include_ai_overview": { "title": "Include AI Overview Search 🆕", "type": "boolean", "description": "Needs Domain / Website. If checked, the search will include AI overview data from Ahrefs.", "default": false }, "include_ai_mode": { "title": "Include AI Mode Search 🆕", "type": "boolean", "description": "Needs Domain / Website. If checked, the search will include AI mode data from Ahrefs.", "default": false }, "include_ai_visibility": { "title": "Include AI Visibility Search", "type": "boolean", "description": "Needs Brand or Keyword. If checked, the search will include AI visibility data from Ahrefs.", "default": false }, "include_keywords": { "title": "Include Keywords Search", "type": "boolean", "description": "Needs Keyword and Country. If checked, the search will include keywords data from Ahrefs.", "default": false }, "include_keywords_difficulty": { "title": "Include Keywords Difficulty Search", "type": "boolean", "description": "Needs Keyword and Country. If checked, the search will include keywords difficulty data from Ahrefs.", "default": false }, "include_keywords_ranking": { "title": "Include Keywords Ranking Search", "type": "boolean", "description": "Needs Keyword, Domain and Country. If checked, the search will include keywords ranking data from Ahrefs.", "default": false }, "include_serp": { "title": "Include SERP Search", "type": "boolean", "description": "Needs Keyword and Country. If checked, the search will include SERP data from Ahrefs.", "default": false }, "include_backlinks": { "title": "Include Backlinks Search", "type": "boolean", "description": "Needs Domain / Website. If checked, the search will include backlinks data from Ahrefs.", "default": true }, "include_broken_links": { "title": "Include Broken Links Search", "type": "boolean", "description": "Needs Domain / Website. If checked, the search will include broken links data from Ahrefs.", "default": false }, "include_competitors": { "title": "Include Competitors Search 🆕", "type": "boolean", "description": "Needs Domain / Website. If checked, the search will include competitors data from AhrefsTop.com if available.", "default": false }, "include_xml_sitemap": { "title": "Include XML Sitemap Search 🆕", "type": "boolean", "description": "Needs Domain / Website. If checked, the search will include XML sitemap data from Ahrefs. Limited to 1000 URLs per sitemap. If the sitemap has more than 1000 URLs, only the first 1000 will be returned.", "default": false }, "include_top_websites": { "title": "Include AhrefsTop Trending Websites Search", "type": "boolean", "description": "If checked, the search will include top trending websites data from AhrefsTop.com from the Top 1000 / 100 (when filtered) websites ranking.", "default": false }, "category_top_websites": { "title": "Category (Top Websites Search Only)", "enum": [ "all", "arts-and-entertainment", "autos-and-vehicles", "beauty-and-fitness", "books-and-literature", "business", "computers-and-electronics", "finance", "food-and-drink", "games", "health", "hobbies-and-leisure", "home-and-garden", "internet-and-telecom", "jobs-and-education", "law-and-government", "news", "people-and-society", "pets-and-animals", "real-estate", "reference", "science", "shopping", "social-networks", "sports", "travel-and-transportation" ], "type": "string", "description": "Select the category for the search on Ahrefs Top Websites Ranking.", "default": "all" }, "country_top_websites": { "title": "Country (Top Websites Search Only)", "enum": [ "worldwide", "af", "al", "dz", "as", "ad", "ao", "ai", "ag", "ar", "am", "au", "at", "az", "bs", "bh", "bd", "by", "be", "bz", "bj", "bt", "bo", "ba", "bw", "br", "bn", "bg", "bf", "bi", "kh", "cm", "ca", "cv", "cf", "td", "cl", "co", "cg", "cd", "ck", "cr", "ci", "hr", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "ee", "et", "fj", "fi", "fr", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gp", "gt", "gg", "gy", "ht", "hn", "hk", "hu", "is", "in", "id", "iq", "ie", "il", "it", "jm", "jp", "je", "jo", "kz", "ke", "ki", "kr", "kw", "kg", "la", "lv", "lb", "ls", "ly", "li", "lt", "lu", "mk", "mg", "mw", "my", "mv", "ml", "mt", "mu", "mx", "fm", "md", "mn", "me", "ms", "ma", "mz", "mm", "na", "nr", "np", "nl", "nz", "ni", "ne", "ng", "nu", "no", "om", "pk", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "ro", "ru", "rw", "sh", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sk", "si", "sb", "so", "za", "es", "lk", "sr", "se", "ch", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tr", "tm", "ug", "ua", "ae", "gb", "us", "uy", "uz", "vu", "ve", "vn", "vg", "vi", "zm", "zw" ], "type": "string", "description": "Select the country for the search on Ahrefs Top Websites Ranking.", "default": "worldwide" } } }, "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 } } } } } } } } } }