{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Library Scraper", "description": "Extract ad data with the Facebook Ads Library Scraper. Retrieve active and inactive ads, creatives, targeting info, impressions, and engagement metrics. Perfect for competitor analysis, market research, and ad strategy insights. Fast, reliable, and scalable for bulk ad data extraction.", "version": "0.1", "x-build-id": "HLLrlstZ9A1YjLOLc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~facebook-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-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/scrapier~facebook-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-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/scrapier~facebook-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-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": { "startUrls": { "title": "๐Ÿ“Œ Pages or Ad Library links", "type": "array", "description": "๐Ÿ“‹ One entry per line. You can paste plain URLs, or use objects with a `url` field (optional `label`, `limit`, or `period` per item).", "items": { "type": "string" } }, "resultsLimit": { "title": "๐Ÿ”ข Maximum ads", "minimum": 1, "maximum": 50000, "type": "integer", "description": "๐Ÿ“ˆ Upper bound on ads returned **across all sources** in this run. โฑ๏ธ Lower = faster and lighter; ๐Ÿ“š higher = broader coverage.", "default": 10 }, "onlyTotal": { "title": "๐Ÿ”ข Only return total counts", "type": "boolean", "description": "๐Ÿ“‰ Instead of one row per ad, output **one summary row per source** with a total countโ€”handy for quick audits.", "default": false }, "includeAboutPage": { "title": "โ„น๏ธ Include page โ€œaboutโ€ snippets", "type": "boolean", "description": "๐Ÿ“„ For **Facebook page** sources, attach lightweight public title/description text when available.", "default": false }, "isDetailsPerAd": { "title": "โœจ Enrich each ad with extra fields", "type": "boolean", "description": "๐Ÿ” Runs an additional lookup per ad for richer metadata (more complete rows; โณ slower runs). Turn off for a lighter listing-only export.", "default": true }, "countryCode": { "title": "๐ŸŒ Default country", "enum": [ "ALL", "AR", "AU", "AT", "BD", "BE", "BR", "CA", "CL", "CN", "CO", "CR", "CZ", "DK", "EC", "EG", "FI", "FR", "DE", "GR", "GT", "HK", "HU", "IN", "ID", "IE", "IL", "IT", "JP", "KE", "MY", "MX", "NL", "NZ", "NG", "NO", "PK", "PA", "PE", "PH", "PL", "PT", "PR", "RO", "RU", "SA", "SG", "ZA", "KR", "ES", "SE", "CH", "TW", "TH", "TR", "AE", "GB", "US", "UY", "VE", "VN", "UA" ], "type": "string", "description": "๐Ÿ“ Region used for **Facebook page** sources. Library URLs usually carry their own country in the link.", "default": "ALL" }, "period": { "title": "๐Ÿ“… Default time range", "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "โณ Optional window when your URL does not already specify one. **Leave empty** to follow the libraryโ€™s own default. Pick a calendar date or a relative span (e.g. 7 days)โ€”values are passed through as you provide them.", "default": "" }, "activeStatus": { "title": "โšก Ad activity", "enum": [ "all", "active", "inactive" ], "type": "string", "description": "๐ŸŽ›๏ธ Filter for **page** sources, or when your Ad Library link leaves this unspecified.", "default": "all" }, "proxyConfiguration": { "title": "๐Ÿ›ก๏ธ Proxy (optional)", "type": "object", "description": "๐Ÿ  Leave off for a standard run. If you enable Apify Proxy here, **only residential** proxy traffic is used for the whole run. Requires proxy access on your Apify plan." } } }, "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 } } } } } } } } } }