From 0d4a1cae86b4c2b0d09f8a3226c7587c78262d05 Mon Sep 17 00:00:00 2001 From: justserpapi <258152455+justserpapi@users.noreply.github.com> Date: Wed, 15 Apr 2026 04:48:09 +0000 Subject: [PATCH] chore: sync OpenAPI-generated Ruby SDK --- Gemfile.lock | 39 ++ .../lib/justserpapi/api/google_api.rb | 440 ++++++++++----- openapi/normalized/justserpapi.openapi.json | 489 ++++++++++++++--- openapi/raw/justserpapi.openapi.json | 517 ++++++++++++++---- 4 files changed, 1205 insertions(+), 280 deletions(-) create mode 100644 Gemfile.lock diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..161c53a --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,39 @@ +PATH + remote: . + specs: + justserpapi (0.1.0) + faraday (>= 1.0.1, < 3.0) + faraday-multipart (~> 1.0) + marcel (~> 1.0) + +GEM + remote: https://rubygems.org/ + specs: + faraday (2.14.1) + faraday-net_http (>= 2.0, < 3.5) + json + logger + faraday-multipart (1.2.0) + multipart-post (~> 2.0) + faraday-net_http (3.4.2) + net-http (~> 0.5) + json (2.19.3) + logger (1.7.0) + marcel (1.1.0) + minitest (5.27.0) + multipart-post (2.4.1) + net-http (0.9.1) + uri (>= 0.11.1) + rake (13.4.1) + uri (1.1.1) + +PLATFORMS + x86_64-linux + +DEPENDENCIES + justserpapi! + minitest (~> 5.22) + rake (~> 13.0) + +BUNDLED WITH + 2.4.19 diff --git a/generated/ruby-client/lib/justserpapi/api/google_api.rb b/generated/ruby-client/lib/justserpapi/api/google_api.rb index fb3e47a..3e4897a 100644 --- a/generated/ruby-client/lib/justserpapi/api/google_api.rb +++ b/generated/ruby-client/lib/justserpapi/api/google_api.rb @@ -19,8 +19,8 @@ class GoogleApi def initialize(api_client = ApiClient.default) @api_client = api_client end - # Google AI Mode API - # Access Google's AI-powered search mode with our specialized API. Capture generated answers, follow-up questions, and source links to understand how AI is reshaping search discovery. + # AI Mode + # Get Google aI Mode data, including generated answers, follow-up prompts, and cited links, for AI search experience monitoring. # @param query [String] The search query for Google Search (e.g., 'coffee shops', 'how to bake a cake'). # @param [Hash] opts the optional parameters # @option opts [Boolean] :html Set to true to return the raw HTML of the Google search results page alongside the structured data. @@ -34,8 +34,8 @@ def ai_mode(query, opts = {}) data end - # Google AI Mode API - # Access Google's AI-powered search mode with our specialized API. Capture generated answers, follow-up questions, and source links to understand how AI is reshaping search discovery. + # AI Mode + # Get Google aI Mode data, including generated answers, follow-up prompts, and cited links, for AI search experience monitoring. # @param query [String] The search query for Google Search (e.g., 'coffee shops', 'how to bake a cake'). # @param [Hash] opts the optional parameters # @option opts [Boolean] :html Set to true to return the raw HTML of the Google search results page alongside the structured data. @@ -98,8 +98,8 @@ def ai_mode_with_http_info(query, opts = {}) return data, status_code, headers end - # Google AI Overview API - # Scrape Google's AI-generated search overviews and get structured insights directly from Google's generative search experience. Ideal for SEO research and monitoring generative search trends. + # AI Overview + # Get Google aI Overview data, including generated summaries and cited sources, for generative search visibility tracking. # @param url [String] The unique URL generated by Google to access the AI Overview. This URL is typically extracted from the 'ai_overview_url' field in a <a href=\"/reference/google/search\">Google Search API</a> response. Note: This URL is transient and usually expires within 2 minutes. # @param [Hash] opts the optional parameters # @return [JustSerpApiResponse] @@ -108,8 +108,8 @@ def ai_overview(url, opts = {}) data end - # Google AI Overview API - # Scrape Google's AI-generated search overviews and get structured insights directly from Google's generative search experience. Ideal for SEO research and monitoring generative search trends. + # AI Overview + # Get Google aI Overview data, including generated summaries and cited sources, for generative search visibility tracking. # @param url [String] The unique URL generated by Google to access the AI Overview. This URL is typically extracted from the 'ai_overview_url' field in a <a href=\"/reference/google/search\">Google Search API</a> response. Note: This URL is transient and usually expires within 2 minutes. # @param [Hash] opts the optional parameters # @return [Array<(JustSerpApiResponse, Integer, Hash)>] JustSerpApiResponse data, response status code and response headers @@ -162,8 +162,8 @@ def ai_overview_with_http_info(url, opts = {}) return data, status_code, headers end - # Google Autocomplete API - # Powerful Google Autocomplete API to fetch real-time search suggestions. Ideal for keyword discovery and SEO optimization. Captures dynamic suggestions Google provides as users type, offering high-value long-tail keywords and related search intent across various niches and regions. + # Autocomplete Suggestions + # Get Google autocomplete Suggestions data, including real-time suggestion data, country and language targeting, and structured suggestion lists, for keyword expansion and search intent research. # @param query [String] The search query to get autocomplete suggestions for. As you type, Google provides real-time predictions based on popular searches. # @param [Hash] opts the optional parameters # @option opts [String] :country Set the target country code (e.g., 'us', 'uk') to localize results. See <a href=\"/reference/google-countries\">Google Countries</a>. @@ -174,8 +174,8 @@ def autocomplete(query, opts = {}) data end - # Google Autocomplete API - # Powerful Google Autocomplete API to fetch real-time search suggestions. Ideal for keyword discovery and SEO optimization. Captures dynamic suggestions Google provides as users type, offering high-value long-tail keywords and related search intent across various niches and regions. + # Autocomplete Suggestions + # Get Google autocomplete Suggestions data, including real-time suggestion data, country and language targeting, and structured suggestion lists, for keyword expansion and search intent research. # @param query [String] The search query to get autocomplete suggestions for. As you type, Google provides real-time predictions based on popular searches. # @param [Hash] opts the optional parameters # @option opts [String] :country Set the target country code (e.g., 'us', 'uk') to localize results. See <a href=\"/reference/google-countries\">Google Countries</a>. @@ -232,8 +232,8 @@ def autocomplete_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Finance Search API - # Scrape real-time stock market data, financial news, and currency exchange rates with our Google Finance Search SERP API. Get structured financial information including market movements, historical trends, and detailed company profiles. + # Finance Search + # Get Google finance Search data, including market summaries, company details, and related finance results, for finance monitoring and market research. # @param query [String] The stock symbol, company name, or index you want to search for on Google Finance (e.g., 'AAPL', 'Tesla', 'S&P 500'). # @param [Hash] opts the optional parameters # @option opts [Boolean] :html Set to true to return the raw HTML of the Google search results page alongside the structured data. @@ -244,8 +244,8 @@ def finance_search(query, opts = {}) data end - # Google Finance Search API - # Scrape real-time stock market data, financial news, and currency exchange rates with our Google Finance Search SERP API. Get structured financial information including market movements, historical trends, and detailed company profiles. + # Finance Search + # Get Google finance Search data, including market summaries, company details, and related finance results, for finance monitoring and market research. # @param query [String] The stock symbol, company name, or index you want to search for on Google Finance (e.g., 'AAPL', 'Tesla', 'S&P 500'). # @param [Hash] opts the optional parameters # @option opts [Boolean] :html Set to true to return the raw HTML of the Google search results page alongside the structured data. @@ -302,8 +302,8 @@ def finance_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Hotels Search API - # Scrape hotel listings, prices, ratings, and availability for competitive analysis and travel booking insights. Monitor room rates and identify popular amenities with precise hospitality market data. + # Hotels Search + # Get Google hotels Search data, including prices, ratings, and availability details, for travel comparison and hospitality market analysis. # @param query [String] The destination or specific hotel name you are searching for (e.g., 'Paris', 'Hilton New York'). # @param check_in_date [String] The hotel check-in date in 'YYYY-MM-DD' format (e.g., '2026-05-20'). # @param check_out_date [String] The hotel check-out date in 'YYYY-MM-DD' format (e.g., '2026-05-25'). @@ -337,8 +337,8 @@ def hotels_search(query, check_in_date, check_out_date, opts = {}) data end - # Google Hotels Search API - # Scrape hotel listings, prices, ratings, and availability for competitive analysis and travel booking insights. Monitor room rates and identify popular amenities with precise hospitality market data. + # Hotels Search + # Get Google hotels Search data, including prices, ratings, and availability details, for travel comparison and hospitality market analysis. # @param query [String] The destination or specific hotel name you are searching for (e.g., 'Paris', 'Hilton New York'). # @param check_in_date [String] The hotel check-in date in 'YYYY-MM-DD' format (e.g., '2026-05-20'). # @param check_out_date [String] The hotel check-out date in 'YYYY-MM-DD' format (e.g., '2026-05-25'). @@ -449,8 +449,72 @@ def hotels_search_with_http_info(query, check_in_date, check_out_date, opts = {} return data, status_code, headers end - # Google Images Search API - # Scrape high-resolution images and metadata from Google Images. Supports advanced filters like image size, color, and usage rights for precise visual data extraction for AI models or product monitoring. + # Crawl Webpage (HTML) + # Get webpage crawl data, including returns full raw HTML content, fast and cost-efficient, and optimized for static page crawling, for scraping, metadata extraction, and page structure analysis. + # @param url [String] The full URL of the webpage to crawl (e.g., 'https://www.example.com'). + # @param [Hash] opts the optional parameters + # @return [JustSerpApiResponse] + def html(url, opts = {}) + data, _status_code, _headers = html_with_http_info(url, opts) + data + end + + # Crawl Webpage (HTML) + # Get webpage crawl data, including returns full raw HTML content, fast and cost-efficient, and optimized for static page crawling, for scraping, metadata extraction, and page structure analysis. + # @param url [String] The full URL of the webpage to crawl (e.g., 'https://www.example.com'). + # @param [Hash] opts the optional parameters + # @return [Array<(JustSerpApiResponse, Integer, Hash)>] JustSerpApiResponse data, response status code and response headers + def html_with_http_info(url, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: GoogleApi.html ...' + end + # verify the required parameter 'url' is set + if @api_client.config.client_side_validation && url.nil? + fail ArgumentError, "Missing the required parameter 'url' when calling GoogleApi.html" + end + # resource path + local_var_path = '/api/v1/web/html' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'url'] = url + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'JustSerpApiResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'ApiKeyQuery'] + + new_options = opts.merge( + :operation => :"GoogleApi.html", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: GoogleApi#html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Images Search + # Get Google images Search data, including image URLs and metadata, for filtered image discovery for research and monitoring workflows. # @param query [String] The search query for images (e.g., 'mountain landscape', 'luxury cars'). # @param [Hash] opts the optional parameters # @option opts [Boolean] :html Set to true to return the raw HTML of the Google search results page alongside the structured data. @@ -481,8 +545,8 @@ def images_search(query, opts = {}) data end - # Google Images Search API - # Scrape high-resolution images and metadata from Google Images. Supports advanced filters like image size, color, and usage rights for precise visual data extraction for AI models or product monitoring. + # Images Search + # Get Google images Search data, including image URLs and metadata, for filtered image discovery for research and monitoring workflows. # @param query [String] The search query for images (e.g., 'mountain landscape', 'luxury cars'). # @param [Hash] opts the optional parameters # @option opts [Boolean] :html Set to true to return the raw HTML of the Google search results page alongside the structured data. @@ -579,8 +643,8 @@ def images_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Immersive Product API - # Access rich product data and immersive shopping results from Google. Scrape detailed product features, 3D views, and specifications to enhance e-commerce research and monitor brand presentation. + # Immersive Product + # Get Google immersive Product data, including features, specifications, and seller information, for product research and merchandising analysis. # @param page_token [String] The unique token used to retrieve detailed product information in Google's immersive view. This token is typically found in Google Shopping or Search results. # @param [Hash] opts the optional parameters # @option opts [Boolean] :stores If set to true, the API will retrieve a list of more sellers for the product. Use this together with the 'sori' parameter. @@ -593,8 +657,8 @@ def immersive_product(page_token, opts = {}) data end - # Google Immersive Product API - # Access rich product data and immersive shopping results from Google. Scrape detailed product features, 3D views, and specifications to enhance e-commerce research and monitor brand presentation. + # Immersive Product + # Get Google immersive Product data, including features, specifications, and seller information, for product research and merchandising analysis. # @param page_token [String] The unique token used to retrieve detailed product information in Google's immersive view. This token is typically found in Google Shopping or Search results. # @param [Hash] opts the optional parameters # @option opts [Boolean] :stores If set to true, the API will retrieve a list of more sellers for the product. Use this together with the 'sori' parameter. @@ -655,8 +719,8 @@ def immersive_product_with_http_info(page_token, opts = {}) return data, status_code, headers end - # Google Jobs Search API - # Scrape real-time job listings from Google Jobs for HR tech and recruitment apps. Extract structured data including job titles, descriptions, companies, and locations at scale. + # Jobs Search + # Get Google jobs Search data, including titles, companies, and locations, for aggregating job board results, analyzing hiring trends, and monitoring recruitment activity. # @param query [String] The job search query (e.g., 'software engineer', 'data scientist London'). # @param [Hash] opts the optional parameters # @option opts [String] :country Set the target country code (e.g., 'us', 'uk') to localize results. See <a href=\"/reference/google-countries\">Google Countries</a>. @@ -673,8 +737,8 @@ def jobs_search(query, opts = {}) data end - # Google Jobs Search API - # Scrape real-time job listings from Google Jobs for HR tech and recruitment apps. Extract structured data including job titles, descriptions, companies, and locations at scale. + # Jobs Search + # Get Google jobs Search data, including titles, companies, and locations, for aggregating job board results, analyzing hiring trends, and monitoring recruitment activity. # @param query [String] The job search query (e.g., 'software engineer', 'data scientist London'). # @param [Hash] opts the optional parameters # @option opts [String] :country Set the target country code (e.g., 'us', 'uk') to localize results. See <a href=\"/reference/google-countries\">Google Countries</a>. @@ -743,8 +807,8 @@ def jobs_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Lens API - # Extract visual search results and product info using our Google Lens API. Identify objects, products, and landmarks directly from images and discover related web links with high speed. + # Lens Search + # Get Google lens Search data, including visual matches, product matches, and related links, for visual search analysis and product matching workflows. # @param url [String] The URL of the image you want to analyze with Google Lens. Must be a publicly accessible image URL. # @param [Hash] opts the optional parameters # @option opts [String] :country Set the target country code (e.g., 'us', 'uk') to localize results. See <a href=\"/reference/google-countries\">Google Countries</a>. @@ -758,8 +822,8 @@ def lens(url, opts = {}) data end - # Google Lens API - # Extract visual search results and product info using our Google Lens API. Identify objects, products, and landmarks directly from images and discover related web links with high speed. + # Lens Search + # Get Google lens Search data, including visual matches, product matches, and related links, for visual search analysis and product matching workflows. # @param url [String] The URL of the image you want to analyze with Google Lens. Must be a publicly accessible image URL. # @param [Hash] opts the optional parameters # @option opts [String] :country Set the target country code (e.g., 'us', 'uk') to localize results. See <a href=\"/reference/google-countries\">Google Countries</a>. @@ -822,8 +886,8 @@ def lens_with_http_info(url, opts = {}) return data, status_code, headers end - # Google Local Search API - # Scrape local business listings and map results for structured data including addresses, phone numbers, and ratings. Extract valuable B2B lead info and analyze the local competitive landscape for specific keywords. + # Local Search + # Get Google local Search data, including business listings, ratings, and contact details, for local lead generation and competitor research. # @param query [String] The search query for local businesses (e.g., 'pizza', 'dentist near me'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -840,8 +904,8 @@ def local_search(query, opts = {}) data end - # Google Local Search API - # Scrape local business listings and map results for structured data including addresses, phone numbers, and ratings. Extract valuable B2B lead info and analyze the local competitive landscape for specific keywords. + # Local Search + # Get Google local Search data, including business listings, ratings, and contact details, for local lead generation and competitor research. # @param query [String] The search query for local businesses (e.g., 'pizza', 'dentist near me'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -910,8 +974,8 @@ def local_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Maps Photos API - # Extract high-quality photos and metadata from Google Maps locations. Access thousands of user-contributed and official photos for business listings and points of interest to build rich geographical content or verify local business details visually. + # Maps Photos + # Get Google maps Photos data, including related metadata, for visual location research and listing QA. # @param data_id [String] The unique Google Maps location ID (feature ID). You can get this from our Google Maps Search API. # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -923,8 +987,8 @@ def maps_photos(data_id, opts = {}) data end - # Google Maps Photos API - # Extract high-quality photos and metadata from Google Maps locations. Access thousands of user-contributed and official photos for business listings and points of interest to build rich geographical content or verify local business details visually. + # Maps Photos + # Get Google maps Photos data, including related metadata, for visual location research and listing QA. # @param data_id [String] The unique Google Maps location ID (feature ID). You can get this from our Google Maps Search API. # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -983,8 +1047,8 @@ def maps_photos_with_http_info(data_id, opts = {}) return data, status_code, headers end - # Google Maps Places API - # Get comprehensive details about specific locations using the Google Maps Places API. Scrape contact info, business hours, coordinates, and more from Google Maps for millions of locations worldwide. Perfect for directory sites, delivery apps, and local service guides. + # Maps Place Details + # Get Google maps Place Details data, including contact details and business information, for enrich business directories, look up place details, and sync local app data. # @param [Hash] opts the optional parameters # @option opts [String] :place_id The unique Google Place ID. Obtainable via the Google Maps Search API. Use this or 'data_id'. # @option opts [String] :data_id The unique Google Maps location data ID. Use this or 'place_id'. @@ -995,8 +1059,8 @@ def maps_places(opts = {}) data end - # Google Maps Places API - # Get comprehensive details about specific locations using the Google Maps Places API. Scrape contact info, business hours, coordinates, and more from Google Maps for millions of locations worldwide. Perfect for directory sites, delivery apps, and local service guides. + # Maps Place Details + # Get Google maps Place Details data, including contact details and business information, for enrich business directories, look up place details, and sync local app data. # @param [Hash] opts the optional parameters # @option opts [String] :place_id The unique Google Place ID. Obtainable via the Google Maps Search API. Use this or 'data_id'. # @option opts [String] :data_id The unique Google Maps location data ID. Use this or 'place_id'. @@ -1049,8 +1113,8 @@ def maps_places_with_http_info(opts = {}) return data, status_code, headers end - # Google Maps Posts API - # Scrape business updates and posts from Google Maps. Monitor time-sensitive announcements, promotional content, and official news directly from business profiles for local discovery or competitor monitoring. + # Maps Posts + # Get Google maps Posts data, including business post content, post dates and images, and profile-specific feeds, for local business monitoring and promotion tracking. # @param data_id [String] The unique Google Maps location ID (feature ID). You can get this from our Google Maps Search API. # @param [Hash] opts the optional parameters # @option opts [String] :next_page_token Token used to retrieve the next page of business posts. @@ -1060,8 +1124,8 @@ def maps_posts(data_id, opts = {}) data end - # Google Maps Posts API - # Scrape business updates and posts from Google Maps. Monitor time-sensitive announcements, promotional content, and official news directly from business profiles for local discovery or competitor monitoring. + # Maps Posts + # Get Google maps Posts data, including business post content, post dates and images, and profile-specific feeds, for local business monitoring and promotion tracking. # @param data_id [String] The unique Google Maps location ID (feature ID). You can get this from our Google Maps Search API. # @param [Hash] opts the optional parameters # @option opts [String] :next_page_token Token used to retrieve the next page of business posts. @@ -1116,8 +1180,8 @@ def maps_posts_with_http_info(data_id, opts = {}) return data, status_code, headers end - # Google Maps Reviews API - # Extract user reviews and ratings from Google Maps. Get structured data for sentiment analysis and brand reputation management. Deliver complete review texts, ratings, response statuses, and reviewer metadata at scale. + # Maps Reviews + # Get Google maps Reviews data, including ratings and reviewer metadata, for reputation analysis and review monitoring. # @param data_id [String] The unique Google Maps location ID (feature ID). You can get this from our Google Maps Search API. # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -1131,8 +1195,8 @@ def maps_reviews(data_id, opts = {}) data end - # Google Maps Reviews API - # Extract user reviews and ratings from Google Maps. Get structured data for sentiment analysis and brand reputation management. Deliver complete review texts, ratings, response statuses, and reviewer metadata at scale. + # Maps Reviews + # Get Google maps Reviews data, including ratings and reviewer metadata, for reputation analysis and review monitoring. # @param data_id [String] The unique Google Maps location ID (feature ID). You can get this from our Google Maps Search API. # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -1195,8 +1259,8 @@ def maps_reviews_with_http_info(data_id, opts = {}) return data, status_code, headers end - # Google Maps Search API - # Powerful Google Maps SERP API to scrape business listings and local search results. Search for businesses across any industry and region with precise coordinate support. Returns structured listings including addresses, map pins, and primary contact information. + # Maps Search + # Get Google maps Search data, including business listings, ratings and contact data, and coordinate and location targeting, for local market research and lead discovery. # @param query [String] The search query for Google Maps (e.g., 'restaurants', 'hospitals in New York'). # @param [Hash] opts the optional parameters # @option opts [String] :ll GPS coordinates for the search origin. Format: '@<latitude>,<longitude>,<zoom>'. Required for precise localization and pagination. @@ -1212,8 +1276,8 @@ def maps_search(query, opts = {}) data end - # Google Maps Search API - # Powerful Google Maps SERP API to scrape business listings and local search results. Search for businesses across any industry and region with precise coordinate support. Returns structured listings including addresses, map pins, and primary contact information. + # Maps Search + # Get Google maps Search data, including business listings, ratings and contact data, and coordinate and location targeting, for local market research and lead discovery. # @param query [String] The search query for Google Maps (e.g., 'restaurants', 'hospitals in New York'). # @param [Hash] opts the optional parameters # @option opts [String] :ll GPS coordinates for the search origin. Format: '@<latitude>,<longitude>,<zoom>'. Required for precise localization and pagination. @@ -1280,8 +1344,72 @@ def maps_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google News Search API - # Get real-time news headlines and stories with our Google News Search API. Scrape structured data including source info, publication dates, and related topics for media monitoring and news aggregation. + # Crawl Webpage (Markdown) + # Get webpage crawl data, including removing boilerplate, for readable extraction, documentation workflows, and LLM input. + # @param url [String] The full URL of the webpage to crawl and convert to Markdown (e.g., 'https://www.example.com'). + # @param [Hash] opts the optional parameters + # @return [JustSerpApiResponse] + def markdown(url, opts = {}) + data, _status_code, _headers = markdown_with_http_info(url, opts) + data + end + + # Crawl Webpage (Markdown) + # Get webpage crawl data, including removing boilerplate, for readable extraction, documentation workflows, and LLM input. + # @param url [String] The full URL of the webpage to crawl and convert to Markdown (e.g., 'https://www.example.com'). + # @param [Hash] opts the optional parameters + # @return [Array<(JustSerpApiResponse, Integer, Hash)>] JustSerpApiResponse data, response status code and response headers + def markdown_with_http_info(url, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: GoogleApi.markdown ...' + end + # verify the required parameter 'url' is set + if @api_client.config.client_side_validation && url.nil? + fail ArgumentError, "Missing the required parameter 'url' when calling GoogleApi.markdown" + end + # resource path + local_var_path = '/api/v1/web/markdown' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'url'] = url + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'JustSerpApiResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'ApiKeyQuery'] + + new_options = opts.merge( + :operation => :"GoogleApi.markdown", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: GoogleApi#markdown\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # News Search + # Get Google news Search data, including headlines and source metadata, for media monitoring and news aggregation. # @param query [String] The search query for Google News (e.g., 'artificial intelligence', 'climate change'). # @param [Hash] opts the optional parameters # @option opts [String] :country Set the target country code (e.g., 'us', 'uk') to localize results. See <a href=\"/reference/google-countries\">Google Countries</a>. @@ -1296,8 +1424,8 @@ def news_search(query, opts = {}) data end - # Google News Search API - # Get real-time news headlines and stories with our Google News Search API. Scrape structured data including source info, publication dates, and related topics for media monitoring and news aggregation. + # News Search + # Get Google news Search data, including headlines and source metadata, for media monitoring and news aggregation. # @param query [String] The search query for Google News (e.g., 'artificial intelligence', 'climate change'). # @param [Hash] opts the optional parameters # @option opts [String] :country Set the target country code (e.g., 'us', 'uk') to localize results. See <a href=\"/reference/google-countries\">Google Countries</a>. @@ -1362,8 +1490,8 @@ def news_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Patents Details API - # Get comprehensive patent information including abstracts, claims, descriptions, and legal statuses. Perform freedom-to-operate searches or competitor IP monitoring with reliable structured data. + # Patent Details + # Get Google patent Details data, including abstracts, claims, and legal status, for patent review and IP due diligence. # @param patent_id [String] The unique Google Patent ID (e.g., 'US1234567B1'). # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -1374,8 +1502,8 @@ def patent_details(patent_id, opts = {}) data end - # Google Patents Details API - # Get comprehensive patent information including abstracts, claims, descriptions, and legal statuses. Perform freedom-to-operate searches or competitor IP monitoring with reliable structured data. + # Patent Details + # Get Google patent Details data, including abstracts, claims, and legal status, for patent review and IP due diligence. # @param patent_id [String] The unique Google Patent ID (e.g., 'US1234567B1'). # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -1432,8 +1560,8 @@ def patent_details_with_http_info(patent_id, opts = {}) return data, status_code, headers end - # Google Patents Search API - # Powerful Google Patents SERP API to search and scrape patent documents. Filter by inventor, assignee, date, and status to stay updated on new filings or monitor corporate IP portfolios. + # Patent Search + # Get Google patent Search data, including filters, for patent discovery and portfolio monitoring. # @param query [String] The search query for patents (e.g., 'autonomous vehicles', 'blockchain security'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -1458,8 +1586,8 @@ def patent_search(query, opts = {}) data end - # Google Patents Search API - # Powerful Google Patents SERP API to search and scrape patent documents. Filter by inventor, assignee, date, and status to stay updated on new filings or monitor corporate IP portfolios. + # Patent Search + # Get Google patent Search data, including filters, for patent discovery and portfolio monitoring. # @param query [String] The search query for patents (e.g., 'autonomous vehicles', 'blockchain security'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -1544,8 +1672,72 @@ def patent_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Scholar Author API - # Scrape Google Scholar author profiles to get comprehensive lists of publications, citations, and research interests. Structured data for academic research, talent discovery, and tracking scholarly impact. + # Crawl Webpage (Rendered HTML) + # Get webpage crawl data, including returns full raw Rendered HTML content, fast and cost-efficient, and optimized for static page crawling, for scraping, metadata extraction, and page structure analysis. + # @param url [String] The full URL of the webpage to crawl (e.g., 'https://www.example.com'). + # @param [Hash] opts the optional parameters + # @return [JustSerpApiResponse] + def rendered_html(url, opts = {}) + data, _status_code, _headers = rendered_html_with_http_info(url, opts) + data + end + + # Crawl Webpage (Rendered HTML) + # Get webpage crawl data, including returns full raw Rendered HTML content, fast and cost-efficient, and optimized for static page crawling, for scraping, metadata extraction, and page structure analysis. + # @param url [String] The full URL of the webpage to crawl (e.g., 'https://www.example.com'). + # @param [Hash] opts the optional parameters + # @return [Array<(JustSerpApiResponse, Integer, Hash)>] JustSerpApiResponse data, response status code and response headers + def rendered_html_with_http_info(url, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: GoogleApi.rendered_html ...' + end + # verify the required parameter 'url' is set + if @api_client.config.client_side_validation && url.nil? + fail ArgumentError, "Missing the required parameter 'url' when calling GoogleApi.rendered_html" + end + # resource path + local_var_path = '/api/v1/web/rendered-html' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'url'] = url + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'JustSerpApiResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'ApiKeyQuery'] + + new_options = opts.merge( + :operation => :"GoogleApi.rendered_html", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: GoogleApi#rendered_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Scholar Author + # Get Google scholar Author data, including publications, citation metrics, and research interests, for researcher analysis and academic profiling. # @param author_id [String] The unique Google Scholar ID of the researcher/author (e.g., 'LSs6DR8AAAAJ'). # @param [Hash] opts the optional parameters # @option opts [Integer] :results The number of results to return per page. @@ -1559,8 +1751,8 @@ def scholar_author(author_id, opts = {}) data end - # Google Scholar Author API - # Scrape Google Scholar author profiles to get comprehensive lists of publications, citations, and research interests. Structured data for academic research, talent discovery, and tracking scholarly impact. + # Scholar Author + # Get Google scholar Author data, including publications, citation metrics, and research interests, for researcher analysis and academic profiling. # @param author_id [String] The unique Google Scholar ID of the researcher/author (e.g., 'LSs6DR8AAAAJ'). # @param [Hash] opts the optional parameters # @option opts [Integer] :results The number of results to return per page. @@ -1623,8 +1815,8 @@ def scholar_author_with_http_info(author_id, opts = {}) return data, status_code, headers end - # Google Scholar Cite Search API - # Retrieve citation information for specific academic papers and articles. Provides structured bibtex and citation formats (APA, MLA, Chicago, etc.) directly from Google Scholar. Perfect for automated bibliography generation and research management. + # Scholar Citations + # Get Google scholar Citations data, including export links, for bibliography automation and citation workflows. # @param query [String] The unique ID of a Google Scholar search result to retrieve citation formats for. Found in the 'id' field of previous Scholar Search responses. # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -1634,8 +1826,8 @@ def scholar_cite_search(query, opts = {}) data end - # Google Scholar Cite Search API - # Retrieve citation information for specific academic papers and articles. Provides structured bibtex and citation formats (APA, MLA, Chicago, etc.) directly from Google Scholar. Perfect for automated bibliography generation and research management. + # Scholar Citations + # Get Google scholar Citations data, including export links, for bibliography automation and citation workflows. # @param query [String] The unique ID of a Google Scholar search result to retrieve citation formats for. Found in the 'id' field of previous Scholar Search responses. # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -1690,8 +1882,8 @@ def scholar_cite_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Scholar Profiles API - # Search and extract data from Google Scholar user profiles. Get real-time access to researcher information, h-index, and publication history for academic networking and institutional research assessment. + # Scholar Profiles + # Get Google scholar Profiles data, including profile search results, affiliation and citation counts, and pagination tokens, for researcher discovery and academic directory building. # @param mauthors [String] The search query for author profiles (e.g., 'John Smith', 'Harvard University'). # @param [Hash] opts the optional parameters # @option opts [String] :after_author Token used to retrieve the next page of author profiles. @@ -1702,8 +1894,8 @@ def scholar_profiles(mauthors, opts = {}) data end - # Google Scholar Profiles API - # Search and extract data from Google Scholar user profiles. Get real-time access to researcher information, h-index, and publication history for academic networking and institutional research assessment. + # Scholar Profiles + # Get Google scholar Profiles data, including profile search results, affiliation and citation counts, and pagination tokens, for researcher discovery and academic directory building. # @param mauthors [String] The search query for author profiles (e.g., 'John Smith', 'Harvard University'). # @param [Hash] opts the optional parameters # @option opts [String] :after_author Token used to retrieve the next page of author profiles. @@ -1760,8 +1952,8 @@ def scholar_profiles_with_http_info(mauthors, opts = {}) return data, status_code, headers end - # Google Scholar Search API - # Comprehensive Google Scholar SERP API to scrape academic papers, patents, and legal documents. Filter by date, relevance, and citation count for precise research data and systematic literature reviews. + # Scholar Search + # Get Google scholar Search data, including papers, patents, and legal docs, citation and year filters, and versions and cited-by links, for literature review and academic result monitoring. # @param query [String] The academic search query (e.g., 'machine learning', 'CRISPR gene editing'). Supports advanced operators like 'author:'. # @param [Hash] opts the optional parameters # @option opts [Boolean] :html Set to true to return the raw HTML of the Google Scholar search page. @@ -1785,8 +1977,8 @@ def scholar_search(query, opts = {}) data end - # Google Scholar Search API - # Comprehensive Google Scholar SERP API to scrape academic papers, patents, and legal documents. Filter by date, relevance, and citation count for precise research data and systematic literature reviews. + # Scholar Search + # Get Google scholar Search data, including papers, patents, and legal docs, citation and year filters, and versions and cited-by links, for literature review and academic result monitoring. # @param query [String] The academic search query (e.g., 'machine learning', 'CRISPR gene editing'). Supports advanced operators like 'author:'. # @param [Hash] opts the optional parameters # @option opts [Boolean] :html Set to true to return the raw HTML of the Google Scholar search page. @@ -1869,8 +2061,8 @@ def scholar_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Search API - # Powerful Google Search SERP API to scrape organic search results, ads, knowledge panels, and more. Monitor keyword rankings and analyze competitor strategies across different countries and languages with built-in anti-bot protection. + # Search SERP + # Get Google search SERP data, including organic results, ads, and knowledge panels, for keyword tracking and SERP analysis across markets. # @param query [String] The search query for Google Search (e.g., 'coffee shops', 'how to bake a cake'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -1898,8 +2090,8 @@ def search(query, opts = {}) data end - # Google Search API - # Powerful Google Search SERP API to scrape organic search results, ads, knowledge panels, and more. Monitor keyword rankings and analyze competitor strategies across different countries and languages with built-in anti-bot protection. + # Search SERP + # Get Google search SERP data, including organic results, ads, and knowledge panels, for keyword tracking and SERP analysis across markets. # @param query [String] The search query for Google Search (e.g., 'coffee shops', 'how to bake a cake'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -1990,8 +2182,8 @@ def search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Light Search API - # A fast and lightweight Google Search API designed for high-speed retrieval of essential SERP data. Ideal for real-time monitoring tools and simple ranking checks where speed is critical. + # Light Search SERP + # Get Google light Search SERP data, including essential result data, for high-volume monitoring and fast rank checks. # @param query [String] The search query for Google Search (e.g., 'coffee shops', 'how to bake a cake'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -2019,8 +2211,8 @@ def search_light(query, opts = {}) data end - # Google Light Search API - # A fast and lightweight Google Search API designed for high-speed retrieval of essential SERP data. Ideal for real-time monitoring tools and simple ranking checks where speed is critical. + # Light Search SERP + # Get Google light Search SERP data, including essential result data, for high-volume monitoring and fast rank checks. # @param query [String] The search query for Google Search (e.g., 'coffee shops', 'how to bake a cake'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -2111,8 +2303,8 @@ def search_light_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Mobile Search API - # Scrape mobile-optimized Google search results to provide accurate mobile rankings, features, and layouts. Identify mobile-specific features like AMP results and touch-optimized snippets for a mobile-first SEO strategy. + # Mobile Search SERP + # Get Google mobile Search SERP data, including mobile-specific layouts and result features, for mobile SEO analysis and ranking checks. # @param query [String] The search query for Google Search (e.g., 'coffee shops', 'how to bake a cake'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -2140,8 +2332,8 @@ def search_mobile(query, opts = {}) data end - # Google Mobile Search API - # Scrape mobile-optimized Google search results to provide accurate mobile rankings, features, and layouts. Identify mobile-specific features like AMP results and touch-optimized snippets for a mobile-first SEO strategy. + # Mobile Search SERP + # Get Google mobile Search SERP data, including mobile-specific layouts and result features, for mobile SEO analysis and ranking checks. # @param query [String] The search query for Google Search (e.g., 'coffee shops', 'how to bake a cake'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -2232,8 +2424,8 @@ def search_mobile_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Shopping Search API - # Scrape real-time product listings, prices, and merchant info from Google Shopping. Ideal for dynamic pricing engines and market research with detailed attributes like shipping costs and seller ratings. + # Shopping Search + # Get Google shopping Search data, including product listings, prices, and merchants, for pricing research and catalog monitoring. # @param query [String] The shopping search query (e.g., 'iPhone 15', 'running shoes'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -2253,8 +2445,8 @@ def shopping_search(query, opts = {}) data end - # Google Shopping Search API - # Scrape real-time product listings, prices, and merchant info from Google Shopping. Ideal for dynamic pricing engines and market research with detailed attributes like shipping costs and seller ratings. + # Shopping Search + # Get Google shopping Search data, including product listings, prices, and merchants, for pricing research and catalog monitoring. # @param query [String] The shopping search query (e.g., 'iPhone 15', 'running shoes'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -2329,8 +2521,8 @@ def shopping_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Shorts Search API - # Access trending Google Shorts content and scrape video details, rankings, and metadata. Monitor viral trends and analyze short-form video engagement across Google's shorts ecosystem. + # Shorts Search + # Get Google shorts Search data, including video metadata and rankings, for short-form content tracking and trend analysis. # @param query [String] The search query for Google Shorts (e.g., 'cooking tips', 'travel hacks'). # @param [Hash] opts the optional parameters # @option opts [Integer] :start The result offset to skip a specific number of entries (e.g., set to 12 to skip the first 12 results). @@ -2349,8 +2541,8 @@ def shorts_search(query, opts = {}) data end - # Google Shorts Search API - # Access trending Google Shorts content and scrape video details, rankings, and metadata. Monitor viral trends and analyze short-form video engagement across Google's shorts ecosystem. + # Shorts Search + # Get Google shorts Search data, including video metadata and rankings, for short-form content tracking and trend analysis. # @param query [String] The search query for Google Shorts (e.g., 'cooking tips', 'travel hacks'). # @param [Hash] opts the optional parameters # @option opts [Integer] :start The result offset to skip a specific number of entries (e.g., set to 12 to skip the first 12 results). @@ -2423,8 +2615,8 @@ def shorts_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Trends Autocomplete API - # Access real-time search suggestions and trending keywords with the Google Trends Autocomplete API. Enhance keyword research and discover emerging search patterns by capturing Google's predictive search data, providing immediate insight into user interest shifts. + # Trends Autocomplete + # Get Google trends Autocomplete data, including topic IDs, for trend discovery and topic expansion. # @param query [String] The search query to get trending autocomplete suggestions for (e.g., 'artificial'). # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -2434,8 +2626,8 @@ def trends_autocomplete(query, opts = {}) data end - # Google Trends Autocomplete API - # Access real-time search suggestions and trending keywords with the Google Trends Autocomplete API. Enhance keyword research and discover emerging search patterns by capturing Google's predictive search data, providing immediate insight into user interest shifts. + # Trends Autocomplete + # Get Google trends Autocomplete data, including topic IDs, for trend discovery and topic expansion. # @param query [String] The search query to get trending autocomplete suggestions for (e.g., 'artificial'). # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -2490,8 +2682,8 @@ def trends_autocomplete_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Trends Search API - # Scrape detailed search interest data, regional trends, and related queries from Google Trends. Programmatically analyze the relative popularity of search terms over time to compare keywords, analyze seasonal fluctuations, and drill down into specific geographic regions. + # Trends Search + # Get Google trends Search data, including interest over time, geo breakdowns, and related queries, for demand analysis and seasonal trend monitoring. # @param query [String] The search term or topic ID to analyze in Google Trends (e.g., 'iPhone', '/m/027lnzs' for Bitcoin). You can provide up to 5 terms separated by commas for comparisons. # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -2508,8 +2700,8 @@ def trends_search(query, opts = {}) data end - # Google Trends Search API - # Scrape detailed search interest data, regional trends, and related queries from Google Trends. Programmatically analyze the relative popularity of search terms over time to compare keywords, analyze seasonal fluctuations, and drill down into specific geographic regions. + # Trends Search + # Get Google trends Search data, including interest over time, geo breakdowns, and related queries, for demand analysis and seasonal trend monitoring. # @param query [String] The search term or topic ID to analyze in Google Trends (e.g., 'iPhone', '/m/027lnzs' for Bitcoin). You can provide up to 5 terms separated by commas for comparisons. # @param [Hash] opts the optional parameters # @option opts [String] :language Set the language for the results using its two-letter code (e.g., 'en' for English, 'fr' for French). See <a href=\"/reference/google-language\">Google Language</a>. @@ -2578,8 +2770,8 @@ def trends_search_with_http_info(query, opts = {}) return data, status_code, headers end - # Google Trends Trending Now API - # Retrieve the latest trending topics and daily search trends across different regions. Monitor rapid shifts in search interest, viral stories, and breaking news as they happen. Provides search volume indicators and related news articles to keep you updated with what's hot on Google in real-time. + # Trends Trending Now + # Get Google trends Trending Now data, including latest trending topics, region and time-window filters, and volume indicators, for breaking-trend monitoring and editorial planning. # @param geo [String] The geographic location code to retrieve real-time trends for (e.g., 'US' for United States). Default is 'US'. # @param [Hash] opts the optional parameters # @option opts [String] :hours Time window for trending topics. Supported values: '4' (past 4 hours), '24' (past 24 hours), '48' (past 48 hours), '168' (past 7 days). @@ -2590,8 +2782,8 @@ def trends_trending_now(geo, opts = {}) data end - # Google Trends Trending Now API - # Retrieve the latest trending topics and daily search trends across different regions. Monitor rapid shifts in search interest, viral stories, and breaking news as they happen. Provides search volume indicators and related news articles to keep you updated with what's hot on Google in real-time. + # Trends Trending Now + # Get Google trends Trending Now data, including latest trending topics, region and time-window filters, and volume indicators, for breaking-trend monitoring and editorial planning. # @param geo [String] The geographic location code to retrieve real-time trends for (e.g., 'US' for United States). Default is 'US'. # @param [Hash] opts the optional parameters # @option opts [String] :hours Time window for trending topics. Supported values: '4' (past 4 hours), '24' (past 24 hours), '48' (past 48 hours), '168' (past 7 days). @@ -2648,8 +2840,8 @@ def trends_trending_now_with_http_info(geo, opts = {}) return data, status_code, headers end - # Google Videos Search API - # Scrape video search results from Google with structured data for titles, descriptions, source platforms, and publication dates. Monitor video performance or analyze search results for video SEO and content strategy. + # Video Search + # Get Google video Search data, including titles, sources, and dates, for video SEO and content monitoring. # @param query [String] The search query for Google Videos (e.g., 'coding tutorial', 'movie trailers'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. @@ -2669,8 +2861,8 @@ def videos_search(query, opts = {}) data end - # Google Videos Search API - # Scrape video search results from Google with structured data for titles, descriptions, source platforms, and publication dates. Monitor video performance or analyze search results for video SEO and content strategy. + # Video Search + # Get Google video Search data, including titles, sources, and dates, for video SEO and content monitoring. # @param query [String] The search query for Google Videos (e.g., 'coding tutorial', 'movie trailers'). # @param [Hash] opts the optional parameters # @option opts [Integer] :page The results page number. Use 0 for the first page, 1 for the second, and so on. diff --git a/openapi/normalized/justserpapi.openapi.json b/openapi/normalized/justserpapi.openapi.json index 1ba12c0..3b443c1 100644 --- a/openapi/normalized/justserpapi.openapi.json +++ b/openapi/normalized/justserpapi.openapi.json @@ -62,7 +62,7 @@ "paths": { "/api/v1/google/ai-mode": { "get": { - "description": "Access Google's AI-powered search mode with our specialized API. Capture generated answers, follow-up questions, and source links to understand how AI is reshaping search discovery.", + "description": "Get Google aI Mode data, including generated answers, follow-up prompts, and cited links, for AI search experience monitoring.", "operationId": "aiMode", "parameters": [ { @@ -380,15 +380,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google AI Mode API", + "summary": "AI Mode", "tags": [ "Google" + ], + "x-highlights": [ + "Generated answer blocks", + "Follow-up question data", + "Cited source links", + "Country and location targeting" ] } }, "/api/v1/google/ai-overview": { "get": { - "description": "Scrape Google's AI-generated search overviews and get structured insights directly from Google's generative search experience. Ideal for SEO research and monitoring generative search trends.", + "description": "Get Google aI Overview data, including generated summaries and cited sources, for generative search visibility tracking.", "operationId": "aiOverview", "parameters": [ { @@ -588,15 +594,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google AI Overview API", + "summary": "AI Overview", "tags": [ "Google" + ], + "x-highlights": [ + "AI overview summaries", + "Cited source extraction", + "Structured text blocks", + "Country and location targeting" ] } }, "/api/v1/google/autocomplete": { "get": { - "description": "Powerful Google Autocomplete API to fetch real-time search suggestions. Ideal for keyword discovery and SEO optimization. Captures dynamic suggestions Google provides as users type, offering high-value long-tail keywords and related search intent across various niches and regions.", + "description": "Get Google autocomplete Suggestions data, including real-time suggestion data, country and language targeting, and structured suggestion lists, for keyword expansion and search intent research.", "operationId": "autocomplete", "parameters": [ { @@ -750,15 +762,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Autocomplete API", + "summary": "Autocomplete Suggestions", "tags": [ "Google" + ], + "x-highlights": [ + "Real-time suggestion data", + "Country and language targeting", + "Structured suggestion lists", + "Query-based autocomplete" ] } }, "/api/v1/google/finance/search": { "get": { - "description": "Scrape real-time stock market data, financial news, and currency exchange rates with our Google Finance Search SERP API. Get structured financial information including market movements, historical trends, and detailed company profiles.", + "description": "Get Google finance Search data, including market summaries, company details, and related finance results, for finance monitoring and market research.", "operationId": "financeSearch", "parameters": [ { @@ -1390,15 +1408,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Finance Search API", + "summary": "Finance Search", "tags": [ "Google" + ], + "x-highlights": [ + "Company result fields", + "Market summary data", + "Finance-related results", + "Language targeting" ] } }, "/api/v1/google/hotels/search": { "get": { - "description": "Scrape hotel listings, prices, ratings, and availability for competitive analysis and travel booking insights. Monitor room rates and identify popular amenities with precise hospitality market data.", + "description": "Get Google hotels Search data, including prices, ratings, and availability details, for travel comparison and hospitality market analysis.", "operationId": "hotelsSearch", "parameters": [ { @@ -5601,15 +5625,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Hotels Search API", + "summary": "Hotels Search", "tags": [ "Google" + ], + "x-highlights": [ + "Rates and availability", + "Hotel metadata", + "Review and rating fields", + "Localized results" ] } }, "/api/v1/google/images/search": { "get": { - "description": "Scrape high-resolution images and metadata from Google Images. Supports advanced filters like image size, color, and usage rights for precise visual data extraction for AI models or product monitoring.", + "description": "Get Google images Search data, including image URLs and metadata, for filtered image discovery for research and monitoring workflows.", "operationId": "imagesSearch", "parameters": [ { @@ -7375,15 +7405,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Images Search API", + "summary": "Images Search", "tags": [ "Google" + ], + "x-highlights": [ + "Image URLs and metadata", + "Size, color, and type filters", + "Usage rights filters", + "Date filters" ] } }, "/api/v1/google/immersive/product": { "get": { - "description": "Access rich product data and immersive shopping results from Google. Scrape detailed product features, 3D views, and specifications to enhance e-commerce research and monitor brand presentation.", + "description": "Get Google immersive Product data, including features, specifications, and seller information, for product research and merchandising analysis.", "operationId": "immersiveProduct", "parameters": [ { @@ -8144,15 +8180,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Immersive Product API", + "summary": "Immersive Product", "tags": [ "Google" + ], + "x-highlights": [ + "Product feature fields", + "Specification data", + "Seller listings", + "Country and language targeting" ] } }, "/api/v1/google/jobs/search": { "get": { - "description": "Scrape real-time job listings from Google Jobs for HR tech and recruitment apps. Extract structured data including job titles, descriptions, companies, and locations at scale.", + "description": "Get Google jobs Search data, including titles, companies, and locations, for aggregating job board results, analyzing hiring trends, and monitoring recruitment activity.", "operationId": "jobsSearch", "parameters": [ { @@ -9178,15 +9220,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Jobs Search API", + "summary": "Jobs Search", "tags": [ "Google" + ], + "x-highlights": [ + "Job listing fields", + "Company and location data", + "Pagination tokens", + "Chips and remote filters" ] } }, "/api/v1/google/lens": { "get": { - "description": "Extract visual search results and product info using our Google Lens API. Identify objects, products, and landmarks directly from images and discover related web links with high speed.", + "description": "Get Google lens Search data, including visual matches, product matches, and related links, for visual search analysis and product matching workflows.", "operationId": "lens", "parameters": [ { @@ -9837,15 +9885,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Lens API", + "summary": "Lens Search", "tags": [ "Google" + ], + "x-highlights": [ + "Visual matches", + "Product matches", + "Exact-match search", + "Image URL input" ] } }, "/api/v1/google/local/search": { "get": { - "description": "Scrape local business listings and map results for structured data including addresses, phone numbers, and ratings. Extract valuable B2B lead info and analyze the local competitive landscape for specific keywords.", + "description": "Get Google local Search data, including business listings, ratings, and contact details, for local lead generation and competitor research.", "operationId": "localSearch", "parameters": [ { @@ -9996,15 +10050,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Local Search API", + "summary": "Local Search", "tags": [ "Google" + ], + "x-highlights": [ + "Business listings and ratings", + "Address and phone fields", + "Location and UULE targeting", + "Specific listing lookup" ] } }, "/api/v1/google/maps/photos": { "get": { - "description": "Extract high-quality photos and metadata from Google Maps locations. Access thousands of user-contributed and official photos for business listings and points of interest to build rich geographical content or verify local business details visually.", + "description": "Get Google maps Photos data, including related metadata, for visual location research and listing QA.", "operationId": "mapsPhotos", "parameters": [ { @@ -10224,15 +10284,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Maps Photos API", + "summary": "Maps Photos", "tags": [ "Google" + ], + "x-highlights": [ + "User and owner photos", + "Category filters", + "Pagination tokens", + "Structured photo URLs" ] } }, "/api/v1/google/maps/places": { "get": { - "description": "Get comprehensive details about specific locations using the Google Maps Places API. Scrape contact info, business hours, coordinates, and more from Google Maps for millions of locations worldwide. Perfect for directory sites, delivery apps, and local service guides.", + "description": "Get Google maps Place Details data, including contact details and business information, for enrich business directories, look up place details, and sync local app data.", "operationId": "mapsPlaces", "parameters": [ { @@ -10350,15 +10416,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Maps Places API", + "summary": "Maps Place Details", "tags": [ "Google" + ], + "x-highlights": [ + "Contact details", + "Hours and coordinates", + "place_id or data_id lookup", + "Country targeting" ] } }, "/api/v1/google/maps/posts": { "get": { - "description": "Scrape business updates and posts from Google Maps. Monitor time-sensitive announcements, promotional content, and official news directly from business profiles for local discovery or competitor monitoring.", + "description": "Get Google maps Posts data, including business post content, post dates and images, and profile-specific feeds, for local business monitoring and promotion tracking.", "operationId": "mapsPosts", "parameters": [ { @@ -10476,15 +10548,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Maps Posts API", + "summary": "Maps Posts", "tags": [ "Google" + ], + "x-highlights": [ + "Business post content", + "Post dates and images", + "Profile-specific feeds", + "Structured post links" ] } }, "/api/v1/google/maps/reviews": { "get": { - "description": "Extract user reviews and ratings from Google Maps. Get structured data for sentiment analysis and brand reputation management. Deliver complete review texts, ratings, response statuses, and reviewer metadata at scale.", + "description": "Get Google maps Reviews data, including ratings and reviewer metadata, for reputation analysis and review monitoring.", "operationId": "mapsReviews", "parameters": [ { @@ -10951,15 +11029,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Maps Reviews API", + "summary": "Maps Reviews", "tags": [ "Google" + ], + "x-highlights": [ + "Ratings and review text", + "Sort and topic filters", + "Reviewer metadata", + "Pagination and result controls" ] } }, "/api/v1/google/maps/search": { "get": { - "description": "Powerful Google Maps SERP API to scrape business listings and local search results. Search for businesses across any industry and region with precise coordinate support. Returns structured listings including addresses, map pins, and primary contact information.", + "description": "Get Google maps Search data, including business listings, ratings and contact data, and coordinate and location targeting, for local market research and lead discovery.", "operationId": "mapsSearch", "parameters": [ { @@ -14748,15 +14832,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Maps Search API", + "summary": "Maps Search", "tags": [ "Google" + ], + "x-highlights": [ + "Business listings", + "Ratings and contact data", + "Coordinate and location targeting", + "Structured local results" ] } }, "/api/v1/google/news/search": { "get": { - "description": "Get real-time news headlines and stories with our Google News Search API. Scrape structured data including source info, publication dates, and related topics for media monitoring and news aggregation.", + "description": "Get Google news Search data, including headlines and source metadata, for media monitoring and news aggregation.", "operationId": "newsSearch", "parameters": [ { @@ -15989,15 +16079,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google News Search API", + "summary": "News Search", "tags": [ "Google" + ], + "x-highlights": [ + "Headline and source fields", + "Publication dates", + "Topic coverage", + "Localized results" ] } }, "/api/v1/google/patents/details": { "get": { - "description": "Get comprehensive patent information including abstracts, claims, descriptions, and legal statuses. Perform freedom-to-operate searches or competitor IP monitoring with reliable structured data.", + "description": "Get Google patent Details data, including abstracts, claims, and legal status, for patent review and IP due diligence.", "operationId": "patentDetails", "parameters": [ { @@ -17317,15 +17413,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Patents Details API", + "summary": "Patent Details", "tags": [ "Google" + ], + "x-highlights": [ + "Abstract and claims", + "Description fields", + "Legal status data", + "Patent ID lookup" ] } }, "/api/v1/google/patents/search": { "get": { - "description": "Powerful Google Patents SERP API to search and scrape patent documents. Filter by inventor, assignee, date, and status to stay updated on new filings or monitor corporate IP portfolios.", + "description": "Get Google patent Search data, including filters, for patent discovery and portfolio monitoring.", "operationId": "patentSearch", "parameters": [ { @@ -20365,15 +20467,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Patents Search API", + "summary": "Patent Search", "tags": [ "Google" + ], + "x-highlights": [ + "Inventor and assignee filters", + "Date and status filters", + "Patent and scholar toggles", + "Structured search results" ] } }, "/api/v1/google/scholar/author": { "get": { - "description": "Scrape Google Scholar author profiles to get comprehensive lists of publications, citations, and research interests. Structured data for academic research, talent discovery, and tracking scholarly impact.", + "description": "Get Google scholar Author data, including publications, citation metrics, and research interests, for researcher analysis and academic profiling.", "operationId": "ScholarAuthor", "parameters": [ { @@ -20897,15 +21005,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Scholar Author API", + "summary": "Scholar Author", "tags": [ "Google" + ], + "x-highlights": [ + "Publication lists", + "Citation metrics", + "Research interests", + "Co-author and article views" ] } }, "/api/v1/google/scholar/cite/search": { "get": { - "description": "Retrieve citation information for specific academic papers and articles. Provides structured bibtex and citation formats (APA, MLA, Chicago, etc.) directly from Google Scholar. Perfect for automated bibliography generation and research management.", + "description": "Get Google scholar Citations data, including export links, for bibliography automation and citation workflows.", "operationId": "ScholarCiteSearch", "parameters": [ { @@ -21011,15 +21125,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Scholar Cite Search API", + "summary": "Scholar Citations", "tags": [ "Google" + ], + "x-highlights": [ + "Multiple citation styles", + "BibTeX and RIS links", + "Structured citation entries", + "Direct Scholar lookup" ] } }, "/api/v1/google/scholar/profiles": { "get": { - "description": "Search and extract data from Google Scholar user profiles. Get real-time access to researcher information, h-index, and publication history for academic networking and institutional research assessment.", + "description": "Get Google scholar Profiles data, including profile search results, affiliation and citation counts, and pagination tokens, for researcher discovery and academic directory building.", "operationId": "ScholarProfiles", "parameters": [ { @@ -21361,15 +21481,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Scholar Profiles API", + "summary": "Scholar Profiles", "tags": [ "Google" + ], + "x-highlights": [ + "Profile search results", + "Affiliation and citation counts", + "Pagination tokens", + "Interest topics" ] } }, "/api/v1/google/scholar/search": { "get": { - "description": "Comprehensive Google Scholar SERP API to scrape academic papers, patents, and legal documents. Filter by date, relevance, and citation count for precise research data and systematic literature reviews.", + "description": "Get Google scholar Search data, including papers, patents, and legal docs, citation and year filters, and versions and cited-by links, for literature review and academic result monitoring.", "operationId": "ScholarSearch", "parameters": [ { @@ -21902,15 +22028,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Scholar Search API", + "summary": "Scholar Search", "tags": [ "Google" + ], + "x-highlights": [ + "Papers, patents, and legal docs", + "Citation and year filters", + "Versions and cited-by links", + "Structured scholarly results" ] } }, "/api/v1/google/search": { "get": { - "description": "Powerful Google Search SERP API to scrape organic search results, ads, knowledge panels, and more. Monitor keyword rankings and analyze competitor strategies across different countries and languages with built-in anti-bot protection.", + "description": "Get Google search SERP data, including organic results, ads, and knowledge panels, for keyword tracking and SERP analysis across markets.", "operationId": "search", "parameters": [ { @@ -22928,15 +23060,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Search API", + "summary": "Search SERP", "tags": [ "Google" + ], + "x-highlights": [ + "Organic and paid results", + "Knowledge panels and local packs", + "Country and language targeting", + "Structured SERP response" ] } }, "/api/v1/google/search/light": { "get": { - "description": "A fast and lightweight Google Search API designed for high-speed retrieval of essential SERP data. Ideal for real-time monitoring tools and simple ranking checks where speed is critical.", + "description": "Get Google light Search SERP data, including essential result data, for high-volume monitoring and fast rank checks.", "operationId": "searchLight", "parameters": [ { @@ -23380,15 +23518,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Light Search API", + "summary": "Light Search SERP", "tags": [ "Google" + ], + "x-highlights": [ + "Reduced payload response", + "Core SERP elements", + "Pagination support", + "Localization parameters" ] } }, "/api/v1/google/search/mobile": { "get": { - "description": "Scrape mobile-optimized Google search results to provide accurate mobile rankings, features, and layouts. Identify mobile-specific features like AMP results and touch-optimized snippets for a mobile-first SEO strategy.", + "description": "Get Google mobile Search SERP data, including mobile-specific layouts and result features, for mobile SEO analysis and ranking checks.", "operationId": "searchMobile", "parameters": [ { @@ -23671,15 +23815,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Mobile Search API", + "summary": "Mobile Search SERP", "tags": [ "Google" + ], + "x-highlights": [ + "Mobile result layouts", + "Mobile-specific features", + "Structured SERP extraction", + "Localization parameters" ] } }, "/api/v1/google/shopping/search": { "get": { - "description": "Scrape real-time product listings, prices, and merchant info from Google Shopping. Ideal for dynamic pricing engines and market research with detailed attributes like shipping costs and seller ratings.", + "description": "Get Google shopping Search data, including product listings, prices, and merchants, for pricing research and catalog monitoring.", "operationId": "shoppingSearch", "parameters": [ { @@ -24531,15 +24681,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Shopping Search API", + "summary": "Shopping Search", "tags": [ "Google" + ], + "x-highlights": [ + "Product prices and sellers", + "Shipping details", + "Shopping filter tokens", + "Country and language targeting" ] } }, "/api/v1/google/shorts/search": { "get": { - "description": "Access trending Google Shorts content and scrape video details, rankings, and metadata. Monitor viral trends and analyze short-form video engagement across Google's shorts ecosystem.", + "description": "Get Google shorts Search data, including video metadata and rankings, for short-form content tracking and trend analysis.", "operationId": "shortsSearch", "parameters": [ { @@ -24794,15 +24950,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Shorts Search API", + "summary": "Shorts Search", "tags": [ "Google" + ], + "x-highlights": [ + "Shorts rankings", + "Video metadata", + "Result pagination", + "Localized results" ] } }, "/api/v1/google/trends/autocomplete": { "get": { - "description": "Access real-time search suggestions and trending keywords with the Google Trends Autocomplete API. Enhance keyword research and discover emerging search patterns by capturing Google's predictive search data, providing immediate insight into user interest shifts.", + "description": "Get Google trends Autocomplete data, including topic IDs, for trend discovery and topic expansion.", "operationId": "TrendsAutocomplete", "parameters": [ { @@ -24900,15 +25062,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Trends Autocomplete API", + "summary": "Trends Autocomplete", "tags": [ "Google" + ], + "x-highlights": [ + "Suggestion titles and topic IDs", + "Real-time trend suggestions", + "Language targeting", + "Trends explore links" ] } }, "/api/v1/google/trends/search": { "get": { - "description": "Scrape detailed search interest data, regional trends, and related queries from Google Trends. Programmatically analyze the relative popularity of search terms over time to compare keywords, analyze seasonal fluctuations, and drill down into specific geographic regions.", + "description": "Get Google trends Search data, including interest over time, geo breakdowns, and related queries, for demand analysis and seasonal trend monitoring.", "operationId": "TrendsSearch", "parameters": [ { @@ -25627,15 +25795,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Trends Search API", + "summary": "Trends Search", "tags": [ "Google" + ], + "x-highlights": [ + "Interest over time", + "Geo breakdowns", + "Related queries", + "Multi-term comparisons" ] } }, "/api/v1/google/trends/trending-now": { "get": { - "description": "Retrieve the latest trending topics and daily search trends across different regions. Monitor rapid shifts in search interest, viral stories, and breaking news as they happen. Provides search volume indicators and related news articles to keep you updated with what's hot on Google in real-time.", + "description": "Get Google trends Trending Now data, including latest trending topics, region and time-window filters, and volume indicators, for breaking-trend monitoring and editorial planning.", "operationId": "TrendsTrendingNow", "parameters": [ { @@ -26298,15 +26472,21 @@ "ApiKeyQuery": [] } ], - "summary": "Google Trends Trending Now API", + "summary": "Trends Trending Now", "tags": [ "Google" + ], + "x-highlights": [ + "Latest trending topics", + "Region and time-window filters", + "Volume indicators", + "Related news links" ] } }, "/api/v1/google/videos/search": { "get": { - "description": "Scrape video search results from Google with structured data for titles, descriptions, source platforms, and publication dates. Monitor video performance or analyze search results for video SEO and content strategy.", + "description": "Get Google video Search data, including titles, sources, and dates, for video SEO and content monitoring.", "operationId": "videosSearch", "parameters": [ { @@ -26614,11 +26794,196 @@ "ApiKeyQuery": [] } ], - "summary": "Google Videos Search API", + "summary": "Video Search", + "tags": [ + "Google" + ], + "x-highlights": [ + "Title and snippet fields", + "Source platform data", + "Publication dates", + "Time filters" + ] + } + }, + "/api/v1/web/html": { + "get": { + "description": "Get webpage crawl data, including returns full raw HTML content, fast and cost-efficient, and optimized for static page crawling, for scraping, metadata extraction, and page structure analysis.", + "operationId": "html", + "parameters": [ + { + "description": "The full URL of the webpage to crawl (e.g., 'https://www.example.com').", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example search response": { + "description": "Example search response" + } + }, + "schema": { + "$ref": "#/components/schemas/JustSerpApiResponse" + } + } + }, + "description": "Successful JustSerpAPI response." + }, + "401": { + "description": "Authentication failed: API Key is invalid or missing" + }, + "403": { + "description": "Access denied: Insufficient credits or quota exceeded" + }, + "500": { + "description": "Internal server error or upstream service exception" + }, + "default": { + "description": "Unexpected response." + } + }, + "security": [ + { + "ApiKeyAuth": [], + "ApiKeyQuery": [] + } + ], + "summary": "Crawl Webpage (HTML)", "tags": [ "Google" + ], + "x-highlights": [ + "Returns full raw HTML content", + "Fast and cost-efficient", + "Optimized for static page crawling" ] } + }, + "/api/v1/web/markdown": { + "get": { + "description": "Get webpage crawl data, including removing boilerplate, for readable extraction, documentation workflows, and LLM input.", + "operationId": "markdown", + "parameters": [ + { + "description": "The full URL of the webpage to crawl and convert to Markdown (e.g., 'https://www.example.com').", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example search response": { + "description": "Example search response" + } + }, + "schema": { + "$ref": "#/components/schemas/JustSerpApiResponse" + } + } + }, + "description": "Successful JustSerpAPI response." + }, + "401": { + "description": "Authentication failed: API Key is invalid or missing" + }, + "403": { + "description": "Access denied: Insufficient credits or quota exceeded" + }, + "500": { + "description": "Internal server error or upstream service exception" + }, + "default": { + "description": "Unexpected response." + } + }, + "security": [ + { + "ApiKeyAuth": [], + "ApiKeyQuery": [] + } + ], + "summary": "Crawl Webpage (Markdown)", + "tags": [ + "Google" + ], + "x-highlights": [ + "Clean Markdown output", + "Removes boilerplate like ads and navigation", + "Ideal for LLM input and data processing" + ] + } + }, + "/api/v1/web/rendered-html": { + "get": { + "description": "Get webpage crawl data, including returns full raw Rendered HTML content, fast and cost-efficient, and optimized for static page crawling, for scraping, metadata extraction, and page structure analysis.", + "operationId": "renderedHtml", + "parameters": [ + { + "description": "The full URL of the webpage to crawl (e.g., 'https://www.example.com').", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "Example search response": { + "description": "Example search response" + } + }, + "schema": { + "$ref": "#/components/schemas/JustSerpApiResponse" + } + } + }, + "description": "Successful JustSerpAPI response." + }, + "401": { + "description": "Authentication failed: API Key is invalid or missing" + }, + "403": { + "description": "Access denied: Insufficient credits or quota exceeded" + }, + "500": { + "description": "Internal server error or upstream service exception" + }, + "default": { + "description": "Unexpected response." + } + }, + "security": [ + { + "ApiKeyAuth": [], + "ApiKeyQuery": [] + } + ], + "summary": "Crawl Webpage (Rendered HTML)", + "tags": [ + "Google" + ], + "x-highlights": [] + } } }, "security": [ diff --git a/openapi/raw/justserpapi.openapi.json b/openapi/raw/justserpapi.openapi.json index 348b96b..a3614ac 100644 --- a/openapi/raw/justserpapi.openapi.json +++ b/openapi/raw/justserpapi.openapi.json @@ -9,7 +9,7 @@ "paths": { "/api/v1/google/ai-mode": { "get": { - "description": "Access Google's AI-powered search mode with our specialized API. Capture generated answers, follow-up questions, and source links to understand how AI is reshaping search discovery.", + "description": "Get Google aI Mode data, including generated answers, follow-up prompts, and cited links, for AI search experience monitoring.", "operationId": "aiMode", "parameters": [ { @@ -315,15 +315,21 @@ "description": "default response" } }, - "summary": "Google AI Mode API", + "summary": "AI Mode", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Generated answer blocks", + "Follow-up question data", + "Cited source links", + "Country and location targeting" ] } }, "/api/v1/google/ai-overview": { "get": { - "description": "Scrape Google's AI-generated search overviews and get structured insights directly from Google's generative search experience. Ideal for SEO research and monitoring generative search trends.", + "description": "Get Google aI Overview data, including generated summaries and cited sources, for generative search visibility tracking.", "operationId": "aiOverview", "parameters": [ { @@ -511,15 +517,21 @@ "description": "default response" } }, - "summary": "Google AI Overview API", + "summary": "AI Overview", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "AI overview summaries", + "Cited source extraction", + "Structured text blocks", + "Country and location targeting" ] } }, "/api/v1/google/autocomplete": { "get": { - "description": "Powerful Google Autocomplete API to fetch real-time search suggestions. Ideal for keyword discovery and SEO optimization. Captures dynamic suggestions Google provides as users type, offering high-value long-tail keywords and related search intent across various niches and regions.", + "description": "Get Google autocomplete Suggestions data, including real-time suggestion data, country and language targeting, and structured suggestion lists, for keyword expansion and search intent research.", "operationId": "autocomplete", "parameters": [ { @@ -661,15 +673,21 @@ "description": "default response" } }, - "summary": "Google Autocomplete API", + "summary": "Autocomplete Suggestions", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Real-time suggestion data", + "Country and language targeting", + "Structured suggestion lists", + "Query-based autocomplete" ] } }, "/api/v1/google/finance/search": { "get": { - "description": "Scrape real-time stock market data, financial news, and currency exchange rates with our Google Finance Search SERP API. Get structured financial information including market movements, historical trends, and detailed company profiles.", + "description": "Get Google finance Search data, including market summaries, company details, and related finance results, for finance monitoring and market research.", "operationId": "financeSearch", "parameters": [ { @@ -1289,15 +1307,21 @@ "description": "default response" } }, - "summary": "Google Finance Search API", + "summary": "Finance Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Company result fields", + "Market summary data", + "Finance-related results", + "Language targeting" ] } }, "/api/v1/google/hotels/search": { "get": { - "description": "Scrape hotel listings, prices, ratings, and availability for competitive analysis and travel booking insights. Monitor room rates and identify popular amenities with precise hospitality market data.", + "description": "Get Google hotels Search data, including prices, ratings, and availability details, for travel comparison and hospitality market analysis.", "operationId": "hotelsSearch", "parameters": [ { @@ -5488,15 +5512,21 @@ "description": "default response" } }, - "summary": "Google Hotels Search API", + "summary": "Hotels Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Rates and availability", + "Hotel metadata", + "Review and rating fields", + "Localized results" ] } }, "/api/v1/google/images/search": { "get": { - "description": "Scrape high-resolution images and metadata from Google Images. Supports advanced filters like image size, color, and usage rights for precise visual data extraction for AI models or product monitoring.", + "description": "Get Google images Search data, including image URLs and metadata, for filtered image discovery for research and monitoring workflows.", "operationId": "imagesSearch", "parameters": [ { @@ -7250,15 +7280,21 @@ "description": "default response" } }, - "summary": "Google Images Search API", + "summary": "Images Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Image URLs and metadata", + "Size, color, and type filters", + "Usage rights filters", + "Date filters" ] } }, "/api/v1/google/immersive/product": { "get": { - "description": "Access rich product data and immersive shopping results from Google. Scrape detailed product features, 3D views, and specifications to enhance e-commerce research and monitor brand presentation.", + "description": "Get Google immersive Product data, including features, specifications, and seller information, for product research and merchandising analysis.", "operationId": "immersiveProduct", "parameters": [ { @@ -8007,15 +8043,21 @@ "description": "default response" } }, - "summary": "Google Immersive Product API", + "summary": "Immersive Product", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Product feature fields", + "Specification data", + "Seller listings", + "Country and language targeting" ] } }, "/api/v1/google/jobs/search": { "get": { - "description": "Scrape real-time job listings from Google Jobs for HR tech and recruitment apps. Extract structured data including job titles, descriptions, companies, and locations at scale.", + "description": "Get Google jobs Search data, including titles, companies, and locations, for aggregating job board results, analyzing hiring trends, and monitoring recruitment activity.", "operationId": "jobsSearch", "parameters": [ { @@ -9029,15 +9071,21 @@ "description": "default response" } }, - "summary": "Google Jobs Search API", + "summary": "Jobs Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Job listing fields", + "Company and location data", + "Pagination tokens", + "Chips and remote filters" ] } }, "/api/v1/google/lens": { "get": { - "description": "Extract visual search results and product info using our Google Lens API. Identify objects, products, and landmarks directly from images and discover related web links with high speed.", + "description": "Get Google lens Search data, including visual matches, product matches, and related links, for visual search analysis and product matching workflows.", "operationId": "lens", "parameters": [ { @@ -9676,15 +9724,21 @@ "description": "default response" } }, - "summary": "Google Lens API", + "summary": "Lens Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Visual matches", + "Product matches", + "Exact-match search", + "Image URL input" ] } }, "/api/v1/google/local/search": { "get": { - "description": "Scrape local business listings and map results for structured data including addresses, phone numbers, and ratings. Extract valuable B2B lead info and analyze the local competitive landscape for specific keywords.", + "description": "Get Google local Search data, including business listings, ratings, and contact details, for local lead generation and competitor research.", "operationId": "localSearch", "parameters": [ { @@ -9823,15 +9877,21 @@ "description": "default response" } }, - "summary": "Google Local Search API", + "summary": "Local Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Business listings and ratings", + "Address and phone fields", + "Location and UULE targeting", + "Specific listing lookup" ] } }, "/api/v1/google/maps/photos": { "get": { - "description": "Extract high-quality photos and metadata from Google Maps locations. Access thousands of user-contributed and official photos for business listings and points of interest to build rich geographical content or verify local business details visually.", + "description": "Get Google maps Photos data, including related metadata, for visual location research and listing QA.", "operationId": "mapsPhotos", "parameters": [ { @@ -10039,15 +10099,21 @@ "description": "default response" } }, - "summary": "Google Maps Photos API", + "summary": "Maps Photos", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "User and owner photos", + "Category filters", + "Pagination tokens", + "Structured photo URLs" ] } }, "/api/v1/google/maps/places": { "get": { - "description": "Get comprehensive details about specific locations using the Google Maps Places API. Scrape contact info, business hours, coordinates, and more from Google Maps for millions of locations worldwide. Perfect for directory sites, delivery apps, and local service guides.", + "description": "Get Google maps Place Details data, including contact details and business information, for enrich business directories, look up place details, and sync local app data.", "operationId": "mapsPlaces", "parameters": [ { @@ -10153,15 +10219,21 @@ "description": "default response" } }, - "summary": "Google Maps Places API", + "summary": "Maps Place Details", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Contact details", + "Hours and coordinates", + "place_id or data_id lookup", + "Country targeting" ] } }, "/api/v1/google/maps/posts": { "get": { - "description": "Scrape business updates and posts from Google Maps. Monitor time-sensitive announcements, promotional content, and official news directly from business profiles for local discovery or competitor monitoring.", + "description": "Get Google maps Posts data, including business post content, post dates and images, and profile-specific feeds, for local business monitoring and promotion tracking.", "operationId": "mapsPosts", "parameters": [ { @@ -10267,15 +10339,21 @@ "description": "default response" } }, - "summary": "Google Maps Posts API", + "summary": "Maps Posts", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Business post content", + "Post dates and images", + "Profile-specific feeds", + "Structured post links" ] } }, "/api/v1/google/maps/reviews": { "get": { - "description": "Extract user reviews and ratings from Google Maps. Get structured data for sentiment analysis and brand reputation management. Deliver complete review texts, ratings, response statuses, and reviewer metadata at scale.", + "description": "Get Google maps Reviews data, including ratings and reviewer metadata, for reputation analysis and review monitoring.", "operationId": "mapsReviews", "parameters": [ { @@ -10730,15 +10808,21 @@ "description": "default response" } }, - "summary": "Google Maps Reviews API", + "summary": "Maps Reviews", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Ratings and review text", + "Sort and topic filters", + "Reviewer metadata", + "Pagination and result controls" ] } }, "/api/v1/google/maps/search": { "get": { - "description": "Powerful Google Maps SERP API to scrape business listings and local search results. Search for businesses across any industry and region with precise coordinate support. Returns structured listings including addresses, map pins, and primary contact information.", + "description": "Get Google maps Search data, including business listings, ratings and contact data, and coordinate and location targeting, for local market research and lead discovery.", "operationId": "mapsSearch", "parameters": [ { @@ -14515,15 +14599,21 @@ "description": "default response" } }, - "summary": "Google Maps Search API", + "summary": "Maps Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Business listings", + "Ratings and contact data", + "Coordinate and location targeting", + "Structured local results" ] } }, "/api/v1/google/news/search": { "get": { - "description": "Get real-time news headlines and stories with our Google News Search API. Scrape structured data including source info, publication dates, and related topics for media monitoring and news aggregation.", + "description": "Get Google news Search data, including headlines and source metadata, for media monitoring and news aggregation.", "operationId": "newsSearch", "parameters": [ { @@ -15744,15 +15834,21 @@ "description": "default response" } }, - "summary": "Google News Search API", + "summary": "News Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Headline and source fields", + "Publication dates", + "Topic coverage", + "Localized results" ] } }, "/api/v1/google/patents/details": { "get": { - "description": "Get comprehensive patent information including abstracts, claims, descriptions, and legal statuses. Perform freedom-to-operate searches or competitor IP monitoring with reliable structured data.", + "description": "Get Google patent Details data, including abstracts, claims, and legal status, for patent review and IP due diligence.", "operationId": "patentDetails", "parameters": [ { @@ -17060,15 +17156,21 @@ "description": "default response" } }, - "summary": "Google Patents Details API", + "summary": "Patent Details", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Abstract and claims", + "Description fields", + "Legal status data", + "Patent ID lookup" ] } }, "/api/v1/google/patents/search": { "get": { - "description": "Powerful Google Patents SERP API to search and scrape patent documents. Filter by inventor, assignee, date, and status to stay updated on new filings or monitor corporate IP portfolios.", + "description": "Get Google patent Search data, including filters, for patent discovery and portfolio monitoring.", "operationId": "patentSearch", "parameters": [ { @@ -20096,15 +20198,21 @@ "description": "default response" } }, - "summary": "Google Patents Search API", + "summary": "Patent Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Inventor and assignee filters", + "Date and status filters", + "Patent and scholar toggles", + "Structured search results" ] } }, "/api/v1/google/scholar/author": { "get": { - "description": "Scrape Google Scholar author profiles to get comprehensive lists of publications, citations, and research interests. Structured data for academic research, talent discovery, and tracking scholarly impact.", + "description": "Get Google scholar Author data, including publications, citation metrics, and research interests, for researcher analysis and academic profiling.", "operationId": "ScholarAuthor", "parameters": [ { @@ -20616,15 +20724,21 @@ "description": "default response" } }, - "summary": "Google Scholar Author API", + "summary": "Scholar Author", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Publication lists", + "Citation metrics", + "Research interests", + "Co-author and article views" ] } }, "/api/v1/google/scholar/cite/search": { "get": { - "description": "Retrieve citation information for specific academic papers and articles. Provides structured bibtex and citation formats (APA, MLA, Chicago, etc.) directly from Google Scholar. Perfect for automated bibliography generation and research management.", + "description": "Get Google scholar Citations data, including export links, for bibliography automation and citation workflows.", "operationId": "ScholarCiteSearch", "parameters": [ { @@ -20718,15 +20832,21 @@ "description": "default response" } }, - "summary": "Google Scholar Cite Search API", + "summary": "Scholar Citations", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Multiple citation styles", + "BibTeX and RIS links", + "Structured citation entries", + "Direct Scholar lookup" ] } }, "/api/v1/google/scholar/profiles": { "get": { - "description": "Search and extract data from Google Scholar user profiles. Get real-time access to researcher information, h-index, and publication history for academic networking and institutional research assessment.", + "description": "Get Google scholar Profiles data, including profile search results, affiliation and citation counts, and pagination tokens, for researcher discovery and academic directory building.", "operationId": "ScholarProfiles", "parameters": [ { @@ -21056,15 +21176,21 @@ "description": "default response" } }, - "summary": "Google Scholar Profiles API", + "summary": "Scholar Profiles", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Profile search results", + "Affiliation and citation counts", + "Pagination tokens", + "Interest topics" ] } }, "/api/v1/google/scholar/search": { "get": { - "description": "Comprehensive Google Scholar SERP API to scrape academic papers, patents, and legal documents. Filter by date, relevance, and citation count for precise research data and systematic literature reviews.", + "description": "Get Google scholar Search data, including papers, patents, and legal docs, citation and year filters, and versions and cited-by links, for literature review and academic result monitoring.", "operationId": "ScholarSearch", "parameters": [ { @@ -21585,15 +21711,21 @@ "description": "default response" } }, - "summary": "Google Scholar Search API", + "summary": "Scholar Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Papers, patents, and legal docs", + "Citation and year filters", + "Versions and cited-by links", + "Structured scholarly results" ] } }, "/api/v1/google/search": { "get": { - "description": "Powerful Google Search SERP API to scrape organic search results, ads, knowledge panels, and more. Monitor keyword rankings and analyze competitor strategies across different countries and languages with built-in anti-bot protection.", + "description": "Get Google search SERP data, including organic results, ads, and knowledge panels, for keyword tracking and SERP analysis across markets.", "operationId": "search", "parameters": [ { @@ -22599,15 +22731,21 @@ "description": "default response" } }, - "summary": "Google Search API", + "summary": "Search SERP", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Organic and paid results", + "Knowledge panels and local packs", + "Country and language targeting", + "Structured SERP response" ] } }, "/api/v1/google/search/light": { "get": { - "description": "A fast and lightweight Google Search API designed for high-speed retrieval of essential SERP data. Ideal for real-time monitoring tools and simple ranking checks where speed is critical.", + "description": "Get Google light Search SERP data, including essential result data, for high-volume monitoring and fast rank checks.", "operationId": "searchLight", "parameters": [ { @@ -23039,15 +23177,21 @@ "description": "default response" } }, - "summary": "Google Light Search API", + "summary": "Light Search SERP", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Reduced payload response", + "Core SERP elements", + "Pagination support", + "Localization parameters" ] } }, "/api/v1/google/search/mobile": { "get": { - "description": "Scrape mobile-optimized Google search results to provide accurate mobile rankings, features, and layouts. Identify mobile-specific features like AMP results and touch-optimized snippets for a mobile-first SEO strategy.", + "description": "Get Google mobile Search SERP data, including mobile-specific layouts and result features, for mobile SEO analysis and ranking checks.", "operationId": "searchMobile", "parameters": [ { @@ -23318,15 +23462,21 @@ "description": "default response" } }, - "summary": "Google Mobile Search API", + "summary": "Mobile Search SERP", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Mobile result layouts", + "Mobile-specific features", + "Structured SERP extraction", + "Localization parameters" ] } }, "/api/v1/google/shopping/search": { "get": { - "description": "Scrape real-time product listings, prices, and merchant info from Google Shopping. Ideal for dynamic pricing engines and market research with detailed attributes like shipping costs and seller ratings.", + "description": "Get Google shopping Search data, including product listings, prices, and merchants, for pricing research and catalog monitoring.", "operationId": "shoppingSearch", "parameters": [ { @@ -24166,15 +24316,21 @@ "description": "default response" } }, - "summary": "Google Shopping Search API", + "summary": "Shopping Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Product prices and sellers", + "Shipping details", + "Shopping filter tokens", + "Country and language targeting" ] } }, "/api/v1/google/shorts/search": { "get": { - "description": "Access trending Google Shorts content and scrape video details, rankings, and metadata. Monitor viral trends and analyze short-form video engagement across Google's shorts ecosystem.", + "description": "Get Google shorts Search data, including video metadata and rankings, for short-form content tracking and trend analysis.", "operationId": "shortsSearch", "parameters": [ { @@ -24417,15 +24573,21 @@ "description": "default response" } }, - "summary": "Google Shorts Search API", + "summary": "Shorts Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Shorts rankings", + "Video metadata", + "Result pagination", + "Localized results" ] } }, "/api/v1/google/trends/autocomplete": { "get": { - "description": "Access real-time search suggestions and trending keywords with the Google Trends Autocomplete API. Enhance keyword research and discover emerging search patterns by capturing Google's predictive search data, providing immediate insight into user interest shifts.", + "description": "Get Google trends Autocomplete data, including topic IDs, for trend discovery and topic expansion.", "operationId": "TrendsAutocomplete", "parameters": [ { @@ -24511,15 +24673,21 @@ "description": "default response" } }, - "summary": "Google Trends Autocomplete API", + "summary": "Trends Autocomplete", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Suggestion titles and topic IDs", + "Real-time trend suggestions", + "Language targeting", + "Trends explore links" ] } }, "/api/v1/google/trends/search": { "get": { - "description": "Scrape detailed search interest data, regional trends, and related queries from Google Trends. Programmatically analyze the relative popularity of search terms over time to compare keywords, analyze seasonal fluctuations, and drill down into specific geographic regions.", + "description": "Get Google trends Search data, including interest over time, geo breakdowns, and related queries, for demand analysis and seasonal trend monitoring.", "operationId": "TrendsSearch", "parameters": [ { @@ -25226,15 +25394,21 @@ "description": "default response" } }, - "summary": "Google Trends Search API", + "summary": "Trends Search", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Interest over time", + "Geo breakdowns", + "Related queries", + "Multi-term comparisons" ] } }, "/api/v1/google/trends/trending-now": { "get": { - "description": "Retrieve the latest trending topics and daily search trends across different regions. Monitor rapid shifts in search interest, viral stories, and breaking news as they happen. Provides search volume indicators and related news articles to keep you updated with what's hot on Google in real-time.", + "description": "Get Google trends Trending Now data, including latest trending topics, region and time-window filters, and volume indicators, for breaking-trend monitoring and editorial planning.", "operationId": "TrendsTrendingNow", "parameters": [ { @@ -25885,15 +26059,21 @@ "description": "default response" } }, - "summary": "Google Trends Trending Now API", + "summary": "Trends Trending Now", "tags": [ - "Google API" + "Google" + ], + "x-highlights": [ + "Latest trending topics", + "Region and time-window filters", + "Volume indicators", + "Related news links" ] } }, "/api/v1/google/videos/search": { "get": { - "description": "Scrape video search results from Google with structured data for titles, descriptions, source platforms, and publication dates. Monitor video performance or analyze search results for video SEO and content strategy.", + "description": "Get Google video Search data, including titles, sources, and dates, for video SEO and content monitoring.", "operationId": "videosSearch", "parameters": [ { @@ -26189,17 +26369,166 @@ "description": "default response" } }, - "summary": "Google Videos Search API", + "summary": "Video Search", + "tags": [ + "Google" + ], + "x-highlights": [ + "Title and snippet fields", + "Source platform data", + "Publication dates", + "Time filters" + ] + } + }, + "/api/v1/web/html": { + "get": { + "description": "Get webpage crawl data, including returns full raw HTML content, fast and cost-efficient, and optimized for static page crawling, for scraping, metadata extraction, and page structure analysis.", + "operationId": "html", + "parameters": [ + { + "description": "The full URL of the webpage to crawl (e.g., 'https://www.example.com').", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authentication failed: API Key is invalid or missing" + }, + "403": { + "description": "Access denied: Insufficient credits or quota exceeded" + }, + "500": { + "description": "Internal server error or upstream service exception" + }, + "default": { + "content": { + "application/json": { + "examples": { + "Example search response": { + "description": "Example search response" + } + } + } + }, + "description": "default response" + } + }, + "summary": "Crawl Webpage (HTML)", + "tags": [ + "Web Crawling" + ], + "x-highlights": [ + "Returns full raw HTML content", + "Fast and cost-efficient", + "Optimized for static page crawling" + ] + } + }, + "/api/v1/web/markdown": { + "get": { + "description": "Get webpage crawl data, including removing boilerplate, for readable extraction, documentation workflows, and LLM input.", + "operationId": "markdown", + "parameters": [ + { + "description": "The full URL of the webpage to crawl and convert to Markdown (e.g., 'https://www.example.com').", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authentication failed: API Key is invalid or missing" + }, + "403": { + "description": "Access denied: Insufficient credits or quota exceeded" + }, + "500": { + "description": "Internal server error or upstream service exception" + }, + "default": { + "content": { + "application/json": { + "examples": { + "Example search response": { + "description": "Example search response" + } + } + } + }, + "description": "default response" + } + }, + "summary": "Crawl Webpage (Markdown)", "tags": [ - "Google API" + "Web Crawling" + ], + "x-highlights": [ + "Clean Markdown output", + "Removes boilerplate like ads and navigation", + "Ideal for LLM input and data processing" ] } + }, + "/api/v1/web/rendered-html": { + "get": { + "description": "Get webpage crawl data, including returns full raw Rendered HTML content, fast and cost-efficient, and optimized for static page crawling, for scraping, metadata extraction, and page structure analysis.", + "operationId": "renderedHtml", + "parameters": [ + { + "description": "The full URL of the webpage to crawl (e.g., 'https://www.example.com').", + "in": "query", + "name": "url", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authentication failed: API Key is invalid or missing" + }, + "403": { + "description": "Access denied: Insufficient credits or quota exceeded" + }, + "500": { + "description": "Internal server error or upstream service exception" + }, + "default": { + "content": { + "application/json": { + "examples": { + "Example search response": { + "description": "Example search response" + } + } + } + }, + "description": "default response" + } + }, + "summary": "Crawl Webpage (Rendered HTML)", + "tags": [ + "Web Crawling" + ], + "x-highlights": [] + } } }, "servers": [ { "description": "Generated server url", - "url": "http://api.justserpapi.com" + "url": "http://127.0.0.1:8008" } ] }