{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper - Full History & Media", "description": "Export the complete post history of any public Telegram channel: text, direct media URLs, reactions, polls, replies and forwards. No account, phone number or API key, and no cap on messages per channel.", "version": "0.1", "x-build-id": "e4fqyOTAmKZcmIqcx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/monkey.d.scraping~telegram-channel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-monkey.d.scraping-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/monkey.d.scraping~telegram-channel-scraper/runs": { "post": { "operationId": "runs-sync-monkey.d.scraping-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/monkey.d.scraping~telegram-channel-scraper/run-sync": { "post": { "operationId": "run-sync-monkey.d.scraping-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", "properties": { "channels": { "title": "Channels", "type": "array", "description": "Public Telegram channels to export. The `@` prefix is optional and full links work too — `durov`, `@durov` and `https://t.me/durov` are all accepted. Add one channel per line.", "items": { "type": "string" } }, "maxMessagesPerChannel": { "title": "Max messages per channel", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "How many messages to export from each channel. Clear the field to export the **complete history** of every channel, all the way back to its first post.", "default": 100 }, "afterDate": { "title": "Published after", "type": "string", "description": "Export only messages published **on or after** this date. Pick a date or type a relative expression — e.g. `7 days`, `2 weeks`, `1 month`, `1 year`. Deep date cutoffs are located directly, without paging through the newer history first. *(Optional)*" }, "beforeDate": { "title": "Published before", "type": "string", "description": "Export only messages published **on or before** this date. Combine with *Published after* to pull one exact window out of a long history. *(Optional)*" }, "outputPreset": { "title": "Output format", "enum": [ "full", "compact", "llm" ], "type": "string", "description": "Pick the shape that matches where the data is going next.", "default": "full" }, "includeChannelInfo": { "title": "Include channel details", "type": "boolean", "description": "Adds subscriber count, verification badge, description, avatar and the channel's photo, video, file and link counters. Free — channel details are never charged as results.", "default": true }, "downloadMedia": { "title": "Download media files", "type": "boolean", "description": "Off by default, because direct media URLs are always included and keep runs fast. When on, available public photos and videos are also saved to this run's key-value store.", "default": false }, "includeKeywords": { "title": "Must contain", "type": "array", "description": "Keep a message only when its text contains at least one of these phrases. *(Optional)*", "items": { "type": "string" } }, "excludeKeywords": { "title": "Must not contain", "type": "array", "description": "Drop a message when its text contains any of these phrases. *(Optional)*", "items": { "type": "string" } }, "regexFilters": { "title": "Regular expressions", "type": "array", "description": "Keep a message only when its text matches at least one JavaScript-compatible pattern. *(Optional)*", "items": { "type": "string" } }, "postUrls": { "title": "Single post URLs", "type": "array", "description": "Export only these exact posts, e.g. `https://t.me/durov/342`. Useful for enriching a list of links you already have. Works on its own or alongside the channels above. *(Optional)*", "items": { "type": "string" } }, "fromMessageId": { "title": "Resume after message ID", "minimum": 1, "type": "integer", "description": "Export only messages newer than this ID. Store the highest `messageId` from your last run here to pull just what has been posted since. *(Optional)*" }, "sortOrder": { "title": "Order of results", "enum": [ "newestFirst", "oldestFirst" ], "type": "string", "description": "Newest first streams results as they are found. Oldest first waits for each channel to finish before writing it out.", "default": "newestFirst" }, "maxMessages": { "title": "Max messages for the whole run", "minimum": 1, "maximum": 5000000, "type": "integer", "description": "A single ceiling across every channel, for predictable cost on large runs. *(Optional)*" } } }, "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 } } } } } } } } } }