{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Library Scraper for Marketers", "description": "Get the ads any brand or keyword runs on Facebook and Instagram from the Meta Ad Library: advertiser, ad copy, CTA, landing page URL, start date, days running, platforms, ad variations and an ads-per-advertiser summary. $6 per 1,000 ads; empty searches are free.", "version": "1.0", "x-build-id": "pV41KSuU1cILitCsL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tenfoldfleet~facebook-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tenfoldfleet-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/tenfoldfleet~facebook-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-tenfoldfleet-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/tenfoldfleet~facebook-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-tenfoldfleet-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", "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search in the Meta Ad Library, one per line (a product, a niche, a brand or a phrase). Each term is one query.", "items": { "type": "string" } }, "pageIds": { "title": "Advertiser Page IDs", "type": "array", "description": "Facebook Page IDs of advertisers, to get every ad one brand runs. The ID is the number after view_all_page_id= in an Ad Library link (you can paste that whole link here too).", "items": { "type": "string" } }, "adLibraryUrls": { "title": "Ad Library URLs", "type": "array", "description": "Search links copied from https://www.facebook.com/ads/library/ after you set filters there. The filters in the link are used as they are.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code of the market where the ads ran (US, GB, DE, FR, AU, BR...), or ALL for every country.", "default": "US" }, "activeStatus": { "title": "Active status", "enum": [ "active", "all", "inactive" ], "type": "string", "description": "Only ads running now, only ads that stopped, or both.", "default": "active" }, "adType": { "title": "Ad category", "enum": [ "all", "political_and_issue_ads" ], "type": "string", "description": "All ads, or only ads about social issues, elections or politics (these include spend, impressions and who paid).", "default": "all" }, "mediaType": { "title": "Media type", "enum": [ "all", "image", "video", "meme", "image_and_meme", "none" ], "type": "string", "description": "Filter by the creative's media.", "default": "all" }, "exactPhrase": { "title": "Exact phrase", "type": "boolean", "description": "Match the search term as an exact phrase instead of any of its words.", "default": false }, "startDate": { "title": "Ran from (date)", "type": "string", "description": "Optional. Only ads that delivered impressions on or after this date (YYYY-MM-DD)." }, "endDate": { "title": "Ran until (date)", "type": "string", "description": "Optional. Only ads that delivered impressions on or before this date (YYYY-MM-DD)." }, "maxAdsPerQuery": { "title": "Max ads per query", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop each search term, Page or URL after this many ads (up to 5,000). Each ad returned is one charged result. On the Apify Free plan the run also stops when your monthly free credit runs out.", "default": 100 }, "maxConcurrency": { "title": "Parallel queries", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many queries to load at the same time. Keep it low: Meta slows down sessions that load too fast.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxy is the default and the cost is included in the price per ad. Datacenter IPs only get the first 30 ads of each query before Meta rate-limits them.", "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 } } } } } } } } } }