Skip to content

Commit c20e70c

Browse files
title fix, asynchronous header fix, search header fixes, example header update, markdown output keyword add, reword default output, playground and integration page links add
1 parent e7e950f commit c20e70c

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SerpApi Python Library & Package
1+
# SerpApi Python Library
22
[![Package](https://img.shields.io/pypi/v/serpapi?color=green)](https://pypi.org/project/serpapi) [![serpapi-python](https://github.com/serpapi/serpapi-python/actions/workflows/ci.yml/badge.svg)](https://github.com/serpapi/serpapi-python/actions/workflows/ci.yml)
33

44
Integrate search data into your AI workflow, RAG / fine-tuning, or Python application using this official [SerpApi Python SDK](https://serpapi.com/integrations/python).
@@ -85,13 +85,13 @@ except serpapi.TimeoutError as e:
8585

8686
- **Asynchronous searches** for submitting non-blocking jobs and retrieving completed results from the Search Archive API.
8787
- **Persistent connections and connection pooling** for reusing HTTP connections across searches.
88-
- Search results as **Python dict** with `search`, token-efficient **Markdown** with `md`, or raw **search-engine HTML** with `html`.
88+
- Search results as **Python dict** by default, token-efficient **Markdown** with `"output": "md"`, or raw **search-engine HTML** with `"output": "html"`.
8989
- SDK methods for the [Image API](https://serpapi.com/image-api), [Location API](https://serpapi.com/locations-api), [Search Archive API](https://serpapi.com/search-archive-api), and [Account API](https://serpapi.com/account-api).
9090
- **Configurable HTTP timeouts** established by setting `timeout` in the client.
9191

9292
## Response formats
9393

94-
Use `search` and default output (none) for structured results decoded into a `dict`:
94+
Use `search` without `output` for structured results decoded into a `dict`:
9595

9696
```python
9797
results = client.search({
@@ -153,7 +153,7 @@ Everything else is passed with each call:
153153

154154
The client has no default `engine` or `async` setting, so include them in every search.
155155

156-
### Search asynchronously
156+
### Asynchronous searches
157157

158158
Use `{"async": True}` to submit searches without waiting for them to complete.
159159

@@ -215,7 +215,7 @@ print("done")
215215
This code batches searches into a [queue](https://en.wikipedia.org/wiki/Queue_(abstract_data_type)).
216216
Each search can take a few seconds to complete, so by the time the first ID is popped, its results are usually already in the archive. Searches that are still processing are put back in the queue and checked again.
217217

218-
## Basic examples in Python
218+
## Examples
219219

220220
Here are some examples of our most popular APIs. You can find the full list of supported engines and parameters in our [documentation](https://serpapi.com/search-engine-apis).
221221

@@ -376,7 +376,7 @@ pprint(text_blocks)
376376

377377
[See documentation](https://serpapi.com/google-ai-mode-api)
378378

379-
### Search Bing
379+
### Bing Search
380380

381381
Scrape Bing web search results, including organic results, ads, related searches, and more.
382382

@@ -396,7 +396,7 @@ pprint(results)
396396

397397
[See documentation](https://serpapi.com/bing-search-api)
398398

399-
### Search DuckDuckGo
399+
### DuckDuckGo Search
400400

401401
Scrape DuckDuckGo search results, including organic results, ads, knowledge graphs, and related searches.
402402

@@ -416,7 +416,7 @@ pprint(results)
416416

417417
[See documentation](https://serpapi.com/duckduckgo-search-api)
418418

419-
### Search Baidu
419+
### Baidu Search
420420

421421
Scrape Baidu search results, including organic results, answer boxes, and related searches.
422422

@@ -466,6 +466,13 @@ Documentation is [available on Read the Docs](https://serpapi-python.readthedocs
466466

467467
Change history is [available on GitHub](https://github.com/serpapi/serpapi-python/blob/master/HISTORY.md).
468468

469+
Browse the [SerpApi documentation](https://serpapi.com/search-api) to find supported APIs and parameters, or use the [Playground](https://serpapi.com/playground) to build a request and generate Python code.
470+
471+
Additional SDK resources:
472+
473+
- [Python SDK integration page](https://serpapi.com/integrations/python)
474+
- [SerpApi status](https://serpapi.com/api-metrics)
475+
469476
## License
470477

471478
MIT License.

0 commit comments

Comments
 (0)