Install with npm
npm install google-maps-review-scraperInstall with yarn
yarn add google-maps-review-scraperimport { scraper } from "google-maps-review-scraper"
const reviews = await scraper("url", { sort_type: "sort_type", search_query: "search_query", pages: "pages" })url - string: A google maps place url as explained here
sort_type - string: The sort parameter ("relevent", "newest", "highest_rating", "lowest_rating").
search_query - string: Search query to search in reviews.
pages - integer: Number of pages that will be scraped. Will return less reviews if no more reviews exist.
Note
sort_type, search_query and pages are all optional paremeters which should be included within the object literals (the curly brackets).
reviews - Promise<Array|number>: A promise that resolves to a array containing the reviews in this format or the number 0 if no reivews exist.
All documentation related to API's and URL's used in this project can be found in the docs folder divided into endpoints for API's and urls for URL's. Note that everything included here was based on my reasearch, so errors could be present. A pull request is always welcome (see contributing)
This project is licensed under the MIT License - see the LICENSE file for details.
The MIT License is a permissive open-source license that allows users significant freedom with minimal conditions.
- Freedom to Use: You can use the software for any purpose, including commercial use.
- Freedom to Modify: You are free to modify the software as needed.
- Freedom to Distribute: You can distribute copies of the software, whether in its original or modified form.
- Freedom to Sell: You can sublicense, distribute, and even sell the software.
- Attribution: You must include the original copyright notice and the MIT license text in any copies or substantial portions of the software.
- The software is provided "as is," with no warranties or guarantees. The author is not liable for any damages arising from the use of the software.
For full details, refer to the license text.
I welcome contributions from the community! Please see our CONTRIBUTING.md for details on how to contribute to this project.
Please note that this project is governed by a Code of Conduct. By participating, you are expected to uphold this code.
Special thanks to @marin-m for his outstanding work on the pbtk repository. His contributions and insights on protocol buffers were invaluable in my research and development process.
- hex2dec by @donmccurdy
- axios by @mzabriskie and collaborators
This project is not affiliated with, endorsed by, or associated with Google LLC or any of its products and services. All product and company names are trademarks or registered trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.
This project was created with the primary intent of serving as an educational tool and proof of concept. The objectives include:
- Educational Use: To provide a hands-on learning experience in developing software, using APIs, and understanding the integration of various technologies. The project is intended to help developers, students, and enthusiasts enhance their skills and knowledge.
- Proof of Concept: To demonstrate the feasibility and potential of certain technical approaches and solutions. This includes showcasing how different APIs and tools can be utilized together in a functional application.
This project is non-commercial and is not intended for any form of profit generation or business use. It is shared openly with the community to foster learning and collaboration.
We acknowledge and respect the intellectual property rights of Google and other third parties. Any content used from external sources is credited appropriately, and no proprietary data or materials are misused.
If you have any concerns or questions regarding the legality of this project, any specific legal queries or issues, please seek professional legal advice.