The official Python client for SerpApi.com.
Project description
This repository is the home of the soon–to–be official Python API wrapper for SerpApi. This serpapi
module allows you to access search data in your Python application.
SerpApi supports Google, Google Maps, Google Shopping, Bing, Baidu, Yandex, Yahoo, eBay, App Stores, and more. Check out the documentation for a full list.
Installation
To install the serpapi
package, simply run the following command:
$ pip install serpapi
Please note that this package is separate from the legacy serpapi
module, which is available on PyPi as google-search-results
. This package is maintained by SerpApi, and is the recommended way to access the SerpApi service from Python.
Usage
Let's start by searching for Coffee on Google:
>>> import serpapi
>>> s = serpapi.search(q="Coffee", engine="google", location="Austin, Texas", hl="en", gl="us")
The s
variable now contains a SerpResults
object, which acts just like a standard dictionary, with some convenient functions added on top.
Let's print the first result:
>>> s["organic_results"][0]["link"]
'https://en.wikipedia.org/wiki/Coffee'
Let's print the title of the first result, but in a more Pythonic way:
>>> s["organic_results"][0].get("title")
'Coffee - Wikipedia'
The SerpApi.com API Documentation contains a list of all the possible parameters that can be passed to the API.
Documentation
Documentation is available on Read the Docs.
Basic Examples in Python
Search Bing
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'bing',
'q': 'coffee',
})
- API Documentation: serpapi.com/bing-search-api
Search Baidu
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'baidu',
'q': 'coffee',
})
- API Documentation: serpapi.com/baidu-search-api
Search Yahoo
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'yahoo',
'p': 'coffee',
})
- API Documentation: serpapi.com/yahoo-search-api
Search YouTube
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'youtube',
'search_query': 'coffee',
})
- API Documentation: serpapi.com/youtube-search-api
Search Walmart
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'walmart',
'query': 'coffee',
})
- API Documentation: serpapi.com/walmart-search-api
Search eBay
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'ebay',
'_nkw': 'coffee',
})
- API Documentation: serpapi.com/ebay-search-api
Search Naver
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'naver',
'query': 'coffee',
})
- API Documentation: serpapi.com/naver-search-api
Search Home Depot
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'home_depot',
'q': 'table',
})
- API Documentation: serpapi.com/home-depot-search-api
Search Apple App Store
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'apple_app_store',
'term': 'coffee',
})
- API Documentation: serpapi.com/apple-app-store
Search DuckDuckGo
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'duckduckgo',
'q': 'coffee',
})
- API Documentation: serpapi.com/duckduckgo-search-api
Search Google
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'google',
'q': 'coffee',
'engine': 'google',
})
- API Documentation: serpapi.com/search-api
Search Google Scholar
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'google_scholar',
'q': 'coffee',
})
- API Documentation: serpapi.com/google-scholar-api
Search Google Autocomplete
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'google_autocomplete',
'q': 'coffee',
})
- API Documentation: serpapi.com/google-autocomplete-api
Search Google Product
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'google_product',
'q': 'coffee',
'product_id': '4887235756540435899',
})
- API Documentation: serpapi.com/google-product-api
Search Google Reverse Image
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'google_reverse_image',
'image_url': 'https://i.imgur.com/5bGzZi7.jpg',
'max_results': '1',
})
- API Documentation: serpapi.com/google-reverse-image
Search Google Events
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'google_events',
'q': 'coffee',
})
- API Documentation: serpapi.com/google-events-api
Search Google Local Services
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'google_local_services',
'q': 'electrician',
'data_cid': '6745062158417646970',
})
- API Documentation: serpapi.com/google-local-services-api
Search Google Maps
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'google_maps',
'q': 'pizza',
'll': '@40.7455096,-74.0083012,15.1z',
'type': 'search',
})
- API Documentation: serpapi.com/google-maps-api
Search Google Jobs
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'google_jobs',
'q': 'coffee',
})
- API Documentation: serpapi.com/google-jobs-api
Search Google Play
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'google_play',
'q': 'kite',
'store': 'apps',
'max_results': '2',
})
- API Documentation: serpapi.com/google-play-api
Search Google Images
import os
import serpapi
client = serpapi.Client(api_key=os.getenv("API_KEY"))
results = client.search({
'engine': 'google_images',
'tbm': 'isch',
'q': 'coffee',
})
- API Documentation: serpapi.com/images-results
License
MIT License.
Contributing
Bug reports and pull requests are welcome on GitHub. Once dependencies are installed, you can run the tests with pytest
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file serpapi-0.1.5.tar.gz
.
File metadata
- Download URL: serpapi-0.1.5.tar.gz
- Upload date:
- Size: 14.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9707ed54750fdd2f62dc3a17c6a3fb7fa421dc37902fd65b2263c0ac765a1a5 |
|
MD5 | 96ed177557ba4c4746ba6524d0ef3f49 |
|
BLAKE2b-256 | f0fa3fd8809287f3977a3e752bb88610e918d49cb1038b14f4bc51e13e594197 |
File details
Details for the file serpapi-0.1.5-py2.py3-none-any.whl
.
File metadata
- Download URL: serpapi-0.1.5-py2.py3-none-any.whl
- Upload date:
- Size: 11.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6467b6adec1231059f754ccaa952b229efeaa8b9cae6e71f879703ec9e5bb3d1 |
|
MD5 | 0fcbf9d9163ab52e0e6d98f652752aef |
|
BLAKE2b-256 | df6a21deade04100d64844e494353a5d65e7971fbdfddf78eb1f248423593ad0 |