{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper: Whole Message History", "description": "A public Telegram channel's messages back to its first post, with views and every reaction. $0.50 per 1,000 messages. Media links, polls and the subscriber count.", "version": "0.1", "x-build-id": "TdfcnYbcNEAftNEk9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/luzivanlt~telegram-channels-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-luzivanlt-telegram-channels-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/luzivanlt~telegram-channels-scraper/runs": { "post": { "operationId": "runs-sync-luzivanlt-telegram-channels-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/luzivanlt~telegram-channels-scraper/run-sync": { "post": { "operationId": "run-sync-luzivanlt-telegram-channels-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": "Channels", "type": "array", "description": "Public Telegram channels to read: a username (durov or @durov), a channel link (https://t.me/durov, t.me/s/durov or telegram.me/durov) or a link to one of its posts (https://t.me/durov/300), which starts the read at that post and goes back from there. Each channel gives you its messages, newest first. Invite links (t.me/+…) and private channels cannot be read. Example: telegram", "items": { "type": "string" } }, "onlyMessagesNewerThan": { "title": "Only messages newer than", "type": "string", "description": "Keep only messages from this date on: a date (YYYY-MM-DD, UTC) or a period, e.g. \"7 days\", \"2 weeks\", \"3 months\" or \"1 year\". The date cannot be in the future. Applies to every channel; older messages are not saved or charged. Leave empty for the whole history." }, "maxMessagesPerChannel": { "title": "Max messages per channel", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop reading a channel after this many messages, newest first, from 1 to 50,000. The form starts at 500; left empty, it is 100. Each message is charged once ($0.50 per 1,000 messages), so this caps what one channel costs: 1,000 messages cost at most $0.50.", "default": 100 }, "includeServiceMessages": { "title": "Include service messages", "type": "boolean", "description": "Also save the channel's service messages, such as \"Channel created\" or a new channel photo. Off by default: they carry no post. When on, each service message saved is a row, charged like any other message.", "default": false }, "onlyNewItems": { "title": "Only new messages", "type": "boolean", "description": "Turn this on for a scheduled run, or a re-run of the same task: each run then returns only the messages it has not returned before, reading each channel back to a day before the last run that read it. Skipped messages are neither saved nor charged; each new message is charged as usual. Runs with other settings, or from another task, keep their own list. Off by default." } } }, "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 } } } } } } } } } }