{ "openapi": "3.0.1", "info": { "title": "Meta Ad Library Scraper - Facebook & Instagram Ads", "description": "Scrape public Facebook and Instagram ads by keyword or exact advertiser. Export creatives, stable IDs and dates with pagination reports and only-new monitoring.", "version": "1.0", "x-build-id": "XnZStJhbNCv0pek1i" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/benthepythondev~meta-ad-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-benthepythondev-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/benthepythondev~meta-ad-library-scraper/runs": { "post": { "operationId": "runs-sync-benthepythondev-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/benthepythondev~meta-ad-library-scraper/run-sync": { "post": { "operationId": "run-sync-benthepythondev-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": { "keyword": { "title": "Search keyword", "type": "string", "description": "Meta keyword search. Explicit Page IDs take precedence, including over the default keyword.", "default": "Nike" }, "pageIds": { "title": "Exact advertiser Page IDs", "type": "array", "description": "Up to ten numeric Page ID strings. Every returned ad must match the requested advertiser. Overrides keyword.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code such as DE, US or GB; ALL searches all available countries.", "default": "DE" }, "activeStatus": { "title": "Ad status", "enum": [ "active", "inactive", "all" ], "type": "string", "description": "Select active, inactive or all ads available in the public library.", "default": "active" }, "maxResults": { "title": "Maximum matching ads", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on matching ads inspected across all searches, including already-seen ads in monitor mode. Not a guarantee of this many new results.", "default": 10 }, "maxPages": { "title": "Maximum result pages per advertiser/search", "minimum": 1, "maximum": 50, "type": "integer", "description": "Bounded source pages. SUMMARY reports the actual stop reason and incomplete coverage.", "default": 5 }, "strictKeyword": { "title": "Require keyword words in the returned creative or advertiser", "type": "boolean", "description": "Checks every whitespace-separated keyword word locally. Ignored in exact advertiser mode.", "default": false }, "startDateFrom": { "title": "Earliest ad start date", "type": "string", "description": "Optional inclusive YYYY-MM-DD UTC date. Filters the scanned window, not the entire library." }, "startDateTo": { "title": "Latest ad start date", "type": "string", "description": "Optional inclusive YYYY-MM-DD UTC date. Ads with missing dates are excluded when a date bound is used." }, "onlyNew": { "title": "Only new ad IDs", "type": "boolean", "description": "Persist seen IDs in your account and export new ones on later runs of this monitor.", "default": false }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Optional stable monitor name. Use a distinct value for each search; otherwise derived from search filters." }, "firstRunMode": { "title": "First monitor run", "enum": [ "emitAll", "seedOnly" ], "type": "string", "description": "Seed-only establishes a baseline; later runs export only new IDs within the scanned window.", "default": "emitAll" }, "resetState": { "title": "Reset this monitor", "type": "boolean", "description": "Reset only this monitor state. Switch off again for subsequent scheduled runs.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy required by the verified Apify route. Select the country appropriate for your search. Public static bundles load directly to reduce proxy traffic.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "DE" } } } }, "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 } } } } } } } } } }