Skip to main content
Ahrefs logo

​
Overview

Add Ahrefs to any ModuleX agent or workflow. SEO backlink analysis and referring domain data via the Ahrefs REST API (api.ahrefs.com/v3).
Categories: Marketing & Advertising · SEO · Marketing · Web Search & Scraping · Auth: API Key · Actions: 3

​
Authentication

​
API Key

Authenticate with an Ahrefs API v3 key (Account settings -> API keys; requires an eligible paid plan, key valid 1 year)
1

Step 1

Sign in to Ahrefs as a workspace owner or admin
2

Step 2

Go to Account settings -> API keys
3

Step 3

Create a new API key and copy it (each key is valid for 1 year)
4

Step 4

Paste the key into ModuleX

​
Required Credentials

FieldDescriptionRequiredFormat
Ahrefs API KeyAhrefs API v3 key, sent as Authorization: Bearer <key>Yes-

​
Available Actions

​
Parameters

​
target
string
required
Domain or URL to get backlinks for
​
select
array
required
List of columns to return (e.g. url_from, url_to, ahrefs_rank, anchor, page_title)
​
mode
string
Mode of operation: exact, domain, subdomains, or prefix (Default: domain)
​
limit
integer
Number of results to return (Default: 1000)

​
Response

{
  "$defs": {
    "BacklinkItem": {
      "additionalProperties": false,
      "description": "A single backlink record returned by the Ahrefs API.",
      "properties": {
        "url_from": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url From"
        },
        "url_to": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url To"
        },
        "ahrefs_rank": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Ahrefs Rank"
        },
        "anchor": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Anchor"
        },
        "page_title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Page Title"
        },
        "first_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "First Seen"
        },
        "last_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Last Seen"
        },
        "domain_rating": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Domain Rating"
        },
        "extra": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Additional fields returned by the API based on the select parameter",
          "title": "Extra"
        }
      },
      "title": "BacklinkItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "backlinks": {
      "items": {
        "$ref": "#/$defs/BacklinkItem"
      },
      "title": "Backlinks",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetBacklinksOutput",
  "type": "object"
}

​
Limits & Quotas

  • Rate limits depend on your Ahrefs subscription plan (Lite, Standard, Advanced, Enterprise).
  • API usage is metered against monthly “API rows” quota included in your plan.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

Google Search Console

Google Ad Manager

Google My Business