{ "openapi": "3.0.1", "info": { "title": "Telegram Channel and Group Scraper (tgstat, telegramic)", "description": "Collect Telegram channel and group listings from tgstat and telegramic in one row shape: name, @handle, t.me link, category, members, growth, post reach, language and country where reported. Filter by directory, channel or group, category, country ranking and ranking order.", "version": "0.1", "x-build-id": "ve6w9K8DRhkaEV2Kr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jungle_synthesizer~tgstat-telegramic-group-directory-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jungle_synthesizer-tgstat-telegramic-group-directory-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/jungle_synthesizer~tgstat-telegramic-group-directory-scraper/runs": { "post": { "operationId": "runs-sync-jungle_synthesizer-tgstat-telegramic-group-directory-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/jungle_synthesizer~tgstat-telegramic-group-directory-scraper/run-sync": { "post": { "operationId": "run-sync-jungle_synthesizer-tgstat-telegramic-group-directory-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", "properties": { "sp_intended_usage": { "title": "What is the intended usage of this data?", "minLength": 1, "type": "string", "description": "What will this data feed? E.g. lead lists, KYB checks, price tracking." }, "sp_improvement_suggestions": { "title": "How can we improve this crawler for you?", "minLength": 1, "type": "string", "description": "Provide any feedback or suggestions for improvements." }, "sp_contact": { "title": "Contact email (optional)", "minLength": 1, "type": "string", "description": "We'll personally help with your use case. No spam." }, "resumeCursor": { "title": "Resume cursor (continue a previous run)", "type": "string", "description": "Leave empty for a fresh crawl. To CONTINUE a previous run where it stopped — without paying again for records you already received — paste the `resumeCursor` value from that run's Output (the run's OUTPUT key). Resume promptly: the previous run's data expires with your account's retention window (free tier: your ~10 most recent runs)." }, "sources": { "title": "Directories", "type": "array", "description": "Which directories to read. Leave empty for both.", "items": { "type": "string", "enum": [ "tgstat", "telegramic" ], "enumTitles": [ "tgstat (ranked top lists, growth and reach)", "telegramic (browse directory, language and about text)" ] } }, "groupTypes": { "title": "Channels or groups", "type": "array", "description": "Channels broadcast to subscribers, groups are chats members post in. Leave empty for both.", "items": { "type": "string", "enum": [ "channel", "group" ], "enumTitles": [ "Channels", "Groups" ] } }, "categories": { "title": "Categories", "type": "array", "description": "Only listings in these categories. Each directory names its categories differently, so a directory without the category you pick contributes nothing for it. Leave empty for every category.", "items": { "type": "string", "enum": [ "news", "crypto", "tech", "economics", "entertainment", "education", "games", "music", "sport", "travel", "politics", "art", "design", "books", "health", "language", "beauty", "shopping", "science", "programming", "anime", "self-development", "tv-series-movies", "fitness", "animals", "celebrities", "funny", "jobs-marketing", "photo-video", "social-fun", "do-it-yourself", "analytics", "blogs", "random-talk", "business", "marketing", "psychology", "law", "career", "courses", "medicine", "pics", "video", "food", "quotes", "handmade", "babies", "nature", "construction", "instagram", "telegram", "transport", "religion", "esoterics", "edutainment", "apps", "other" ], "enumTitles": [ "News & Media", "Cryptocurrency", "Technology", "Economics", "Entertainment", "Education", "Games & Apps", "Music", "Sports", "Travel", "Politics", "Art", "Design", "Books", "Health", "Languages", "Beauty", "Shopping & Sales", "Science", "Programming", "Anime", "Self-development", "TV Series & Movies", "Fitness", "Animals", "Celebrities", "Funny", "Jobs & Marketing", "Photo & Video", "Social & Fun", "Do It Yourself", "Analytics", "Blogs", "Random Talk", "Business & Startups", "Marketing & Advertising", "Psychology", "Law", "Career", "Courses & Guides", "Medicine", "Pictures", "Video & Films", "Food & Cooking", "Quotes", "Handmade", "Parents & Children", "Nature", "Construction & Repair", "Instagram", "Telegram", "Transport", "Religion", "Esoterics", "Edutainment", "Apps & Software", "Other" ] } }, "regions": { "title": "tgstat regional rankings", "type": "array", "description": "tgstat publishes a separate ranking per country. Pick the countries whose rankings you want; each row records the country it was ranked in. Leave empty for the global ranking. Ignored for telegramic.", "items": { "type": "string", "enum": [ "global", "ua", "by", "uz", "kz", "kg", "ir", "cn", "in", "et" ], "enumTitles": [ "Global", "Ukraine", "Belarus", "Uzbekistan", "Kazakhstan", "Kyrgyzstan", "Iran", "China", "India", "Ethiopia" ] } }, "rankings": { "title": "tgstat ranking order", "type": "array", "description": "tgstat lists the top 100 per ranking, so each extra ranking surfaces different listings. Channel-only orders are skipped for groups and the reverse. Leave empty for most members. Ignored for telegramic.", "items": { "type": "string", "enum": [ "members", "members_7d", "members_30d", "members_t", "members_y", "reach", "ci", "mau", "msgs" ], "enumTitles": [ "Most members", "Growth, last 7 days", "Growth, last 30 days", "Growth, today", "Growth, yesterday", "Post reach (channels)", "Citation index (channels)", "Monthly active users (groups)", "Most messages (groups)" ] } }, "maxItems": { "title": "Max Items", "minimum": 1, "type": "integer", "description": "Maximum number of listings to return.", "default": 15 } } }, "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 } } } } } } } } } }