Add parse parameter to search function for JSON parsing support

- Add parse parameter to search() method in both API and client
- When parse=True, appends &brd_json=1 to search URLs
- Update documentation to describe the new parameter
- Add unit test to verify URL construction
- Update examples to demonstrate usage
- Bump version to 1.0.4

Author: עידן וילנסקי

brightdata/__init__.py

@@ -32,7 +32,7 @@
     APIError
 )
 
-__version__ = "1.0.3"
+__version__ = "1.0.4"
 __author__ = "Bright Data"
 __email__ = "support@brightdata.com"
 

brightdata/api/search.py

@@ -35,7 +35,8 @@ def search(
         data_format: str = "markdown",
         async_request: bool = False,
         max_workers: int = 10,
-        timeout: int = None
+        timeout: int = None,
+        parse: bool = False
     ) -> Union[Dict[str, Any], str, List[Union[Dict[str, Any], str]]]:
         """
         ## Search the web using Bright Data SERP API
@@ -54,6 +55,7 @@ def search(
         - `async_request` (bool, optional): Enable asynchronous processing (default: `False`)
         - `max_workers` (int, optional): Maximum parallel workers for multiple queries (default: `10`)
         - `timeout` (int, optional): Request timeout in seconds (default: `30`)
+        - `parse` (bool, optional): Enable JSON parsing by adding brd_json=1 to URL (default: `False`)
         
         ### Returns:
         - Single query: `Dict[str, Any]` if `response_format="json"`, `str` if `response_format="raw"`
@@ -116,7 +118,7 @@ def search(
                     executor.submit(
                         self._perform_single_search,
                         single_query, zone, response_format, method, country,
-                        data_format, async_request, base_url, timeout
+                        data_format, async_request, base_url, timeout, parse
                     ): i
                     for i, single_query in enumerate(query)
                 }
@@ -133,7 +135,7 @@ def search(
         else:
             return self._perform_single_search(
                 query, zone, response_format, method, country, 
-                data_format, async_request, base_url, timeout
+                data_format, async_request, base_url, timeout, parse
             )
 
     def _perform_single_search(
@@ -146,14 +148,18 @@ def _perform_single_search(
         data_format: str,
         async_request: bool,
         base_url: str,
-        timeout: int
+        timeout: int,
+        parse: bool
     ) -> Union[Dict[str, Any], str]:
         """
         Perform a single search operation
         """
         encoded_query = quote_plus(query)
         url = f"{base_url}{encoded_query}"
 
+        if parse:
+            url += "&brd_json=1"
+        
         endpoint = "https://api.brightdata.com/request"
 
         payload = {

brightdata/client.py

@@ -207,7 +207,8 @@ def search(
         data_format: str = "markdown",
         async_request: bool = False,
         max_workers: int = None,
-        timeout: int = None
+        timeout: int = None,
+        parse: bool = False
     ) -> Union[Dict[str, Any], str, List[Union[Dict[str, Any], str]]]:
         """
         ## Search the web using Bright Data SERP API
@@ -226,6 +227,7 @@ def search(
         - `async_request` (bool, optional): Enable asynchronous processing (default: `False`)
         - `max_workers` (int, optional): Maximum parallel workers for multiple queries (default: `10`)
         - `timeout` (int, optional): Request timeout in seconds (default: `30`)
+        - `parse` (bool, optional): Enable JSON parsing by adding brd_json=1 to URL (default: `False`)
         
         ### Returns:
         - Single query: `Dict[str, Any]` if `response_format="json"`, `str` if `response_format="raw"`
@@ -264,7 +266,7 @@ def search(
 
         return self.search_api.search(
             query, search_engine, zone, response_format, method, country,
-            data_format, async_request, max_workers, timeout
+            data_format, async_request, max_workers, timeout, parse
         )
 
     def download_content(self, content: Union[Dict, str], filename: str = None, format: str = "json") -> str:

examples/scrape_example.py

@@ -12,4 +12,4 @@
 
 results = client.scrape(url=URL, max_workers=5)
 
-client.download_content(results)
+client.download_content(results)

examples/search_example.py

@@ -5,12 +5,12 @@
 
 from brightdata import bdclient
 
-client = bdclient(api_token="your-api-key",auto_create_zones=False, serp_zone="your-custom-serp-zone") # zone and API token can also be defined in .env file
+client = bdclient(api_token="your-api-token", auto_create_zones=False, serp_zone="your-custom-serp-zone") # zone and API token can also be defined in .env file
 
 query = ["iphone 16", "coffee maker", "portable projector", "sony headphones",
         "laptop stand", "power bank", "running shoes", "android tablet",
         "hiking backpack", "dash cam"]
 
-results = client.search(query, search_engine="bing", max_workers=10)
+results = client.search(query, max_workers=10)
 
-print(results)
+client.download_content(results)

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "brightdata-sdk"
-version = "1.0.3"
+version = "1.0.4"
 description = "Python SDK for Bright Data Web Scraping and SERP APIs"
 authors = [
     {name = "Bright Data", email = "support@brightdata.com"}

tests/test_client.py

@@ -94,6 +94,27 @@ def test_search_unsupported_engine(self, client):
         """Test unsupported search engine validation"""
         with pytest.raises(ValidationError, match="Invalid search engine"):
             client.search("test query", search_engine="invalid_engine")
+    
+    def test_search_with_parse_parameter(self, client, monkeypatch):
+        """Test search with parse parameter adds brd_json=1 to URL"""
+        # Mock the session.post method to capture the request
+        captured_request = {}
+        
+        def mock_post(*args, **kwargs):
+            captured_request.update(kwargs)
+            from unittest.mock import Mock
+            response = Mock()
+            response.status_code = 200
+            response.text = "mocked html response"
+            return response
+        
+        monkeypatch.setattr(client.search_api.session, 'post', mock_post)
+        
+        result = client.search("test query", parse=True)
+        
+        # Verify the request was made with correct URL containing &brd_json=1
+        request_data = captured_request.get('json', {})
+        assert "&brd_json=1" in request_data["url"]
 
 
 if __name__ == "__main__":