{ "openapi": "3.0.1", "info": { "title": "Meta Ad Library Scraper - Facebook & Instagram Ads", "description": "Scrape the Meta Ad Library: Facebook & Instagram ads by keyword, advertiser page or Ad Library URL. Ad copy, CTA, landing page, media, run dates, platforms, plus spend, impressions, demographics and regions for political ads. No login.", "version": "1.0", "x-build-id": "aqX4rysXV9epxqiAf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zkill3r~meta-ad-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zkill3r-meta-ad-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/zkill3r~meta-ad-library-scraper/runs": { "post": { "operationId": "runs-sync-zkill3r-meta-ad-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/zkill3r~meta-ad-library-scraper/run-sync": { "post": { "operationId": "run-sync-zkill3r-meta-ad-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 terms", "type": "array", "description": "Keywords to search in ad text, e.g. \"air fryer\". Each term is searched separately.", "items": { "type": "string" } }, "pageUrls": { "title": "Advertiser page URLs", "type": "array", "description": "Facebook page URLs of advertisers, e.g. https://www.facebook.com/nike. The Actor looks up each page's ID. If a page can't be resolved, use Page IDs instead.", "items": { "type": "string" } }, "pageIds": { "title": "Advertiser page IDs", "type": "array", "description": "Numeric Facebook page IDs. Most reliable way to get all ads of one advertiser. Find it in the Ad Library URL after view_all_page_id=.", "items": { "type": "string" } }, "startUrls": { "title": "Ad Library URLs", "type": "array", "description": "URLs copied from facebook.com/ads/library in your browser. All filters in the URL are kept; the filter fields below are ignored for these.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "country": { "title": "Country", "pattern": "^([A-Za-z]{2}|ALL|all)$", "type": "string", "description": "Two-letter ISO country code (e.g. MY, US, GB) or ALL.", "default": "ALL" }, "adType": { "title": "Ad category", "enum": [ "all", "political_and_issue_ads" ], "type": "string", "description": "Which ad category to search: all ads, or only political/issue ads (these include spend, impressions and audience breakdowns).", "default": "all" }, "activeStatus": { "title": "Status", "enum": [ "active", "inactive", "all" ], "type": "string", "description": "Show only active ads, only inactive ads, or all ads.", "default": "active" }, "platforms": { "title": "Platforms", "type": "array", "description": "Only show ads running on these platforms. Leave empty for all.", "items": { "type": "string", "enum": [ "facebook", "instagram", "messenger", "audience_network" ], "enumTitles": [ "Facebook", "Instagram", "Messenger", "Audience Network" ] } }, "mediaType": { "title": "Media type", "enum": [ "all", "image", "video", "meme", "none" ], "type": "string", "description": "Filter by creative type (images, videos, memes, or no media).", "default": "all" }, "startDate": { "title": "Delivered from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only ads delivered on or after this date (YYYY-MM-DD)." }, "endDate": { "title": "Delivered until", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only ads delivered on or before this date (YYYY-MM-DD)." }, "maxItems": { "title": "Max ads", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of ads to save across all inputs.", "default": 100 }, "includePoliticalDetails": { "title": "Political ad breakdowns", "type": "boolean", "description": "For political and issue ads, open each ad's details to collect demographic and region breakdowns. One extra page load per political ad.", "default": true }, "downloadMedia": { "title": "Download media", "type": "boolean", "description": "Save ad images and videos to the key-value store. Media URLs from Facebook expire, so turn this on if you need the files later. Uses more traffic and time.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "RESIDENTIAL proxies are strongly recommended. Facebook rate-limits datacenter IPs quickly.", "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 } } } } } } } } } }