{ "openapi": "3.0.1", "info": { "title": "Meta/Facebook Ads Library Scraper", "description": "Scrape ads, creatives, advertisers, and landing pages from the Facebook (Meta) Ad Library by keyword or advertiser — fast, structured JSON.", "version": "0.1", "x-build-id": "20WFudX5qWPFsJZQ4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alwaysprimedev~facebook-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alwaysprimedev-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/alwaysprimedev~facebook-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-alwaysprimedev-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/alwaysprimedev~facebook-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-alwaysprimedev-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 terms (keywords)", "type": "array", "description": "Keywords or brand names to search the Facebook Ad Library for, e.g. \"coffee\" or \"Nike\". One search runs per term. Leave empty if you are using Advertiser page IDs or Start URLs instead.", "items": { "type": "string" } }, "pageIds": { "title": "Advertiser page IDs", "type": "array", "description": "Facebook Page IDs whose entire ad portfolio you want to pull (e.g. 101265672868155). This returns every ad a specific advertiser is running — ideal for competitor monitoring. Find the ID in the page's Ad Library URL (view_all_page_id=...).", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (paste from the Ad Library)", "type": "array", "description": "Paste full Facebook Ad Library search URLs straight from your browser. All filters in the URL (query, country, ad type, active status, media type, advertiser page) are honoured automatically.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Two-letter ISO country code to search ads in, e.g. US, GB, DE, IN, BR. The Ad Library is region-scoped, so this changes which ads are returned." }, "adType": { "title": "Ad category", "enum": [ "ALL", "POLITICAL_AND_ISSUE_ADS", "HOUSING_ADS", "EMPLOYMENT_ADS", "CREDIT_ADS", "FINANCIAL_PRODUCTS_AND_SERVICES_ADS" ], "type": "string", "description": "Which ad category to return. \"All ads\" covers regular commercial ads; the other options are the special transparency categories Facebook tracks separately.", "default": "ALL" }, "activeStatus": { "title": "Active status", "enum": [ "active", "inactive", "all" ], "type": "string", "description": "Whether to return ads that are currently running, ads that have stopped, or both.", "default": "active" }, "mediaType": { "title": "Media type", "enum": [ "all", "image", "meme", "video", "none" ], "type": "string", "description": "Restrict results to a creative format. \"All media\" returns everything.", "default": "all" }, "searchType": { "title": "Keyword match", "enum": [ "keyword_unordered", "keyword_exact_phrase" ], "type": "string", "description": "How to match the search terms. \"Match any words\" is broad; \"Exact phrase\" only returns ads containing the exact phrase.", "default": "keyword_unordered" }, "since": { "title": "Only ads started on/after (optional)", "type": "string", "description": "Optional ISO 8601 date (e.g. 2025-01-01) — only ads whose start date is on or after this are kept. Leave empty to fetch all ads regardless of start date. Use this for fast daily refresh runs." }, "maxItems": { "title": "Max ads", "minimum": 0, "type": "integer", "description": "Maximum number of ads to save across the whole run. Set to 0 for unlimited (use with care — large advertisers can have thousands of ads)." }, "maxAdsPerSearch": { "title": "Max ads per search term / advertiser", "minimum": 0, "type": "integer", "description": "Maximum ads to save for each individual search term or advertiser page. 0 means no per-search limit (only the overall Max ads applies). Useful to spread a budget evenly across many advertisers." }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many search terms / advertisers to crawl in parallel. The default is fine for almost everyone; raise it only for very large multi-advertiser runs." } } }, "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 } } } } } } } } } }