{ "openapi": "3.0.1", "info": { "title": "Telegram Channel Search – Find Channels by Keyword", "description": "Find public Telegram channels and groups by keyword or from seed channels. Snowball via forwards, links and mentions. Subscribers, verified flag, last post, matching posts. No login. $3 per 1,000 channels.", "version": "0.1", "x-build-id": "PD3NHDwwEX5eyrdZP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ryumoon-data~telegram-channel-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ryumoon-data-telegram-channel-finder", "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/ryumoon-data~telegram-channel-finder/runs": { "post": { "operationId": "runs-sync-ryumoon-data-telegram-channel-finder", "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/ryumoon-data~telegram-channel-finder/run-sync": { "post": { "operationId": "run-sync-ryumoon-data-telegram-channel-finder", "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": { "seedChannels": { "title": "Seed channels", "type": "array", "description": "Public channels to start from (usernames or t.me links). The Actor reads their recent posts and follows the channels they forward from, link to or @mention. Directory-style channels and news aggregators make the best seeds.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Topic words, brands or phrases, e.g. [\"bitcoin\", \"remote jobs\"]. You can use keywords alone (no seed channels). Used to (1) try matching channel usernames such as 'bitcoinnews', (2) search each found channel's posts with Telegram's in-channel search, and (3) keep only channels that match.", "items": { "type": "string" } }, "probeUsernamesFromKeywords": { "title": "Probe usernames from keywords", "type": "boolean", "description": "Try likely usernames built from each keyword (e.g. bitcoin, bitcoinnews, bitcoin_news, thebitcoin) as extra starting points. Lets you search with keywords only, no seeds.", "default": true }, "maxProbesPerKeyword": { "title": "Usernames to try per keyword", "minimum": 0, "maximum": 40, "type": "integer", "description": "How many username guesses to try for each keyword.", "default": 12 }, "maxDepth": { "title": "Discovery depth", "minimum": 0, "maximum": 3, "type": "integer", "description": "0 = only check the seeds and probed usernames. 1 = also check every channel they reference. 2 = also the channels those reference (grows fast).", "default": 1 }, "pagesPerChannel": { "title": "Post pages to read per channel for discovery", "minimum": 1, "maximum": 10, "type": "integer", "description": "Each page is about 20 recent posts. More pages find more referenced channels but take more requests.", "default": 1 }, "searchPostsForKeywords": { "title": "Search each channel's posts for the keywords", "type": "boolean", "description": "Uses Telegram's public in-channel search (one request per keyword per channel) to count matching posts and return sample matches. Off = only check title, description and the recent posts already read.", "default": true }, "onlyMatchingChannels": { "title": "Only return channels matching a keyword", "type": "boolean", "description": "When keywords are set, skip channels whose username, title, description and posts don't contain any keyword.", "default": true }, "includeSeedChannels": { "title": "Include the seed channels in results", "type": "boolean", "description": "Also return a row for each seed channel.", "default": true }, "includeGroups": { "title": "Include public groups", "type": "boolean", "description": "Return public groups too (title, description and member count only; never member lists).", "default": true }, "minSubscribers": { "title": "Minimum subscribers / members", "minimum": 0, "type": "integer", "description": "Skip discovered channels smaller than this.", "default": 0 }, "activeWithinDays": { "title": "Posted within the last N days", "minimum": 0, "type": "integer", "description": "Skip channels whose last visible post is older than this. 0 = no filter. Channels without a web preview have no post date and are skipped when this is set.", "default": 0 }, "maxSampleMatches": { "title": "Sample matching posts per channel", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many matching posts (link, date, views and a text snippet) to include per channel.", "default": 3 }, "maxChannels": { "title": "Max channels to return", "minimum": 1, "type": "integer", "description": "Stops when this many channels/groups have been saved. Use it to cap cost.", "default": 50 }, "maxCandidates": { "title": "Max candidates to check", "minimum": 1, "type": "integer", "description": "Upper bound on usernames checked (including ones filtered out).", "default": 300 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Channels checked at the same time.", "default": 3 }, "requestDelayMs": { "title": "Delay before each request (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Keeps the request rate polite towards t.me.", "default": 500 }, "maxRequestRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 8, "type": "integer", "description": "Retries with back-off when t.me rate-limits or fails.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Usually not needed. Use a proxy for very large discovery runs.", "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 } } } } } } } } } }