# Telegram scraper (`curious_coder/telegram-scraper`) Actor

Scrape group members from any telegram group. (⚠️ Warning: Auto adding feature is no longer available!)

- **URL**: https://apify.com/curious\_coder/telegram-scraper.md
- **Developed by:** [Curious Coder](https://apify.com/curious_coder) (community)
- **Categories:** Social media, Automation
- **Stats:** 7,123 total users, 0 monthly users, 100.0% runs succeeded, 116 bookmarks
- **User rating**: 2.01 out of 5 stars

## Pricing

$25.00/month + usage

To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

### Features

- Scrape any telegram group members

#### NOTE: Auto add feature is no longer available!

https://youtu.be/j_vSazbotQ8


## Getting started

- Click on 'Try for free' button 
- Go to 'Input' tab and select action you want to perform
- Go to [web.telegram.org](https://web.telegram.org) and copy the group URL you want to use. 
- Paste them in the 'Scrape group' input field
- Click on 'Save and start' button

The following steps required only for first time: 

- Go to 'Live view' tab to scan the QR code to authenticate the actor with telegram (This step is only one time)
- Open telegram app on your device.
- Go to Telegram menu -> Settings -> Devices and click on 'Add device' button and scan the QR code
- Copy the auth code to use it in future runs by filling 'Auth code'. If you pass auth token, you can avoid scanning QR code


✳️ **You might be interested in:** [Whatsapp scraper](https://apify.com/curious_coder/whatsapp-scraper) | [Discord scraper](https://apify.com/curious_coder/discord-data-scraper) | [Facebook group members scraper](https://apify.com/curious_coder/facebook-scraper) | [Other useful scrapers](https://apify.com/curious_coder)

### How to get group URL

![Telegram group member scraper- how to get group url](https://ik.imagekit.io/webscraper/Telegram%20auto%20adder%20-%20How%20to%20get%20group%20url?updatedAt=1696420161947)


### Integrations

You can use [Make](https://www.make.com/en/register?pc=growthhack) to integrate telegram scraper data to any other SaaS platform by designing your own automation flows.


### Group members output

```json
{
	"flags": 33554543,
	"self": false,
	"contact": false,
	"mutualContact": false,
	"deleted": false,
	"bot": false,
	"botChatHistory": false,
	"botNochats": false,
	"verified": false,
	"restricted": false,
	"min": false,
	"botInlineGeo": false,
	"support": false,
	"scam": false,
	"applyMinPhoto": true,
	"fake": false,
	"botAttachMenu": false,
	"premium": false,
	"attachMenuEnabled": false,
	"flags2": 0,
	"botCanEdit": false,
	"id": "202577853",
	"accessHash": "-2127225199806290195",
	"firstName": "Pavel",
	"lastName": "Tsyganov",
	"username": "Tsyganov_pro",
	"phone": null,
	"photo": {
		"flags": 2,
		"hasVideo": false,
		"personal": false,
		"photoId": "870065253985134518",
		"strippedThumb": {
			"type": "Buffer",
			"data": [
				"<... buffer data ...>"
			]
		},
		"dcId": 2,
		"className": "UserProfilePhoto"
	},
	"status": {
		"className": "UserStatusRecently"
	},
	"botInfoVersion": null,
	"restrictionReason": null,
	"botInlinePlaceholder": null,
	"langCode": null,
	"emojiStatus": null,
	"usernames": null,
	"className": "User"
}
````

# Actor input Schema

## `authToken` (type: `string`):

Used to authorize with telegram <p> If not provied, you will be asked to scan a QR code to generate the token

## `scrapeGroup` (type: `string`):

Group URL, @name or ID<p>To get the URL, go to [web.telegram.org](https://web.telegram.org) and open that group, then copy the URL from the address bar. <p> Examples: <ul><li> `@group_name` </li><li> `https://t.me/group_name` </li><li> `1691104978` </li><li> `https://web.telegram.org/k/#-1949445241` </li>

## `startPage` (type: `integer`):

Page number to start scraping

## `count` (type: `integer`):

Leave this field empty to remove the limit

## `proxy.ip` (type: `string`):

No description

## `proxy.port` (type: `integer`):

No description

## `proxy.username` (type: `string`):

No description

## `proxy.password` (type: `string`):

No description

## Actor input object example

```json
{
  "scrapeGroup": "https://t.me/BitSquad",
  "startPage": 1,
  "count": 10
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "authToken": "",
    "scrapeGroup": "https://t.me/BitSquad",
    "startPage": 1,
    "count": 10
};

// Run the Actor and wait for it to finish
const run = await client.actor("curious_coder/telegram-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "authToken": "",
    "scrapeGroup": "https://t.me/BitSquad",
    "startPage": 1,
    "count": 10,
}

# Run the Actor and wait for it to finish
run = client.actor("curious_coder/telegram-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "authToken": "",
  "scrapeGroup": "https://t.me/BitSquad",
  "startPage": 1,
  "count": 10
}' |
apify call curious_coder/telegram-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=curious_coder/telegram-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Telegram scraper",
        "description": "Scrape group members from any telegram group. (⚠️ Warning: Auto adding feature is no longer available!)",
        "version": "1.0",
        "x-build-id": "mrvNhW4IA9SyQotfT"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/curious_coder~telegram-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-curious_coder-telegram-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/curious_coder~telegram-scraper/runs": {
            "post": {
                "operationId": "runs-sync-curious_coder-telegram-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/curious_coder~telegram-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-curious_coder-telegram-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": [
                    "scrapeGroup"
                ],
                "properties": {
                    "authToken": {
                        "title": "🔑 Auth token",
                        "type": "string",
                        "description": "Used to authorize with telegram <p> If not provied, you will be asked to scan a QR code to generate the token"
                    },
                    "scrapeGroup": {
                        "title": "👥 Group to scrape members",
                        "pattern": "^(?:@[\\w_]+|https://t\\.me/[\\w_]+|-?\\d{10,}|https://web\\.telegram\\.org/(a|k)/#(@[\\w_]+|-?\\d{10,}))$",
                        "type": "string",
                        "description": "Group URL, @name or ID<p>To get the URL, go to [web.telegram.org](https://web.telegram.org) and open that group, then copy the URL from the address bar. <p> Examples: <ul><li> `@group_name` </li><li> `https://t.me/group_name` </li><li> `1691104978` </li><li> `https://web.telegram.org/k/#-1949445241` </li>"
                    },
                    "startPage": {
                        "title": "▶️ Start page",
                        "type": "integer",
                        "description": "Page number to start scraping",
                        "default": 1
                    },
                    "count": {
                        "title": "#️⃣ Scrape/Add Limit",
                        "minimum": 10,
                        "type": "integer",
                        "description": "Leave this field empty to remove the limit"
                    },
                    "proxy.ip": {
                        "title": "IP",
                        "type": "string",
                        "description": ""
                    },
                    "proxy.port": {
                        "title": "Port",
                        "type": "integer",
                        "description": ""
                    },
                    "proxy.username": {
                        "title": "Username",
                        "type": "string",
                        "description": ""
                    },
                    "proxy.password": {
                        "title": "Password",
                        "type": "string",
                        "description": ""
                    }
                }
            },
            "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
                                    }
                                }
                            },
                            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```