{
"openapi": "3.0.1",
"info": {
"title": "Telegram Channel Scraper – Posts, Views & Media",
"description": "Telegram scraper for public channels, no login or API key. Scrape Telegram channel messages with text, views, reactions, links, photos and videos, forwards and replies. Date and keyword filters plus a monitoring mode that returns only new posts. Export JSON, CSV or Excel.",
"version": "1.0",
"x-build-id": "fokeBXHEcOwHc5zCw"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/signalwharf~telegram-channel-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-signalwharf-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/signalwharf~telegram-channel-scraper/runs": {
"post": {
"operationId": "runs-sync-signalwharf-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/signalwharf~telegram-channel-scraper/run-sync": {
"post": {
"operationId": "run-sync-signalwharf-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 Telegram channel usernames or links, e.g. durov, @telegram or https://t.me/durov. Private invite links (t.me/+...) and groups without a public preview are not supported.",
"items": {
"type": "string"
}
},
"maxPostsPerChannel": {
"title": "Max posts per channel",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "Stop after saving this many posts from each channel (newest first). Each saved post is one billable result.",
"default": 100
},
"dateFrom": {
"title": "Posts from (date)",
"type": "string",
"description": "Only posts on or after this date. YYYY-MM-DD or full ISO datetime (UTC if no zone is given). Scraping stops once older posts are reached."
},
"dateTo": {
"title": "Posts until (date)",
"type": "string",
"description": "Only posts on or before this date (inclusive, end of day UTC)."
},
"keywords": {
"title": "Keyword filter",
"type": "array",
"description": "Optional. Keep only posts whose text or links contain at least one of these words or phrases (case-insensitive). Posts that do not match are not saved and not charged.",
"items": {
"type": "string"
}
},
"includeMedia": {
"title": "Include media URLs",
"type": "boolean",
"description": "Include photo, video, voice and link-preview image URLs. Media types are always returned. Note: Telegram CDN media URLs are temporary.",
"default": true
},
"onlyNewPosts": {
"title": "Only new posts since last run (monitoring mode)",
"type": "boolean",
"description": "Remembers the newest post ID per channel in a named key-value store and on later runs returns only posts newer than that. Ideal for scheduled runs, alerts and AI agents.",
"default": false
},
"stateStoreName": {
"title": "Monitoring state store name",
"type": "string",
"description": "Name of the key-value store used to remember the last seen post per channel. Use different names to run separate monitors.",
"default": "telegram-channel-scraper-state"
},
"resetMonitoringState": {
"title": "Reset monitoring state for these channels",
"type": "boolean",
"description": "Forget the last seen post for the listed channels before this run.",
"default": false
},
"maxPagesPerChannel": {
"title": "Max pages per channel",
"minimum": 1,
"type": "integer",
"description": "Safety limit on pagination (each page holds about 20 posts).",
"default": 500
},
"requestDelaySecs": {
"title": "Delay between requests (seconds)",
"minimum": 0.3,
"maximum": 30,
"type": "number",
"description": "Polite delay between page requests. Lower values are faster but more likely to be rate-limited.",
"default": 1.5
},
"maxRetries": {
"title": "Max retries per page",
"minimum": 0,
"maximum": 10,
"type": "integer",
"description": "Retries on rate limits (HTTP 429), server errors and network errors, with backoff.",
"default": 4
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Usually not needed. Enable if you scrape many channels and hit rate limits."
}
}
},
"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
},
"PROXY_UNBLOCKER_UNITS": {
"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
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}