add coordinates, update links to API

vs · vs · commit 20035dc39818 · 2024-01-23T23:39:44.000+02:00
diff --git a/outscraper/api_client.py b/outscraper/api_client.py
@@ -143,7 +143,7 @@ def google_search(self, query: Union[list, str], pages_per_query: int = 1, uule:
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Google-Search/paths/~1google-search-v2/get
+            See: https://app.outscraper.com/api-docs#tag/Google/paths/~1google-search-v3/get
         '''
         queries = as_list(query)
         wait_async = async_request or (len(queries) > 1 or pages_per_query > 1)
@@ -176,7 +176,7 @@ def google_search_news(self, query: Union[list, str], pages_per_query: int = 1,
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Google-Search/paths/~1google-search-news/get
+            See: https://app.outscraper.com/api-docs#tag/Google/paths/~1google-search-news/get
         '''
         response = requests.get(f'{self._api_url}/google-search-news', params={
             'query': as_list(query),
@@ -215,7 +215,7 @@ def google_maps_search_v1(self, query: Union[list, str], limit: int = 500, extra
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Google-Maps/paths/~1maps~1search/get
+            See: https://app.outscraper.com/api-docs#tag/Google/paths/~1maps~1search/get
         '''
         response = requests.get(f'{self._api_url}/maps/search', params={
             'query': as_list(query),
@@ -234,11 +234,12 @@ def google_maps_search_v1(self, query: Union[list, str], limit: int = 500, extra
         raise Exception(f'Response status code: {response.status_code}')
 
     def google_maps_search(self, query: Union[list, str], limit: int = 20, drop_duplicates: bool = False,
-        language: str = 'en', region: str = None, skip: int = 0, enrichment: list = None, fields: Union[list, str] = None,
+        language: str = 'en', region: str = None, skip: int = 0, coordinates: str = None,
+        enrichment: list = None, fields: Union[list, str] = None,
         async_request: bool = False, ui: bool = None, webhook: bool = None
     ) -> Union[list, dict]:
         '''
-            Get Google Maps Data V2 (speed optimized endpoint for real time data)
+            Get Google Maps Data V3 (speed optimized endpoint for real time data)
 
             Returns places from Google Maps based on a given search query (or many queries).
             The results from searches are the same as you would see by visiting a regular Google Maps site. However, in most cases, it's recommended to use locations inside queries (e.g., bars, NY, USA) as the IP addresses of Outscraper's servers might be located in different countries.
@@ -247,10 +248,11 @@ def google_maps_search(self, query: Union[list, str], limit: int = 20, drop_dupl
                     Parameters:
                             query (list | str): parameter defines the query you want to search. You can use anything that you would use on a regular Google Maps site. Additionally, you can use google_id. The example of valid queries: Real estate agency, Rome, Italy, The NoMad Restaurant, NY, USA, restaurants, Brooklyn 11203, 0x886916e8bc273979:0x5141fcb11460b226, etc. Using a lists allows multiple queries (up to 50) to be sent in one request and save on network latency time.
                             limit (int): parameter specifies the limit of places to take from one query search. The same as on Google Maps site, there are no more than 400 organizations per one query search. Use more precise categories (e.g., Asian restaurant, Italian restaurant) and/or locations (e.g., restaurants, Brooklyn 11211, restaurants, Brooklyn 11215) to overcome this limitation.
-                            skip (int): skip first N places, where N should be multiple to 20 (e.g. 0, 20, 40). It's commonly used in pagination.
                             drop_duplicates (bool): parameter specifies whether the bot will drop the same organizations from different queries. Using the parameter combines results from each query inside one big array.
                             language (str): parameter specifies the language to use for Google. Available values: "en", "de", "es", "es-419", "fr", "hr", "it", "nl", "pl", "pt-BR", "pt-PT", "vi", "tr", "ru", "ar", "th", "ko", "zh-CN", "zh-TW", "ja", "ach", "af", "ak", "ig", "az", "ban", "ceb", "xx-bork", "bs", "br", "ca", "cs", "sn", "co", "cy", "da", "yo", "et", "xx-elmer", "eo", "eu", "ee", "tl", "fil", "fo", "fy", "gaa", "ga", "gd", "gl", "gn", "xx-hacker", "ht", "ha", "haw", "bem", "rn", "id", "ia", "xh", "zu", "is", "jw", "rw", "sw", "tlh", "kg", "mfe", "kri", "la", "lv", "to", "lt", "ln", "loz", "lua", "lg", "hu", "mg", "mt", "mi", "ms", "pcm", "no", "nso", "ny", "nn", "uz", "oc", "om", "xx-pirate", "ro", "rm", "qu", "nyn", "crs", "sq", "sk", "sl", "so", "st", "sr-ME", "sr-Latn", "su", "fi", "sv", "tn", "tum", "tk", "tw", "wo", "el", "be", "bg", "ky", "kk", "mk", "mn", "sr", "tt", "tg", "uk", "ka", "hy", "yi", "iw", "ug", "ur", "ps", "sd", "fa", "ckb", "ti", "am", "ne", "mr", "hi", "bn", "pa", "gu", "or", "ta", "te", "kn", "ml", "si", "lo", "my", "km", "chr".
                             region (str): parameter specifies the region to use for Google. Available values: "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AG", "AR", "AM", "AU", "AT", "AZ", "BS", "BH", "BD", "BY", "BE", "BZ", "BJ", "BT", "BO", "BA", "BW", "BR", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "CF", "TD", "CL", "CN", "CO", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "EE", "ET", "FJ", "FI", "FR", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GT", "GG", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LY", "LI", "LT", "LU", "MG", "MW", "MY", "MV", "ML", "MT", "MU", "MX", "FM", "MD", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NZ", "NI", "NE", "NG", "NU", "MK", "NO", "OM", "PK", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RO", "RU", "RW", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "KR", "ES", "LK", "SH", "VC", "SR", "SE", "CH", "TW", "TJ", "TZ", "TH", "TL", "TG", "TO", "TT", "TN", "TR", "TM", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VE", "VN", "ZM", "ZW".
+                            skip (int): skip first N places, where N should be multiple to 20 (e.g. 0, 20, 40). It's commonly used in pagination.
+                            coordinates (str): parameter defines the coordinates of the location where you want your query to be applied. It has to be constructed in the next sequence: "@" + "latitude" + "," + "longitude" + "," + "zoom" (e.g. "@41.3954381,2.1628662,15.1z").
                             enrichment (list): parameter defines enrichments you want to apply to the results. Available values: "domains_service", "emails_validator_service", "disposable_email_checker", "whatsapp_checker", "imessage_checker", "phones_enricher_service", "trustpilot_service", "companies_data".
                             fields (list | str): parameter defines which fields you want to include with each item returned in the response. By default, it returns all fields.
                             async_request (bool): parameter defines the way you want to submit your task to Outscraper. It can be set to `False` (default) to send a task and wait until you got your results, or `True` to submit your task and retrieve the results later using a request ID with `get_request_archive`. Each response is available for `2` hours after a request has been completed.
@@ -259,17 +261,18 @@ def google_maps_search(self, query: Union[list, str], limit: int = 20, drop_dupl
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Google-Maps/paths/~1maps~1search-v2/get
+            See: https://app.outscraper.com/api-docs#tag/Google/paths/~1maps~1search-v3/get
         '''
         queries = as_list(query)
         wait_async = async_request or (len(queries) > 10 and limit > 1)
 
-        response = requests.get(f'{self._api_url}/maps/search-v2', params={
+        response = requests.get(f'{self._api_url}/maps/search-v3', params={
             'query': queries,
             'language': language,
             'region': region,
             'organizationsPerQueryLimit': limit,
             'skipPlaces': skip,
+            'coordinates': coordinates,
             'dropDuplicates': drop_duplicates,
             'async': wait_async,
             'enrichment': as_list(enrichment) if enrichment else '',
@@ -300,7 +303,7 @@ def google_maps_directions(self, query: Union[list, str], departure_time: int =
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Google-Maps/paths/~1maps~1directions/get
+            See: https://app.outscraper.com/api-docs#tag/Google/paths/~1maps~1directions/get
         '''
         response = requests.get(f'{self._api_url}/maps/directions', params={
             'query': as_list(query),
@@ -349,7 +352,7 @@ def google_maps_reviews_v2(self, query: Union[list, str], reviews_limit: int = 1
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Google-Maps/paths/~1maps~1reviews-v2/get
+            See: https://app.outscraper.com/api-docs#tag/Google/paths/~1maps~1reviews-v3/get
         '''
         response = requests.get(f'{self._api_url}/maps/reviews-v2', params={
             'query': as_list(query),
@@ -405,7 +408,7 @@ def google_maps_reviews(self, query: Union[list, str], reviews_limit: int = 10,
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Google-Maps/paths/~1maps~1reviews-v3/get
+            See: https://app.outscraper.com/api-docs#tag/Google/paths/~1maps~1reviews-v3/get
         '''
         queries = as_list(query)
         wait_async = async_request or reviews_limit > 499 or len(queries) > 10
@@ -448,7 +451,7 @@ def google_maps_photos(self, query: Union[list, str], photosLimit: int = 100, li
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Google-Maps/paths/~1maps~1photos/get
+            See: https://app.outscraper.com/api-docs#tag/Google/paths/~1maps~1photos-v3/get
         '''
         response = requests.get(f'{self._api_url}/maps/photos-v3', params={
             'query': as_list(query),
@@ -513,7 +516,7 @@ def emails_and_contacts(self, query: Union[list, str], fields: Union[list, str]
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Emails-and-Contacts
+            See: https://app.outscraper.com/api-docs#tag/Email-Related/paths/~1emails-and-contacts/get
         '''
         response = requests.get(f'{self._api_url}/emails-and-contacts', params={
             'query': as_list(query),
@@ -536,7 +539,7 @@ def phones_enricher(self, query: Union[list, str], fields: Union[list, str] = No
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Phones/paths/~1phones-enricher/get
+            See: https://app.outscraper.com/api-docs#tag/Phone-Related/paths/~1phones-enricher/get
         '''
         response = requests.get(f'{self._api_url}/phones-enricher', params={
             'query': as_list(query),
@@ -552,6 +555,8 @@ def amazon_products(self, query: Union[list, str], limit: int = 24, fields: Unio
         ui: bool = None, webhook: bool = None
     ) -> Union[list, dict]:
         '''
+            Amazon Products V2 (speed optimized)
+
             Returns information about products on Amazon.
 
                     Parameters:
@@ -564,12 +569,12 @@ def amazon_products(self, query: Union[list, str], limit: int = 24, fields: Unio
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Amazon/paths/~1amazon~1products/get
+            See: https://app.outscraper.com/api-docs#tag/Amazon/paths/~1amazon~1products-v2/get
         '''
         queries = as_list(query)
         wait_async = async_request or (len(queries) > 1 and limit > 1)
 
-        response = requests.get(f'{self._api_url}/amazon/products', params={
+        response = requests.get(f'{self._api_url}/amazon/products-v2', params={
             'query': queries,
             'limit': limit,
             'async': wait_async,
@@ -636,7 +641,7 @@ def yelp_search(self, query: Union[list, str], limit: int = 100,
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Yelp/paths/~1yelp-search/get
+            See: https://app.outscraper.com/api-docs#tag/Others/paths/~1yelp-search/get
         '''
         queries = as_list(query)
         wait_async = async_request or len(queries) > 10
@@ -672,7 +677,7 @@ def yelp_reviews(self, query: Union[list, str], limit: int = 100, sort: str = 'r
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Yelp/paths/~1yelp~1reviews/get
+            See: https://app.outscraper.com/api-docs#tag/Reviews-and-Comments/paths/~1yelp~1reviews/get
         '''
         queries = as_list(query)
         wait_async = async_request or limit > 499 or len(queries) > 10
@@ -708,7 +713,7 @@ def tripadvisor_reviews(self, query: Union[list, str], limit: int = 100,
                     Returns:
                             list: json result
 
-            See: https://app.outscraper.com/api-docs#tag/Tripadvisor/paths/~1tripadvisor~1reviews/get
+            See: https://app.outscraper.com/api-docs#tag/Reviews-and-Comments/paths/~1trustpilot~1reviews/get
         '''
         queries = as_list(query)
         wait_async = async_request or limit > 499 or len(queries) > 10
diff --git a/setup.py b/setup.py
@@ -8,7 +8,7 @@ def readme():
 
 setup(
     name='outscraper',
-    version='4.1.0',
+    version='5.0.0',
     description='Python bindings for the Outscraper API',
     long_description=readme(),
     classifiers = ['Programming Language :: Python',
