{
"openapi": "3.0.1",
"info": {
"title": "Meta Ad Library Scraper",
"description": "Scrape Facebook and Instagram ads from Meta's Ad Library by keyword or advertiser page: ad text, headline, call to action, link, image and video URLs, format, platforms and run dates. One flat row per ad, with a hard cap. Export data, run via API, schedule runs.",
"version": "0.0",
"x-build-id": "zgiQuXjy4OMdVxRed"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/lergassy~meta-ad-library-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-lergassy-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/lergassy~meta-ad-library-scraper/runs": {
"post": {
"operationId": "runs-sync-lergassy-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/lergassy~meta-ad-library-scraper/run-sync": {
"post": {
"operationId": "run-sync-lergassy-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": {
"queries": {
"title": "🔍 Search keywords",
"type": "array",
"description": "Words or brand names to search the Ad Library for, one per line. Every ad whose text, advertiser or link matches is returned.",
"default": [
"nike"
],
"items": {
"type": "string"
}
},
"pageIds": {
"title": "📄 Facebook page IDs",
"type": "array",
"description": "Numeric page IDs to pull every ad of one advertiser, instead of searching by keyword. The ID is the number in an ad's Ad Library link, and it is also returned as pageId on every row.",
"default": [],
"items": {
"type": "string"
}
},
"country": {
"title": "🌍 Country",
"type": "string",
"description": "Two-letter country code of the audience the ads were shown to, for example US, GB, DE. Meta indexes ads per country, so this changes which ads exist, not just how they are filtered.",
"default": "US"
},
"activeStatus": {
"title": "🟢 Ad status",
"enum": [
"active",
"inactive",
"all"
],
"type": "string",
"description": "Whether to return ads that are still running, ads that have stopped, or both.",
"default": "active"
},
"adType": {
"title": "🗳️ Ad type",
"enum": [
"all",
"political"
],
"type": "string",
"description": "All ads, or only the political and social-issue shelf. Meta publishes spend, impressions and reach for that shelf and for nothing else, so the spend, impressionsText and reachEstimate columns only carry numbers here.",
"default": "all"
},
"mediaType": {
"title": "🖼️ Media type",
"enum": [
"all",
"image",
"video",
"meme",
"none"
],
"type": "string",
"description": "Keep only ads of one format. Meta applies this itself, so it changes which ads are fetched and therefore what you pay for.",
"default": "all"
},
"platforms": {
"title": "📱 Platforms",
"type": "array",
"description": "Limit to ads shown on particular Meta surfaces. Leave empty for all of them.",
"items": {
"type": "string",
"enum": [
"FACEBOOK",
"INSTAGRAM",
"MESSENGER",
"AUDIENCE_NETWORK",
"THREADS"
],
"enumTitles": [
"Facebook",
"Instagram",
"Messenger",
"Audience Network",
"Threads"
]
},
"default": []
},
"startDate": {
"title": "📅 Ads started after",
"type": "string",
"description": "Only ads that began running on or after this date, as YYYY-MM-DD."
},
"endDate": {
"title": "📅 Ads started before",
"type": "string",
"description": "Only ads that began running on or before this date, as YYYY-MM-DD."
},
"maxAds": {
"title": "💯 Maximum ads",
"minimum": 1,
"type": "integer",
"description": "Hard cap for the whole run. It is checked before every request, so the run stops at this number and never bills you past it.",
"default": 30
},
"maxAdsPerQuery": {
"title": "Maximum ads per keyword or page",
"minimum": 1,
"type": "integer",
"description": "Optional per-target cap, so one broad keyword cannot eat the whole run."
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Meta serves the Ad Library to residential addresses only; from a datacentre address it answers with an empty response. Leave this on the default unless you know why you are changing it.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
],
"apifyProxyCountry": "US"
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}