Merge pull request #1 from ScrapeGraphAI/feat/add-location-geo-code-to-searchscraper

feat: add locationGeoCode option to searchScraper for geo-targeted search

Author: VinciGit00

README.md

@@ -416,6 +416,28 @@ const prompt = 'What is the latest version of Python and what are its main featu
 })();
 ```
 
+#### Geo-Targeted Search
+
+Use `locationGeoCode` to target search results from a specific geographic location:
+
+```javascript
+import { searchScraper } from 'scrapegraph-js';
+
+const apiKey = 'your-api-key';
+const prompt = 'Best restaurants near me';
+
+(async () => {
+  try {
+    const response = await searchScraper(apiKey, prompt, 5, null, null, {
+      locationGeoCode: 'us' // Search results targeted to United States
+    });
+    console.log(response.result);
+  } catch (error) {
+    console.error('Error:', error);
+  }
+})();
+```
+
 ### Crawl API
 
 Start a crawl job to extract structured data from a website and its linked pages, using a custom schema.
@@ -1122,6 +1144,7 @@ Searches and extracts information from multiple web sources using AI.
   - `stealth` (boolean): Enable stealth mode
   - `extractionMode` (boolean): Whether to use AI extraction
   - `renderHeavyJs` (boolean): Whether to render heavy JavaScript
+  - `locationGeoCode` (string): The geo code of the location to search in (e.g., "us", "gb", "de")
   - `mock` (boolean): Override mock mode for this request
 
 **Returns:** Promise that resolves to an object containing:

src/searchScraper.js

@@ -21,11 +21,12 @@ import { getMockResponse } from './utils/mockResponse.js';
  * @param {boolean} [options.extractionMode=true] - Whether to use AI extraction (true) or markdown conversion (false).
  *                                                 AI extraction costs 10 credits per page, markdown conversion costs 2 credits per page.
  * @param {boolean} [options.stealth=false] - Enable stealth mode to avoid bot detection
+ * @param {string} [options.locationGeoCode=null] - The geo code of the location to search in (e.g., "us", "gb", "de")
  * @returns {Promise<string>} Extracted data in JSON format matching the provided schema
  * @throws - Will throw an error in case of an HTTP failure.
  */
 export async function searchScraper(apiKey, prompt, numResults = 3, schema = null, userAgent = null, options = {}) {
-  const { mock = null, renderHeavyJs = false, extractionMode = true, stealth = false } = options;
+  const { mock = null, renderHeavyJs = false, extractionMode = true, stealth = false, locationGeoCode = null } = options;
 
   // Check if mock mode is enabled
   const useMock = mock !== null ? mock : isMockEnabled();
@@ -61,6 +62,10 @@ export async function searchScraper(apiKey, prompt, numResults = 3, schema = nul
     payload.stealth = stealth;
   }
 
+  if (locationGeoCode) {
+    payload.location_geo_code = locationGeoCode;
+  }
+
   if (schema) {
     if (schema instanceof ZodType) {
       payload.output_schema = zodToJsonSchema(schema);