Skip to content

Commit 9ac9d4d

Browse files
committed
feat: move to static docs site using great-docs package
1 parent 2d51097 commit 9ac9d4d

14 files changed

Lines changed: 643 additions & 0 deletions
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: "Amazon Product Search"
3+
description: "Search Amazon products and read price, rating, delivery, and product identifiers."
4+
---
5+
6+
# Amazon Product Search
7+
8+
Use the Amazon Search API when you need product listings, prices, ratings, delivery details, sponsored products, or Amazon product identifiers. The Amazon engine uses `k` for the search query.
9+
10+
## Search Products
11+
12+
```python
13+
import os
14+
import serpapi
15+
16+
17+
client = serpapi.Client(api_key=os.environ["SERPAPI_KEY"], timeout=20)
18+
19+
results = client.search(
20+
engine="amazon",
21+
k="coffee grinder",
22+
amazon_domain="amazon.com",
23+
)
24+
25+
for product in results.get("organic_results", [])[:5]:
26+
print(product.get("title"))
27+
print(product.get("price"), product.get("rating"), product.get("reviews"))
28+
print(product.get("asin"), product.get("link_clean"))
29+
```
30+
31+
## What to Read
32+
33+
Start with `organic_results` for product cards. Useful fields include `title`, `asin`, `price`, `extracted_price`, `rating`, `reviews`, `thumbnail`, `delivery`, `prime`, `link_clean`, and `serpapi_link`. Some searches also return `product_ads`, `featured_products`, `video_results`, `filters`, and `related_searches`.
34+
35+
For localization, sorting, category nodes, and Amazon-specific filters, see the [Amazon Search API documentation](https://serpapi.com/amazon-search-api). Use the [SerpApi Playground](https://serpapi.com/playground) to inspect result shapes for the product category you care about.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: "Walmart Product Search"
3+
description: "Search Walmart products and read pricing, reviews, shipping, and product IDs."
4+
---
5+
6+
# Walmart Product Search
7+
8+
Use the Walmart Search API for product search, price monitoring, catalog enrichment, and availability checks. Walmart uses `query` instead of `q`.
9+
10+
## Search Products
11+
12+
```python
13+
import os
14+
import serpapi
15+
16+
17+
client = serpapi.Client(api_key=os.environ["SERPAPI_KEY"], timeout=20)
18+
19+
results = client.search(
20+
engine="walmart",
21+
query="coffee maker",
22+
walmart_domain="walmart.com",
23+
)
24+
25+
for product in results.get("organic_results", [])[:5]:
26+
offer = product.get("primary_offer", {})
27+
print(product.get("title"))
28+
print(offer.get("offer_price"), product.get("rating"), product.get("reviews"))
29+
print(product.get("us_item_id"), product.get("product_page_url"))
30+
```
31+
32+
## What to Read
33+
34+
Start with `organic_results`. Useful fields include `title`, `us_item_id`, `product_id`, `rating`, `reviews`, `seller_name`, `primary_offer.offer_price`, `price_per_unit`, `out_of_stock`, `product_page_url`, and `serpapi_product_page_url`.
35+
36+
Use `sort`, `min_price`, `max_price`, `store_id`, and `facet` when you need more targeted product monitoring. See the [Walmart Search API documentation](https://serpapi.com/walmart-search-api) for supported filters and pagination behavior.
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: "Tripadvisor Travel Search"
3+
description: "Search Tripadvisor places, hotels, restaurants, and attractions."
4+
---
5+
6+
# Tripadvisor Travel Search
7+
8+
Use the Tripadvisor Search API when you need destination, hotel, restaurant, attraction, or forum search results from Tripadvisor. The `ssrc` parameter narrows the search to a result type such as hotels, restaurants, or things to do.
9+
10+
## Search Places
11+
12+
```python
13+
import os
14+
import serpapi
15+
16+
17+
client = serpapi.Client(api_key=os.environ["SERPAPI_KEY"], timeout=20)
18+
19+
results = client.search(
20+
engine="tripadvisor",
21+
q="Rome",
22+
ssrc="h",
23+
)
24+
25+
for place in results.get("places", [])[:5]:
26+
print(place.get("title"))
27+
print(place.get("place_type"), place.get("location"))
28+
print(place.get("link"))
29+
```
30+
31+
## What to Read
32+
33+
Start with `places`. Useful fields include `title`, `place_type`, `place_id`, `location`, `description`, `thumbnail`, `link`, and `serpapi_link`.
34+
35+
Use `ssrc` to focus the search: `h` for hotels, `r` for restaurants, `A` for things to do, `g` for destinations, and `a` for all results. See the [Tripadvisor Search API documentation](https://serpapi.com/tripadvisor-search-api) for the current filter and pagination options.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: "Google Shopping Price Monitoring"
3+
description: "Filter Google Shopping results by price and read product cards for monitoring workflows."
4+
---
5+
6+
# Google Shopping Price Monitoring
7+
8+
Use the Google Shopping API when you need product cards from many merchants. For price monitoring, combine query, market, price filters, and selected result fields.
9+
10+
## Search Filtered Products
11+
12+
```python
13+
import os
14+
import serpapi
15+
16+
17+
client = serpapi.Client(api_key=os.environ["SERPAPI_KEY"], timeout=20)
18+
19+
results = client.search(
20+
engine="google_shopping",
21+
q="espresso machine",
22+
location="Austin, Texas",
23+
gl="us",
24+
hl="en",
25+
min_price=100,
26+
max_price=800,
27+
sort_by=1,
28+
json_restrictor="shopping_results[].{title, price, source, rating, reviews, link}",
29+
)
30+
31+
for product in results.get("shopping_results", [])[:5]:
32+
print(product.get("title"))
33+
print(product.get("price"), product.get("source"))
34+
print(product.get("rating"), product.get("reviews"))
35+
```
36+
37+
## What to Read
38+
39+
Start with `shopping_results`. Useful fields include `title`, `product_id`, `price`, `extracted_price`, `source`, `rating`, `reviews`, `thumbnail`, `delivery`, `product_link`, and `serpapi_immersive_product_api`.
40+
41+
Use `min_price`, `max_price`, `sort_by`, `free_shipping`, and `on_sale` for monitoring workflows. For pagination, prefer `serpapi_pagination.next` over hand-built offsets when it is present. See the [Google Shopping API documentation](https://serpapi.com/google-shopping-api) for the full parameter set.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: "DuckDuckGo Search"
3+
description: "Run a DuckDuckGo search and read organic result fields."
4+
---
5+
6+
# DuckDuckGo Search
7+
8+
Use the DuckDuckGo Search API when you need another privacy-oriented web result source alongside Google and Bing. Start with a simple query, then add region and time filters when your workflow needs them.
9+
10+
## Search DuckDuckGo
11+
12+
```python
13+
import os
14+
import serpapi
15+
16+
17+
client = serpapi.Client(api_key=os.environ["SERPAPI_KEY"], timeout=20)
18+
19+
results = client.search(
20+
engine="duckduckgo",
21+
q="coffee",
22+
)
23+
24+
for result in results.get("organic_results", [])[:5]:
25+
print(result.get("position"), result.get("title"))
26+
print(result.get("link"))
27+
```
28+
29+
## What to Read
30+
31+
Most workflows start with `organic_results`. Useful fields include `title`, `link`, `snippet`, `position`, and any rich result blocks returned for the query.
32+
33+
See the [DuckDuckGo Search API documentation](https://serpapi.com/duckduckgo-search-api) for region, date, and safe-search options.

docs/examples/16-baidu-search.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: "Baidu Search"
3+
description: "Search Baidu results for China-focused research workflows."
4+
---
5+
6+
# Baidu Search
7+
8+
Use the Baidu Search API when your application needs results from Baidu's web index. It is useful for China-focused SEO checks, market research, and search result monitoring.
9+
10+
## Search Baidu
11+
12+
```python
13+
import os
14+
import serpapi
15+
16+
17+
client = serpapi.Client(api_key=os.environ["SERPAPI_KEY"], timeout=20)
18+
19+
results = client.search(
20+
engine="baidu",
21+
q="coffee",
22+
)
23+
24+
for result in results.get("organic_results", [])[:5]:
25+
print(result.get("position"), result.get("title"))
26+
print(result.get("link"))
27+
```
28+
29+
## What to Read
30+
31+
Start with `organic_results`, then inspect any top-level result blocks returned by the query. Baidu result shapes can vary by keyword, so store only fields you have observed in sample responses.
32+
33+
See the [Baidu Search API documentation](https://serpapi.com/baidu-search-api) for supported filters.
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: "Google Local Services"
3+
description: "Read Google Local Services ad cards for a service category."
4+
---
5+
6+
# Google Local Services
7+
8+
Use the Google Local Services API when you need local services ad data for a category, provider, or market. It returns ad cards rather than general Google Maps place results.
9+
10+
## Search Local Services
11+
12+
```python
13+
import os
14+
import serpapi
15+
16+
17+
client = serpapi.Client(api_key=os.environ["SERPAPI_KEY"], timeout=20)
18+
19+
results = client.search(
20+
engine="google_local_services",
21+
q="electrician",
22+
data_cid="6745062158417646970",
23+
)
24+
25+
for ad in results.get("local_ads", [])[:5]:
26+
print(ad.get("title"))
27+
print(ad.get("rating"), ad.get("reviews"))
28+
print(ad.get("phone"))
29+
```
30+
31+
## What to Read
32+
33+
Start with `local_ads`. Useful fields include `title`, `rating`, `reviews`, `phone`, `service_area`, `years_in_business`, and `link` when present.
34+
35+
See the [Google Local Services API documentation](https://serpapi.com/google-local-services-api) for query and provider detail options.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: "eBay Product Listings"
3+
description: "Search eBay listings and read product, price, and seller fields."
4+
---
5+
6+
# eBay Product Listings
7+
8+
Use the eBay Search API when you need marketplace listings, prices, condition data, or seller result pages. eBay uses `_nkw` for the search keyword.
9+
10+
## Search eBay
11+
12+
```python
13+
import os
14+
import serpapi
15+
16+
17+
client = serpapi.Client(api_key=os.environ["SERPAPI_KEY"], timeout=20)
18+
19+
results = client.search(
20+
engine="ebay",
21+
_nkw="coffee",
22+
)
23+
24+
for listing in results.get("organic_results", [])[:5]:
25+
print(listing.get("title"))
26+
print(listing.get("price"), listing.get("condition"))
27+
print(listing.get("link"))
28+
```
29+
30+
## What to Read
31+
32+
Start with `organic_results`. Useful fields include `title`, `price`, `condition`, `shipping`, `location`, `seller`, `thumbnail`, and `link`.
33+
34+
See the [eBay Search API documentation](https://serpapi.com/ebay-search-api) for filters, sorting, and pagination.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: "Home Depot Product Search"
3+
description: "Search Home Depot product cards and read price, rating, and product identifiers."
4+
---
5+
6+
# Home Depot Product Search
7+
8+
Use The Home Depot Search API for home improvement product discovery, price tracking, and catalog enrichment. Start with a broad query and then add filters once you know the category shape.
9+
10+
## Search Products
11+
12+
```python
13+
import os
14+
import serpapi
15+
16+
17+
client = serpapi.Client(api_key=os.environ["SERPAPI_KEY"], timeout=20)
18+
19+
results = client.search(
20+
engine="home_depot",
21+
q="table",
22+
)
23+
24+
for product in results.get("products", [])[:5]:
25+
print(product.get("title"))
26+
print(product.get("price"), product.get("rating"))
27+
print(product.get("product_id"))
28+
```
29+
30+
## What to Read
31+
32+
Start with `products`. Useful fields include `title`, `product_id`, `price`, `rating`, `reviews`, `brand`, `thumbnail`, and product URLs when present.
33+
34+
See the [The Home Depot Search API documentation](https://serpapi.com/home-depot-search-api) for product filters and pagination.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: "Google Events Discovery"
3+
description: "Search Google Events for upcoming event cards."
4+
---
5+
6+
# Google Events Discovery
7+
8+
Use the Google Events API when you need event cards for a topic, venue, or local market. It returns event-specific metadata instead of general organic search results.
9+
10+
## Search Events
11+
12+
```python
13+
import os
14+
import serpapi
15+
16+
17+
client = serpapi.Client(api_key=os.environ["SERPAPI_KEY"], timeout=20)
18+
19+
results = client.search(
20+
engine="google_events",
21+
q="coffee",
22+
)
23+
24+
for event in results.get("events_results", [])[:5]:
25+
print(event.get("title"))
26+
print(event.get("date", {}).get("when"))
27+
print(event.get("address"))
28+
```
29+
30+
## What to Read
31+
32+
Start with `events_results`. Useful fields include `title`, `date`, `address`, `link`, `ticket_info`, `venue`, and `description` when present.
33+
34+
See the [Google Events API documentation](https://serpapi.com/google-events-api) for date and location parameters.

0 commit comments

Comments
 (0)