{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Library Scraper: Meta Ads by Keyword or Page", "description": "Ads from Meta's public Ad Library by keyword or advertiser in any country: text, images, videos, links, call to action, start date and days running, platforms; political ads with spend and impressions. No login. $1 per 1,000 ads.", "version": "0.1", "x-build-id": "mzbHvm5SWaLgLab3Z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zaiq~facebook-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zaiq-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/zaiq~facebook-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-zaiq-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/zaiq~facebook-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-zaiq-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", "type": "array", "description": "Keywords the ads mention, one search per line, as you would type them into the Ad Library.", "items": { "type": "string" } }, "advertisers": { "title": "Advertisers", "type": "array", "description": "One advertiser per line: a Facebook Page link (https://www.facebook.com/brand), a username, a Page id, an Ad Library link with view_all_page_id, or a name. Returns that advertiser's ads.", "items": { "type": "string" } }, "advertiserKeyword": { "title": "Only an advertiser's ads that mention", "type": "string", "description": "Optional: with advertisers, keep only their ads whose text mentions these words (the others are left out and not charged)." }, "country": { "title": "Country", "enum": [ "ALL", "US", "GB", "CA", "AU", "NZ", "IE", "IN", "ZA", "DE", "AT", "CH", "FR", "BE", "NL", "ES", "PT", "IT", "SE", "NO", "DK", "FI", "PL", "CZ", "RO", "GR", "HU", "TR", "UA", "IL", "AE", "SA", "EG", "NG", "KE", "JP", "KR", "TW", "HK", "SG", "MY", "ID", "PH", "TH", "VN", "PK", "BR", "MX", "AR", "CL", "CO" ], "type": "string", "description": "Where the ads were shown. ALL = every country.", "default": "US" }, "activeStatus": { "title": "Ad status", "enum": [ "active", "inactive", "all" ], "type": "string", "description": "Active: running now. Inactive: stopped. All: both.", "default": "active" }, "mediaType": { "title": "Media type", "enum": [ "all", "image", "video", "meme", "image_and_meme", "none" ], "type": "string", "description": "Only ads with this kind of media.", "default": "all" }, "platforms": { "title": "Platforms", "type": "array", "description": "Only ads shown on these. Empty = all platforms.", "items": { "type": "string", "enum": [ "facebook", "instagram", "messenger", "threads", "audience_network" ], "enumTitles": [ "Facebook", "Instagram", "Messenger", "Threads", "Audience Network" ] } }, "exactPhrase": { "title": "Search terms as an exact phrase", "type": "boolean", "description": "Match the words in order, as one phrase.", "default": false }, "politicalAdsOnly": { "title": "Political and issue ads only", "type": "boolean", "description": "Only ads about social issues, elections or politics: these come with spend, impressions and who paid.", "default": false }, "language": { "title": "Ad language", "type": "string", "description": "Only ads in this language, as a two-letter code (en, es, de, af...). Empty = any." }, "shownFrom": { "title": "Shown on or after", "type": "string", "description": "Only ads shown on or after this day." }, "shownTo": { "title": "Shown on or before", "type": "string", "description": "Only ads shown on or before this day." }, "maxAdsPerSearch": { "title": "Maximum ads per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many ads at most for each search term or advertiser.", "default": 100 }, "maxConcurrency": { "title": "Searches at once", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many searches run at the same time.", "default": 3 } } }, "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 } } } } } } } } } }