{ "openapi": "3.0.1", "info": { "title": "Telegram Scraper — Channel Messages, Views & Channel Info", "description": "Telegram scraper and API: public channel messages with views, reactions, media, links and exact subscriber counts. Keyword search, date range, only-new mode. No login.", "version": "0.1", "x-build-id": "FxF6Oq2kVuEL52FOr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/innolabs~telegram-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-innolabs-telegram-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/innolabs~telegram-scraper/runs": { "post": { "operationId": "runs-sync-innolabs-telegram-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/innolabs~telegram-scraper/run-sync": { "post": { "operationId": "run-sync-innolabs-telegram-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 message links", "type": "array", "description": "Public Telegram channels: durov, @durov, https://t.me/durov, https://t.me/s/durov. A message link such as https://t.me/durov/455 returns just that message. Duplicates are scraped once.", "items": { "type": "string" } }, "maxMessagesPerChannel": { "title": "Max messages per channel", "minimum": 0, "maximum": 100000, "type": "integer", "description": "How many messages to collect from each channel, newest first, paging back through its history. With search keywords this is also the cap per keyword. 0 returns channel info only.", "default": 100 }, "includeChannelInfo": { "title": "Include channel info", "type": "boolean", "description": "Add one channel record per channel: title, description, exact subscriber count, photo/video/file/link counters, verified badge, avatar.", "default": true }, "newerThan": { "title": "Only messages newer than", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])(T[0-2]\\d:[0-5]\\d(:[0-5]\\d)?(\\.\\d+)?(Z|[+-]\\d{2}:?\\d{2})?)?$|^(\\d+)\\s*(minute|hour|day|week|month|year)s?$", "type": "string", "description": "Stop at messages older than this date: YYYY-MM-DD, an ISO date-time in UTC, or a relative value such as '7 days' (counted back from now)." }, "olderThan": { "title": "Only messages older than", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])(T[0-2]\\d:[0-5]\\d(:[0-5]\\d)?(\\.\\d+)?(Z|[+-]\\d{2}:?\\d{2})?)?$|^(\\d+)\\s*(minute|hour|day|week|month|year)s?$", "type": "string", "description": "Skip messages newer than this date (same formats). Combine with 'newer than' for a window, e.g. a past month." }, "keywords": { "title": "Keep messages containing", "type": "array", "description": "Case-insensitive words or phrases; a message is kept when its text, link-preview title or poll question contains any of them. The scraper pages through the channel history until it has enough matches.", "items": { "type": "string" } }, "searchQueries": { "title": "Telegram search in each channel", "type": "array", "description": "Runs Telegram's own in-channel search for each keyword (like the search box on t.me/s/channel). Telegram returns only the ~20 newest matches per keyword; use 'Keep messages containing' for deeper keyword scans.", "items": { "type": "string" } }, "onlyNewMessages": { "title": "Only new messages (incremental)", "type": "boolean", "description": "Push only messages newer than the newest one previous runs delivered for the same channel (and search keyword). The state is kept in a named key-value store, so a daily schedule outputs just the new posts. The first run works normally and saves the state.", "default": false }, "stateName": { "title": "State name", "type": "string", "description": "Separate 'already delivered' memory for different schedules or tasks. Letters, digits, '-' and '_' only. Change it to start fresh.", "default": "default" }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Hard cap on dataset items (messages and channel records) for the whole run. The run stops cleanly when reached.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. The default datacenter proxy works for Telegram; switch the country if a channel is restricted in some regions.", "default": { "useApifyProxy": true } }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Log every page fetched.", "default": false } } }, "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 } } } } } } } } } }