{ "openapi": "3.0.1", "info": { "title": "Telegram Keyword Search Scraper", "description": "The most versatile Telegram scraper. Search message by keyword across all public channels, or scrape any channel's full history by username. No API key needed. 43 countries, 30 languages, real-time streaming.", "version": "0.1", "x-build-id": "pxjCIwRegwYKozXNT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lofomachines~telegram-keyword-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lofomachines-telegram-keyword-search-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/lofomachines~telegram-keyword-search-scraper/runs": { "post": { "operationId": "runs-sync-lofomachines-telegram-keyword-search-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/lofomachines~telegram-keyword-search-scraper/run-sync": { "post": { "operationId": "run-sync-lofomachines-telegram-keyword-search-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" ], "properties": { "mode": { "title": "Scraping mode", "enum": [ "keyword", "channel" ], "type": "string", "description": "Choose how to discover Telegram posts:\n\n- **Keyword Search** — searches your keywords across any public channel. Best for topic discovery.\n- **Channel Scraping** — paginates backwards through the history of channels you already know. Best for monitoring specific sources.", "default": "channel" }, "keywords": { "title": "Keywords", "type": "array", "description": "Words or phrases to search for. Each entry triggers a separate search across public Telegram posts. Example: `bitcoin`, `NATO offensive`, `crypto airdrop`.", "items": { "type": "string" } }, "afterDate": { "title": "Published after", "type": "string", "description": "Return only posts published **on or after** this date. Select a specific date or type a relative expression — e.g. `7 days`, `2 weeks`, `1 month`, `1 year`. Leave empty for no lower bound. *(Optional)*" }, "beforeDate": { "title": "Published before", "type": "string", "description": "Return only posts published **before** this date. Leave empty for no upper bound. *(Optional)*" }, "maxResultsPerKeyword": { "title": "Max results per keyword", "minimum": 10, "maximum": 100, "type": "integer", "description": "Maximum number of search results to collect per keyword. Results arrive in pages of 10 — higher values give broader coverage but take longer to run.", "default": 100 }, "countryCode": { "title": "Country", "type": "string", "description": "Regional bias for search results. Affects which regional results are prioritised. Select from the list or type any [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code. *(Optional)*", "default": "us" }, "languageCode": { "title": "Language", "type": "string", "description": "Language preference for search results. Select from the list or type any [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) code. *(Optional)*", "default": "en" }, "channels": { "title": "Channels", "type": "array", "description": "Public Telegram channel usernames to scrape. The `@` prefix is optional — both `durov` and `@durov` are accepted. Add one username per line.", "items": { "type": "string" } }, "channelMaxMessages": { "title": "Max messages per channel", "minimum": 10, "maximum": 100000, "type": "integer", "description": "Maximum number of messages to collect per channel. The scraper stops as soon as this limit **or** the *Published after* cutoff is reached — whichever comes first.", "default": 100 }, "channelAfterDate": { "title": "Published after", "type": "string", "description": "Collect only messages published **on or after** this date (inclusive). Select a specific date or type a relative expression — e.g. `7 days`, `2 weeks`, `1 month`, `1 year`. Leave empty to collect the most recent messages up to the limit above. *(Optional)*" } } }, "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 } } } } } } } } } }