{ "openapi": "3.0.1", "info": { "title": "Ahrefs SEO Checker & API: Bulk DR, Backlinks & Traffic", "description": "All-in-one Ahrefs checker for lists of domains, URLs and keywords: DR, backlinks with the top 20 links, referring domains, organic traffic and value, top pages, keywords, competitors, keyword difficulty and volume. Tracks changes between runs. Works on the free Apify plan.", "version": "0.1", "x-build-id": "KuPvkb8IGzEYpQhN3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s_actors~ahrefs-seo-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s_actors-ahrefs-seo-checker", "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/s_actors~ahrefs-seo-checker/runs": { "post": { "operationId": "runs-sync-s_actors-ahrefs-seo-checker", "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/s_actors~ahrefs-seo-checker/run-sync": { "post": { "operationId": "run-sync-s_actors-ahrefs-seo-checker", "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": { "targets": { "title": "🌐 Domains or URLs", "type": "array", "description": "One domain or URL per line (competitor.com, https://example.com/blog/post). Domains get DR, backlinks, referring domains, traffic, keywords and competitors; a URL gets the numbers of that page. Duplicates are checked once. Up to 5,000 per run.", "items": { "type": "string" } }, "keywords": { "title": "🔑 Keywords", "type": "array", "description": "Optional: one keyword per line. Each gets the exact Keyword Difficulty (KD), search volume, referring domains needed for the top 10 and the Google SERP with DR and traffic of the top pages. Up to 1,000 per run.", "items": { "type": "string" } }, "includeBacklinks": { "title": "🔗 Backlinks: exact counts and top 20 backlinks", "type": "boolean", "description": "A live check on Ahrefs per domain or URL: today's backlinks, referring domains, dofollow share and the top 20 backlinks (linking page, its DR, anchor). One \"Live check\" charge each. Turn off for DR and traffic from the free index only (cheapest).", "default": true }, "includeTopPages": { "title": "📄 Top pages by organic traffic", "type": "boolean", "description": "One more live check per domain or URL: the top 5 pages by organic traffic (plus top countries and keywords for sites missing from the index). One \"Live check\" charge each.", "default": false }, "liveCheck": { "title": "⚡ Domains missing from the free index", "enum": [ "missing", "never" ], "type": "string", "description": "Popular sites come from the Ahrefs Top index: fast and cheap. Small and niche sites are not in it: they get DR and traffic from live checks of Ahrefs' own free tools (\"Live check\" charges).", "default": "missing" }, "mode": { "title": "🎯 What counts for a URL", "enum": [ "auto", "subdomains", "domain", "prefix", "exact" ], "type": "string", "description": "Ahrefs' target modes for the live checks (backlinks, top pages).", "default": "auto" }, "includeKeywordIdeas": { "title": "💡 Keyword ideas and questions", "type": "boolean", "description": "One more live check per keyword: 20 keyword ideas and 20 questions with volume range and difficulty label, plus the total number of ideas.", "default": false }, "country": { "title": "🌍 Keyword country", "enum": [ "al", "dz", "as", "ad", "ao", "ai", "ag", "ar", "am", "au", "at", "az", "bs", "bh", "bd", "be", "bz", "bj", "bt", "bo", "ba", "bw", "br", "bn", "bg", "bf", "bi", "kh", "cm", "ca", "cv", "cf", "td", "cl", "co", "cg", "ck", "cr", "ci", "hr", "cy", "cz", "cd", "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", "ie", "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", "mu", "mx", "fm", "md", "mn", "me", "ms", "ma", "mz", "na", "nr", "np", "nl", "nz", "ni", "ne", "ng", "nu", "mk", "no", "om", "pk", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "ro", "rw", "sh", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sk", "si", "sb", "za", "kr", "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", "vn", "vg", "vi", "zm", "zw" ], "type": "string", "description": "Search market of the keyword difficulty, volume and SERP (Google in that country).", "default": "us" }, "trackChanges": { "title": "🔔 Track changes between runs", "type": "boolean", "description": "Remember DR, backlinks, referring domains, traffic, the top backlinks and keyword KD, and add the change since the previous run with the same tracker name (plus new backlinks in the top 20). Schedule the Actor weekly to monitor your sites and competitors.", "default": false }, "onlyChanged": { "title": "Return only changed results", "type": "boolean", "description": "With tracking on: return (and pay for) only rows that changed since the previous run, plus new ones.", "default": false }, "monitorName": { "title": "Tracker name", "type": "string", "description": "Separate trackers for separate lists, e.g. \"my-sites\" and \"competitors\".", "default": "default" }, "includeHistory": { "title": "🗓️ Include monthly history", "type": "boolean", "description": "Monthly organic traffic, traffic value and referring domains for the last 12 months (6 months of traffic for live-checked sites).", "default": true }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Log every request retry.", "default": false } } }, "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 } } } } } } } } } }