{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Library Scraper", "description": "Search public Facebook Ads Library records by keyword or advertiser, export structured ad and creative data, and optionally retrieve bounded ad details.", "version": "0.1", "x-build-id": "iMUq4kR8CyrlTw4GZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/data-slayer~facebook-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-data-slayer-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/data-slayer~facebook-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-data-slayer-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/data-slayer~facebook-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-data-slayer-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": "Ad search terms", "maxItems": 20, "type": "array", "description": "Keywords, brands, products, or topics to search in the public Ads Library.", "items": { "type": "string" } }, "advertiserQueries": { "title": "Find advertiser pages", "maxItems": 20, "type": "array", "description": "Optional advertiser names to resolve before collecting ads.", "items": { "type": "string" } }, "advertiserPageIds": { "title": "Advertiser page IDs", "maxItems": 20, "type": "array", "description": "Optional numeric public page IDs whose ads you want to collect.", "items": { "type": "string", "pattern": "^[0-9]{3,40}$" } }, "adIds": { "title": "Ad IDs for details", "maxItems": 100, "type": "array", "description": "Optional numeric Ads Library IDs to retrieve directly. Enable ad details when using this field.", "items": { "type": "string", "pattern": "^[0-9]{3,40}$" } }, "country": { "title": "Country", "pattern": "^(ALL|[A-Z]{2})$", "type": "string", "description": "Use a two-letter ISO country code or ALL. Coverage depends on what the public Ads Library exposes for the selected ad category and region.", "default": "US" }, "adStatus": { "title": "Ad status", "enum": [ "active", "inactive", "all" ], "type": "string", "description": "Return active ads, inactive ads, or both when supported.", "default": "active" }, "mediaType": { "title": "Media type", "enum": [ "all", "image", "video" ], "type": "string", "description": "Limit results to image or video ads when supported.", "default": "all" }, "maxItems": { "title": "Maximum discovery results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap across ad and advertiser discovery rows. Detail and included creative records are counted separately.", "default": 100 }, "maxPages": { "title": "Maximum pages per discovery input", "minimum": 1, "maximum": 100, "type": "integer", "description": "Safety cap for pagination on each keyword, advertiser query, or page ID.", "default": 10 }, "includeDetails": { "title": "Include separately priced ad details", "type": "boolean", "description": "Retrieve a separate ad-detail record for accepted ads, up to the detail cap. This creates a separate billable event per successful detail record.", "default": false }, "maxDetailItems": { "title": "Maximum ad details", "minimum": 0, "maximum": 500, "type": "integer", "description": "Hard cap for separately priced ad-detail records when details are enabled.", "default": 25 } } }, "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 } } } } } } } } } }