{ "openapi": "3.0.1", "info": { "title": "X Ads Transparency Scraper: Twitter Ads Library", "description": "Scrape the X (Twitter) Ads Repository for ads served in Europe: advertiser handle, creative text (via oEmbed), targeting, impressions, reach, funding and dates. Optional only-new monitor for competitor tracking. No X login.", "version": "1.0", "x-build-id": "afofp4sMYiZaAElaD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northloop-labs~x-ads-transparency-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northloop-labs-x-ads-transparency-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/northloop-labs~x-ads-transparency-scraper/runs": { "post": { "operationId": "runs-sync-northloop-labs-x-ads-transparency-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/northloop-labs~x-ads-transparency-scraper/run-sync": { "post": { "operationId": "run-sync-northloop-labs-x-ads-transparency-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": [ "advertisers" ], "properties": { "advertisers": { "title": "Advertisers", "type": "array", "description": "X handles, @handles or profile URLs to look up (up to 50). Example: Apple, @Nike, https://x.com/SamsungMobile", "default": [ "Apple" ], "items": { "type": "string" } }, "marketPreset": { "title": "Market preset", "enum": [ "eu27", "dach", "nordics", "uk_ie", "benelux", "southern", "eea", "custom" ], "type": "string", "description": "Ready-made country groups. Choose Custom to use the Markets list below.", "default": "dach" }, "countries": { "title": "Markets (country codes)", "type": "array", "description": "Two-letter country codes when Market preset is Custom. The repository covers EU/EEA ads; empty results outside that scope are normal.", "items": { "type": "string" } }, "startDate": { "title": "Start date", "type": "string", "description": "Inclusive delivery start (YYYY-MM-DD). Repository coverage generally starts in 2023.", "default": "2026-01-01" }, "endDate": { "title": "End date", "type": "string", "description": "Inclusive delivery end (YYYY-MM-DD). Leave empty to use today." }, "maxResults": { "title": "Max ads to save", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap on ads written (and charged) in this run.", "default": 100 }, "maxAdsPerAdvertiser": { "title": "Max ads per advertiser", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Optional cap after X returns the result set for one handle. 0 = no extra cap.", "default": 0 }, "onlyNew": { "title": "Only new ads", "type": "boolean", "description": "Skip ads already stored under the monitor key. Use with a schedule for competitor alerts.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Key-value store in your account that remembers seen ad keys when Only new is on.", "default": "x-ads-monitor" }, "enrichCreatives": { "title": "Enrich creative text (oEmbed)", "type": "boolean", "description": "Resolve each unique tweet through X's public oEmbed endpoint for creative text and author. Recommended. No extra charge.", "default": true }, "searchTerms": { "title": "Filter terms (optional)", "type": "array", "description": "Keep a row only when creative, advertiser or targeting contains any of these case-insensitive terms.", "items": { "type": "string" } }, "minImpressions": { "title": "Min impressions", "minimum": 0, "type": "integer", "description": "Drop ads with fewer disclosed impressions.", "default": 0 }, "minReach": { "title": "Min reach", "minimum": 0, "type": "integer", "description": "Drop ads with less disclosed reach.", "default": 0 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Raise this if X returns rate limits or over-capacity errors.", "default": 400 }, "maxRetries": { "title": "Max retries", "minimum": 1, "maximum": 8, "type": "integer", "description": "Retries for timeouts, 429 and 5xx with exponential backoff.", "default": 4 }, "useProxy": { "title": "Use residential proxy", "type": "boolean", "description": "Off by default — the repository works with a guest session from most IPs. Turn on only if you see blocks.", "default": false }, "proxyCountry": { "title": "Proxy country", "type": "string", "description": "Residential exit country when Use residential proxy is on (e.g. DE, FR)." } } }, "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 } } } } } } } } } }