{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Posts Scraper", "description": "Collect public Telegram channel posts with date, text, views, photos, video, links and reactions, plus optional channel profiles with subscriber counts. Reads the public t.me/s preview with no login or phone number; filter by date or keyword. Channels without a preview return a status row.", "version": "0.0", "x-build-id": "eT7JpcaRXKsJBUBhk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~telegram-channel-posts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-telegram-channel-posts-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/axiomworks~telegram-channel-posts-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-telegram-channel-posts-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/axiomworks~telegram-channel-posts-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-telegram-channel-posts-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 (required)", "type": "array", "description": "Public Telegram channels to scrape, as usernames or t.me URLs. Required, at least one. Example: [\"durov\", \"@telegram\", \"https://t.me/bbcnews\"]. Private channels, groups and invite links return a channel-status record instead of posts.", "items": { "type": "string" } }, "maxPostsPerChannel": { "title": "Posts per channel", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum post records collected per channel, integer 1-1000, default 50. Example: 20. Newest posts come first.", "default": 50 }, "maxItems": { "title": "Maximum total records", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on total records across all channels, including channel profile records, integer 1-10000, default 1000. Example: 100.", "default": 1000 }, "dateFrom": { "title": "Date from", "type": "string", "description": "Only posts on or after this date. ISO date or timestamp, for example 2026-01-01 or 2026-01-01T12:00:00Z. Leave empty for no lower bound." }, "dateTo": { "title": "Date to", "type": "string", "description": "Only posts on or before this date. ISO date or timestamp, for example 2026-09-30 (a date alone includes the whole UTC day). Leave empty for no upper bound." }, "afterPostIds": { "title": "Post checkpoints", "type": "object", "description": "Monitoring checkpoints: object mapping channel to the last post ID you already have, for example {\"durov\": 525}. Only posts with a higher ID are returned. Keys accept usernames, @handles or t.me URLs. Default empty.", "default": {}, "additionalProperties": true }, "searchQuery": { "title": "Search query", "type": "string", "description": "Keyword or phrase to search inside each channel via Telegram web search, at most 200 characters, for example 'bitcoin'. Leave empty to get the most recent posts." }, "includeChannelInfo": { "title": "Include channel profile", "type": "boolean", "description": "true adds one channel profile record per channel (title, description, subscribers, photo/video/link counts). false returns posts only. Default true.", "default": true }, "enrich": { "title": "Enrich posts with AI", "type": "boolean", "description": "true adds AI-classified topic and sentiment to each post via the third-party TypeSafe AI processor, billed as an extra enriched-result event per labelled post. If unavailable, topic and sentiment stay null and nothing extra is charged. Default false.", "default": false }, "maxJevCalls": { "title": "Max AI-labelled posts", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cap on posts sent for AI labelling in one run, integer 1-500, default 500. Only used when enrich is true.", "default": 500 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings, for example {\"useApifyProxy\": true}. Default datacenter proxy; blocked requests retry on fresh sessions and may fall back to residential. Disable only for local testing.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }