{
  "openapi": "3.0.1",
  "info": {
    "title": "Linktree Scraper: Profiles, Emails and the Creator Directory",
    "description": "Scrape Linktree profiles: emails, phones, WhatsApp, every link, socials, products, country and plan. Or discover creators by category in Linktree's public directory of ~380,000 profiles, with free email, country and link-type filters. New and changed profile watch.",
    "version": "0.1",
    "x-build-id": "hBheC9q4bgb3kPkxF"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/alexmorain~linktree-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-alexmorain-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/alexmorain~linktree-scraper/runs": {
      "post": {
        "operationId": "runs-sync-alexmorain-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/alexmorain~linktree-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-alexmorain-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": {
          "profiles": {
            "title": "Linktree profiles",
            "type": "array",
            "description": "Profiles to scrape, one per line: <code>https://linktr.ee/selenagomez</code>, <code>linktr.ee/garyvee</code>, <code>@garyvee</code> or the bare username. A profile that does not exist, is suspended or cannot be reached comes back as a free row with <code>status</code> set to <code>not_found</code>, <code>blocked</code> or <code>unavailable</code>. Can be combined with the directory below.",
            "items": {
              "type": "string"
            }
          },
          "categories": {
            "title": "Directory categories",
            "type": "array",
            "description": "Find new creators in Linktree's public profile directory (about 380,000 profiles, 18 per page). <code>all</code> walks the whole directory. Use <b>Max profiles</b> and <b>Max directory pages</b> to size the run.",
            "items": {
              "type": "string",
              "enum": [
                "all",
                "business",
                "creative",
                "education",
                "entertainment",
                "fashion-beauty",
                "food-beverage",
                "government-politics",
                "health-wellness",
                "non-profit",
                "other",
                "tech",
                "travel-tourism"
              ],
              "enumTitles": [
                "All profiles",
                "Business",
                "Creative",
                "Education",
                "Entertainment",
                "Fashion and beauty",
                "Food and beverage",
                "Government and politics",
                "Health and wellness",
                "Non and profit",
                "Other",
                "Tech",
                "Travel and tourism"
              ]
            }
          },
          "subcategories": {
            "title": "Directory subcategories",
            "type": "array",
            "description": "Narrower directory lists, such as <code>real-estate</code>, <code>marketing-advertising</code>, <code>fitness</code> or <code>musicians</code>.",
            "items": {
              "type": "string",
              "enum": [
                "activism",
                "actor",
                "affiliate-marketing",
                "agency-consulting",
                "alcohol",
                "attractions",
                "automobiles",
                "bars-restaurants",
                "campus-organizations",
                "cannabis",
                "chef",
                "climate",
                "clothing-accessories",
                "coffee-tea",
                "comedy",
                "community-organization",
                "contests-giveaways",
                "cosplay",
                "countries-municipalities",
                "crafts",
                "crowdfunding",
                "dance-theatre",
                "designer",
                "desserts",
                "digital-creator",
                "disaster-relief",
                "diversity-inclusion",
                "e-learning",
                "edutech",
                "electronic-press-kit",
                "emergency-services",
                "fan-club",
                "film-tv",
                "financial-services",
                "fintech",
                "fragrances",
                "gaming-esports",
                "groceries",
                "hair-care",
                "hardware",
                "healthcare",
                "home-cooking",
                "home-improvement-maintenance",
                "hotels-lodging",
                "hr-recruiting",
                "influencer",
                "jewelry",
                "judiciary",
                "law-enforcement",
                "legal-services",
                "library",
                "life-coaching",
                "live-events",
                "makeup-skincare",
                "marketing-advertising",
                "memes",
                "military-veterans",
                "mobile-app",
                "model",
                "museums",
                "music",
                "nail-care",
                "not-listed",
                "nutrition",
                "performance-art",
                "personal",
                "pets",
                "policy",
                "politicians-campaigns",
                "portfolio",
                "public-figure",
                "public-relations",
                "public-services",
                "radio-podcasts",
                "real-estate",
                "recreation",
                "religion",
                "saas",
                "schools-universities",
                "shoes",
                "shopping-retail",
                "social-media",
                "spirituality",
                "sports",
                "startup",
                "talent-agency",
                "talent-management",
                "tattoos-piercings",
                "teacher",
                "transportation",
                "venture-capital",
                "visual-arts",
                "weddings",
                "wildlife",
                "writer"
              ],
              "enumTitles": [
                "Activism",
                "Actor",
                "Affiliate marketing",
                "Agency consulting",
                "Alcohol",
                "Attractions",
                "Automobiles",
                "Bars restaurants",
                "Campus organizations",
                "Cannabis",
                "Chef",
                "Climate",
                "Clothing accessories",
                "Coffee tea",
                "Comedy",
                "Community organization",
                "Contests giveaways",
                "Cosplay",
                "Countries municipalities",
                "Crafts",
                "Crowdfunding",
                "Dance theatre",
                "Designer",
                "Desserts",
                "Digital creator",
                "Disaster relief",
                "Diversity inclusion",
                "E learning",
                "Edutech",
                "Electronic press kit",
                "Emergency services",
                "Fan club",
                "Film tv",
                "Financial services",
                "Fintech",
                "Fragrances",
                "Gaming esports",
                "Groceries",
                "Hair care",
                "Hardware",
                "Healthcare",
                "Home cooking",
                "Home improvement maintenance",
                "Hotels lodging",
                "Hr recruiting",
                "Influencer",
                "Jewelry",
                "Judiciary",
                "Law enforcement",
                "Legal services",
                "Library",
                "Life coaching",
                "Live events",
                "Makeup skincare",
                "Marketing advertising",
                "Memes",
                "Military veterans",
                "Mobile app",
                "Model",
                "Museums",
                "Music",
                "Nail care",
                "Not listed",
                "Nutrition",
                "Performance art",
                "Personal",
                "Pets",
                "Policy",
                "Politicians campaigns",
                "Portfolio",
                "Public figure",
                "Public relations",
                "Public services",
                "Radio podcasts",
                "Real estate",
                "Recreation",
                "Religion",
                "Saas",
                "Schools universities",
                "Shoes",
                "Shopping retail",
                "Social media",
                "Spirituality",
                "Sports",
                "Startup",
                "Talent agency",
                "Talent management",
                "Tattoos piercings",
                "Teacher",
                "Transportation",
                "Venture capital",
                "Visual arts",
                "Weddings",
                "Wildlife",
                "Writer"
              ]
            }
          },
          "maxProfiles": {
            "title": "Max profiles",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many profiles delivered (and charged). Filtered-out profiles do not count. <code>0</code> = no limit.",
            "default": 100
          },
          "maxPagesPerDirectory": {
            "title": "Max directory pages",
            "minimum": 1,
            "maximum": 25000,
            "type": "integer",
            "description": "Directory pages read per category or subcategory, 18 profiles per page. The whole <code>all</code> directory is about 21,100 pages.",
            "default": 50
          },
          "startPage": {
            "title": "Start at directory page",
            "minimum": 1,
            "maximum": 25000,
            "type": "integer",
            "description": "Skip the first pages of each directory list, to split a big list across several runs.",
            "default": 1
          },
          "onlyWithEmail": {
            "title": "Only profiles with an email",
            "type": "boolean",
            "description": "Keep only profiles where an email address was found. About 1 profile in 5 in the directory has one.",
            "default": false
          },
          "onlyWithContact": {
            "title": "Only profiles with an email or a phone",
            "type": "boolean",
            "description": "Keep only profiles with an email, a phone number or a WhatsApp link.",
            "default": false
          },
          "countries": {
            "title": "Countries",
            "type": "array",
            "description": "Two-letter country codes such as <code>US</code>, <code>GB</code>, <code>FR</code>. Keeps profiles whose owner set one of these countries. About 4 profiles in 10 set no country and are left out by this filter.",
            "items": {
              "type": "string"
            }
          },
          "linkCategories": {
            "title": "Link types",
            "type": "array",
            "description": "Keep only profiles with at least one link of these types, to find creators who sell, take bookings or run a newsletter.",
            "items": {
              "type": "string",
              "enum": [
                "shop",
                "booking",
                "newsletter",
                "payment",
                "membership",
                "music",
                "podcast",
                "messaging",
                "form"
              ],
              "enumTitles": [
                "Shop (Shopify, Etsy, Amazon, Gumroad...)",
                "Booking (Calendly, Cal.com, Fresha...)",
                "Newsletter (Substack, beehiiv, Mailchimp...)",
                "Payment (PayPal, Venmo, Ko-fi...)",
                "Membership (Patreon, OnlyFans, Skool, Kajabi...)",
                "Music (Spotify, Apple Music, SoundCloud...)",
                "Podcast",
                "Messaging (WhatsApp, Telegram...)",
                "Form (Google Forms, Typeform, Tally...)"
              ]
            }
          },
          "monitorMode": {
            "title": "Monitoring",
            "enum": [
              "off",
              "new",
              "changed"
            ],
            "type": "string",
            "description": "For scheduled runs. <code>new</code> delivers only profiles never delivered by an earlier run with the same input. <code>changed</code> also delivers profiles whose links, emails, phones, socials, bio or products changed, with a <code>changes</code> field listing added and removed links and emails. Unchanged profiles are read but not charged.",
            "default": "off"
          },
          "registryKey": {
            "title": "Monitoring key",
            "type": "string",
            "description": "Optional name for the monitoring memory. By default it is derived from the input, so changing the input starts a fresh one. Set a key to keep it across input changes."
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "Called with a JSON summary (run id, dataset id, counts, status) when the run ends."
          },
          "maxConcurrency": {
            "title": "Parallel connections",
            "minimum": 1,
            "maximum": 32,
            "type": "integer",
            "description": "Each connection uses its own proxy IP and reads about one page per second. Without a proxy the actor uses one connection.",
            "default": 16
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify datacenter proxy by default. Linktree limits each IP to about one page per second.",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}