{
  "openapi": "3.0.1",
  "info": {
    "title": "Backlink Checker - Referring Domains & Link Gap, Open Data",
    "description": "Referring domains of any website, strongest first, with authority score and Chrome traffic rank, plus a competitor link gap: sites linking to your competitors but not to you. Common Crawl web graph, no Ahrefs login. $1.50 per 1,000 referring domains.",
    "version": "0.1",
    "x-build-id": "CFRLhygafidkh7qax"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tidytools~backlink-gap/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tidytools-backlink-gap",
        "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/tidytools~backlink-gap/runs": {
      "post": {
        "operationId": "runs-sync-tidytools-backlink-gap",
        "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/tidytools~backlink-gap/run-sync": {
      "post": {
        "operationId": "run-sync-tidytools-backlink-gap",
        "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 do you want?",
            "enum": [
              "referringDomains",
              "linkGap"
            ],
            "type": "string",
            "description": "\"Referring domains\": the websites that link to each domain in your list, strongest first. \"Link gap\": websites that link to your competitors but not to you (link prospects), ranked by how many competitors they link to.",
            "default": "referringDomains"
          },
          "domains": {
            "title": "Domains (referring domains mode)",
            "type": "array",
            "description": "Domains or website addresses, one per line (example.com, https://www.example.com/page); spaces, commas and semicolons also separate entries. Subdomains are checked as their registrable domain (blog.example.co.uk -> example.co.uk). Up to 1,000 per run; duplicates are merged. Invalid lines become a result row with errorType \"invalid_input\" (not charged).",
            "items": {
              "type": "string"
            }
          },
          "yourDomain": {
            "title": "Your domain (link gap mode)",
            "type": "string",
            "description": "Your website. Prospects that already link to it are left out."
          },
          "monitorName": {
            "title": "Monitor name (optional, link gap mode)",
            "maxLength": 100,
            "type": "string",
            "description": "Reuse the same name and Your domain across runs to compare the sampled Common Crawl domain graph between data releases. SUMMARY reports newly observed and lost-from-sample referring domains only when both releases have complete lists. These are not verified backlink gains or losses. No extra paid rows."
          },
          "competitors": {
            "title": "Competitors (link gap mode)",
            "type": "array",
            "description": "1 to 10 competitor domains. A prospect is a website that links to at least one of them (see \"Linking to at least N competitors\") and not to you.",
            "items": {
              "type": "string"
            }
          },
          "minCompetitorsLinked": {
            "title": "Linking to at least N competitors (link gap mode)",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Only prospects that link to at least this many of your competitors. 2 or more finds sites that link to businesses like yours on purpose (directories, review sites, partner lists).",
            "default": 1
          },
          "minAuthority": {
            "title": "Minimum authority (0-100)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Leave out referring domains with a lower open-data authority score (same score as our Domain Authority Checker). 0 = keep all.",
            "default": 0
          },
          "onlyWithChromeTraffic": {
            "title": "Only websites with real visitors",
            "type": "boolean",
            "description": "Keep only referring domains that are in Chrome's top 1 million websites (Chrome UX Report): sites real people visit, not link farms or abandoned blogs.",
            "default": false
          },
          "excludeBigPlatforms": {
            "title": "Leave out big platforms",
            "type": "boolean",
            "description": "Leave out about 90 big platforms where links come from user pages, hosted sites, app listings or link shorteners rather than editorial choices (google.com, youtube.com, github.com, medium.com, blogspot.com, wordpress.com, amazonaws.com, linkedin.com, reddit.com...). Review sites and directories stay in. Default: on for the link gap, off for referring domains."
          },
          "excludeDomains": {
            "title": "Exclude domains",
            "type": "array",
            "description": "Referring domains to leave out, e.g. social networks or your own other sites.",
            "items": {
              "type": "string"
            }
          },
          "maxReferringDomainsPerDomain": {
            "title": "Max referring domains per domain",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Referring domains mode: at most this many rows per domain, strongest (best-connected) first. Up to 1,000.",
            "default": 100
          },
          "maxResults": {
            "title": "Max results per run",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many charged rows in total (referring domains or link prospects). Link gap default: 200."
          },
          "datasetId": {
            "title": "Dataset ID (optional, referring domains mode)",
            "type": "string",
            "description": "Also check the domains in another Actor run's dataset, e.g. the website field of a lead list."
          },
          "datasetField": {
            "title": "Dataset field",
            "type": "string",
            "description": "Field with the domain or URL, e.g. \"website\" or \"domain\" (dot paths work). Empty = the first URL field found."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}