{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper & Keyword Alerts | $0.50/1K", "description": "Scrape posts from public Telegram channels without login: text, date, views, reactions, photos, videos, files, polls, link previews, forwards and replies. Exact date ranges, only new posts since the last run, and keyword alerts to Slack, Discord, webhook or e-mail.", "version": "1.0", "x-build-id": "demvOuR9u0U7tCKbs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/layerwiselabs~telegram-channel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-layerwiselabs-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/layerwiselabs~telegram-channel-scraper/runs": { "post": { "operationId": "runs-sync-layerwiselabs-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/layerwiselabs~telegram-channel-scraper/run-sync": { "post": { "operationId": "run-sync-layerwiselabs-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 to read. Each line is a username (durov or @durov) or a link (https://t.me/durov, https://t.me/s/durov or a link to one of its posts).", "items": { "type": "string" } }, "maxPostsPerChannel": { "title": "Max posts per channel", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "How many posts to return per channel, newest first. With 'Only new posts', each run returns at most this many new posts per channel, oldest first; any others follow with the next run.", "default": 100 }, "dateFrom": { "title": "Posted from", "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|[+-][0-2]\\d:[0-5]\\d)?)?$|^(\\d+)\\s*(minute|hour|day|week|month|year)s?$", "type": "string", "description": "Only posts published on or after this day (UTC), or within a relative time such as '7 days'. Reading stops as soon as older posts begin, so you only pay for posts in the range." }, "dateTo": { "title": "Posted until", "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|[+-][0-2]\\d:[0-5]\\d)?)?$|^(\\d+)\\s*(minute|hour|day|week|month|year)s?$", "type": "string", "description": "Only posts published on or before this day (UTC), or before a relative time such as '1 month'. The Actor jumps straight to that date, also in channels with years of posts." }, "keywords": { "title": "Keywords", "type": "array", "description": "Only posts that contain at least one of these words or phrases, in the text, linked addresses, link preview, file names or poll. Case does not matter, and a keyword also finds longer words that start with it (bitcoin finds Bitcoins). Put a keyword in quotes (\"AI\") to match the exact word only. Without Posted from, a search stops after looking through about 10,000 posts of a channel; monitoring runs read every new post. Posts without a match are not charged.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Skip posts that contain any of these words or phrases (same rules as Keywords).", "items": { "type": "string" } }, "onlyNewPosts": { "title": "Only new posts (monitoring)", "type": "boolean", "description": "Remembers the last post of each channel and returns only posts published since the previous run. The first run returns the latest posts as usual and marks the starting point. Schedule the Actor (for example every hour) to follow channels, together with Keywords for keyword alerts.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Names this monitor in alert titles and keeps its memory separate from other monitors of the same channels. Saved tasks get their own memory automatically." }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Posts new posts to a Slack channel (Incoming Webhook URL). Needs 'Only new posts'." }, "discordWebhookUrl": { "title": "Discord webhook URL", "type": "string", "description": "Posts new posts to a Discord channel. Needs 'Only new posts'." }, "webhookUrl": { "title": "Webhook URL (JSON)", "type": "string", "description": "Sends the new posts as JSON in a POST request, for example to Make, Zapier or n8n. Needs 'Only new posts'." }, "notifyEmail": { "title": "E-mail for alerts", "type": "string", "description": "Sends new posts by e-mail through the apify/send-mail Actor (about $0.001 of platform usage per e-mail). Use the e-mail address of your Apify account. Needs 'Only new posts'." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Usually not needed: the Actor reads Telegram directly. A proxy set here is used for every request.", "default": { "useApifyProxy": 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 } } } } } } } } } }