{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper", "description": "Give it a public Telegram channel and get its profile plus messages: text, exact publish time, views, reactions, forwards, replies and media links. Subscriber counts are exact, not the rounded 11M the preview page shows. Channels with no web preview return the reason, not an empty file.", "version": "0.1", "x-build-id": "VsqW9NH2odlihoIjN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/garnet_puppet~telegram-channel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-garnet_puppet-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/garnet_puppet~telegram-channel-scraper/runs": { "post": { "operationId": "runs-sync-garnet_puppet-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/garnet_puppet~telegram-channel-scraper/run-sync": { "post": { "operationId": "run-sync-garnet_puppet-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 channel usernames or t.me links. Accepted forms: durov, @durov, t.me/durov, https://t.me/s/durov.", "default": [ "durov" ], "items": { "type": "string" } }, "maxMessagesPerChannel": { "title": "Max messages per channel", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many messages to return for each channel. Telegram serves 20 messages per page request.", "default": 100 }, "searchQuery": { "title": "Search inside channel", "type": "string", "description": "Optional keyword. When set, only messages matching this keyword inside the given channels are returned." }, "sinceDate": { "title": "Only messages after this date", "type": "string", "description": "ISO date, for example 2026-01-31. Pagination stops once older messages are reached." }, "afterMessageId": { "title": "Only messages after this ID", "type": "integer", "description": "Manual watermark. Only messages with a higher ID are returned." }, "incremental": { "title": "Incremental mode", "type": "boolean", "description": "Remember the last message ID per channel and return only new messages on the next run.", "default": false }, "includeChannelInfo": { "title": "Include channel profile", "type": "boolean", "description": "Emit one channel record per channel with the exact subscriber count, title, description and photo.", "default": true }, "includeMedia": { "title": "Include media links", "type": "boolean", "description": "Return photo, video, voice and sticker URLs. Files are never downloaded.", "default": true }, "extractEmails": { "title": "Extract e-mail addresses", "type": "boolean", "description": "Find e-mail addresses written in the message text.", "default": true }, "verifyEmails": { "title": "Verify e-mail domains", "type": "boolean", "description": "Run an MX lookup for every extracted address and report provider, role, free and disposable flags. Mailbox existence is never claimed.", "default": true }, "maxRequestsPerChannel": { "title": "Max requests per channel", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard safety cap on the number of page requests made for a single channel.", "default": 60 } } }, "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 } } } } } } } } } }