{ "openapi": "3.0.1", "info": { "title": "Facebook & Meta Ad Library Scraper: by website, with EU reach", "description": "Type a website, Facebook page or brand and get its running Facebook & Instagram ads: days running, landing page, copies of each creative, Meta's ad count, EU reach by age and gender, lasting image links, new and stopped ads, and a summary per advertiser.", "version": "0.1", "x-build-id": "3BWPMJrGgnufNFVxa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reachlens~meta-ad-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reachlens-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/reachlens~meta-ad-library-scraper/runs": { "post": { "operationId": "runs-sync-reachlens-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/reachlens~meta-ad-library-scraper/run-sync": { "post": { "operationId": "run-sync-reachlens-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", "required": [ "searches" ], "properties": { "searches": { "title": "Websites, Facebook pages or brand names", "type": "array", "description": "One per line. A website (gymshark.com) finds the brand's own Facebook pages for you: pages linked from the site and pages whose ads land on it. You can also give a Facebook page link, a page ID, an Ad Library link, or a brand name.", "items": { "type": "string" } }, "country": { "title": "Country", "enum": [ "ALL", "AT", "AU", "BE", "BG", "BR", "CA", "CH", "CY", "CZ", "DE", "DK", "EE", "ES", "FI", "FR", "GB", "GR", "HR", "HU", "IE", "IN", "IT", "LT", "LU", "LV", "MT", "MX", "NL", "NO", "NZ", "PL", "PT", "RO", "SE", "SI", "SK", "US" ], "type": "string", "description": "Ads shown in this country, as Meta's Ad Library filters them.", "default": "ALL" }, "maxAdsPerAdvertiser": { "title": "Max ads per advertiser", "minimum": 1, "maximum": 500, "type": "integer", "description": "Running ads to read for each input, in the order Meta lists them (not by date), up to 500. When empty: 100 (30 in one-row-per-advertiser mode, where Meta's own total gives the count). The summary says how many Meta shows." }, "output": { "title": "What to return", "enum": [ "ads", "advertisers" ], "type": "string", "description": "Every ad, or one row per advertiser (is it advertising, how many ads and creatives, formats, landing pages, its most-copied creatives). The per-advertiser row is the cheapest way to check many companies.", "default": "ads" }, "euAudience": { "title": "EU reach, age and gender per ad", "type": "boolean", "description": "For ads shown in the EU, Meta publishes how many people each ad reached, by country, age and gender, and its targeting. Charged only for ads where Meta publishes it.", "default": false }, "euAudienceMaxAds": { "title": "EU reach: max ads per advertiser", "minimum": 1, "maximum": 500, "type": "integer", "description": "Reads EU reach for this many of each advertiser's ads (the first ones read).", "default": 50 }, "trackChanges": { "title": "Mark new and stopped ads since your last run", "type": "boolean", "description": "Remembers what each input showed last time (in your own storage), so a scheduled run flags new ads and counts stopped ones.", "default": true }, "saveImages": { "title": "Keep a copy of each ad's image", "type": "boolean", "description": "Meta's image links stop working after a few days. This saves each ad's picture (a video's preview frame) in your Apify storage and adds a lasting link (savedImageUrl). Charged per picture saved; pictures saved by earlier runs are reused for free.", "default": false }, "proxy": { "title": "Proxy", "type": "object", "description": "Apify's datacenter proxies read Meta's library well and keep runs fast and cheap; when Meta slows a read, the retry goes through residential proxies automatically, unless you pick proxy groups yourself.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }