{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper: Messages, Views & Reactions", "description": "Scrape public Telegram channels without login or API keys: message text, date, views, reactions, photos, videos, links, hashtags, replies and forwards, plus channel title, description and subscriber count. Date range, keyword filter and new-messages-only monitoring. $0.50 per 1,000 messages.", "version": "0.1", "x-build-id": "BRTF5dFh7Y0o1XA9f" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/magenta_waterwheel~telegram-channel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-magenta_waterwheel-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/magenta_waterwheel~telegram-channel-scraper/runs": { "post": { "operationId": "runs-sync-magenta_waterwheel-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/magenta_waterwheel~telegram-channel-scraper/run-sync": { "post": { "operationId": "run-sync-magenta_waterwheel-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 Telegram channels, one per line: username (durov), @handle (@durov) or link (https://t.me/durov or https://t.me/s/durov). Private groups and invite links (t.me/+...) are not supported.", "items": { "type": "string" } }, "maxMessagesPerChannel": { "title": "Max messages per channel", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Maximum number of messages to save from each channel, newest first. Set 0 to save only channel info.", "default": 100 }, "oldestDate": { "title": "Oldest message date", "type": "string", "description": "Only messages posted on or after this date. Use a date (2026-01-31), a date and time (2026-01-31T08:00:00Z) or a relative period such as \"7 days\" or \"12 hours\". Scraping stops when it reaches older messages." }, "newestDate": { "title": "Newest message date", "type": "string", "description": "Only messages posted on or before this date (same formats as above). Newer messages are skipped for free." }, "keywords": { "title": "Keywords", "type": "array", "description": "Only save messages whose text (or link preview or poll question) contains these words or phrases. Case-insensitive. Messages that don't match are free.", "items": { "type": "string" } }, "keywordMatch": { "title": "Keyword match", "enum": [ "any", "all" ], "type": "string", "description": "Save messages that contain any of the keywords, or only those that contain all of them.", "default": "any" }, "maxPagesPerChannel": { "title": "Max pages without matches per channel", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Safety limit for date and keyword searches: stop a channel after this many pages (about 20 messages each) that contain no message you asked for. Pages with matches don't count. 50 pages is about 1,000 skipped messages.", "default": 50 }, "onlyNewMessages": { "title": "Only new messages since the last run", "type": "boolean", "description": "For scheduled monitoring. Remembers the newest message ID per channel in a named key-value store and on the next run saves only newer messages. The first run saves up to the message limit.", "default": false }, "stateStoreName": { "title": "Monitoring state store name", "type": "string", "description": "Name of the key-value store that remembers the last message ID per channel. Use a different name for each monitoring task.", "default": "telegram-channel-scraper-state" }, "minMessageId": { "title": "Only messages after ID", "minimum": 0, "type": "integer", "description": "Only save messages with an ID greater than this number (the number at the end of a message link, e.g. 460 in t.me/telegram/460). Useful for your own incremental logic." }, "includeMessages": { "title": "Include messages", "type": "boolean", "description": "Save channel messages.", "default": true }, "includeChannelInfo": { "title": "Include channel info", "type": "boolean", "description": "Save one record per channel with title, description, full subscriber count, verification badge, avatar and media counters.", "default": true }, "includeHtml": { "title": "Include message HTML", "type": "boolean", "description": "Also save the original message HTML (formatting, bold, links) in textHtml.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many pages to load in parallel. Pages of one channel are always loaded in order.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed in most cases. Use Apify Proxy if Telegram starts rate-limiting very large runs." } } }, "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 } } } } } } } } } }