{
  "openapi": "3.0.1",
  "info": {
    "title": "Backlink Checker — Backlinks, Domains & Anchors",
    "description": "Check backlinks, referring domains, anchor texts, top pages, link competitors, new & lost links and authority scores for any domain or URL.",
    "version": "1.0",
    "x-build-id": "ZbsUjd04bT9zrwX92"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/cheapapi~backlink-checker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-cheapapi-backlink-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/cheapapi~backlink-checker/runs": {
      "post": {
        "operationId": "runs-sync-cheapapi-backlink-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/cheapapi~backlink-checker/run-sync": {
      "post": {
        "operationId": "run-sync-cheapapi-backlink-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",
        "required": [
          "domains"
        ],
        "properties": {
          "domains": {
            "title": "Websites to analyze",
            "type": "array",
            "description": "Domains, subdomains or page URLs, one per line, e.g. <code>example.com</code>, <code>blog.example.com</code> or <code>https://example.com/pricing</code>. Domains are analyzed as a whole (without <code>www.</code>); page URLs are analyzed as a single page. For the link gap reports enter 2–20 domains; for bulk metrics up to 10,000 (sent in batches of 1,000).",
            "items": {
              "type": "string"
            }
          },
          "report": {
            "title": "What do you want?",
            "enum": [
              "overview",
              "backlinks",
              "referringDomains",
              "anchors",
              "topPages",
              "competitors",
              "newLost",
              "bulkMetrics",
              "growth",
              "referringNetworks",
              "linkGap",
              "pageLinkGap"
            ],
            "type": "string",
            "description": "<b>Overview</b>: authority score, backlink and referring-domain totals, spam score, link type / country / TLD breakdowns. <b>Lists</b>: individual backlinks, referring domains, anchors, top pages, competitors or networks. <b>Over time</b>: new & lost links or profile growth by day/week/month/year. <b>Bulk metrics</b>: one row per domain for up to 10,000 domains at a fraction of the cost. <b>Link gap</b>: sites that link to the other domains in your list but not (or also) to the first one.",
            "default": "overview"
          },
          "maxResults": {
            "title": "Max rows per domain",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "For list reports (backlinks, referring domains, anchors, pages, competitors, networks, link gap): how many rows to save per domain. You pay per saved row plus $0.035 per report (charged even if nothing is found). Rows are fetched in pages of 1,000; above 1,000, a follow-up page that brings fewer than 21 rows adds a $0.0303 extra-page fee, so 1,000 (or a multiple of 1,000 plus at least 21) is the most economical choice.",
            "default": 100
          },
          "linkStatus": {
            "title": "Link status",
            "enum": [
              "active",
              "lost",
              "all"
            ],
            "type": "string",
            "description": "Count only links that currently exist, only links that were removed, or both. Not used by competitors and history reports.",
            "default": "active"
          },
          "includeSubdomains": {
            "title": "Include subdomains",
            "type": "boolean",
            "description": "Also count links pointing to subdomains of the domain (e.g. <code>blog.example.com</code> for <code>example.com</code>).",
            "default": true
          },
          "includeIndirectLinks": {
            "title": "Include indirect links",
            "type": "boolean",
            "description": "Also count links that reach the site through a redirect or canonical tag.",
            "default": true
          },
          "excludeInternalLinks": {
            "title": "Exclude links from the site itself",
            "type": "boolean",
            "description": "Ignore links coming from the domain's own subdomains.",
            "default": true
          },
          "dofollowOnly": {
            "title": "Dofollow links only",
            "type": "boolean",
            "description": "Count only dofollow links.",
            "default": false
          },
          "excludeBrokenLinks": {
            "title": "Exclude broken links",
            "type": "boolean",
            "description": "Ignore links that point to pages that no longer work.",
            "default": false
          },
          "newLinksOnly": {
            "title": "New links only",
            "type": "boolean",
            "description": "Count only links found in the most recent crawl.",
            "default": false
          },
          "minSourceAuthority": {
            "title": "Min. authority of linking site",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "Only links from sites with at least this authority score (on the score scale chosen under \"Score scale\"; 0–100 by default). <b>Default: empty = no filter</b> (links from sites of any authority are included). Example: <code>30</code> keeps links from reasonably strong sites only."
          },
          "maxLinkSpamScore": {
            "title": "Max. link spam score",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Only links with a spam score at or below this value (0 = clean, 100 = very spammy). <b>Default: empty = no filter</b> (links of any spam score are included). Example: <code>30</code> removes the spammiest links."
          },
          "sourceCountries": {
            "title": "Linking site countries",
            "type": "array",
            "description": "Only links from sites in these countries (two-letter ISO codes, e.g. <code>US</code>, <code>DE</code>).",
            "items": {
              "type": "string"
            }
          },
          "anchorContains": {
            "title": "Anchor text contains",
            "type": "string",
            "description": "Only links whose anchor text contains this text."
          },
          "linkFilters": {
            "title": "Custom link filters (expert)",
            "type": "array",
            "description": "Extra conditions on individual links, using the output field names of the backlinks list. Example: <code>[[\"sourceDomainScore\", \">=\", 40], \"and\", [\"linkType\", \"=\", \"anchor\"]]</code>. Operators: =, &lt;&gt;, &lt;, &lt;=, &gt;, &gt;=, in, not_in, like, not_like, regex, not_regex. Max 8 conditions including the filters above."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "auto",
              "authorityScore",
              "backlinks",
              "referringDomains",
              "referringMainDomains",
              "referringPages",
              "linkSpamScore",
              "brokenBacklinks",
              "firstSeen",
              "lostDate",
              "lastSeen",
              "sourceDomainScore",
              "sourcePageScore",
              "sharedReferringDomains",
              "anchorText",
              "wordCount"
            ],
            "type": "string",
            "description": "How list rows are ordered. \"Automatic\" uses the most useful order per report (strongest links, most-linked pages, most shared domains…).",
            "default": "auto"
          },
          "sortDirection": {
            "title": "Sort direction",
            "enum": [
              "desc",
              "asc"
            ],
            "type": "string",
            "description": "Direction for \"Sort by\".",
            "default": "desc"
          },
          "customSort": {
            "title": "Custom sort (expert)",
            "type": "array",
            "description": "Up to 3 rules like <code>backlinks,desc</code> using output field names. Overrides the automatic order.",
            "items": {
              "type": "string"
            }
          },
          "resultFilters": {
            "title": "Custom result filters (expert)",
            "type": "array",
            "description": "Conditions on the rows of the report itself, using its output field names. Example for referring domains: <code>[[\"authorityScore\", \">\", 30], \"and\", [\"backlinks\", \">=\", 5]]</code>. For link gap reports prefix a field with the position of the domain in your list, e.g. <code>\"2.backlinks\"</code>. Max 8 conditions."
          },
          "startOffset": {
            "title": "Skip first rows",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Skip this many rows before saving (to continue a previous run).",
            "default": 0
          },
          "scoreScale": {
            "title": "Score scale",
            "enum": [
              "100",
              "1000"
            ],
            "type": "string",
            "description": "Scale of the authority scores in the output.",
            "default": "100"
          },
          "breakdownLimit": {
            "title": "Breakdown size",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "How many entries the breakdowns (top TLDs, countries, link types…) contain per row.",
            "default": 10
          },
          "groupLinks": {
            "title": "Backlinks: group links",
            "enum": [
              "none",
              "onePerDomain",
              "onePerAnchor",
              "custom"
            ],
            "type": "string",
            "description": "Backlinks list only. \"One link per linking domain\" is ideal for outreach lists.",
            "default": "none"
          },
          "customGroupField": {
            "title": "Backlinks: custom group field",
            "enum": [
              "sourceDomain",
              "anchorText",
              "sourceCountry",
              "sourceTld",
              "sourcePageLanguage",
              "sourcePageEncoding",
              "linkType",
              "sourcePageStatusCode",
              "linkPosition"
            ],
            "type": "string",
            "description": "Used when \"Group links\" is Custom.",
            "default": "sourceDomain"
          },
          "customGroupLimit": {
            "title": "Backlinks: links per group",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Used when \"Group links\" is Custom: max links kept per group.",
            "default": 1
          },
          "pagesDetail": {
            "title": "Top pages: detail level",
            "enum": [
              "full",
              "linkMetrics"
            ],
            "type": "string",
            "description": "Top pages report only.",
            "default": "full"
          },
          "mainDomainsOnly": {
            "title": "Competitors: main domains only",
            "type": "boolean",
            "description": "Group competitors by main domain instead of listing subdomains separately.",
            "default": true
          },
          "excludeLargeSites": {
            "title": "Competitors: exclude large sites",
            "type": "boolean",
            "description": "Leave out huge sites (search engines, social networks, marketplaces) that share links with everyone.",
            "default": true
          },
          "networkType": {
            "title": "Networks: group by",
            "enum": [
              "ip",
              "subnet"
            ],
            "type": "string",
            "description": "Referring IPs / subnets report only.",
            "default": "ip"
          },
          "gapMode": {
            "title": "Link gap: match",
            "enum": [
              "sharedByAll",
              "anyOverlap"
            ],
            "type": "string",
            "description": "Link gap reports only. Each row shows which of your domains the site links to and which it is missing from.",
            "default": "sharedByAll"
          },
          "excludeLinkingTo": {
            "title": "Link gap: exclude sites that link to",
            "type": "array",
            "description": "Up to 10 domains (e.g. your own). Sites linking to any of them are left out — perfect to find link opportunities you do not have yet.",
            "items": {
              "type": "string"
            }
          },
          "dateFrom": {
            "title": "History: from",
            "type": "string",
            "description": "Start date for the over-time reports (YYYY-MM-DD). Default: 12 months ago. Earliest: 2019-01-30."
          },
          "dateTo": {
            "title": "History: to",
            "type": "string",
            "description": "End date for the over-time reports. Default: today."
          },
          "groupInterval": {
            "title": "History: group by",
            "enum": [
              "day",
              "week",
              "month",
              "year"
            ],
            "type": "string",
            "description": "One row per period. You pay per row, so \"month\" is the most economical.",
            "default": "month"
          },
          "bulkMetrics": {
            "title": "Bulk: metrics",
            "type": "array",
            "description": "Bulk metrics report only. Each selected group adds one domain report fee per 1,000 domains; the per-domain price stays the same. \"Link profile\" already contains the three \"only\" metrics.",
            "items": {
              "type": "string",
              "enum": [
                "profile",
                "siteSpamScore",
                "newLostBacklinks",
                "newLostReferringDomains",
                "authority",
                "backlinkCount",
                "referringDomainCount"
              ],
              "enumTitles": [
                "Link profile (authority, backlinks, referring domains, link spam score, broken links)",
                "Site spam score",
                "New & lost backlinks",
                "New & lost referring domains",
                "Authority score only",
                "Backlink count only",
                "Referring domain count only"
              ]
            },
            "default": [
              "profile"
            ]
          },
          "newLostSince": {
            "title": "Bulk: new & lost since",
            "type": "string",
            "description": "Start date for the bulk new & lost counts (YYYY-MM-DD). Default: last month."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}