{"id":14987086,"url":"https://github.com/andre-ols/whatsapp_api_nodejs","last_synced_at":"2025-04-11T23:22:17.734Z","repository":{"id":128058964,"uuid":"476849381","full_name":"andre-ols/whatsapp_api_nodejs","owner":"andre-ols","description":"NodeJS API Wrapper for WhatsApp","archived":false,"fork":false,"pushed_at":"2022-04-09T19:18:46.000Z","size":38,"stargazers_count":9,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T19:12:38.300Z","etag":null,"topics":["bot","nodejs","nodejs-bot","nodejs-wrapper","whatsapp","whatsapp-api","whatsapp-bot","whatsapp-chat","whatsapp-web","wrapper","wrapper-api"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/andre-ols.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2022-04-01T19:45:45.000Z","updated_at":"2025-01-26T20:31:59.000Z","dependencies_parsed_at":"2023-05-29T08:00:11.840Z","dependency_job_id":null,"html_url":"https://github.com/andre-ols/whatsapp_api_nodejs","commit_stats":{"total_commits":10,"total_committers":1,"mean_commits":10.0,"dds":0.0,"last_synced_commit":"c7f4b1d3d3507872b23cf21bfa751043d4a99308"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andre-ols%2Fwhatsapp_api_nodejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andre-ols%2Fwhatsapp_api_nodejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andre-ols%2Fwhatsapp_api_nodejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andre-ols%2Fwhatsapp_api_nodejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andre-ols","download_url":"https://codeload.github.com/andre-ols/whatsapp_api_nodejs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248493180,"owners_count":21113209,"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","nodejs","nodejs-bot","nodejs-wrapper","whatsapp","whatsapp-api","whatsapp-bot","whatsapp-chat","whatsapp-web","wrapper","wrapper-api"],"created_at":"2024-09-24T14:14:04.268Z","updated_at":"2025-04-11T23:22:17.712Z","avatar_url":"https://github.com/andre-ols.png","language":"JavaScript","readme":"![Badge](https://img.shields.io/static/v1?label=NodeJs\u0026message=16.14.2\u0026color=339933\u0026logo=node.js\u0026link=https://nodejs.org/en/)\n![Badge](https://img.shields.io/static/v1?label=Yarn\u0026message=1.22.15\u0026color=2C8EBB\u0026logo=yarn\u0026link=https://yarnpkg.com/)\n![badge](https://img.shields.io/static/v1?label=license\u0026message=MIT\u0026color)\n![badge](https://img.shields.io/github/last-commit/andre-ols/whatsapp_api_nodejs)\n\n\n# Whatsapp API Nodejs\n\n\u003cp align=\"center\"\u003e\nIt is an unofficial Whatsapp API, which performs web scraping using puppeteer through the whatsapp-web.js library to automate whatsapp, making its resources available through a RESTful API.\n\u003c/p\u003e\n\n\u003ch4 align=\"center\"\u003e \n\t🚧  Whatsapp API Nodejs under construction...  🚧\n\u003c/h4\u003e\n\n### Supported features\n\n| Feature  | Status |\n| ------------- | ------------- |\n| Multi Device  | ✅  |\n| Send messages  | ✅  |\n| Send media (images/audio/documents)  | ✅  |\n| Send contact cards | ✅ |\n| Send location | ✅ |\n| Send buttons | ⏳ |\n| Send lists | ⏳ (business accounts not supported) |\n| Send messages in group  | ✅  |\n| Send media (images/audio/documents) in group | ✅  |\n| Send contact cards in group | ✅ |\n| Send location in group | ✅ |\n| Get contact info | ✅ |\n| Get profile pictures | ✅ |\n\n### How to Install\n\nBefore starting, you will need to have the following tools installed on your machine:\n[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/), [Yarn](https://yarnpkg.com/). \nBesides, it's good to have an editor to work with the code like [VSCode](https://code.visualstudio.com/)\n\n### 🎲 Running the API\n\n```bash\n# Clone this repository\n$ git clone https://github.com/andre-ols/whatsapp_api_nodejs.git\n\n# access the project folder in the terminal/cmd\n$ cd whatsapp_api_nodejs\n\n# Install the dependencies and start the server:\n\n$ yarn install\n$ yarn start\n\n# or\n\n$ npm install\n$ npm start\n\n# Server Running Live on Port: 3000 - access \u003chttp://localhost:3000\u003e\n```\n\n### How to use the API 🚀\n\n- Access the API through the browser: \u003chttp://localhost:3000/auth\u003e to get QR code to scan.\n\n- After scanning the QR code, refresh the page to scan second QR code.\n\n- Done! ✅ You can now access the API Docs through \u003chttp://localhost:3000/api-docs\u003e\n\n### 🛠 Technologies Used\n\nThe following tools were used in building the project:\n\n- [Node.js](https://nodejs.org/en/)\n- [Yarn](https://yarnpkg.com/)\n- [Express](https://expressjs.com/)\n- [Whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js)\n- [qrcode](https://www.npmjs.com/package/qrcode)\n\n\n### Author\n---\n\n\u003ca href=\"https://www.linkedin.com/in/andr%C3%A9-oliveira-silva-3496a2106/\"\u003e\n \u003cimg style=\"border-radius: 50%;\" src=\"https://media-exp1.licdn.com/dms/image/C5603AQFnZ5ECKE8vNQ/profile-displayphoto-shrink_800_800/0/1614707358251?e=1654732800\u0026v=beta\u0026t=yJ-wUUT6I8aRFfEWFANyAsojs4hOjdrViBuDSqWF0Ew\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\n\u003csub\u003e\u003cb\u003eAndré Oliveira\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e \n\u003cbr /\u003e\n\u003cbr /\u003e\n\n[![Linkedin Badge](https://img.shields.io/badge/-André-blue?style=flat-square\u0026logo=Linkedin\u0026logoColor=white\u0026link=https://www.linkedin.com/in/andr%C3%A9-oliveira-silva-3496a2106/)](https://www.linkedin.com/in/andr%C3%A9-oliveira-silva-3496a2106/) \n[![Gmail Badge](https://img.shields.io/badge/-contato.andreols@gmail.com-c14438?style=flat-square\u0026logo=Gmail\u0026logoColor=white\u0026link=mailto:contato.andreols@gmail.com)](mailto:contato.andreols@gmail.com)\n\n## License\n\nThis project is under the license [MIT](./LICENSE).\n\n\u003cp\u003eMade with ❤️ by \u003ca href=\"https://www.linkedin.com/in/andr%C3%A9-oliveira-silva-3496a2106/\"\u003eAndré Oliveira\u003c/a\u003e!\u003c/p\u003e","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandre-ols%2Fwhatsapp_api_nodejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandre-ols%2Fwhatsapp_api_nodejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandre-ols%2Fwhatsapp_api_nodejs/lists"}