{ "openapi": "3.0.1", "info": { "title": "Linktree Profile & Contact Scraper - Emails, Phones, Socials", "description": "Linktree scraper for lead generation and creator discovery. Extract emails, phone numbers, Instagram handles, social links, outbound buttons, profile metadata, account tier/country/active signals, commerce and affiliate signals, and related profiles from public Linktree URLs or usernames.", "version": "1.0", "x-build-id": "NYdwDoSsaznTzoXa5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/elliotpadfield~linktree-profile-contact-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-elliotpadfield-linktree-profile-contact-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/elliotpadfield~linktree-profile-contact-scraper/runs": { "post": { "operationId": "runs-sync-elliotpadfield-linktree-profile-contact-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/elliotpadfield~linktree-profile-contact-scraper/run-sync": { "post": { "operationId": "run-sync-elliotpadfield-linktree-profile-contact-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": "Profiles", "uniqueItems": true, "type": "array", "description": "Linktree slugs, handles, or full profile URLs. Examples: garyvee, @garyvee, https://linktr.ee/garyvee.", "items": { "type": "string" }, "default": [ "garyvee" ] }, "urls": { "title": "Profile URLs", "uniqueItems": true, "type": "array", "description": "Alias for Profiles. Useful for API clients that send a generic urls field.", "items": { "type": "string" } }, "profileUrls": { "title": "Profile URL Alias", "uniqueItems": true, "type": "array", "description": "Alias for Profiles. Paste one or more Linktree profile URLs.", "items": { "type": "string" } }, "usernames": { "title": "Usernames", "uniqueItems": true, "type": "array", "description": "Alias for Profiles. Paste bare Linktree usernames or handles.", "items": { "type": "string" } }, "handles": { "title": "Handles", "uniqueItems": true, "type": "array", "description": "Alias for Profiles. Accepts handles with or without @.", "items": { "type": "string" } }, "bulkText": { "title": "Bulk Text With Linktree URLs", "type": "string", "description": "Paste raw text, CSV snippets, HTML, emails, or notes. The Actor extracts every linktr.ee/profile URL it can find." }, "sourceUrls": { "title": "Source Pages Containing Linktree URLs", "uniqueItems": true, "type": "array", "description": "Fetch these pages and extract Linktree profile URLs from the HTML. Useful for public directories, blog posts, exported landing pages, and saved lists.", "items": { "type": "string" } }, "sitemapUrls": { "title": "Sitemap URLs", "uniqueItems": true, "type": "array", "description": "Alias for Source Pages. Paste XML sitemap URLs or any public URL that contains Linktree links.", "items": { "type": "string" } }, "enableCrawling": { "title": "Enable Related Profile Crawling", "type": "boolean", "description": "Expand from seed profiles using Linktree's related/trusted profile graph. Seeds are processed first and maxProfiles remains the hard cap.", "default": false }, "crawlDepth": { "title": "Crawl Depth", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum related-profile hops from your seed profiles. 1 means scrape seeds plus directly related profiles.", "default": 1 }, "searchKeywords": { "title": "Keyword Discovery", "uniqueItems": true, "type": "array", "description": "Discover Linktree profiles via search using site:linktr.ee plus these keywords. Best for niche prospecting; direct profile inputs are more deterministic.", "items": { "type": "string" } }, "queries": { "title": "Keyword Query Alias", "uniqueItems": true, "type": "array", "description": "Alias for Keyword Discovery. Useful when calling the Actor from generic search workflows.", "items": { "type": "string" } }, "location": { "title": "Location For Discovery", "type": "string", "description": "Optional location appended to keyword discovery searches, such as London, New York, Austin, or Berlin." }, "maxProfiles": { "title": "Maximum Profiles", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Maximum unique profiles to scrape after discovery and before output filters.", "default": 100 }, "requireInstagram": { "title": "Only Profiles With Instagram", "type": "boolean", "description": "Save only profiles that link a real Instagram account.", "default": false }, "requireEmail": { "title": "Only Profiles With Email", "type": "boolean", "description": "Save only profiles that expose at least one email address.", "default": false }, "requirePhone": { "title": "Only Profiles With Phone", "type": "boolean", "description": "Save only profiles where a phone number or tel: link is detected.", "default": false }, "requiredPlatforms": { "title": "Required Platforms", "uniqueItems": true, "type": "array", "description": "Save only profiles that link all selected platforms.", "items": { "type": "string", "enum": [ "INSTAGRAM", "TIKTOK", "YOUTUBE", "X", "FACEBOOK", "LINKEDIN", "SPOTIFY", "THREADS", "TWITCH", "SNAPCHAT", "WHATSAPP", "PINTEREST", "DISCORD", "PATREON", "SHOPIFY" ] } }, "excludedPlatforms": { "title": "Excluded Platforms", "uniqueItems": true, "type": "array", "description": "Drop profiles that link any selected platform.", "items": { "type": "string", "enum": [ "INSTAGRAM", "TIKTOK", "YOUTUBE", "X", "FACEBOOK", "LINKEDIN", "SPOTIFY", "THREADS", "TWITCH", "SNAPCHAT", "WHATSAPP", "PINTEREST", "DISCORD", "PATREON", "SHOPIFY" ] } }, "verifiedOnly": { "title": "Verified Profiles Only", "type": "boolean", "description": "Save only Linktree profiles marked as verified.", "default": false }, "activeOnly": { "title": "Active Profiles Only", "type": "boolean", "description": "Drop profiles where Linktree marks the account as inactive.", "default": false }, "countryCodes": { "title": "Country Codes", "uniqueItems": true, "type": "array", "description": "Save only profiles with one of these Linktree account country codes, such as US, GB, CA, AU, DE, FR.", "items": { "type": "string" } }, "tiers": { "title": "Account Tiers", "uniqueItems": true, "type": "array", "description": "Save only profiles on these Linktree account tiers when exposed in the profile payload, such as free, paid, pro, premium.", "items": { "type": "string" } }, "excludeSensitive": { "title": "Exclude Sensitive Profiles", "type": "boolean", "description": "Drop profiles flagged by Linktree as sensitive content.", "default": false }, "excludePasswordLocked": { "title": "Exclude Password Locked Profiles", "type": "boolean", "description": "Drop profiles that expose a page password lock signal.", "default": false }, "requireCommerce": { "title": "Only Profiles With Commerce", "type": "boolean", "description": "Save only profiles with Linktree commerce/storefront items.", "default": false }, "requireAffiliateContent": { "title": "Only Profiles With Affiliate Content", "type": "boolean", "description": "Save only profiles where Linktree exposes affiliate-content signals.", "default": false }, "minLinks": { "title": "Minimum Outbound Links", "minimum": 0, "type": "integer", "description": "Save only profiles with at least this many outbound links.", "default": 0 }, "maxLinks": { "title": "Maximum Outbound Links", "minimum": 0, "type": "integer", "description": "Optional upper bound for outbound link count. Useful for avoiding directory-style or spammy profiles." }, "emailDomains": { "title": "Email Domain Allowlist", "uniqueItems": true, "type": "array", "description": "If set, keep only emails ending in these domains and apply email filters after that allowlist. Examples: gmail.com, outlook.com, agency.com.", "items": { "type": "string" } }, "linkDomains": { "title": "Required Link Domains", "uniqueItems": true, "type": "array", "description": "Save only profiles linking at least one of these domains. Examples: instagram.com, tiktok.com, shopify.com, calendly.com, patreon.com.", "items": { "type": "string" } }, "excludeLinkDomains": { "title": "Excluded Link Domains", "uniqueItems": true, "type": "array", "description": "Drop profiles linking any of these domains.", "items": { "type": "string" } }, "linkTypes": { "title": "Required Link Types", "uniqueItems": true, "type": "array", "description": "Save only profiles that contain at least one of these Linktree button/link types, such as CLASSIC, COMMERCE, MUSIC, VIDEO.", "items": { "type": "string" } }, "includeKeywords": { "title": "Required Keywords", "uniqueItems": true, "type": "array", "description": "Save profiles where at least one keyword appears in the title, bio, social URLs, emails, or link titles/URLs.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Excluded Keywords", "uniqueItems": true, "type": "array", "description": "Drop profiles where any keyword appears in the title, bio, social URLs, emails, or link titles/URLs.", "items": { "type": "string" } }, "includeLinks": { "title": "Include Outbound Links", "type": "boolean", "description": "Include the links array and linkDomains in saved dataset rows.", "default": true }, "includeSocials": { "title": "Include Social Links", "type": "boolean", "description": "Include instagram and socials fields in saved dataset rows.", "default": true }, "includeEmails": { "title": "Include Emails", "type": "boolean", "description": "Include emails in saved dataset rows. Email filters still work when this is disabled.", "default": true }, "includePhones": { "title": "Include Phones", "type": "boolean", "description": "Include detected phone numbers in saved dataset rows. Phone filters still work when this is disabled.", "default": true }, "includeRelatedProfiles": { "title": "Include Related Profiles", "type": "boolean", "description": "Include Linktree related/trusted profile suggestions in saved dataset rows.", "default": true }, "maxLinksPerProfile": { "title": "Maximum Links Per Profile", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum outbound links to store per profile. linkCount still reports the full parsed count.", "default": 250 }, "maxConcurrency": { "title": "Maximum Concurrency", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of Linktree profiles to fetch in parallel. The Actor always uses Apify Residential Proxy for profile, source-page, and discovery requests.", "default": 30 }, "requestDelayMs": { "title": "Per-Profile Delay", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Optional delay in milliseconds after each profile request. Keep at 0 for speed; increase for cautious runs.", "default": 0 }, "maxRetries": { "title": "Maximum Retries", "minimum": 0, "maximum": 8, "type": "integer", "description": "Retries for transient HTTP, timeout, or proxy failures.", "default": 3 } } }, "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 } } } } } } } } } }