Skip to main content
POST
/
tg_subscribe
curl -X POST https://scrape.st/tg_subscribe \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "chatId": "-1001234567890",
    "name": "alerts"
  }'

{
  "message": "Subscription registered"
}
Register a Telegram chat to receive events for everything tracked under your API key. Each API key maps to one chat — subscribing again replaces the existing chat. Before saving, Scrapest sends a confirmation message to the chat. If the bot can’t post there (not a member, kicked, wrong chat ID), the request fails — add the Scrapest bot to the chat first.

​
Request Body

​
chatId
string
required
The Telegram chat ID to deliver events to. Group chat IDs are negative numbers (e.g. -1001234567890).
​
name
string
default:"default"
A label for this subscription, shown in the confirmation message.

​
Response

​
message
string
Subscription registered on first subscribe, Subscription updated when replacing an existing chat.
curl -X POST https://scrape.st/tg_subscribe \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "chatId": "-1001234567890",
    "name": "alerts"
  }'

{
  "message": "Subscription registered"
}