{ "openapi": "3.0.1", "info": { "title": "Facebook Ad Library Scraper: Winning Ads, Meta, EU Reach", "description": "Facebook Ad Library scraper for Meta ads by keyword, page or Ad Library link. Ad text, creatives, landing page, days running, winning-ad filters and EU reach. No login.", "version": "0.1", "x-build-id": "SfUJMNNSiKV7dvcyk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/himanshu-data~meta-ad-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-himanshu-data-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/himanshu-data~meta-ad-library-scraper/runs": { "post": { "operationId": "runs-sync-himanshu-data-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/himanshu-data~meta-ad-library-scraper/run-sync": { "post": { "operationId": "run-sync-himanshu-data-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "Words to search in the Ad Library, e.g. a product, niche, brand or competitor. One per line.", "items": { "type": "string" } }, "exactPhrase": { "title": "Match the exact phrase", "type": "boolean", "description": "On: \"running shoes\" finds only that phrase. Off: ads containing all the words in any order.", "default": false }, "pages": { "title": "Advertisers (Facebook pages)", "type": "array", "description": "Every ad of an advertiser. Page names (Nike), page links (https://www.facebook.com/nike), page IDs (15087023444) or Ad Library page links (view_all_page_id=...). One per line.", "items": { "type": "string" } }, "adLibraryUrls": { "title": "Ad Library links", "type": "array", "description": "Links copied from facebook.com/ads/library with your filters set there: a search, an advertiser, or one ad (?id=...). Their own filters are used.", "items": { "type": "string" } }, "country": { "title": "Country", "enum": [ "ALL", "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "DY", "BM", "BT", "BO", "BA", "BW", "BR", "VG", "BN", "BG", "BF", "HV", "BI", "KH", "CM", "CA", "CV", "BQ", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "KR", "SS", "ES", "LK", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "UK", "US", "UY", "UZ", "NH", "VU", "VA", "VE", "VD", "VN", "WF", "EH", "YE", "ZM", "RH", "ZW" ], "type": "string", "description": "Ads shown in this country. EU countries also unlock reach details (see Ad details).", "default": "ALL" }, "activeStatus": { "title": "Ad status", "enum": [ "active", "inactive", "all" ], "type": "string", "description": "Running ads, stopped ads, or both.", "default": "active" }, "adType": { "title": "Ad category", "enum": [ "all", "political_and_issue_ads" ], "type": "string", "description": "Political and issue ads include spend, impressions and who paid for them.", "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" }, "platforms": { "title": "Platforms", "uniqueItems": true, "type": "array", "description": "Only ads shown on these platforms. Leave empty for all.", "items": { "type": "string", "enum": [ "facebook", "instagram", "audience_network", "messenger", "threads" ], "enumTitles": [ "Facebook", "Instagram", "Audience Network", "Messenger", "Threads" ] } }, "languages": { "title": "Ad languages", "type": "array", "description": "Two-letter language codes, e.g. en, es, hi. Leave empty for all.", "items": { "type": "string" } }, "startedAfter": { "title": "Started running after", "type": "string", "description": "Only ads that started on or after this date." }, "startedBefore": { "title": "Started running before", "type": "string", "description": "Only ads that started on or before this date." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "impressions" ], "type": "string", "description": "Most impressions puts the biggest ads first.", "default": "relevance" }, "maxAdsPerSource": { "title": "Max ads per keyword, advertiser or link", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Meta returns about 10 ads per page.", "default": 100 }, "minDaysRunning": { "title": "Min days running", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Only ads running for at least this many days. Advertisers keep paying for ads that work, so long runners are proven ads. Skipped ads are free." }, "minAdsUsingCreative": { "title": "Min ads using the same creative", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Only ads whose creative runs in at least this many ads (scaled creatives). Skipped ads are free." }, "includeAdDetails": { "title": "Add ad details", "type": "boolean", "description": "One extra lookup per ad: EU reach (total and by country, age and gender) and target audience for ads shown in the EU, who paid for the ad, and the advertiser's about text, verification and Instagram. Charged as a separate event.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Meta limits visitors per IP, so residential proxies are used by default. If another proxy keeps getting rate-limited, the run switches to residential by itself.", "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 }, "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 } } } } } } } } } }