{ "openapi": "3.0.1", "info": { "title": "Telegram Channel & Group Scraper (Public HTTP & BYOS OSINT)", "description": "High-performance zero-ban Telegram scraper. Scrapes public channels with zero authentication at ultra-low compute (<$0.02/1k msgs), or private groups via BYOS Gram.js session. AI & RAG ready.", "version": "1.0", "x-build-id": "90k46W5Kol5t15XuS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mr_hardcoded~telegram-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mr_hardcoded-telegram-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/mr_hardcoded~telegram-scraper/runs": { "post": { "operationId": "runs-sync-mr_hardcoded-telegram-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/mr_hardcoded~telegram-scraper/run-sync": { "post": { "operationId": "run-sync-mr_hardcoded-telegram-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 / Groups", "type": "array", "description": "List of Telegram channel usernames, channel URLs (e.g. 'https://t.me/durov' or 'durov'), or group identifiers.", "items": { "type": "string" } }, "maxMessagesPerChannel": { "title": "Max Messages Per Channel", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of messages to scrape per channel. Scrapes in reverse chronological order (newest first).", "default": 100 }, "mode": { "title": "Scraping Mode", "enum": [ "PUBLIC_HTTP", "BYOS_GRAMJS" ], "type": "string", "description": "Mode A (Public HTTP) scrapes public channels with zero bans and no credentials at <$0.02/1k msgs. Mode B (BYOS Gram.js) connects using your session string for private groups.", "default": "PUBLIC_HTTP" }, "telegramSession": { "title": "BYOS Telegram String Session", "type": "string", "description": "Only required for Mode B (BYOS). Enter your Telegram StringSession string to access private groups/channels." }, "telegramApiId": { "title": "BYOS Telegram API ID", "type": "integer", "description": "Optional Telegram API ID from my.telegram.org (defaults to standard client ID if omitted)." }, "telegramApiHash": { "title": "BYOS Telegram API Hash", "type": "string", "description": "Optional Telegram API Hash from my.telegram.org." }, "query": { "title": "Keyword Search Filter", "type": "string", "description": "Optional search term to filter messages by keyword or regex." }, "outputFormat": { "title": "Output Format", "enum": [ "AI_RAG", "RAW_JSON" ], "type": "string", "description": "Format for output records. 'AI_RAG' generates embeddings-ready markdown chunks with full metadata for vector DB ingestion.", "default": "AI_RAG" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy configuration. Public HTTP mode does not require proxies, but residential or datacenter proxies can be used if desired.", "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 } } } } } } } } } }