{"id":13826391,"url":"https://github.com/kastaid/getter","last_synced_at":"2025-07-09T00:33:11.808Z","repository":{"id":52038056,"uuid":"452978483","full_name":"kastaid/getter","owner":"kastaid","description":"Get and put users (scraping) to the target group/channel efficiently, correctly and safety.","archived":false,"fork":false,"pushed_at":"2023-11-25T14:41:32.000Z","size":588,"stargazers_count":28,"open_issues_count":0,"forks_count":16,"subscribers_count":2,"default_branch":"main","last_synced_at":"2023-11-25T15:26:36.415Z","etag":null,"topics":["bot","bots","group-management","linux","pluggable","python","python3","scraping","scrapper","telegram","telegram-bot","telegram-bots","telegram-userbot","telethon","telethon-based","telethon-userbot","termux","userbot","userbot-telegram","userbots"],"latest_commit_sha":null,"homepage":"https://t.me/kastaid","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kastaid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":["illvart"],"custom":["https://linktr.ee/illvart"]}},"created_at":"2022-01-28T07:35:08.000Z","updated_at":"2023-12-20T16:00:51.506Z","dependencies_parsed_at":"2023-11-25T15:36:29.018Z","dependency_job_id":null,"html_url":"https://github.com/kastaid/getter","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kastaid%2Fgetter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kastaid%2Fgetter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kastaid%2Fgetter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kastaid%2Fgetter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kastaid","download_url":"https://codeload.github.com/kastaid/getter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225476384,"owners_count":17480215,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","bots","group-management","linux","pluggable","python","python3","scraping","scrapper","telegram","telegram-bot","telegram-bots","telegram-userbot","telethon","telethon-based","telethon-userbot","termux","userbot","userbot-telegram","userbots"],"created_at":"2024-08-04T09:01:36.711Z","updated_at":"2025-07-09T00:33:11.783Z","avatar_url":"https://github.com/kastaid.png","language":"Python","funding_links":["https://github.com/sponsors/illvart","https://linktr.ee/illvart"],"categories":["Python"],"sub_categories":[],"readme":"# `getter`\n\n\u003e Get and put users (scraping) to the target **group/channel** efficiently, correctly and safety.\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/kastaid/getter/actions/workflows/ci.yml\"\u003e\u003cimg alt=\"CI\" src=\"https://img.shields.io/github/actions/workflow/status/kastaid/getter/ci.yml?branch=main\u0026logo=github\u0026label=CI\" /\u003e\u003c/a\u003e\n    \u003cimg alt=\"Python\" src=\"https://img.shields.io/badge/Python-3.11.x%20%7C%203.12.x-blue?logoColor=white\u0026logo=python\" /\u003e\n    \u003cimg alt=\"Version\" src=\"https://img.shields.io/github/manifest-json/v/kastaid/getter\" /\u003e\n    \u003ca href=\"https://github.com/kastaid/getter/blob/main/LICENSE\"\u003e\u003cimg alt=\"LICENSE\" src=\"https://img.shields.io/github/license/kastaid/getter\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://telegram.me/kastaid\"\u003e\u003cimg alt=\"Telegram\" src=\"https://img.shields.io/badge/kastaid-blue?logo=telegram\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n```\n#include \u003cstd/disclaimer.h\u003e\n/*\n*   Your Telegram account may get banned.\n*   We are not responsible for any improper use of this userbot.\n*   This userbot is specific for scraping members with some helpfull commands.\n*\n*   If you ended up spamming groups, getting reported left and right,\n*   and you ended up in being fight with Telegram\n*   and at the end Telegram Team deleted your account. DON'T BLAME US.\n*\n*   No personal support will be provided / We won't spoon feed you.\n*   If you need help ask in our support group \n*   and we or our friends will try to help you.\n*/\n```\n\n## Table of Contents\n\n\u003cdetails\u003e\n\u003csummary\u003eDetails\u003c/summary\u003e\n\n- [Requirements](#requirements)\n  - [STRING_SESSION](#string_session)\n  - [Config](#config)\n- [Deployment](#deployment)\n  - [Docker Compose](#docker-compose)\n    - [Full version](#full-version)\n    - [Lite version](#lite-version)\n  - [Locally](#locally)\n- [Example Plugin](#example-plugin)\n- [Supports](#sparkling_heart-supports)\n- [Credits and Thanks](#credits-and-thanks)\n- [Contributing](#contributing)\n- [License](#license)\n\n\u003c/details\u003e\n\n## Requirements\n\n- Python 3.11.x\n- Linux (Recommend Debian/Ubuntu)\n- Telegram `API_ID` and `API_HASH` from [API development tools](https://my.telegram.org)\n\n### STRING_SESSION\n\nGenerate `STRING_SESSION` using [@strgen_bot](https://telegram.me/strgen_bot) or [replit](https://replit.com/@notudope/strgen) or run locally `python3 strgen.py`\n\n### Config\n\nCreate and save `config.env` file at main directory and fill with the example config file at [sample_config.env](https://github.com/kastaid/getter/blob/main/sample_config.env).\n\n## Deployment\n\nDeploy getter to your server or locally.\n\n### Docker Compose\n\nDeploy to your server using docker compose.\n\n#### Full version\n```sh\ngit pull \u0026\u0026 \\\n  docker compose -f local-compose.yml up --detach --build --force-recreate \u0026\u0026 \\\n  docker compose -f local-compose.yml logs -f\n```\n\n#### Lite version\n```sh\ngit pull \u0026\u0026 \\\n  docker compose -f lite-compose.yml up --detach --build --force-recreate \u0026\u0026 \\\n  docker compose -f lite-compose.yml logs -f\n```\n\n### Locally\n\nRun getter as locally eg: termux\n\n#### Production\n```sh\npip3 install -r requirements.txt\npython3 -m getter\n```\n\n#### Development\n```sh\npip3 install -r requirements.txt\npip3 install -r requirements-dev.txt\npython3 -m run --watch\n```\n\nMore commands `python3 -m run -h`\n\n## Example Plugin\n\nClone the repo, then create and save plugin at `./getter/plugins/plugin_name.py`.\n\n\u003ckbd\u003eThis Example Works Everywhere. (e.g. Groups, Personal Chats)\u003c/kbd\u003e\n```python\nfrom . import kasta_cmd\n@kasta_cmd(pattern=\"hi\")\nasync def _(event):\n    await event.eor(\"Hello **World**.\")\n```\n\n\u003ckbd\u003eThis Example Works Only In Personal Chats.\u003c/kbd\u003e\n```python\nfrom . import kasta_cmd\n@kasta_cmd(pattern=\"hi\", func=lambda e: e.is_private)\nasync def _(event):\n    await event.eor(\"Hello **World**.\")\n```\n\n\u003ckbd\u003eThis Example Works Only In Channels.\u003c/kbd\u003e\n```python\nfrom . import kasta_cmd\n@kasta_cmd(pattern=\"hi\", func=lambda e: e.is_channel and e.chat.broadcast)\nasync def _(event):\n    await event.eor(\"Hello **World**.\")\n```\n\n\u003ckbd\u003eThis Example Works Only In Groups.\u003c/kbd\u003e\n```python\nfrom . import kasta_cmd\n@kasta_cmd(pattern=\"hi\", func=lambda e: e.is_group)\nasync def _(event):\n    await event.eor(\"Hello **World**.\")\n```\n\n\u003ckbd\u003eThis Example Works Only In Groups or Channels.\u003c/kbd\u003e\n```python\nfrom . import kasta_cmd\n@kasta_cmd(pattern=\"hi\", func=lambda e: not e.is_private)\nasync def _(event):\n    await event.eor(\"Hello **World**.\")\n```\n\n## :sparkling_heart: Supports\n\nThis project is open source and free to use under the [license](#license). However, if you are using this project and happy with it or just want to encourage me to continue creating stuff please donate!\n\n## Credits and Thanks\n\n* [LonamiWebs](https://github.com/LonamiWebs/Telethon) - Telethon\n* [TeamUltroid](https://github.com/TeamUltroid) - Team Ultroid\n* [userbotindo](https://github.com/userbotindo) - Userbot Indonesia Community\n* [illvart](https://github.com/illvart) - Core Developer\n\nand [everyone](https://github.com/kastaid/getter/graphs/contributors) 🦄\n\n## Contributing\n\nIf you would like to help out with some code, check the [details](https://github.com/kastaid/getter/blob/main/docs/CONTRIBUTING.md).\n\n## License\n\nThis project is licensed under the **GNU Affero General Public License v3.0**. See the [LICENSE](https://github.com/kastaid/getter/blob/main/LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkastaid%2Fgetter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkastaid%2Fgetter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkastaid%2Fgetter/lists"}