{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Library Scraper", "description": "Scrape public Meta/Facebook Ads Library results with strict caps, multi-keyword batching, no-login browser extraction, and optional monitoring snapshots.", "version": "0.0", "x-build-id": "Oh1iVBAyFC70ZynXr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/techionik9993~facebook-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-techionik9993-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/techionik9993~facebook-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-techionik9993-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/techionik9993~facebook-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-techionik9993-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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Keywords or brand names to search in the public Meta Ads Library. Add multiple queries to collect more total rows in one run.", "default": [ "nike", "adidas", "puma", "reebok" ], "items": { "type": "string" } }, "adLibraryUrls": { "title": "Ad Library URLs", "type": "array", "description": "Optional full Meta Ads Library URLs. Use this for advanced filters configured in the Ads Library UI.", "default": [], "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code used for keyword searches.", "default": "US" }, "activeStatus": { "title": "Ad status", "enum": [ "active", "inactive", "all" ], "type": "string", "description": "Which ads to search for.", "default": "active" }, "maxResults": { "title": "Max ads", "minimum": 1, "type": "integer", "description": "Maximum ad rows to write across all sources. Meta currently exposes about 18-29 ads per search in Apify cloud, so use multiple queries or Ad Library URLs for larger runs.", "default": 100 }, "monitorChanges": { "title": "Monitor changes since last run", "type": "boolean", "description": "Save snapshots in a named key-value store and compare ad IDs across scheduled runs.", "default": false }, "onlyChanges": { "title": "Output only the changes", "type": "boolean", "description": "When monitoring is enabled, output only new or changed ad rows.", "default": false }, "proxyMode": { "title": "Proxy mode", "enum": [ "none", "auto", "datacenter", "residential" ], "type": "string", "description": "Use no proxy for lowest cost. Choose Auto or proxy modes only if Meta blocks direct access.", "default": "none" }, "proxyCountryCode": { "title": "Residential proxy country", "type": "string", "description": "Optional two-letter country code for residential proxy. Used only when Proxy mode is Residential.", "default": "" }, "includeRawText": { "title": "Include raw ad text", "type": "boolean", "description": "Include the raw text block used for parsing each ad row.", "default": true }, "maxRunMinutes": { "title": "Max run minutes", "minimum": 1, "maximum": 10, "type": "integer", "description": "Cost protection timeout for the whole run. The Actor stops early instead of waiting forever when Meta stalls or blocks loading.", "default": 8 }, "maxSourceSeconds": { "title": "Max seconds per query or URL", "minimum": 30, "maximum": 180, "type": "integer", "description": "Cost protection timeout per search query or Ad Library URL. Lower values reduce risk and cost; higher values may collect more rows on slow pages.", "default": 120 } } }, "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 } } } } } } } } } }