{ "openapi": "3.0.1", "info": { "title": "Telegram Info Scraper", "description": "Looks up public Telegram channels, groups, bots and users by username or t.me link: titles, bios, member counts, verification, preview counters, post stats, a liveliness score and an HTML report.", "version": "0.1", "x-build-id": "Qe6eZ4I4nIwIenjYA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solalab_digital~telegram-info-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solalab_digital-telegram-info-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/solalab_digital~telegram-info-scraper/runs": { "post": { "operationId": "runs-sync-solalab_digital-telegram-info-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/solalab_digital~telegram-info-scraper/run-sync": { "post": { "operationId": "run-sync-solalab_digital-telegram-info-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": [ "targets" ], "properties": { "targets": { "title": "Telegram targets", "type": "array", "description": "What to look up: a plain username, an @handle, or any t.me / telegram.me link, including links to a single post or to t.me/s/. Up to 1000 entries; duplicates that resolve to the same username are looked up once. Private links (t.me/c/..., t.me/+..., joinchat) have no public page and are never fetched.", "default": [ "telegram", "durov", "BotFather" ], "items": { "type": "string" } }, "fetchPreview": { "title": "Fetch the channel preview", "type": "boolean", "description": "Also open t.me/s/ for channels to read post counters, the channel ID, the latest post date and the liveliness score. Turn it off for one request per target and card fields only. Groups, bots and users have no web preview, so this never costs anything for them.", "default": true }, "maxPosts": { "title": "Posts per channel", "minimum": 0, "maximum": 500, "type": "integer", "description": "Include the last N posts of each channel in its row, with date, views, reactions and text. 0 keeps rows small and adds no requests. Every 20 posts beyond the first page costs one extra request per channel.", "default": 0 }, "includeFailedRows": { "title": "Also write unavailable targets", "type": "boolean", "description": "Off by default: targets that do not exist, are private or failed are reported in the log and in the HTML report, but no row is written and nothing is charged for them. Turn it on to get a row with status and errorMessage for every target you asked for - those rows are billed like any other.", "default": false }, "compareWithPrevious": { "title": "Compare with the previous run", "type": "boolean", "description": "Load the member counts stored by the last run under the same monitor key and add the change to every row. The first run has nothing to compare against and reports nulls, not zeros.", "default": false }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Name of the snapshot slot, so separate target lists can be tracked independently.", "default": "default" }, "maxConcurrency": { "title": "Parallel targets", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many targets are looked up at the same time.", "default": 2 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Pause each worker takes after every request. Doubled automatically when Telegram answers 429, then eased back down.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy. Not needed for small runs; useful if a long list starts drawing 429s or blocks. Without it the actor connects directly.", "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 } } } } } } } } } }