{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Messages Scraper with Comments", "description": "Export public Telegram channel messages: text, date, views, reactions, media and links, with optional comments and exact subscriber counts. Search inside channels, filter by date or words, and get only new posts on a schedule. No login. $0.80 per 1,000 posts. Maintained by CleanScrape.", "version": "0.1", "x-build-id": "4PZkGbh1Vmb5Jp7MS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cleanscrape~telegram-channel-messages-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cleanscrape-telegram-channel-messages-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/cleanscrape~telegram-channel-messages-scraper/runs": { "post": { "operationId": "runs-sync-cleanscrape-telegram-channel-messages-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/cleanscrape~telegram-channel-messages-scraper/run-sync": { "post": { "operationId": "run-sync-cleanscrape-telegram-channel-messages-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 or post links", "type": "array", "description": "Paste public channel names or links, one per line. Examples: @TelegramTips, https://t.me/TelegramTips or a link to one post.", "items": { "type": "string" } }, "maxPosts": { "title": "Posts per channel", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The most posts to save per channel. Actual results can be lower.", "default": 20 }, "period": { "title": "Dates", "enum": [ "all", "7days", "30days", "custom" ], "type": "string", "description": "Limit posts by publication date. The post and page limits still apply.", "default": "all" }, "startDate": { "title": "Start date", "type": "string", "description": "For Custom dates only. Leave empty for no lower date limit." }, "endDate": { "title": "End date", "type": "string", "description": "For Custom dates only. Includes the entire day in UTC." }, "search": { "title": "Search within channels", "type": "string", "description": "Optional phrase to search in the channels you supplied. Telegram chooses matches. Applies to channel inputs, not individual post links." }, "includeWords": { "title": "Include words", "type": "array", "description": "Keep posts containing any of these words or phrases in their text. Case does not matter.", "items": { "type": "string" } }, "excludeWords": { "title": "Exclude words", "type": "array", "description": "Skip posts containing any of these words or phrases in their text.", "items": { "type": "string" } }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Also save recent public comments in their own table, when available.", "default": false }, "commentsPerPost": { "title": "Comments per post", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum recent comments to save for each collected post. Telegram may expose fewer.", "default": 20 }, "onlyNew": { "title": "Only new posts", "type": "boolean", "description": "For scheduled runs: save only posts that earlier runs with the same watch name did not save. The first run saves the newest posts as the starting point; later runs save what was published since. A run cut short by Posts per channel or a limit continues where it stopped on the next run, so no new post is skipped.", "default": false }, "watchName": { "title": "Watch name (optional)", "maxLength": 100, "type": "string", "description": "Leave empty, and runs with the same channels share one history. Or give a name, such as \"Crypto news channels\", to keep the history when you change the channel list. Changing the search or the words starts a new history." }, "maxPages": { "title": "Pages per channel", "minimum": 1, "maximum": 500, "type": "integer", "description": "Stops long or narrow searches after this many pages. Each page usually contains about 20 posts.", "default": 50 }, "maxRequests": { "title": "Request limit", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Safety limit for all source requests, including comments and retries.", "default": 500 } } }, "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 } } } } } } } } } }