{ "openapi": "3.0.1", "info": { "title": "Facebook Ad Scraper", "description": "Analyze Facebook Ad Library campaigns to uncover advertisers, active ads, creatives, copy, landing pages, and targeting signals. Build structured competitor intelligence datasets for ad research, market analysis, creative benchmarking, and performance strategy.", "version": "1.0", "x-build-id": "SL54Ne0EJdf6ViVmg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~facebook-ad-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-facebook-ad-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-ad-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-facebook-ad-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-ad-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-facebook-ad-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": [ "adLibrarySources", "proxyConfig" ], "properties": { "adLibrarySources": { "title": "Ad Library sources", "type": "array", "description": "One or more Facebook Ad Library search URLs (keyword searches) or Facebook Page URLs to pull ads from.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "proxyConfig": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by the crawler." }, "maxAdsPerSource": { "title": "Max ads per source", "minimum": 0, "type": "integer", "description": "Maximum number of ads to collect per source URL. Set to 0 for unlimited.", "default": 10 }, "fetchAdDetails": { "title": "Fetch ad details", "type": "boolean", "description": "If enabled, fetches an extra per-ad details request (slower but adds fields such as advertiserDetails, transparencyByLocation and violationTypes when Meta exposes them).", "default": true }, "dateRange": { "title": "Date range", "enum": [ "", "LAST_90_DAYS", "LAST_30_DAYS", "LAST_7_DAYS", "LAST_3_DAYS", "TODAY" ], "type": "string", "description": "Date preset for ads (search sources only).", "default": "" }, "pageAdsActiveStatus": { "title": "Page ads: active status", "enum": [ "all", "active", "inactive" ], "type": "string", "description": "Filter by active status when scraping a Page URL directly.", "default": "all" }, "pageAdsCountryCode": { "title": "Page ads: country code", "type": "string", "description": "Country code filter when scraping a Page URL directly (e.g. US, IN, ALL).", "default": "ALL" }, "deduplicateAds": { "title": "Deduplicate ads", "type": "boolean", "description": "Skip ads whose adId (ad_archive_id) has already been collected in this run. Facebook's own pagination can return the same ad twice across overlapping pages; this suppresses exact repeats before they reach the dataset.", "default": true }, "creativeFormatFilter": { "title": "Creative format filter", "type": "array", "description": "Only keep ads whose computed creativeFormat is in this list. Leave empty to keep every format. Values are computed from the actual creative payload (carousel cards / images / videos), not just Meta's raw display_format code.", "items": { "type": "string", "enum": [ "CAROUSEL", "VIDEO", "SINGLE_IMAGE", "UNKNOWN" ] }, "default": [] }, "minAdvertiserLikes": { "title": "Minimum advertiser Page likes", "minimum": 0, "type": "integer", "description": "Skip ads whose advertiser Page like count is below this threshold. Useful for filtering out low-authority or throwaway pages when doing competitive research. Set to 0 to disable.", "default": 0 } } }, "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 } } } } } } } } } }