{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Library Scraper & Meta Ads API", "description": "Facebook Ad Library scraper & Meta ads API: track competitor Facebook & Instagram ads by keyword, advertiser page or Ad Library URL, with country, status, category, media, platform, language and date filters. Ad copy, creatives, CTA, landing page, run dates, political spend. $0.50 per 1,000 ads.", "version": "0.1", "x-build-id": "fpDOPyNLp2SdkXekz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/atlasdata~facebook-ad-library-scraper-reliable/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-atlasdata-facebook-ad-library-scraper-reliable", "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/atlasdata~facebook-ad-library-scraper-reliable/runs": { "post": { "operationId": "runs-sync-atlasdata-facebook-ad-library-scraper-reliable", "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/atlasdata~facebook-ad-library-scraper-reliable/run-sync": { "post": { "operationId": "run-sync-atlasdata-facebook-ad-library-scraper-reliable", "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 (keywords)", "type": "array", "description": "Keywords to search in the Facebook Ad Library (ad text, advertiser names). Each keyword is a separate search.", "items": { "type": "string" } }, "pageIds": { "title": "Advertisers (Facebook page IDs or page URLs)", "type": "array", "description": "All ads of an advertiser: numeric Facebook page ID (e.g. 15087023444), a page URL like https://www.facebook.com/nike or an Ad Library URL with view_all_page_id. Page-name URLs are matched to the page ID through the Ad Library itself, so they work for pages that run ads.", "items": { "type": "string" } }, "startUrls": { "title": "Ad Library URLs", "type": "array", "description": "Paste URLs from facebook.com/ads/library (search pages or single ads, ?id=...). Filters in the URL (country, status, media type, dates, platforms, languages, sorting) override the filters below.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "ISO 3166 two-letter code where the ads were shown (US, GB, DE, FR, BR, IN...) or ALL for all countries.", "default": "ALL" }, "activeStatus": { "title": "Ad status", "enum": [ "active", "inactive", "all" ], "type": "string", "description": "Active ads are running now; inactive ads have stopped.", "default": "active" }, "adType": { "title": "Ad category", "enum": [ "all", "political_and_issue_ads", "housing", "employment", "financial_products_and_services" ], "type": "string", "description": "Special categories require a country (US is used if Country is ALL).", "default": "all" }, "mediaType": { "title": "Media type", "enum": [ "all", "image", "video", "meme", "image_and_meme", "none" ], "type": "string", "description": "Only ads with this kind of creative.", "default": "all" }, "exactPhrase": { "title": "Exact phrase", "type": "boolean", "description": "Match the search terms as an exact phrase instead of all words in any order.", "default": false }, "platforms": { "title": "Platforms", "type": "array", "description": "Only ads shown on these platforms: facebook, instagram, audience_network, messenger, threads. Empty = all.", "items": { "type": "string" } }, "languages": { "title": "Ad languages", "type": "array", "description": "Two-letter language codes of the ad text (en, de, es...). Empty = all.", "items": { "type": "string" } }, "dateFrom": { "title": "Shown on or after", "type": "string", "description": "YYYY-MM-DD. Only ads that were shown (delivered) on or after this date - Facebook's own date filter." }, "dateTo": { "title": "Shown on or before", "type": "string", "description": "YYYY-MM-DD. Only ads that were shown on or before this date." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "impressions" ], "type": "string", "description": "Order in which Facebook returns the ads.", "default": "relevance" }, "maxAdsPerSearch": { "title": "Max ads per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop each search after this many unique ads.", "default": 100 }, "maxConcurrency": { "title": "Parallel searches", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many searches run at the same time.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxy is required - Facebook rate-limits datacenter IPs. The default uses Apify residential proxy (included in the price).", "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 } } } } } } } } } }