{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Library Scraper", "description": "Programmatic access to Meta Ad Library. Extract ad creative, spend ranges, impressions, demographic targeting, and active status for any advertiser or keyword. Official Graph API v21.0 + web fallback. AI analysis via 5 LLM providers. $0.005/ad PPE.", "version": "0.1", "x-build-id": "JyWXeo21HMiOxRNK1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/harvestlab~facebook-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-harvestlab-facebook-ads-library-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/harvestlab~facebook-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-harvestlab-facebook-ads-library-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/harvestlab~facebook-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-harvestlab-facebook-ads-library-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", "required": [ "searchQuery" ], "properties": { "searchQuery": { "title": "Search Query", "type": "string", "description": "Keyword, brand name, or topic to search in the Facebook Ad Library." }, "advertiserName": { "title": "Advertiser Page Name", "type": "string", "description": "Optional: filter results by a specific advertiser's Facebook page name." }, "country": { "title": "Country", "type": "string", "description": "ISO country code (e.g. US, GB, DE) or ALL to search globally.", "default": "ALL" }, "adType": { "title": "Ad Type", "enum": [ "ALL", "POLITICAL_AND_ISSUE_ADS" ], "type": "string", "description": "Filter by ad type category.", "default": "ALL" }, "activeStatus": { "title": "Active Status", "enum": [ "all", "active", "inactive" ], "type": "string", "description": "Filter by whether ads are currently active.", "default": "active" }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of ads to scrape.", "default": 50 }, "facebookAccessToken": { "title": "Facebook Access Token", "type": "string", "description": "Facebook Graph API access token for the official Ad Library API (recommended). Get yours at https://developers.facebook.com. Without this, the actor falls back to web scraping (requires residential proxy)." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxy strongly recommended for web scraping fallback." }, "enableAiAnalysis": { "title": "Enable AI Analysis", "type": "boolean", "description": "Use an LLM to analyze each ad for category, target audience inference, creative strategy, key messages, and competitive score (1-10). Adds $0.005/ad.", "default": false }, "llmProvider": { "title": "LLM Provider", "enum": [ "openrouter", "anthropic", "google", "openai", "ollama" ], "type": "string", "description": "AI provider to use for ad analysis.", "default": "openrouter" }, "llmModel": { "title": "LLM Model Override", "type": "string", "description": "Override the default model for your chosen provider. Leave blank to use the recommended default." }, "openrouterApiKey": { "title": "OpenRouter API Key", "type": "string", "description": "API key for OpenRouter. Get yours at https://openrouter.ai/keys" }, "anthropicApiKey": { "title": "Anthropic API Key", "type": "string", "description": "API key for Anthropic Claude. Get yours at https://console.anthropic.com/settings/keys" }, "googleApiKey": { "title": "Google AI API Key", "type": "string", "description": "API key for Google Gemini. Get yours at https://aistudio.google.com/app/apikey" }, "openaiApiKey": { "title": "OpenAI API Key", "type": "string", "description": "API key for OpenAI. Get yours at https://platform.openai.com/api-keys" }, "ollamaBaseUrl": { "title": "Ollama Base URL", "type": "string", "description": "Base URL for your local Ollama instance. Install at https://ollama.com/download", "default": "http://localhost:11434" }, "q": { "title": "Search Query (alias)", "type": "string", "description": "Alias for searchQuery." }, "maxItems": { "title": "Max Items (alias)", "type": "integer", "description": "Alias for maxResults." } } }, "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 } } } } } } } } } }