Skip to content

Commit 37b9118

Browse files
committed
Update README to higlight the new Markdown Output
1 parent c7cedd6 commit 37b9118

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
[![License](https://img.shields.io/github/license/serpapi/serpapi-javascript)](https://github.com/serpapi/serpapi-javascript/blob/master/LICENSE)
77
[![SerpApi Libraries](https://img.shields.io/badge/SerpApi-Libraries-blue)](https://serpapi.com/integrations)
88

9-
Scrape and parse search engine results using [SerpApi](https://serpapi.com). Get
10-
search results from Google, Bing, Baidu, Yandex, Yahoo, Home Depot, eBay and
11-
more.
9+
Scrape and parse search engine results using [SerpApi](https://serpapi.com).
10+
Retrieve structured JSON, token-efficient Markdown for AI agents, or raw HTML
11+
from Google, Bing, Baidu, Yandex, Yahoo, Home Depot, eBay and more.
1212

1313
| 🪧 Coming from `google-search-results-nodejs`? <br /> Check out the [migration document](https://github.com/serpapi/serpapi-javascript/blob/master/docs/migrating_from_google_search_results_nodejs.md) to find out how to upgrade. |
1414
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -407,6 +407,7 @@ Get a Markdown response given a search ID.
407407
#### Examples
408408

409409
```javascript
410+
// Submit as JSON so the search ID is available in the structured response.
410411
const response = await getJson({
411412
engine: "google",
412413
api_key: API_KEY,

‎src/serpapi.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,7 @@ export async function getHtmlBySearchId(
353353
* @param {number=} [parameters.timeout] Timeout in milliseconds.
354354
* @param {fn=} callback Optional callback.
355355
* @example
356+
* // Submit as JSON so the search ID is available in the structured response.
356357
* const response = await getJson({ engine: "google", api_key: API_KEY, async: true, q: "coffee" });
357358
* const { id } = response.search_metadata;
358359
* await delay(1000); // wait for the request to be processed.

0 commit comments

Comments
 (0)