{
  "openapi": "3.0.1",
  "info": {
    "title": "Telegram Channel Scraper: Monitor Posts & Keyword Search",
    "description": "Monitor public Telegram channels for new posts, or find channels by keyword through a web search: text, date, views, reactions, media, cashtags, Slack or Discord alerts. Input: channel names or keywords. No login. $0.30 per 1,000 posts on Free, $0.22 on Business.",
    "version": "0.1",
    "x-build-id": "q66QoGCtqIw6hmo4u"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/fetchwright~telegram-channel-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-fetchwright-telegram-channel-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/fetchwright~telegram-channel-scraper/runs": {
      "post": {
        "operationId": "runs-sync-fetchwright-telegram-channel-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/fetchwright~telegram-channel-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-fetchwright-telegram-channel-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": {
          "channels": {
            "title": "Channels",
            "type": "array",
            "description": "Required, unless you search by keyword below or read channels from a dataset. Public Telegram channels, one per line. Any form works, for example **durov**, **@durov**, **https://t.me/durov** or a post link such as **t.me/durov/123** (the whole channel is read). Duplicates are removed. Invite links to private channels are reported as unavailable and never charged.",
            "items": {
              "type": "string"
            }
          },
          "maxPostsPerChannel": {
            "title": "Maximum posts per channel",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many posts from each channel, for example **20** for a quick look or **5000** for a full archive. You pay $0.30 per 1,000 posts saved, so this caps the cost of a run. Default: 100. Up to 100,000.",
            "default": 100
          },
          "searchQuery": {
            "title": "Only posts containing",
            "type": "string",
            "description": "Optional. Return only posts that match this word or phrase, searched inside each channel, for example **bitcoin** or a hashtag such as **#update**. Leave empty for all posts."
          },
          "searchQueries": {
            "title": "Only posts containing any of",
            "type": "array",
            "description": "Optional. Several words or phrases at once, for example **TON**, **Bitcoin ETF** and **#airdrop**: each is searched inside every channel, and a post that matches several is returned and charged once, with the ones it matched in matchedKeywords. Works together with the field above. Up to 20. In new-posts-only mode, changing this starts a new watch whose first run returns only the newest posts.",
            "items": {
              "type": "string"
            }
          },
          "findByKeyword": {
            "title": "Find channels by keyword",
            "type": "array",
            "description": "Optional. Find public Telegram channels and posts about these words or phrases, for example **bitcoin etf** or **remote jobs**; put a phrase in quotes, such as **\"chatgpt\"**, to keep its words together. Each keyword returns the public Telegram channels and posts that web search has indexed for it, one row each, once the channel is confirmed public. Found pages are free for now; matching posts read from the channels found are charged as posts at the normal price. Works with or without channels above. Keywords that find nothing or cannot be searched are listed and never charged. Up to 100.",
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerKeyword": {
            "title": "Maximum results per keyword",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Stop after this many Telegram pages (channels and posts) for each keyword, for example **20** for a quick look or **50** for a wide sweep. Fewer come back when web search has fewer. While found pages are free, at most 50 per keyword are returned. Default: 20. Up to 200.",
            "default": 20
          },
          "keywordCountry": {
            "title": "Search country",
            "type": "string",
            "description": "Two-letter country code the keyword search is made from, for example **US**, **GB** (or **UK**), **DE**, **IN** or **RU**. Results differ by country. Default: US.",
            "default": "US"
          },
          "keywordLanguage": {
            "title": "Search language",
            "type": "string",
            "description": "Language code of the keyword search, for example **en**, **ru**, **es** or **pt-br**. It favours pages in that language; it does not translate your keywords. Default: en.",
            "default": "en"
          },
          "keywordFreshness": {
            "title": "Found pages from",
            "enum": [
              "any",
              "day",
              "week",
              "month",
              "year"
            ],
            "type": "string",
            "description": "Apply the search engine's own time filter to keyword results: past day, week, month or year, for example **Past week** to see what is being posted now. Default: any time.",
            "default": "any"
          },
          "readMatchingPosts": {
            "title": "Also read the matching posts of each channel found",
            "type": "boolean",
            "description": "For every channel a keyword finds (up to **Channels read per keyword**), search that channel for the keyword and save the matching posts as ordinary post rows, with views, reactions, media and cashtags, each marked with the keyword that found it. Posts cost $0.30 per 1,000, as in channel mode. A found channel's matching posts are read once per run, and **Maximum posts per channel** holds for the whole run. Your date, content, cashtag and exclude filters apply. Turn it off to get only the channels and posts found, with no post charges. Default: on.",
            "default": true
          },
          "maxChannelsPerKeyword": {
            "title": "Channels read per keyword",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Read the matching posts of at most this many channels per keyword, in the order the search found them, for example **10** (the default) or **3** to keep runs small. The other channels found are still listed, as far as the run's time and maximum charge allow. From 1 to 50.",
            "default": 10
          },
          "minSubscribers": {
            "title": "Minimum subscribers (found channels)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. Keep only channels found by keyword with at least this many subscribers (public groups: members), for example **1000**. Channels outside the range give no rows and are not charged; the run summary lists them per keyword. Compared with the exact count while channel rows are on, otherwise with the figure the channel's page shows (rounded above 1,000). Channels you list by name are always read."
          },
          "maxSubscribers": {
            "title": "Maximum subscribers (found channels)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. Keep only channels found by keyword with at most this many subscribers (public groups: members), for example **50000**, to find smaller channels. Channels outside the range give no rows and are not charged. Channels you list by name are always read."
          },
          "newerThan": {
            "title": "Posts newer than",
            "type": "string",
            "description": "Optional. Keep only posts published on or after this date, for example **2026-10-01**. Older posts are never returned or charged. Leave empty for no date limit."
          },
          "lastDays": {
            "title": "Only the last N days",
            "minimum": 1,
            "type": "integer",
            "description": "Optional. Keep only posts from the last N days, for example **7** for the past week. If you also set a date above, the later of the two applies. Leave empty for no limit."
          },
          "untilDate": {
            "title": "Posts older than",
            "type": "string",
            "description": "Optional. Keep only posts published on or before this date, for example **2026-10-31** for an archive that ends in October. Combine it with **Posts newer than** for an exact window. Newer posts are skipped and never charged. Leave empty for no end date. In new-posts-only mode, changing this starts a new watch whose first run returns only the newest posts."
          },
          "mediaTypes": {
            "title": "Content types",
            "type": "array",
            "description": "Optional. Keep only posts with at least one of these, for example **Video** and **Photo**. Text-only means posts with no media, poll or link card. Posts that do not match are skipped and never charged. Leave empty for all posts. In new-posts-only mode, changing this starts a new watch whose first run returns only the newest posts.",
            "items": {
              "type": "string",
              "enum": [
                "photo",
                "video",
                "round_video",
                "document",
                "sticker",
                "poll",
                "link",
                "text"
              ],
              "enumTitles": [
                "Photo",
                "Video",
                "Round video message",
                "Document or audio file",
                "Sticker",
                "Poll",
                "Link",
                "Text-only"
              ]
            }
          },
          "minViews": {
            "title": "Minimum views",
            "minimum": 1,
            "type": "integer",
            "description": "Keep only posts with at least this many views (as Telegram shows them). Posts with fewer views, or without a view count, are left out and not charged. On an only-new watch a post left out is not returned later, even when its views grow."
          },
          "originalPostsOnly": {
            "title": "Only the channel's own posts",
            "type": "boolean",
            "description": "Leave out posts forwarded from another channel or user (Telegram marks them \"Forwarded from\"). Left-out posts are not saved and not charged, and the run summary counts them. On an only-new watch a forwarded post left out is not returned later.",
            "default": false
          },
          "excludeKeywords": {
            "title": "Exclude posts containing",
            "type": "array",
            "description": "Optional. Skip posts that contain any of these words or phrases, for example **giveaway** or **sponsored post**. Not case-sensitive; a single word must appear as a whole word, so **ad** does not skip a post that says \"added\". Skipped posts are never charged. Leave empty to keep all posts. In new-posts-only mode, changing this starts a new watch whose first run returns only the newest posts.",
            "items": {
              "type": "string"
            }
          },
          "cashtags": {
            "title": "Only posts mentioning these cashtags",
            "type": "array",
            "description": "Optional. Keep only posts that mention at least one of these tickers, for example **BTC** and **NVDA** (with or without the $). Other posts are skipped and never charged, and the SUMMARY record counts them. Leave empty for all posts. In new-posts-only mode, changing this starts a new watch whose first run returns only the newest posts.",
            "items": {
              "type": "string"
            }
          },
          "onlyNewPosts": {
            "title": "Only posts not returned in earlier runs",
            "type": "boolean",
            "description": "For scheduled monitoring, for example a run every hour on news channels. The Actor records, per channel, which posts it returned. With one run of a watch at a time, the next run returns and charges only posts it has not recorded; if a run stops early, the next run returns the rest first. Two overlapping runs of the same watch, or a run killed before it saved its memory, can return a post again. Each saved task keeps its own memory. Runs started outside a task (for example through the API) share one memory per channel, search text and content filter unless you set a Monitor name. Default: off.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Optional. Give a watch its own memory, for example **crypto-news**. Use it for runs started through the API, which otherwise share one memory per channel, search text and content filter across your account. The same name in two tasks means one shared watch. Leave empty in a saved task: each task already has its own memory."
          },
          "trackChannelChanges": {
            "title": "Report channel changes",
            "type": "boolean",
            "description": "For a named watch (a Monitor name, or a saved task): each run compares every listed channel with the copy the watch kept from its last run and reports subscriber growth or loss (number and percent), a new title and a new description, with the old text, on the free channel row, in the run summary and in the alert. A channel that changed gets its channel row even when no post is new. With one run of a watch at a time. Needs channel rows on. No extra charge. Default: off.",
            "default": false
          },
          "notifyWebhookUrl": {
            "title": "Send an alert to Slack, Discord or a webhook",
            "type": "string",
            "description": "Optional. Paste a Slack or Discord incoming-webhook address, or any https:// address that accepts JSON. When the run saves posts, a short message is posted there: how many posts per channel, the first three with the start of their text and their link, and a link to all rows. With **Only new posts** on a schedule and a keyword or cashtag filter, this is a keyword alert for Telegram channels. No extra charge."
          },
          "notifyWhenNothingFound": {
            "title": "Alert even when nothing was saved",
            "type": "boolean",
            "description": "Also post a message when the run saved no posts. Off by default, so a quiet run sends nothing.",
            "default": false
          },
          "includeChannelInfo": {
            "title": "Include one row per channel",
            "type": "boolean",
            "description": "Adds one free row per channel with its title, description, exact subscriber count where Telegram shows it, photo, video and link counts, verified badge, avatar and the date of its last post, for example to rank channels by audience. A public group, listed or found by keyword, gives one free group row with its title, description and member count (never its members or messages). Reading the exact count takes one more page per channel; posts of that channel then work out views per subscriber from it. Default: on.",
            "default": true
          },
          "textFormat": {
            "title": "Post text format",
            "enum": [
              "text",
              "html",
              "markdown"
            ],
            "type": "string",
            "description": "Also returns each post's text with its formatting: bold, italic, strikethrough, code, quotes, links and line breaks, as **HTML** (textHtml, also with underline) or **Markdown** (textMarkdown; Markdown has no underline). Built from the page already read: no extra request or charge. Spoilers and emoji appear as their plain text. The plain text field stays as it is. Default: plain text only.",
            "default": "text"
          },
          "channelsDatasetId": {
            "title": "Read channels from a dataset",
            "type": "string",
            "description": "Optional. Pick a dataset from another run, for example a list of channel links or this Actor's own channel rows, and its channels are added to the list above. Use it to chain Actors without exporting anything."
          },
          "channelsDatasetField": {
            "title": "Dataset field",
            "type": "string",
            "description": "Name of the field that holds channel names or links, for example **channel** or **url**. Leave empty to detect it automatically (channel, username, channelUrl, telegram, url, searchTarget, link, name)."
          },
          "maxConcurrency": {
            "title": "Channels read at once",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many channels are read in parallel, for example **5** (the default). Each channel's posts still come newest first. Higher values finish long channel lists sooner. From 1 to 10.",
            "default": 5
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Usually not needed: the Actor handles Telegram's rate limits by itself. Set a proxy only if you have a specific reason to, for example a channel that is shown only in some countries."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}