{"id":23881913,"url":"https://github.com/rmncldyo/google-search-api-wrapper","last_synced_at":"2025-10-12T06:26:18.158Z","repository":{"id":215178803,"uuid":"737905751","full_name":"RMNCLDYO/Google-Search-API-Wrapper","owner":"RMNCLDYO","description":"A simple python wrapper for Google's Search API, enabling programatic web and image searches.","archived":false,"fork":false,"pushed_at":"2024-02-14T02:34:18.000Z","size":91,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-06T01:36:55.896Z","etag":null,"topics":["api","api-wrapper","google","google-search","google-search-api","google-search-console","google-search-console-python","google-search-results","google-search-scraper","google-search-using-python","images","python","python3","requests","text","wrapper"],"latest_commit_sha":null,"homepage":"","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/RMNCLDYO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-01-01T23:10:24.000Z","updated_at":"2024-12-14T10:15:37.000Z","dependencies_parsed_at":"2025-04-16T04:02:38.586Z","dependency_job_id":null,"html_url":"https://github.com/RMNCLDYO/Google-Search-API-Wrapper","commit_stats":null,"previous_names":["rmncldyo/google-search-api-wrapper"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RMNCLDYO/Google-Search-API-Wrapper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RMNCLDYO%2FGoogle-Search-API-Wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RMNCLDYO%2FGoogle-Search-API-Wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RMNCLDYO%2FGoogle-Search-API-Wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RMNCLDYO%2FGoogle-Search-API-Wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RMNCLDYO","download_url":"https://codeload.github.com/RMNCLDYO/Google-Search-API-Wrapper/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RMNCLDYO%2FGoogle-Search-API-Wrapper/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279010483,"owners_count":26084757,"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","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["api","api-wrapper","google","google-search","google-search-api","google-search-console","google-search-console-python","google-search-results","google-search-scraper","google-search-using-python","images","python","python3","requests","text","wrapper"],"created_at":"2025-01-04T01:59:49.003Z","updated_at":"2025-10-12T06:26:18.102Z","avatar_url":"https://github.com/RMNCLDYO.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://python.org\" title=\"Go to Python homepage\"\u003e\u003cimg src=\"https://img.shields.io/badge/Python-\u0026gt;=3.x-blue?logo=python\u0026amp;logoColor=white\" alt=\"Made with Python\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/maintained-yes-2ea44f\" alt=\"maintained - yes\"\u003e\n    \u003ca href=\"/CONTRIBUTING.md\" title=\"Go to contributions doc\"\u003e\u003cimg src=\"https://img.shields.io/badge/contributions-welcome-2ea44f\" alt=\"contributions - welcome\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://pypi.org/project/requests\"\u003e\u003cimg src=\"https://img.shields.io/badge/dependency-requests-critical\" alt=\"dependency - requests\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/python-dotenv\"\u003e\u003cimg src=\"https://img.shields.io/badge/dependency-python--dotenv-critical\" alt=\"dependency - python-dotenv\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg width=\"700\" src=\"https://raw.githubusercontent.com/RMNCLDYO/Google-Search-API-Wrapper/main/.github/logo.png\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/dynamic/json?label=Google+Search+API+Wrapper\u0026query=version\u0026url=https%3A%2F%2Fraw.githubusercontent.com%2FRMNCLDYO%2FGoogle-Search-API-Wrapper%2Fmain%2F.github%2Fversion.json\" alt=\"Version\"\u003e\n\u003c/p\u003e\n\n## Overview\nA simple python wrapper for Google's Search API, enabling programatic web and image searches.\n\n## Key Features\n- Web and image search functionality using Google Custom Search JSON API.\n- Customizable search queries and result limits.\n- Formatted search results including titles, links, snippets, and images.\n- Error handling for missing credentials or invalid queries.\n\n## Prerequisites\n- `Python 3.x`\n\n## Dependencies\nThe following Python packages are required:\n- `requests`: For making HTTP requests to the Google API.\n- `python-dotenv`: For loading environment variables from an `.env` file.\n\n## Installation\nTo use this wrapper, clone the repository and install dependencies:\n```bash\ngit clone https://github.com/RMNCLDYO/Google-Search-API-Wrapper.git\ncd Google-Search-API-Wrapper\npip install -r requirements.txt\n```\n\n### Obtaining Google Custom Search API Credentials\n\n#### Obtaining an API Key\n1. Visit the [Programmable Search Engine](https://developers.google.com/custom-search/v1/introduction) introduction page.\n2. Scroll down to the middle of the page and click on 'Get a Key' to generate your API key.\n\n#### What is a Programmable Search Engine?\nA Programmable Search Engine allows you to search google via the API, using Google's core search technology. You can customize it extensively, including the look and feel, search features, and even link it with Google Analytics for user behavior insights.\n\n#### Creating a Programmable Search Engine\nBefore using the Google Custom Search API, you need to create a Programmable Search Engine. Follow these steps:\n\n1. Visit the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/controlpanel/all).\n2. Name your search engine and specify what to search:\n   - Choose specific sites or the entire web.\n3. Set your search settings, such as enabling image search and/or SafeSearch.\n4. Complete the reCAPTCHA verification and create your search engine.\n5. Once created, find your Search Engine ID (cx parameter) in the Overview page's Basic section.\n\n## Configuration\n1. Once you've obtained your API key and CX id, add them to your `.env` file.\n2. Create a new file named `.env` in the root directory, or rename the `example.env` file in the root directory of the project to `.env`.\n3. Add your API key and CX id to the `.env` file as follows:\n   ```\n   api_key=your_api_key_here\n   cx=your_cx_id_here\n   ```\n4. The application will automatically load and use the API key and CX id when making API requests.\n\n## Usage\n\n#### Text Search Example\n\n```python\nfrom google_search_api import GoogleSearchAPI\n\nprint(GoogleSearchAPI().response(method='text', max_results=5, query='Your text prompt'))\n```\n\n#### Image Search Example\n\n```python\nfrom google_search_api import GoogleSearchAPI\n\nprint(GoogleSearchAPI().response(method='image', max_results=5, query='Your image prompt'))\n```\n\n## Contributing\nContributions are welcome!\n\nPlease refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md) for detailed guidelines on how to contribute to this project.\n\n## Reporting Issues\nEncountered a bug? We'd love to hear about it. Please follow these steps to report any issues:\n\n1. Check if the issue has already been reported.\n2. Use the [Bug Report](.github/ISSUE_TEMPLATE/bug_report.md) template to create a detailed report.\n3. Submit the report [here](https://github.com/RMNCLDYO/Google-Search-API-Wrapper/issues).\n\nYour report will help us make the project better for everyone.\n\n## Feature Requests\nGot an idea for a new feature? Feel free to suggest it. Here's how:\n\n1. Check if the feature has already been suggested or implemented.\n2. Use the [Feature Request](.github/ISSUE_TEMPLATE/feature_request.md) template to create a detailed request.\n3. Submit the request [here](https://github.com/RMNCLDYO/Google-Search-API-Wrapper/issues).\n\nYour suggestions for improvements are always welcome.\n\n## Versioning and Changelog\nStay up-to-date with the latest changes and improvements in each version:\n\n- [CHANGELOG.md](.github/CHANGELOG.md) provides detailed descriptions of each release.\n\n## Security\nYour security is important to us. If you discover a security vulnerability, please follow our responsible disclosure guidelines found in [SECURITY.md](.github/SECURITY.md). Please refrain from disclosing any vulnerabilities publicly until said vulnerability has been reported and addressed.\n\n## License\nLicensed under the MIT License. See [LICENSE](LICENSE) for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmncldyo%2Fgoogle-search-api-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frmncldyo%2Fgoogle-search-api-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmncldyo%2Fgoogle-search-api-wrapper/lists"}