{"id":17492418,"url":"https://github.com/filipporomani/whatsapp-python","last_synced_at":"2025-05-16T07:00:18.714Z","repository":{"id":151908547,"uuid":"625009040","full_name":"filipporomani/whatsapp-python","owner":"filipporomani","description":"Open source Python wrapper for the WhatsApp Cloud API.","archived":false,"fork":false,"pushed_at":"2024-11-30T07:08:57.000Z","size":2175,"stargazers_count":129,"open_issues_count":0,"forks_count":20,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-05-11T14:04:07.389Z","etag":null,"topics":["python","python-whatsapp","whatsapp","whatsapp-api","whatsapp-python"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/whatsapp-python/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"Neurotech-HQ/heyoo","license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/filipporomani.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"filipporomani"}},"created_at":"2023-04-07T20:28:45.000Z","updated_at":"2025-05-04T13:46:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"54387990-0acc-4774-8341-e33b33c45f6b","html_url":"https://github.com/filipporomani/whatsapp-python","commit_stats":{"total_commits":333,"total_committers":23,"mean_commits":"14.478260869565217","dds":0.4054054054054054,"last_synced_commit":"0b0589672fb9ce7176b81e4a1f0746d0e1e0c2c4"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipporomani%2Fwhatsapp-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipporomani%2Fwhatsapp-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipporomani%2Fwhatsapp-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipporomani%2Fwhatsapp-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/filipporomani","download_url":"https://codeload.github.com/filipporomani/whatsapp-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253576269,"owners_count":21930169,"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":["python","python-whatsapp","whatsapp","whatsapp-api","whatsapp-python"],"created_at":"2024-10-19T09:04:18.273Z","updated_at":"2025-05-16T07:00:18.612Z","avatar_url":"https://github.com/filipporomani.png","language":"Python","readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://gist.githubusercontent.com/boywithkeyboard/e8dc5b1810bd29e1d70346ca11d7f09d/raw/7f7eeea482f5047e62944e54182aa26c89cc299a/whatsapp_python.svg\" alt=\"logo\" width=\"128px\"\u003e\n  \u003ch1\u003ewhatsapp-python\u003c/h1\u003e\n  \u003cp\u003eFree, open-source Python wrapper for the \u003ca href=\"https://developers.facebook.com/docs/whatsapp/cloud-api\"\u003eWhatsApp Cloud API\u003c/a\u003e.\u003cbr\u003eForked from \u003ca href=\"https://github.com/Neurotech-HQ/heyoo\"\u003eNeurotech-HQ/heyoo\u003c/a\u003e.\n  \u003c/p\u003e\n  \u003cimg src=\"https://img.shields.io/badge/made%20in-italy-008751.svg?style=flat-square\" alt=\"Made in Italy\"\u003e\n  \u003ca href=\"https://pepy.tech/project/whatsapp-python\"\u003e\u003cimg src=\"https://static.pepy.tech/personalized-badge/whatsapp-python?period=total\u0026units=none\u0026left_color=grey\u0026right_color=blue\u0026left_text=Downloads\" alt=\"Downloads\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://pepy.tech/project/whatsapp-python\"\u003e\u003cimg src=\"https://pepy.tech/badge/whatsapp-python/month\" alt=\"Monthly Downloads\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://pepy.tech/project/whatsapp-python\"\u003e\u003cimg src=\"https://pepy.tech/badge/whatsapp-python/week\" alt=\"Weekly Downloads\"\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n## Installation\n\nTo install the library you can either use pip (latest release version):\n\n``pip install whatsapp-python``\n\nYou can also install the development GitHub version (always up to date, with the latest features and bug fixes):\n\n```bash\ngit clone https://github.com/filipporomani/whatsapp.git\ncd whatsapp\npip install .\n```\n\nIf you want to use a local enviroment you can also use hatch:\n  \n```bash\ngit clone https://github.com/filipporomani/whatsapp.git\ncd whatsapp\npip install hatch\nhatch shell\n```\n\nDocumentation is available in the [wiki](https://github.com/filipporomani/whatsapp/wiki) here on GitHub.\n\n### Key features:\n- Modern interface using `async` and `await`\n- Full support for Graph API error handling\n- Optimized for high-load workflows using asyncronous programming\n- Always up to date\n- All of the WhatsApp Business chat UI features supported\n\n\n### All features\n- Event listening (incoming messages)\n- Asyncronous API calls\n- Error handling\n- Sending messages\n- Sending messages from different numbers individually\n- Marking messages as read\n- Replying to messages\n- Reacting to messages\n- Sending medias (images, audios, videos, links and documents)\n- Sending location\n- Sending interactive buttons\n- Sending template messages\n- Parsing messages and media received\n- Sending contacts\n- Uploading media to the Facebook cloud\n\n## Obtaining the WhatsApp API credentials\n\nTo use the WhatsApp API you need to create a Facebook Business account and a WhatsApp Business account.\n\n\u003e [!TIP]  \n\u003e To create an account, I recommend to follow [this video](https://youtu.be/d6lNxP2gadA).\n\n## Pricing of the API\n\nWhereas using third-party providers of the WhatsApp API can result in monthly fees, using the WhatsApp API[^1] offered directly by Facebook is much cheaper, even if the billing documentation is quite difficult to understand.\n\n\u003e [!CAUTION]  \n\u003e It is now mandatory to add a credit card to the WhatsApp account (at least for me) in order to use the service. I was even charged a tiny fee for using a non-test phone number (~€1.20), so be careful when using the API! I'm not responsible for any costs you may face by using the API.\n\u003e\n\u003e The API should be, however, free for testing purposes with the provided test phone number.\n\nAll the prices are available in the [**WhatsApp API docs**](https://developers.facebook.com/docs/whatsapp/pricing).\n\n\u003e [!TIP]  \n\u003e I recomend to use a test number, as you you can get a free one and use it for testing purposes.\n\n## Migrating from `Neurotech-HQ/heyoo`\n\n*You can ignore this if it's your first time using the library.*\n\n- Any version \u003e1.1.2 is incompatible with the original `heyoo` library! Be careful updating! Read the docs first!\n- Any version \u003c=1.1.2 is fully compatible with the original `heyoo` library and doesn't include breaking changes.\n\nSwitching from heyoo to whatsapp-python doesn't require any change for versions up to 1.1.2: just uninstall `heyoo`, install `whatsapp-python==1.1.2` and change the import name from `heyoo` to `whatsapp`.\n\nFor versions GREATER THAN 1.1.2, messages have became objects, so you need to change your code to use the new methods.\n\n\u003e [!NOTE]  \n\u003e Documentation for version 1.1.2 can be found [here](https://github.com/filipporomani/whatsapp/wiki/v1.1.2).\n\n## Contributing\n\nIf you are facing any issues or have any questions, please [open a new issue](https://github.com/filipporomani/whatsapp/issues/new/choose)!\n\n*This is an open source project published under the [GNU Affero General Public License v3](LICENSE).*\n\n[^1]: https://developers.facebook.com/docs/whatsapp/cloud-api\n","funding_links":["https://github.com/sponsors/filipporomani"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffilipporomani%2Fwhatsapp-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffilipporomani%2Fwhatsapp-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffilipporomani%2Fwhatsapp-python/lists"}