{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper | Posts Messages", "description": "Scrape Telegram channels posts and messages. Export text, media, views, reactions, sender data, and links", "version": "0.1", "x-build-id": "2Z5Q0u39x9QfEm1Uk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/easytools~telegram-channel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-easytools-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/easytools~telegram-channel-scraper/runs": { "post": { "operationId": "runs-sync-easytools-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/easytools~telegram-channel-scraper/run-sync": { "post": { "operationId": "run-sync-easytools-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": [ "sources" ], "properties": { "sources": { "title": "Sources", "type": "array", "description": "List of Telegram sources to scrape. Supports @username, username, https://t.me/username, https://t.me/+inviteHash, and https://t.me/joinchat/inviteHash.", "items": { "type": "string" } }, "maxMessagesPerChannel": { "title": "Maximum messages per source", "type": "integer", "description": "Optional cap for the number of messages to process per source. Leave empty to scrape all available history from the current checkpoint." }, "downloadMedia": { "title": "Download media", "type": "boolean", "description": "When enabled, the actor downloads supported media artifacts into internal storage.", "default": true }, "mediaTypes": { "title": "Media types", "type": "array", "description": "Media types to keep or download. Recommended values for v1: photo, document, video, audio, webpage, poll.", "items": { "type": "string" } }, "includeReactions": { "title": "Include reactions", "type": "boolean", "description": "Include Telegram reaction counters in delivered message items.", "default": true }, "includeViews": { "title": "Include views", "type": "boolean", "description": "Include view counters when Telegram provides them.", "default": true }, "includeForwards": { "title": "Include forwards", "type": "boolean", "description": "Include forward counters when Telegram provides them.", "default": true }, "includeSender": { "title": "Include sender info", "type": "boolean", "description": "Include sender identity fields when available.", "default": true }, "includeWebpageArtifacts": { "title": "Include webpage artifacts", "type": "boolean", "description": "Include normalized webpage metadata for webpage posts.", "default": true }, "includePollArtifacts": { "title": "Include poll artifacts", "type": "boolean", "description": "Include normalized poll metadata for poll posts.", "default": true }, "keywords": { "title": "Keywords filter", "type": "array", "description": "Keep only messages containing at least one of these keywords.", "items": { "type": "string" } }, "mediaOnly": { "title": "Media only", "type": "boolean", "description": "Keep only posts that contain media artifacts.", "default": false }, "textOnly": { "title": "Text only", "type": "boolean", "description": "Keep only posts without downloadable media artifacts.", "default": false }, "fromDate": { "title": "From date", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Optional lower date bound. Select a calendar date. The UI returns the value in YYYY-MM-DD format." }, "toDate": { "title": "To date", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Optional upper date bound. Select a calendar date. The UI returns the value in YYYY-MM-DD format." }, "joinOnInvite": { "title": "Join invite links", "type": "boolean", "description": "When invite access is available, attempt to join or import the invite before scraping.", "default": true }, "resolveOnly": { "title": "Resolve only", "type": "boolean", "description": "Resolve and validate sources without full scraping.", "default": 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 } } }, "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 } } } } } } } } } }