{ "openapi": "3.0.1", "info": { "title": "Meta Ads Library Scraper: Facebook & Instagram Ads", "description": "Scrape the Meta Ads Library for Facebook and Instagram ads by keyword, Page or Ad Library URL: ad copy, creatives, CTA, platforms, start and end dates, landing pages and advertiser details. Optional only-new monitor for competitor tracking.", "version": "1.0", "x-build-id": "KqUm9szYQOLzUP6zi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northloop-labs~meta-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northloop-labs-meta-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/northloop-labs~meta-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-northloop-labs-meta-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/northloop-labs~meta-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-northloop-labs-meta-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 keywords", "type": "array", "description": "Keywords to search in the Meta Ads Library (unordered match). One per line. Example: nike, meal kit, crypto wallet.", "default": [ "nike" ], "items": { "type": "string" } }, "pageIds": { "title": "Facebook Page IDs", "type": "array", "description": "Numeric Facebook Page IDs to scrape all ads for (view_all_page_id). Prefer this when you already know the Page ID.", "items": { "type": "string" } }, "pageUrls": { "title": "Facebook Page URLs", "type": "array", "description": "Facebook Page URLs such as https://www.facebook.com/nike. The Actor resolves the Page ID when possible.", "items": { "type": "string" } }, "startUrls": { "title": "Ad Library URLs", "type": "array", "description": "Full Meta Ads Library search or single-ad URLs. Filters in the URL (country, status, media type) are used as-is for that URL.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "2-letter country code for keyword and Page searches (US, GB, DE, FR, RO...). Use ALL for every country Meta lists.", "default": "US" }, "activeStatus": { "title": "Ad status", "enum": [ "ACTIVE", "INACTIVE", "ALL" ], "type": "string", "description": "Only active ads, only inactive, or all.", "default": "ACTIVE" }, "adType": { "title": "Ad type", "enum": [ "ALL", "POLITICAL_AND_ISSUE_ADS" ], "type": "string", "description": "All ads, or only political / issue ads (where Meta exposes them).", "default": "ALL" }, "mediaType": { "title": "Media type", "enum": [ "ALL", "IMAGE", "VIDEO", "MEME" ], "type": "string", "description": "Filter by creative format.", "default": "ALL" }, "maxResults": { "title": "Max ads (total)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many unique ads are saved. You are charged only for ads saved, never more than this.", "default": 10 }, "maxAdsPerSearch": { "title": "Max ads per search", "minimum": 0, "type": "integer", "description": "Optional cap per keyword, Page or start URL. 0 = share Max ads evenly, then fill leftovers.", "default": 0 }, "onlyNew": { "title": "Only new ads (monitor)", "type": "boolean", "description": "Skip ads already seen in the monitor store. The first run sets the baseline. Schedule daily or weekly to track new competitor ads.", "default": false }, "monitorStoreName": { "title": "Monitor state store", "type": "string", "description": "Key-value store in your Apify account that remembers which ad archive IDs were already seen.", "default": "meta-ads-monitor" }, "proxyCountry": { "title": "Proxy country", "type": "string", "description": "Residential proxy exit country (ISO code). US works best for the Ads Library. Leave empty to use the search country.", "default": "" }, "maxSessionAttempts": { "title": "Max session attempts", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many residential browser sessions to try if Meta challenges one. Each failed attempt is free (no session fee).", "default": 4 } } }, "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 } } } } } } } } } }