{ "openapi": "3.0.1", "info": { "title": "X (Twitter) Ads Library: Promoted Posts and Ad Creative", "description": "550+ brand accounts monitored. Search collected X ads and promoted-only posts by brand, keyword and date. Free demo: fixed sample only; paid Apify plan required for custom data. API platform usage is billed separately by Apify.", "version": "1.0", "x-build-id": "kUuD2Z4EMgynBJNbH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/feeddlabs~x-ads-library/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-feeddlabs-x-ads-library", "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/feeddlabs~x-ads-library/runs": { "post": { "operationId": "runs-sync-feeddlabs-x-ads-library", "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/feeddlabs~x-ads-library/run-sync": { "post": { "operationId": "run-sync-feeddlabs-x-ads-library", "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": { "advertisers": { "title": "Advertisers", "type": "array", "description": "Brand handles (with or without @), up to 50. Leave empty to get ads from every advertiser we watch. A brand we do not watch yet is requested for collection; available results vary.", "default": [ "Starlink" ], "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Only ads whose text contains any of these words, up to 10.", "items": { "type": "string" } }, "language": { "title": "Language", "type": "string", "description": "Two- or three-letter language code, e.g. en, es, ja. Default: en (English). Clear it to get every language.", "default": "en" }, "onlyNew": { "title": "Only new since my last run", "type": "boolean", "description": "Only ads that appeared since your last run with the same brands and keywords. Schedule it for daily new-ad alerts.", "default": false }, "since": { "title": "First seen from", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Ads we first saw on or after this day (UTC)." }, "until": { "title": "First seen until", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Ads we first saw on or before this day (UTC)." }, "maxResults": { "title": "Maximum rows", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many ads. You pay per ad. Total across the whole run, not per query or account. On Free, this can only shorten the fixed sample.", "default": 20 }, "reportProblem": { "title": "Report a problem", "type": "string", "description": "Something wrong or missing? Write it here and run: we get your message, the run does nothing else, and it's free. AI agents can use this too." } } }, "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 } } } } } } } } } }