{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Library Scraper: Meta and Instagram ads", "description": "Scrape Meta's Ad Library by keyword, advertiser page or Ad Library URL: ad text, images, videos, carousel cards, links, dates, platforms, and spend, impressions and EU reach where Meta shows them. Any country, political ads included. No login, no browser.", "version": "0.1", "x-build-id": "5eUR2ojzxu3dngLag" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pikoulas~facebook-ads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pikoulas-facebook-ads", "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/pikoulas~facebook-ads/runs": { "post": { "operationId": "runs-sync-pikoulas-facebook-ads", "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/pikoulas~facebook-ads/run-sync": { "post": { "operationId": "run-sync-pikoulas-facebook-ads", "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 searched in the Ad Library, as its search box does: ads whose text contains them.", "items": { "type": "string" } }, "pages": { "title": "Advertisers (Facebook pages)", "type": "array", "description": "Page names (Nike), page IDs (15087023444) or page URLs (facebook.com/nike). Gives all the ads each page runs.", "items": { "type": "string" } }, "urls": { "title": "Ad Library URLs", "type": "array", "description": "Links copied from facebook.com/ads/library: a search with its filters, an advertiser's ads (view_all_page_id=...), or one ad (?id=...). The filters below don't apply to them.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter country codes (US, GB, DE) of where the ads were shown, or ALL. Each search runs once per country.", "default": [ "ALL" ], "items": { "type": "string" } }, "maxAds": { "title": "Max ads per search", "minimum": 1, "type": "integer", "description": "How many ads to take from each search term, page or URL, in each country.", "default": 100 }, "activeStatus": { "title": "Active status", "enum": [ "active", "inactive", "all" ], "type": "string", "description": "Ads running now, ads that stopped, or both.", "default": "active" }, "adType": { "title": "Ad category", "enum": [ "all", "political_and_issue_ads", "housing_ads", "employment_ads", "credit_ads" ], "type": "string", "description": "All ads, or only political and issue ads (with their spend, impressions and who paid) or the housing, employment or credit ads Meta lists apart.", "default": "all" }, "mediaType": { "title": "Media type", "enum": [ "all", "image", "meme", "image_and_meme", "video", "none" ], "type": "string", "description": "Only ads with images, memes (images with text), videos, or no media.", "default": "all" }, "platforms": { "title": "Platforms", "type": "array", "description": "Only ads shown on these. Leave empty for all.", "items": { "type": "string", "enum": [ "facebook", "instagram", "audience_network", "messenger", "threads" ], "enumTitles": [ "Facebook", "Instagram", "Audience Network", "Messenger", "Threads" ] } }, "languages": { "title": "Languages", "type": "array", "description": "Only ads in these languages, as two-letter codes (en, es, de). Leave empty for all.", "items": { "type": "string" } }, "exactPhrase": { "title": "Exact phrase", "type": "boolean", "description": "Search terms match as a whole phrase, not as separate words.", "default": false }, "startDate": { "title": "Shown from", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Only ads shown on or after this date (YYYY-MM-DD)." }, "endDate": { "title": "Shown until", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Only ads shown on or before this date (YYYY-MM-DD)." }, "includeAdDetails": { "title": "Ad details (EU reach and audience)", "type": "boolean", "description": "One more request per ad, for what its details panel shows: EU reach by country, age and gender, targeted ages, gender and locations, payer and beneficiary, and the advertiser's Instagram.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed for most runs. When Meta refuses the run's IP, the actor switches to Apify's residential proxy by itself.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }