{
  "openapi": "3.0.1",
  "info": {
    "title": "Linktree Scraper - Creator Bio Links, Emails & Leads",
    "description": "Scrape any Linktree (linktr.ee) profile into clean data: name, bio, every link with previews, social handles, emails & phones for lead gen. Discover related creators, enrich contacts from their website, and monitor for new profiles. Export JSON, CSV, Excel.",
    "version": "0.1",
    "x-build-id": "sD8UCfOO4R8EAysOI"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~linktree-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-linktree-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/scrapesage~linktree-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-linktree-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/scrapesage~linktree-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-linktree-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": {
          "profileUrls": {
            "title": "Linktree profile URLs",
            "type": "array",
            "description": "Full Linktree profile URLs, e.g. `https://linktr.ee/garyvee`. The scraper reads the profile's embedded data (no login, no browser).",
            "items": {
              "type": "string"
            }
          },
          "usernames": {
            "title": "Usernames / @handles",
            "type": "array",
            "description": "Bare Linktree usernames or @handles (e.g. `mkbhd`, `@natgeo`). A social-media URL (e.g. an Instagram link) also works — its handle is tried against linktr.ee, since creators reuse the same handle across platforms.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs (any link)",
            "type": "array",
            "description": "Generic URL list — paste Linktree URLs or other profile links. Anything that resolves to a Linktree username is scraped.",
            "items": {
              "type": "string"
            }
          },
          "discoverRelatedProfiles": {
            "title": "Discover related creators (snowball)",
            "type": "boolean",
            "description": "Expand beyond your seed profiles: every Linktree page lists related/SEO-linked creators, so the scraper follows them to discover MORE creators like your seeds — great for building bulk lead lists. Bounded by `Max profiles` and `Discovery depth`.",
            "default": false
          },
          "discoveryDepth": {
            "title": "Discovery depth (hops)",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "How many hops to snowball out from the seed profiles when discovery is on. 1 = direct relations only; 2–3 expands much wider.",
            "default": 2
          },
          "maxProfiles": {
            "title": "Max profiles",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of Linktree profiles to fetch in one run (the work/cost budget). With discovery off, this caps the seed list; with discovery on, it caps total profiles scanned.",
            "default": 100
          },
          "enrichContactEmails": {
            "title": "Enrich contacts from website",
            "type": "boolean",
            "description": "For each profile that links to its own website, crawl the home + contact/about pages (capped) for extra emails, phone numbers and social links — the contact wedge a bio page doesn't always expose. Adds a few requests per profile.",
            "default": false
          },
          "maxEnrichPagesPerProfile": {
            "title": "Max website pages per profile",
            "minimum": 1,
            "maximum": 6,
            "type": "integer",
            "description": "When enriching, the most pages to crawl on each creator's website (home + contact/about).",
            "default": 3
          },
          "includeLinkPreviews": {
            "title": "Include link previews",
            "type": "boolean",
            "description": "Attach each link's rich preview (title, description, image) when Linktree provides it. Turn off for a leaner dataset.",
            "default": true
          },
          "hasEmailOnly": {
            "title": "Only profiles with an email",
            "type": "boolean",
            "description": "Keep only profiles that have at least one email address (after enrichment) — ideal for outreach-ready lead lists.",
            "default": false
          },
          "verifiedOnly": {
            "title": "Only verified profiles",
            "type": "boolean",
            "description": "Keep only Linktree-verified profiles.",
            "default": false
          },
          "countryFilter": {
            "title": "Country filter",
            "type": "string",
            "description": "Keep only profiles whose Linktree country matches this two-letter code (e.g. `US`, `GB`). Leave empty for all countries.",
            "default": ""
          },
          "minLinks": {
            "title": "Minimum links",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only profiles with at least this many links (filters out empty/placeholder pages).",
            "default": 0
          },
          "monitorMode": {
            "title": "Monitor mode — only new profiles",
            "type": "boolean",
            "description": "Remember which profiles were emitted in previous runs (in a named key-value store) and return ONLY profiles not seen before — ideal for watching a niche for new creators. Works with Apify Schedules: the schedule starts the run, monitor mode deduplicates against prior runs.",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor key",
            "type": "string",
            "description": "Names the monitor store so you can keep separate watch-lists. Lowercase letters, numbers and hyphens.",
            "default": "default"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Maximum number of profiles fetched in parallel.",
            "default": 8
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy settings. Linktree serves clean pages to Apify datacenter IPs, so the default Apify proxy is plenty. Switch to residential if you ever see blocks at scale.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}