{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper: Messages & Search", "description": "Scrape public Telegram channel profiles and 60-field messages with reactions, polls, media, keyword search, date filters, and incremental checkpoints.", "version": "0.0", "x-build-id": "kYhRZtevU20p3G7Cl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapingmonkey~telegram-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapingmonkey-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/scrapingmonkey~telegram-scraper/runs": { "post": { "operationId": "runs-sync-scrapingmonkey-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/scrapingmonkey~telegram-scraper/run-sync": { "post": { "operationId": "run-sync-scrapingmonkey-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": [ "mode", "channels" ], "properties": { "mode": { "title": "Mode", "enum": [ "channelInfo", "messages", "searchMessages" ], "type": "string", "description": "Choose whether to return channel profiles, message history, or messages matching keywords.", "default": "channelInfo" }, "channels": { "title": "Public channels", "minItems": 1, "maxItems": 100, "type": "array", "description": "Public Telegram usernames, @usernames, or t.me URLs. Up to 100 channels per run.", "items": { "type": "string" }, "default": [ "durov" ] }, "searchTerms": { "title": "Message search terms", "maxItems": 20, "type": "array", "description": "Keywords or phrases required in searchMessages mode. Each term is searched separately in every channel.", "items": { "type": "string" }, "default": [ "Telegram" ] }, "maxMessages": { "title": "Maximum messages", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum messages per channel in messages mode, or per channel and search-term pair in searchMessages mode.", "default": 100 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of independent channels or channel/search-term pairs processed in parallel.", "default": 5 }, "afterMessageId": { "title": "Only messages after ID", "minimum": 0, "type": "integer", "description": "Optional exclusive global checkpoint. Only messages with a larger Telegram message ID are saved." }, "afterMessageIds": { "title": "Per-channel message checkpoints", "type": "object", "description": "Optional JSON object mapping channel usernames or URLs to exclusive last-seen message IDs. Per-channel values override the global checkpoint.", "additionalProperties": true }, "dateFrom": { "title": "Messages from", "type": "string", "description": "Optional inclusive ISO 8601 date or timestamp, for example 2025-01-01.", "default": "" }, "dateTo": { "title": "Messages to", "type": "string", "description": "Optional inclusive ISO 8601 date or timestamp, for example 2025-12-31.", "default": "" }, "includeServiceMessages": { "title": "Include service messages", "type": "boolean", "description": "Include public service records such as channel-created or channel-name-changed messages.", "default": true }, "mediaMode": { "title": "Media output", "enum": [ "urls", "none" ], "type": "string", "description": "Return public media URLs and metadata, or omit media extraction for smaller records.", "default": "urls" }, "downloadMedia": { "title": "Store media files", "type": "boolean", "description": "Download public message media through Apify Proxy and save successful files to the run Key-value store. Each saved file is a separate paid event.", "default": false }, "maxMediaFiles": { "title": "Maximum stored media files", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Run-wide safety limit used only when Store media files is enabled.", "default": 100 }, "maxMediaSizeMb": { "title": "Maximum size per media file (MB)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Skip individual public media files larger than this limit.", "default": 25 } } }, "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 } } } } } } } } } }