{"id":48345333,"url":"https://github.com/green-api/maxbot-api-client-python","last_synced_at":"2026-04-10T06:04:48.167Z","repository":{"id":348871246,"uuid":"1192420960","full_name":"green-api/maxbot-api-client-python","owner":"green-api","description":"This library helps you easily create a Python application for MAX Bots","archived":false,"fork":false,"pushed_at":"2026-04-07T07:07:06.000Z","size":190,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-04-07T09:00:31.311Z","etag":null,"topics":["max","max-api-python","max-bot","max-bot-api","max-messenger","max-messenger-api","max-python"],"latest_commit_sha":null,"homepage":"https://green-api.com/max-bot-api/docs/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/green-api.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-26T07:42:58.000Z","updated_at":"2026-04-07T07:06:28.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/green-api/maxbot-api-client-python","commit_stats":null,"previous_names":["green-api/maxbot-api-client-python"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/green-api/maxbot-api-client-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fmaxbot-api-client-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fmaxbot-api-client-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fmaxbot-api-client-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fmaxbot-api-client-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/green-api","download_url":"https://codeload.github.com/green-api/maxbot-api-client-python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fmaxbot-api-client-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31506577,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["max","max-api-python","max-bot","max-bot-api","max-messenger","max-messenger-api","max-python"],"created_at":"2026-04-05T06:31:46.075Z","updated_at":"2026-04-10T06:04:48.160Z","avatar_url":"https://github.com/green-api.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MAX BOT API Client (Python)\n\n`maxbot-api-client-python` — это библиотека для интеграции с **MAX BOT API**. Этот проект предоставляет структурированный интерфейс для взаимодействия с конфигурациями бота, управления сообщениями, отправки медиафайлов и подписки на события через *long-polling*.  \n\nДля использования библиотеки потребуется получить токен бота в консоли разработчика MAX bot.    \nОзнакомиться с инструкцией можно [по ссылке](https://green-api.com/max-bot-api/docs/before-start/).     \n\n## API\n\nДокументацию по **REST API MAX** можно найти по ссылке [dev.max.ru/docs-api](https://dev.max.ru/docs-api). Библиотека является оберткой для REST API, поэтому документация по указанной выше ссылке также применима к используемым здесь моделям.\n\nДокументацию по **MAX BOT API** можно найти по ссылке [green-api.com/max-bot-api/docs](https://green-api.com/max-bot-api/docs/).\n\n## Поддержка\n\n[![Support](https://img.shields.io/badge/support@green--bot.com-D14836?style=for-the-badge\u0026logo=gmail\u0026logoColor=white)](mailto:support@green-bot.com)\n[![Support](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge\u0026logo=telegram\u0026logoColor=white)](https://t.me/greenapi_support_ru_bot)\n[![Support](https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge\u0026logo=whatsapp\u0026logoColor=white)](https://wa.me/77780739095)\n\n## Руководства и новости\n\n[![Guides](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge\u0026logo=YouTube\u0026logoColor=white)](https://www.youtube.com/@green-api)\n[![News](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge\u0026logo=telegram\u0026logoColor=white)](https://t.me/green_api)\n[![News](https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge\u0026logo=whatsapp\u0026logoColor=white)](https://whatsapp.com/channel/0029VaHUM5TBA1f7cG29nO1C)\n\n## Установка\n\n**Убедитесь, что у вас установлен Python версии 3.12 или выше:**\n\n```shell\npython --version\n```\n\n**Установите библиотеку:**\n\n```bash\npip install maxbot-api-client-python\n```\n\n**Импорт:**\n\n```python\nfrom maxbot_api_client_python import API, Config\n```\n\n## Использование и примеры\n\n**Параметры конфигурации:** \n\n- `base_url` - Базовый URL-адрес серверов платформы MaxBot. Все методы API будут отправляться по этому корневому адресу. Актуальный адрес указан в [официальной документации](https://dev.max.ru/docs-api).\n- `token` - Уникальный секретный ключ авторизации (API-ключ) вашего бота. Получить его можно в личном кабинете после [регистрации или создании бота](https://green-api.com/max-bot-api/docs/before-start/) на платформе [business.max.ru](https://business.max.ru/).\n- `ratelimiter` - Встроенный ограничитель частоты запросов. Он контролирует количество исходящих запросов в секунду (RPS), защищая бота от блокировки со стороны сервера за превышение лимитов. Рекомендуемое значение — не менее 25.\n- `timeout` - Максимальное время ожидания ответа от сервера (в секундах). Если сервер не ответит в течение этого времени, запрос будет завершен с ошибкой. Оптимальное значение — 30 секунд.\n\n**Как инициализировать клиент:**\n\nИспользование контекстного менеджера (`with` / `async with`) гарантирует, что все сетевые соединения будут автоматически и безопасно закрыты по завершении работы.\n\n```python\nfrom maxbot_api_client_python import API, Config\n\ncfg = Config(\n    base_url=\"https://platform-api.max.ru\",\n    token=\"YOUR_BOT_TOKEN\",\n    ratelimiter=25,\n    timeout=30\n)\n# Синхронный режим:\nwith API(cfg) as bot:\n    pass\n# Асинхронный режим:\nasync with API(cfg) as bot:\n    pass\n```\n\n**Как получить информацию о боте:**\n\n* Ссылка на синхронный пример: [get_bot.py](./examples/sync/get_bot.py)\n\n```python\nwith API(cfg) as bot:\n    response = bot.bots.get_bot()\n```\n\n* Ссылка на асинхронный пример: [get_bot_async.py](./examples/async/get_bot_async.py)\n\n```python\nasync with API(cfg) as bot:\n    response = await bot.bots.get_bot_async()\n```\n\n**Как отправить сообщение:**\n\n* Ссылка на синхронный пример: [send_message.py](./examples/sync/send_message.py)\n\n\n```python\nwith API(cfg) as bot:\n    response = bot.messages.send_message(SendMessageReq(\n        user_id=1234567890,\n        text=\"Hello world!\"\n    ))\n```\n\n* Ссылка на асинхронный пример: [send_message_async.py](./examples/async/send_message_async.py)\n\n```python\nasync with API(cfg) as bot:\n    response = await bot.messages.send_message_async(SendMessageReq(\n        user_id=1234567890,\n        text=\"Hello world from Async!\"\n    ))\n```\n\n**Как легко отправить файл (по ссылке или локальный):**\n\n* Ссылка на синхронный пример: [send_file.py](./examples/sync/send_file.py)\n\n```python\nwith API(cfg) as bot:\n    response = bot.helpers.send_file(SendFileReq(\n        chat_id=1234567890,\n        text=\"Check this!\",\n        file_source=\"https://storage.yandexcloud.net/sw-prod-03-test/ChatBot/corgi.jpg\"\n    ))\n```\n* Ссылка на асинхронный пример: [send_file_async.py](./examples/async/send_file_async.py)\n\n```python\nasync with API(cfg) as bot:\n    response = await bot.helpers.send_file_async(SendFileReq(\n        chat_id=1234567890,\n        text=\"Посмотри на этот файл!\",\n        file_source=\"https://storage.yandexcloud.net/sw-prod-03-test/ChatBot/corgi.jpg\"\n    ))\n```\n\n**Как вручную загрузить файл (для кастомных вложений):**\n\n* Ссылка на синхронный пример: [upload_file.py](./examples/sync/upload_file.py)\n\n```python\nwith API(cfg) as bot:\n    response = bot.uploads.upload_file(UploadFileReq(\n        type=UploadType.image,\n        file_path=\"examples/assets/file.jpg\"\n    ))\n```\n\n* Ссылка на асинхронный пример: [upload_file_async.py](./examples/async/upload_file_async.py)\n\n```python\nasync with API(cfg) as bot:\n    response = await bot.uploads.upload_file_async(UploadFileReq(\n        type=UploadType.image,\n        file_path=\"examples/assets/file.jpg\"\n    ))\n```\n\n**Как получить входящее уведомление (Long Polling):**\n\n* Ссылка на синхронный пример: [get_updates.py](./examples/sync/get_updates.py)\n\n```python\nwith API(cfg) as bot:\n    response = bot.subscriptions.get_updates(GetUpdatesReq(\n        marker=0,\n        timeout=30\n    ))\n```\n\n* Ссылка на асинхронный пример: [get_updates_async.py](./examples/async/get_updates_async.py)\n\n```python\nasync with API(cfg) as bot:\n    response = await bot.subscriptions.get_updates_async(GetUpdatesReq(\n        marker=0,\n        timeout=30\n    ))\n```\n\n-----\n\n## Список примеров\n\n| Описание                                       | Ссылка на пример                                                 |\n| ---------------------------------------------- | ---------------------------------------------------------------- |\n| Как отправить сообщение                        | [send_message.py](./examples/sync/send_message.py)               |\n| Как отправить сообщение *асинхронно*           | [get_messages_async.py](./examples/async/get_messages_async.py)  |\n| Как получить информацию о боте                 | [get_bot.py](./examples/sync/get_bot.py)                         |\n| Как получить информацию о боте *асинхронно*    | [get_bot_async.py](./examples/async/get_bot_async.py)            |\n| Как загрузить файл                             | [upload_file.py](./examples/sync/upload_file.py)                 |\n| Как загрузить файл *асинхронно*                | [upload_file_async.py](./examples/async/upload_file_async.py)    |\n| Как отправить файл                             | [send_file.py](./examples/sync/send_file.py)                     |\n| Как отправить файл *асинхронно*                | [send_file_async.py](./examples/async/send_file_async.py)        |\n| Как получить входящее уведомление              | [get_updates.py](./examples/sync/get_updates.py)                 |\n| Как получить входящее уведомление *асинхронно* | [get_updates_async.py](./examples/async/get_updates_async.py)    |\n\n## Список всех методов библиотеки\n\n| Метод API       | Описание                | Ссылка на документацию MAX                     | Ссылка на документацию MAX BOT API           |\n|-----------------|-------------------------|------------------------------------------------|----------------------------------------------|\n| `bots.get_bot`    | Получает информацию о боте | [get_bot](https://dev.max.ru/docs-api/methods/GET/me) | [GetBot](https://green-api.com/max-bot-api/docs/api/bots/GetBot/) |\n| `bots.patch_bot`  | Изменяет информацию о боте | | [PatchBot](https://green-api.com/max-bot-api/docs/api/bots/PatchBot/) |\n| `chats.get_chats` | Возвращает список групповых чатов, в которых участвовал бот | [get_chats](https://dev.max.ru/docs-api/methods/GET/chats) | [GetChats](https://green-api.com/max-bot-api/docs/api/chats/GetChats/) |\n| `chats.get_chat`  | Возвращает информацию о групповом чате по его ID | [get_chat](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-) | [GetChat](https://green-api.com/max-bot-api/docs/api/chats/GetChat/) |\n| `chats.edit_chat` | Позволяет редактировать информацию о групповом чате | [edit_chat](https://dev.max.ru/docs-api/methods/PATCH/chats/-chatId-) | [EditChat](https://green-api.com/max-bot-api/docs/api/chats/EditChat/) |\n| `chats.delete_chat` | Удаляет групповой чат для всех участников | [delete_chat](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-) | [DeleteChat](https://green-api.com/max-bot-api/docs/api/chats/DeleteChat/) |\n| `chats.send_action` | Позволяет отправлять следующие действия бота в групповой чат | [send_action](https://dev.max.ru/docs-api/methods/POST/chats/-chatId-/actions) | [SendAction](https://green-api.com/max-bot-api/docs/api/chats/SendAction) |\n| `chats.get_pinned_message` | Возвращает закрепленное сообщение в чате | [get_pinned_message](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/pin) | [GetPinnedMessage](https://green-api.com/max-bot-api/docs/api/chats/GetPinnedMessage) |\n| `chats.pin_message` | Закрепляет сообщение в групповом чате | [pin_message](https://dev.max.ru/docs-api/methods/PUT/chats/-chatId-/pin) | [PinMessage](https://green-api.com/max-bot-api/docs/api/chats/PinMessage) |\n| `chats.unpin_message` | Удаляет закрепленное сообщение в групповом чате | [unpin_message](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/pin) | [UnpinMessage](https://green-api.com/max-bot-api/docs/api/chats/UnpinMessage) |\n| `chats.get_chat_membership` | Возвращает членство бота в групповом чате | [get_chat_membership](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members/me) | [GetChatMembership](https://green-api.com/max-bot-api/docs/api/chats/GetChatMembership) |\n| `chats.leave_chat` | Удаляет бота из группового чата | [leave_chat](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/members/me) | [LeaveChat](https://green-api.com/max-bot-api/docs/api/chats/LeaveChat) |\n| `chats.get_chat_admins` | Возвращает список всех администраторов группового чата | [get_chat_admins](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members/admins) | [GetChatAdmins](https://green-api.com/max-bot-api/docs/api/chats/GetChatAdmins) |\n| `chats.set_chat_admins` | Назначает участника группы администратором | [set_chat_admins](https://dev.max.ru/docs-api/methods/POST/chats/-chatId-/members/admins) | [SetChatAdmins](https://green-api.com/max-bot-api/docs/api/chats/SetChatAdmins) |\n| `chats.delete_admin` | Отменяет права администратора пользователя в групповом чате | [delete_admin](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/members/admins/-userId-) | [DeleteAdmin](https://green-api.com/max-bot-api/docs/api/chats/DeleteAdmin) |\n| `chats.get_chat_members`     | Возвращает список участников группового чата | [get_chat_members](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members) | [GetChatMembers](https://green-api.com/max-bot-api/docs/api/chats/GetChatMembers) |\n| `chats.add_members`         | Добавляет участников в групповой чат | [add_members](https://dev.max.ru/docs-api/methods/POST/chats/-chatId-/members) | [AddMembers](https://green-api.com/max-bot-api/docs/api/chats/AddMembers) |\n| `chats.delete_member` | Удаляет участника из группового чата | [delete_member](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/members) | [DeleteMember](https://green-api.com/max-bot-api/docs/api/chats/DeleteMember) |\n| `subscriptions.get_subscriptions` | Возвращает список подписок на уведомления веб-хуков | [get_subscriptions](https://dev.max.ru/docs-api/methods/GET/subscriptions) | [GetSubscriptions](https://green-api.com/max-bot-api/docs/api/subscriptions/GetSubscriptions) |\n| `subscriptions.subscribe`        | Настраивает доставку событий бота через веб-хук | [subscribe](https://dev.max.ru/docs-api/methods/POST/subscriptions) | [Subscribe](https://green-api.com/max-bot-api/docs/api/subscriptions/Subscribe.md)  |\n| `subscriptions.unsubscribe` | Отменяет подписку бота на получение обновлений через веб-хук | [unsubscribe](https://dev.max.ru/docs-api/methods/DELETE/subscriptions) | [Unsubscribe](https://green-api.com/max-bot-api/docs/api/subscriptions/Unsubscribe) |\n| `subscriptions.get_updates` | Получает входящие обновления | [get_updates](https://dev.max.ru/docs-api/methods/GET/updates) | [GetUpdates](https://green-api.com/max-bot-api/docs/api/subscriptions/GetUpdates) |\n| `upload.upload_file` | Загружает файл на серверы MAX для последующей передачи | [upload_file](https://dev.max.ru/docs-api/methods/POST/uploads) | [UploadFile](https://green-api.com/max-bot-api/docs/upload/UploadFile) |\n| `helpers.send_file` | Упрощает отправку файлов, автоматически определяя URL или путь | | [SendFile](https://green-api.com/max-bot-api/docs/helpers/SendFile) |\n| `messages.get_messages` | Возвращает информацию о сообщении или массив сообщений из чата | [get_messages](https://dev.max.ru/docs-api/methods/GET/messages) | [GetMessages](https://green-api.com/max-bot-api/docs/api/messages/GetMessages) |\n| `messages.send_message` | Отправляет текстовое или медиа-сообщение указанному пользователю или в чат | [send_message](https://dev.max.ru/docs-api/methods/POST/messages) | [SendMessage](https://green-api.com/max-bot-api/docs/api/messages/SendMessage) |\n| `messages.edit_message` | Редактирует текст или медиафайл ранее отправленного сообщения | [edit_message](https://dev.max.ru/docs-api/methods/PUT/messages) | [EditMessage](https://green-api.com/max-bot-api/docs/api/messages/EditMessage) |\n| `messages.delete_message` | Удаляет сообщение из чата | [delete_message](https://dev.max.ru/docs-api/methods/DELETE/messages) | [DeleteMessage](https://green-api.com/max-bot-api/docs/api/messages/DeleteMessage) |\n| `messages.get_message` | Извлекает содержимое и метаданные конкретного сообщения по его ID | [get_message](https://dev.max.ru/docs-api/methods/GET/messages/-messageId-) | [GetMessage](https://green-api.com/max-bot-api/docs/api/messages/GetMessage) |\n| `messages.get_video_info` | Возвращает подробную информацию о прикрепленном видео | [get_video_info](https://dev.max.ru/docs-api/methods/GET/videos/-videoToken-) | [GetVideoInfo](https://green-api.com/max-bot-api/docs/api/messages/GetVideoInfo) |\n| `messages.answer_callback` | Отправляет ответ после того, как пользователь нажмет кнопку | [answer_callback](https://dev.max.ru/docs-api/methods/POST/answers) | [AnswerCallback](https://green-api.com/max-bot-api/docs/api/messages/AnswerCallback )|\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-api%2Fmaxbot-api-client-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreen-api%2Fmaxbot-api-client-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-api%2Fmaxbot-api-client-python/lists"}