{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper", "description": "Telegram channel scraper that exports public posts with views, reactions, and media, plus subscriber counts, so you can monitor t.me channels without a login or a bot token.", "version": "0.0", "x-build-id": "9uJZ2uMfGNBgLebWn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bigibyte~telegram-channel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bigibyte-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/bigibyte~telegram-channel-scraper/runs": { "post": { "operationId": "runs-sync-bigibyte-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/bigibyte~telegram-channel-scraper/run-sync": { "post": { "operationId": "run-sync-bigibyte-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": [ "mode", "channels" ], "properties": { "mode": { "title": "What to scrape", "enum": [ "posts", "post_details", "channel_info" ], "type": "string", "description": "Channel posts, one post per URL, or channel info only.", "default": "posts" }, "channels": { "title": "Channels or post URLs", "type": "array", "description": "Usernames (durov, @durov), channel URLs (https://t.me/durov, https://t.me/s/durov) or post URLs (https://t.me/durov/400).", "items": { "type": "string" } }, "searchQuery": { "title": "Keyword search inside channel", "type": "string", "description": "Optional. Uses Telegram's web preview search (?q=)." }, "dateFrom": { "title": "Only posts after", "type": "string", "description": "YYYY-MM-DD. Paging stops when older posts are reached." }, "dateTo": { "title": "Only posts before", "type": "string", "description": "YYYY-MM-DD. Posts newer than this date are skipped. Paging continues toward older posts." }, "includeChannelInfo": { "title": "Add channel info to each post", "type": "boolean", "description": "Attach the channel title, subscriber count, and description on each post row.", "default": false }, "includeServiceMessages": { "title": "Include service messages", "type": "boolean", "description": "Keep service messages such as the channel-created notice. They are skipped by default.", "default": false }, "textFormat": { "title": "Text format", "enum": [ "text", "markdown", "html" ], "type": "string", "description": "How to store the post text. textHtml is always the HTML, when the post has text.", "default": "text" }, "maxItems": { "title": "Max results (total)", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Free version cap: 2,000 per run.", "default": 100 }, "maxPostsPerChannel": { "title": "Max posts per channel", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Stop paging a channel after this many posts. The run also stops at max results.", "default": 100 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many requests can run at once.", "default": 5 }, "timeoutSecs": { "title": "Run timeout (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Stop the run after this many seconds and keep the rows already saved.", "default": 300 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Per-request timeout.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed normally. Enable only if you see 429 or 403.", "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 }, "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 } } } } } } } } } }