{
"openapi": "3.0.1",
"info": {
"title": "Facebook Ads Library Scraper",
"description": "Scrape Meta Ad Library ads (Facebook, Instagram, Messenger, Threads) by keyword, advertiser page or Ad Library URL: ad text, headline, CTA, landing page, images, videos, carousel cards, run dates and platforms.",
"version": "0.1",
"x-build-id": "vIZQi2VLz0PUpjR4P"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/wakeful_outhouse~facebook-ads-library-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-wakeful_outhouse-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/wakeful_outhouse~facebook-ads-library-scraper/runs": {
"post": {
"operationId": "runs-sync-wakeful_outhouse-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/wakeful_outhouse~facebook-ads-library-scraper/run-sync": {
"post": {
"operationId": "run-sync-wakeful_outhouse-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",
"required": [
"queries"
],
"properties": {
"queries": {
"title": "Keywords, pages or Ad Library URLs",
"type": "array",
"description": "One per line. A keyword (running shoes), a Facebook page URL (https://www.facebook.com/nike), a numeric page ID (15087023444), or any Meta Ad Library URL copied from your browser (its filters are used).",
"items": {
"type": "string"
}
},
"country": {
"title": "Country",
"type": "string",
"description": "Two-letter code of the country where the ads were shown (US, DE, GB…) or ALL.",
"default": "ALL"
},
"activeStatus": {
"title": "Status",
"enum": [
"active",
"inactive",
"all"
],
"type": "string",
"description": "Running ads only, stopped ads only, or both.",
"default": "active"
},
"adType": {
"title": "Ad category",
"enum": [
"all",
"political_and_issue_ads"
],
"type": "string",
"description": "Political and issue ads also include spend, impressions and the Paid for by line.",
"default": "all"
},
"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 platforms. Empty means all.",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"messenger",
"audience_network",
"threads"
],
"enumTitles": [
"Facebook",
"Instagram",
"Messenger",
"Audience Network",
"Threads"
]
},
"default": []
},
"exactPhrase": {
"title": "Exact phrase",
"type": "boolean",
"description": "Match keywords as an exact phrase instead of any of their words.",
"default": false
},
"languages": {
"title": "Ad languages",
"type": "array",
"description": "Two-letter language codes of the ad text (en, es…). Empty means all.",
"default": [],
"items": {
"type": "string"
}
},
"dateFrom": {
"title": "Shown from",
"type": "string",
"description": "Only ads that had impressions on or after this date."
},
"dateTo": {
"title": "Shown until",
"type": "string",
"description": "Only ads that had impressions on or before this date."
},
"includeAdDetails": {
"title": "Include EU reach, demographics and targeting",
"type": "boolean",
"description": "For ads shown in the EU, UK or Brazil, add people reached, a breakdown by country, age and gender, targeted locations, gender and ages, and payer and beneficiary. Also adds the linked Instagram account. Makes one extra request per ad. Charged per ad only when Meta publishes this data for it.",
"default": false
},
"monitorName": {
"title": "Monitor name (only new ads)",
"type": "string",
"description": "Turn on monitoring: give this search any name, for example competitors-de. Each run then saves only ads that earlier runs with the same name have not returned, so you pay only for new ads. Use it with an Apify Schedule. The first run returns everything. The list of seen ads is kept in the facebook-ads-monitor key-value store of your account. Leave empty for a normal run."
},
"maxAdsPerQuery": {
"title": "Max ads per query",
"minimum": 0,
"type": "integer",
"description": "Stop after this many ads for each input line. 0 means no limit. In monitor mode this counts all ads checked, new and already seen.",
"default": 200
},
"maxConcurrency": {
"title": "Max concurrency",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "How many queries run in parallel.",
"default": 5
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Residential proxy is recommended.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}