{ "openapi": "3.0.1", "info": { "title": "Facebook User Search Scraper: Photos & AI Bio Analysis", "description": "πŸ”Ž Facebook User Search Scraper extracts public profile data from Facebook search resultsβ€”names, profile links, locations & keywordsβ€”at scale. πŸš€ Perfect for lead gen, recruiting, and research. βœ… Public data only, consent-first, and TOS/GDPR compliant.", "version": "0.1", "x-build-id": "P0OegAo0jgk9JleVq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~Facebook-User-Search-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-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/scraper-engine~Facebook-User-Search-Scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-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/scraper-engine~Facebook-User-Search-Scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-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": "πŸ“ Enter one or more names/keywords. Each is searched to discover matching public Facebook profiles. (Same as the base actor's `queries` field β€” either key works.)", "items": { "type": "string" } }, "maxProfiles": { "title": "πŸ“‡ Max profiles per search", "minimum": 1, "maximum": 50000, "type": "integer", "description": "🎚️ Maximum number of Facebook profiles to scrape in this run (1–5000)." }, "maxPhotos": { "title": "πŸ–ΌοΈ Max gallery photos per profile", "minimum": 0, "maximum": 200, "type": "integer", "description": "πŸ“Έ How many photos to collect per profile from the public /photos gallery (beyond the couple of thumbnails already on the About page). Set 0 to disable the gallery feature entirely. Default 40.", "default": 40 }, "extendedGallery": { "title": "πŸ” Extend gallery beyond the first grid page", "type": "boolean", "description": "βž• When ON, attempts to paginate past the initial /photos grid via Facebook's internal photo-collection API to reach maxPhotos. Best-effort β€” silently keeps only the first-grid photos when the pagination handshake isn't available for a given profile.", "default": true }, "profileLinks": { "title": "Profile URLs", "type": "array", "description": "βž• Paste Facebook profile URLs here to scrape in addition to search results. Leave empty to use only search results. (Same as the base actor's `startUrls` field β€” either key works.)", "items": { "type": "string" } }, "aiEnhancement": { "title": "πŸ€– Enable AI bio/quote analysis", "type": "boolean", "description": "🧠 When ON, analyzes each profile's bio and quotes text (from the public /about_details page) with the model below. Requires an API key for that provider.", "default": false }, "aiModel": { "title": "🧩 AI Model / Provider", "enum": [ "claude-haiku-4-5", "claude-sonnet-5", "claude-opus-4-8", "claude-fable-5", "gpt-4o-mini", "gpt-4o", "gpt-4.1-mini", "gpt-4.1", "o3-mini", "o1", "gemini-2.0-flash-lite", "gemini-2.0-flash", "gemini-1.5-pro", "gemini-2.5-flash", "gemini-2.5-pro", "grok-2-latest", "grok-3-mini", "grok-3", "grok-beta", "deepseek-chat", "deepseek-reasoner", "sonar", "sonar-pro", "sonar-reasoning", "mistral-small-latest", "mistral-large-latest" ], "type": "string", "description": "Provider auto-detected from the name: claude-*=Anthropic, gpt-*/o1/o3=OpenAI, gemini-*=Google, grok-*=xAI, deepseek-*=DeepSeek, sonar*=Perplexity, mistral-*=Mistral. Cheaper mini/flash/haiku/lite models are recommended for this kind of classification.", "default": "claude-haiku-4-5" }, "aiApiKey": { "title": "πŸ”‘ AI provider API key", "type": "string", "description": "πŸ”’ API key for the selected provider (falls back to ANTHROPIC_API_KEY / OPENAI_API_KEY / GEMINI_API_KEY / XAI_API_KEY / DEEPSEEK_API_KEY / PERPLEXITY_API_KEY / MISTRAL_API_KEY env vars if left blank). Only used when AI bio/quote analysis is ON." }, "proxySettings": { "title": "Proxy configuration", "type": "object", "description": "πŸ”’ Search uses a dedicated Google SERP proxy. For Facebook requests: no proxy by default; auto fallback to datacenter β†’ residential if blocked. (Same as the base actor's `proxyConfiguration` field.)" }, "requestDelaySec": { "title": "⏱️ Delay between Facebook requests (seconds)", "minimum": 0, "maximum": 10, "type": "integer", "description": "🐒 Pause between profile fetches to reduce blocking (0–10). Default 1." } } }, "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 } } } } } } } } } }