{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Scraper Goat", "description": "Scrape messages from public Telegram channels in bulk. Returns one clean row per message with id, date, text, views, media flags, media URLs, forwards, and links, plus an optional channel info summary.", "version": "0.1", "x-build-id": "G8HjAiE7KhDckJR0r" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/goat255~telegram-channel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-goat255-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/goat255~telegram-channel-scraper/runs": { "post": { "operationId": "runs-sync-goat255-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/goat255~telegram-channel-scraper/run-sync": { "post": { "operationId": "run-sync-goat255-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": "Telegram Channels or URLs", "type": "array", "description": "List of public Telegram channel handles or URLs. Mix formats freely: example_channel, @example_channel, https://t.me/example_channel.", "default": [ "telegram" ], "items": { "type": "string" } }, "maxMessagesPerChannel": { "title": "Max messages per channel", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of messages to return per channel, newest first. The scraper pages through older messages until this limit is reached or the channel runs out.", "default": 50 }, "includeChannelInfo": { "title": "Include channel info", "type": "boolean", "description": "When true, also output one channel info summary row per channel with title, subscriber count, description, and photo.", "default": true }, "exportMembers": { "title": "Export members", "type": "boolean", "description": "When true, also export the channel's visible members: the people who publicly participate in the channel's discussion. To take part a user must be a member of the channel's linked discussion group, so these are real, identifiable members. Each member row carries a public username, profile link, display name, and avatar. Channels that do not have public discussion return a single not_available result. Note: Telegram never exposes a channel's full subscriber list to a scraper, so this returns the members who are publicly visible, not the entire subscriber count. Off by default.", "default": false }, "maxMembersPerChannel": { "title": "Max members per channel", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Cap on the number of distinct members returned per channel when Export members is on. The scraper pages through the discussion until this limit is reached or no more visible members remain. Only used when Export members is enabled.", "default": 200 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of channels processed in parallel.", "default": 4 }, "delayBetweenRequests": { "title": "Delay Between Requests (seconds)", "minimum": 0, "type": "number", "description": "Seconds to wait between page fetches inside a single channel pipeline.", "default": 1 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. The scraper works without a proxy by default; configure a proxy for large jobs or to spread load.", "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 } } } } } } } } } }