{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper", "description": "Posts from any public Telegram channel, with views, media, links and polls, without a Telegram account or phone number. Only-new mode for schedules. Half a cent per channel, a tenth of a cent per post.", "version": "1.0", "x-build-id": "2BT3EvoAUnf1tRME8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/asgardlabs~telegram-channel-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-asgardlabs-telegram-channel-api", "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/asgardlabs~telegram-channel-api/runs": { "post": { "operationId": "runs-sync-asgardlabs-telegram-channel-api", "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/asgardlabs~telegram-channel-api/run-sync": { "post": { "operationId": "run-sync-asgardlabs-telegram-channel-api", "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 links: durov, @telegram, https://t.me/bloomberg. Case does not matter. Private invite links (t.me/+…) are not supported.", "items": { "type": "string" } }, "maxPostsPerChannel": { "title": "Max posts per channel", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Newest posts first. 20 posts per page are read, so 100 posts is about 5 requests.", "default": 100 }, "onlyNew": { "title": "Only posts newer than the last run", "type": "boolean", "description": "Remembers the last post id per channel in a key-value store. Ideal for hourly/daily schedules.", "default": false }, "minDate": { "title": "Only posts after (ISO date)", "type": "string", "description": "e.g. 2026-09-01" }, "query": { "title": "Search inside channel (Telegram search)", "type": "string", "description": "Uses Telegram's own channel search; returns matching posts only." }, "keywords": { "title": "Keyword filter (any match, applied to text)", "type": "array", "description": "Keep only posts whose text contains at least one of these words, case-insensitive. Filtered posts are not charged.", "default": [], "items": { "type": "string" } }, "includeHtml": { "title": "Include message HTML", "type": "boolean", "description": "Add the post's formatted HTML next to the plain text. Rows get larger.", "default": false }, "timeoutSecs": { "title": "Time budget per channel (seconds)", "minimum": 10, "maximum": 3600, "type": "integer", "description": "A channel that takes longer is reported as timed out and not charged.", "default": 300 }, "concurrency": { "title": "Channels in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many channels to read at the same time. Telegram rate-limits bursts; four is safe.", "default": 4 }, "stateStoreName": { "title": "State store name", "pattern": "^[a-zA-Z0-9-]{1,63}$", "type": "string", "description": "Key-value store in your account that keeps the last post id per channel for \"only new\". Letters, digits and dashes.", "default": "telegram-channel-state" } } }, "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 } } }, "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 } } } } } } } } } }