{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper", "description": "Extracts posts from public Telegram channels with views, dates, text, hashtags, media URLs, link previews and forwards. Reaches full channel history, supports keyword search and incremental monitoring, and exports to JSON, CSV or Excel.", "version": "1.0", "x-build-id": "hEgmbKHqMMF2Ka2e6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/innovatica-ai~telegram-channel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-innovatica-ai-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/innovatica-ai~telegram-channel-scraper/runs": { "post": { "operationId": "runs-sync-innovatica-ai-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/innovatica-ai~telegram-channel-scraper/run-sync": { "post": { "operationId": "run-sync-innovatica-ai-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": "Telegram channels", "type": "array", "description": "Public channels to scrape. Accepts @handle, a bare handle, or a t.me link — e.g. @durov, durov, https://t.me/durov. Private channels, groups and bots are not accessible.", "items": { "type": "string" } }, "postUrls": { "title": "Individual post URLs", "type": "array", "description": "Links to single posts, e.g. https://t.me/durov/538. Returns just those messages.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQuery": { "title": "Search within channels", "type": "string", "description": "Only return posts containing this term. Note: Telegram's channel search returns a single page of about 20 results and cannot be paged, so this is best for finding recent mentions rather than exhaustive history." }, "includeChannelInfo": { "title": "Include a channel summary row", "type": "boolean", "description": "Adds one extra row per channel with its title, description, subscriber count and media counts.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Hard cap on how many rows this run returns in total. Controls your cost.", "default": 200 }, "maxPostsPerChannel": { "title": "Maximum posts per channel", "minimum": 1, "maximum": 100000, "type": "integer", "description": "How far back to go in each channel, newest first. Telegram exposes the full history, so raise this to archive an entire channel.", "default": 100 }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "How many channels to fetch in parallel. Lower it if you see failures.", "default": 5 }, "minViews": { "title": "Minimum views", "minimum": 0, "type": "integer", "description": "Skip posts below this view count." }, "mustContain": { "title": "Must contain text", "type": "string", "description": "Keep only posts whose text contains this string (case-insensitive). Applied after fetching, so unlike Search it works across full history." }, "onlyWithMedia": { "title": "Only posts with photos or video", "type": "boolean", "description": "Skip text-only posts.", "default": false }, "postedAfter": { "title": "Posted after", "type": "string", "description": "Only keep posts published on or after this date." }, "postedBefore": { "title": "Posted before", "type": "string", "description": "Only keep posts published on or before this date." }, "onlyNewResults": { "title": "Only return posts not seen before", "type": "boolean", "description": "Remembers the newest post collected per channel and returns only what has appeared since. Use this for scheduled monitoring so you only pay for genuinely new content.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Telegram serves these pages without blocking datacenter IPs, so no proxy is needed and leaving this off keeps your run cheaper. Enable it only if your own network blocks t.me.", "default": { "useApifyProxy": 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 } } } } } } } } } }