{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Scraper - Meta Ad Library Scraper & API", "description": "Scrape Facebook and Instagram ads from the Meta Ad Library by keyword, Page or Ad Library link: ad text, images, videos, start and end dates, spend, reach and advertiser details. No login. Export to CSV, JSON or Excel, schedule runs or use the API.", "version": "0.1", "x-build-id": "6lyLq3a587VWOwXoB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~facebook-ad-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-facebook-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/automly~facebook-ad-library-scraper/runs": { "post": { "operationId": "runs-sync-automly-facebook-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/automly~facebook-ad-library-scraper/run-sync": { "post": { "operationId": "run-sync-automly-facebook-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": { "searchTerms": { "title": "Search Terms", "type": "array", "description": "Keywords to search for (e.g., 'netflix', 'fitness app'). Each term runs a separate search.", "items": { "type": "string" } }, "urls": { "title": "Ad Library URLs", "type": "array", "description": "Facebook Page links (e.g. https://www.facebook.com/nike) to get that Page's ads with the filters below, or Facebook Ad Library links, whose own filters are used as they are.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code (e.g., US, GB, DE) or country name (e.g., Germany). Use 'ALL' for all countries.", "default": "US" }, "activeStatus": { "title": "Ad Status", "enum": [ "active", "inactive", "all" ], "type": "string", "description": "Which ads to include: active (running now), inactive (stopped) or all.", "default": "active" }, "adType": { "title": "Ad Type", "enum": [ "all", "political_and_issue_ads", "housing_ads", "employment_ads", "credit_ads" ], "type": "string", "description": "Ad category: all, or only political and issue, housing, employment or credit ads.", "default": "all" }, "mediaType": { "title": "Media Type", "enum": [ "all", "image", "video", "meme", "none" ], "type": "string", "description": "Creative format: all, image, video, meme or none (text only).", "default": "all" }, "searchType": { "title": "Search Type", "enum": [ "keyword_unordered", "keyword_exact_phrase" ], "type": "string", "description": "How to match the search terms: keyword_unordered finds ads with all the words in any order, keyword_exact_phrase only the exact phrase.", "default": "keyword_unordered" }, "startDateMin": { "title": "Start Date (From)", "type": "string", "description": "Only include ads that started on or after this date (YYYY-MM-DD)." }, "startDateMax": { "title": "Start Date (To)", "type": "string", "description": "Only include ads that started on or before this date (YYYY-MM-DD)." }, "maxAds": { "title": "Max Ads per Search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of ads to scrape per search term or URL.", "default": 100 }, "outputFormat": { "title": "Output format", "enum": [ "clean", "legacy" ], "type": "string", "description": "Clean: one tidy row per ad with a link that opens the ad, carousel cards kept together, ISO dates, numbers as numbers and a thumbnail. Old format: the fields this scraper has always returned, for existing integrations. Runs that do not set this field (API calls, saved tasks, schedules) get the old format. On the Output tab, each format has its own tabs: old-format ads are under 'Ads (old format)'.", "default": "legacy" }, "includePageTransparency": { "title": "Include Page Transparency Data", "type": "boolean", "description": "Fetch page creation date, name change history, and how many ads each advertiser has in the searched country and ad status. Warning: significantly slower. When this option has its own price on the Pricing tab, it is charged per ad that gets this data.", "default": false }, "includeAdvertiserDetails": { "title": "Include advertiser details", "type": "boolean", "description": "Adds each advertiser's Instagram account and followers, verified badges, About text, cover photo and a larger logo. Looked up once per advertiser, however many of its ads you get. When this option has its own price on the Pricing tab, it is charged per ad that gets this data.", "default": false }, "includeAdDetails": { "title": "Include EU/UK transparency and political audience", "type": "boolean", "description": "For ads shown in the EU or UK: exact reach, targeted ages, gender and places, who paid and who benefits, and reach by country, age and gender. For political and issue ads: audience by age, gender and region, and the Page's spend. Looked up only for ads that have this data. When this option has its own price on the Pricing tab, it is charged per ad that gets this data.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Keep the default setting for the best results.", "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 } } } } } } } } } }