{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Library Scraper", "description": "Scrape the public Facebook Ad Library without logging in: ad copy, titles, images and videos, CTA buttons, landing page links, run dates, platforms and advertiser details, by keyword or advertiser page ID in any country.", "version": "1.0", "x-build-id": "OB420OrKmU1EuesaM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/logical_scrapers~facebook-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-logical_scrapers-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/logical_scrapers~facebook-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-logical_scrapers-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/logical_scrapers~facebook-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-logical_scrapers-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", "properties": { "searchTerms": { "title": "Search keywords", "type": "array", "description": "Keywords to search the Ad Library for. Each keyword is searched separately and returns up to the maximum number of ads below.", "items": { "type": "string" } }, "pageIds": { "title": "Advertiser page IDs", "type": "array", "description": "Numeric Facebook page IDs to pull every ad from one advertiser. Find a page ID in the Ad Library URL of an advertiser's ads (view_all_page_id=…).", "items": { "type": "string" } }, "startUrls": { "title": "Ad Library URLs", "type": "array", "description": "Facebook Ad Library search URLs, pasted straight from the browser — for example https://www.facebook.com/ads/library/?active_status=active&ad_type=all&country=GB&q=running%20shoes. Country and filters in the URL override the ones set below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code of the Ad Library region to search (for example US, GB, DE). The Ad Library returns ads shown in that country.", "default": "US" }, "adActiveStatus": { "title": "Ad status", "enum": [ "all", "active", "inactive" ], "type": "string", "description": "Whether to return ads that are currently running, ads that have stopped, or both.", "default": "all" }, "adType": { "title": "Ad category", "enum": [ "all", "political_and_issue_ads", "housing_ads", "employment_ads", "credit_ads" ], "type": "string", "description": "Restrict the search to one of the Ad Library's special categories. Political and issue ads are the only category that discloses impressions and spend ranges.", "default": "all" }, "mediaType": { "title": "Media type", "enum": [ "all", "image", "meme", "image_and_meme", "video", "none" ], "type": "string", "description": "Return only ads whose creative is of this type. \"No image or video\" returns text-only ads.", "default": "all" }, "publisherPlatforms": { "title": "Platforms", "type": "array", "description": "Return only ads that ran on at least one of the selected platforms. Leave empty for all platforms. Facebook decides which platforms it lists for an ad, so a few results can come back without the platform you picked.", "items": { "type": "string", "enum": [ "facebook", "instagram", "messenger", "audience_network", "whatsapp", "threads" ], "enumTitles": [ "Facebook", "Instagram", "Messenger", "Audience Network", "WhatsApp", "Threads" ] }, "default": [] }, "dateFrom": { "title": "Running on or after", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Keep only ads that were running on or after this date (YYYY-MM-DD). This is the Ad Library's own date filter: it matches ads whose run overlaps the window, so an older ad still running in the window is included." }, "dateTo": { "title": "Running on or before", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Keep only ads that were running on or before this date (YYYY-MM-DD). Combine with the field above for a window, or use either on its own." }, "maxItems": { "title": "Maximum ads per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of ads to scrape for each keyword, advertiser page ID or start URL — not for the run as a whole.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy configuration. Defaults to Apify residential proxies, which is what the Ad Library was measured working through; it refuses unrecognised clients until they pass a verification check.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }