{ "openapi": "3.0.1", "info": { "title": "Facebook User Search Scraper: Related Profiles & Pages", "description": "🔍 Facebook User Search Scraper pulls public Facebook user search results—names, profile URLs, locations, and work/education snippets—for precise targeting. ⚡ Ideal for lead gen, recruiting, and market research. 📦 Fast, accurate, and export-ready (CSV/JSON).", "version": "0.1", "x-build-id": "XLGfdchMKnCdc45Ma" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/simpleapi~Facebook-User-Search-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-simpleapi-Facebook-User-Search-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/simpleapi~Facebook-User-Search-Scraper/runs": { "post": { "operationId": "runs-sync-simpleapi-Facebook-User-Search-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/simpleapi~Facebook-User-Search-Scraper/run-sync": { "post": { "operationId": "run-sync-simpleapi-Facebook-User-Search-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": { "searchNames": { "title": "🧑 Names or keywords to search", "type": "array", "description": "One or more names/keywords. Each is searched on Google (site:facebook.com dork) to discover matching Facebook profile URLs. Same field as the base actor's 'queries' (that key still works if you send it directly).", "items": { "type": "string" } }, "maxProfilesToScrape": { "title": "🔢 Max profiles to scrape per query", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of Facebook profiles to scrape in this run (1-50000). Same as the base actor's 'maxItems'." }, "directProfileUrls": { "title": "Profile URLs", "type": "array", "description": "Paste Facebook profile URLs here to scrape directly, in addition to search results. Same as the base actor's 'startUrls'.", "items": { "type": "string" } }, "includeRelatedProfiles": { "title": "🧑‍🤝‍🧑 Discover related profiles (relationship + family)", "type": "boolean", "description": "Extract related/linked profiles surfaced on the searched profile's own page: relationship status (spouse/partner) and named family members from the public About > Family and relationships section — each with a real Facebook profile link. This is Facebook's own on-page relationship data, not an algorithmic 'People You May Know' feed (confirmed absent from every logged-out profile payload tested).", "default": true }, "includePageAffiliations": { "title": "🏢 Discover Page affiliations (employer/school/city)", "type": "boolean", "description": "Extract Facebook Pages the profile is publicly linked to via its Intro card: employer Page, school Page, hometown Page, current-city Page. Facebook's native 'Pages Liked' and 'Groups Joined' profile tabs are not present on any logged-out profile (confirmed on 5 test profiles of different types) — see README for the honest coverage breakdown.", "default": true }, "maxRelatedProfilesPerItem": { "title": "🎚️ Max related profiles per row", "minimum": 0, "maximum": 100, "type": "integer", "description": "Cap how many relatedProfiles entries are kept per scraped profile. 0 = unlimited.", "default": 0 }, "onlyProfilesWithAffiliations": { "title": "🚫 Only keep profiles with related/affiliation data", "type": "boolean", "description": "When enabled, a profile row is dropped from the output if it has BOTH an empty relatedProfiles list AND an empty affiliatedPages list (e.g. most Page-type/business profiles).", "default": false }, "requestDelaySeconds": { "title": "⏱️ Delay between profile requests (seconds)", "minimum": 0, "maximum": 10, "type": "integer", "description": "Delay in seconds before each Facebook profile fetch (0-10). Same as the base actor's 'requestDelay'." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Google search uses a dedicated SERP proxy. For Facebook requests: no proxy by default; auto-escalates to datacenter then residential if a request looks blocked." } } }, "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 } } } } } } } } } }