{ "openapi": "3.0.1", "info": { "title": "Telegram Ads Scraper - Sponsored Messages Library", "description": "Search Telegram Sponsored Messages (ads): text, button, destination link, advertiser, niche, country, language, payment method (TON/EUR), first/last seen dates and reach estimates. Look up advertisers too. Managed infrastructure, no login.", "version": "0.1", "x-build-id": "0As3wnlQRZDsP0GXw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/myagizm~telegram-ads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-myagizm-telegram-ads-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/myagizm~telegram-ads-scraper/runs": { "post": { "operationId": "runs-sync-myagizm-telegram-ads-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/myagizm~telegram-ads-scraper/run-sync": { "post": { "operationId": "run-sync-myagizm-telegram-ads-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": { "mode": { "title": "What to scrape", "enum": [ "ads", "advertiser" ], "type": "string", "description": "\"ads\" searches Telegram Sponsored Messages with the filters below. \"advertiser\" returns profile stats for each advertiser in \"Advertisers\".", "default": "ads" }, "query": { "title": "Keyword", "type": "string", "description": "Full-text search in ad title and text, e.g. \"vpn\", \"crypto signals\", \"casino\". Leave empty to browse all ads with the filters below." }, "advertiser": { "title": "Only ads from this advertiser", "type": "string", "description": "Optional. Telegram username of the advertiser (with or without @), e.g. \"rhymestg\". Ads mode only." }, "advertisers": { "title": "Advertisers", "type": "array", "description": "Advertiser mode only: Telegram usernames or t.me links, up to 50 per run.", "items": { "type": "string" } }, "niche": { "title": "Niche", "enum": [ "", "trading", "gambling", "crypto", "retail", "betting", "education", "vpn", "bots", "casino", "auto", "fashion", "gaming", "news", "tech", "health", "finance", "real-estate", "jobs", "travel", "marketing" ], "type": "string", "description": "Optional topic filter, e.g. trading, crypto, vpn, gambling.", "default": "" }, "category": { "title": "Category", "enum": [ "", "finance", "gambling", "tech", "content", "commerce", "life" ], "type": "string", "description": "Optional broad category (groups several niches).", "default": "" }, "country": { "title": "Country (ISO code)", "type": "string", "description": "Optional two-letter country code of the targeted audience, e.g. RU, IN, IR, AE, DE, US." }, "language": { "title": "Language (ISO code)", "type": "string", "description": "Optional two-letter language code of the ad text, e.g. en, ru, fa, es." }, "paymentMethod": { "title": "Payment method", "enum": [ "all", "ton", "eur" ], "type": "string", "description": "How the advertiser paid for the campaign.", "default": "all" }, "destination": { "title": "Destination", "enum": [ "all", "telegram", "external" ], "type": "string", "description": "Where the ad button leads.", "default": "all" }, "sort": { "title": "Sort by", "enum": [ "new", "popular", "reach", "proven" ], "type": "string", "description": "Result order. \"proven\" favours ads that ran for a long time and has the best reach data.", "default": "new" }, "days": { "title": "Only last N days", "minimum": 0, "maximum": 365, "type": "integer", "description": "Only ads first seen in the last N days. 0 = no limit.", "default": 0 }, "dateFrom": { "title": "First seen from", "type": "string", "description": "Optional. Only ads first seen on or after this date (YYYY-MM-DD)." }, "dateTo": { "title": "First seen until", "type": "string", "description": "Optional. Only ads first seen on or before this date (YYYY-MM-DD)." }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on ads returned by this run (up to 1,000). Free Apify plan: limited daily results and shallower search depth; any paid plan gets deep results.", "default": 100 } } }, "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 } } } } } } } } } }