{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper & Keyword Search: messages, views", "description": "Search and monitor public Telegram channels—not just scrape them. Get keyword-matched messages, views, reactions, media and subscribers for $1 per 1,000 messages on Free, with no login or API key. Per-channel diagnostic errors explain unavailable inputs; changes-only mode powers alerts.", "version": "0.1", "x-build-id": "KheTM0IQ7fLEfzrgN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brenton8907~telegram-channel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brenton8907-telegram-channel-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/brenton8907~telegram-channel-scraper/runs": { "post": { "operationId": "runs-sync-brenton8907-telegram-channel-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/brenton8907~telegram-channel-scraper/run-sync": { "post": { "operationId": "run-sync-brenton8907-telegram-channel-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": [ "channels" ], "properties": { "channels": { "title": "Channels", "type": "array", "description": "Public channel usernames or t.me links, one per line: durov, @bloomberg, https://t.me/telegram, https://t.me/s/cryptosignals. Private channels, groups, users, bots and invite links have no public preview and are reported as errors, not charged.", "items": { "type": "string" } }, "maxMessagesPerChannel": { "title": "Max messages per channel", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Newest first. This is the total cap per channel; with multiple keywords, results are split fairly across terms. 20 messages per request. Hard cap 50,000.", "default": 100 }, "sinceDate": { "title": "Since date", "type": "string", "description": "Only messages posted on or after this date (UTC). YYYY-MM-DD or ISO 8601 datetime. Paging stops as soon as an older message is reached, so tight windows are cheap." }, "untilDate": { "title": "Until date", "type": "string", "description": "Only messages posted on or before this date (UTC). YYYY-MM-DD or ISO 8601 datetime." }, "sinceMessageId": { "title": "Since message ID", "minimum": 0, "type": "integer", "description": "Only messages with an ID greater than this. Use the highest message_id from your last run to fetch just what is new (or turn on changes-only mode, which does this for you)." }, "keywords": { "title": "Keywords", "type": "array", "description": "Optional. Search each channel for these terms using Telegram's own in-channel search (server side, one search per keyword) instead of reading the full history. Terms are read round-robin up to the per-channel cap instead of exhausting the first term; set the cap at least as high as the number of terms. Results carry a matched_keyword field.", "items": { "type": "string" } }, "includeChannelInfo": { "title": "Include channel info row", "type": "boolean", "description": "Add one channel row per channel: title, description, subscriber count, photo/video/file/link counts, avatar URL. Charged as a channel record.", "default": true }, "includeHtml": { "title": "Include message HTML", "type": "boolean", "description": "Also return the message body as HTML (text_html) with Telegram's formatting, links and custom emoji markup.", "default": false }, "changesOnly": { "title": "Changes only (monitor mode)", "type": "boolean", "description": "Remember the newest message ID per channel in a key-value store and output only messages posted since the last run. The first run outputs everything (all messages are new) and seeds the store. Ideal for scheduled runs that feed alerts or agents.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Key-value store that holds the per-channel last message IDs for changes-only mode. Use a different name per watchlist.", "default": "telegram-channel-monitor" }, "requestDelaySeconds": { "title": "Delay between requests (seconds)", "minimum": 0, "maximum": 10, "type": "number", "description": "Polite pacing toward t.me. 0.5 is safe; lower it for large jobs at your own risk.", "default": 0.5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. t.me serves the public preview without a proxy; enable Apify Proxy only if your runs get HTTP 429." } } }, "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 } } } } } } } } } }