Google Organic Live Advanced

{
  "$defs": {
    "SerpApiStopCrawlOnMatchInfo": {
      "properties": {
        "match_type": {
          "anyOf": [
            {
              "description": "target match type required field if stop_crawl_on_match is specified; type of match for the match_value possible values: domain, with_subdomains, wildcard",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "match_value": {
          "anyOf": [
            {
              "description": "arget domain or wildcard value required field if stop_crawl_on_match is specified; specify a target domain or wildcard value; Note: domain name must be specified without a request protocol; example: Asale.com",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    },
    "SerpGoogleOrganicLiveAdvancedRequestInfo": {
      "properties": {
        "browser_screen_height": {
          "anyOf": [
            {
              "description": "browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "browser_screen_resolution_ratio": {
          "anyOf": [
            {
              "description": "browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "browser_screen_width": {
          "anyOf": [
            {
              "description": "browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true",
              "format": "int64",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "calculate_rectangles": {
          "anyOf": [
            {
              "description": "calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more>>by default, the parameter is set to false;Note: you will be charged extra $0.002 for using this parameter",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "depth": {
          "anyOf": [
            {
              "description": "parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page.",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "device": {
          "anyOf": [
            {
              "description": "device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "find_targets_in": {
          "anyOf": [
            {
              "description": "SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same el",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "group_organic_results": {
          "anyOf": [
            {
              "description": "display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "ignore_targets_in": {
          "anyOf": [
            {
              "description": "SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:\"ignore_targets_in\": [\"paid\",",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "keyword": {
          "description": "keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’,",
          "type": "string"
        },
        "language_code": {
          "anyOf": [
            {
              "description": "search engine language codeoptional field if you specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code by making a separate request to the",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "language_name": {
          "anyOf": [
            {
              "description": "full name of search engine languageoptional field if you specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "load_async_ai_overview": {
          "anyOf": [
            {
              "description": "load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseNote: you will be charged extra $0.002 for using this parameter;if the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "location_code": {
          "description": "search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the",
          "type": "integer"
        },
        "location_coordinate": {
          "anyOf": [
            {
              "description": "GPS coordinates of a locationoptional field if you specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" formatthe maximum number of decimal digits for \"latitude\" and \"longitude\": 7the minimum value for \"radius\": 199 (mm)the maximum value for \"radius\": 199999 (mm)example:53.476225,-2.243572,200",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "location_name": {
          "description": "full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the Kingdom",
          "type": "string"
        },
        "match_type": {
          "description": "target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern",
          "type": "string"
        },
        "match_value": {
          "description": "target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: \"match_value\": \"Asale.com\",\"match_value\": \"/blog/post-*\"",
          "type": "string"
        },
        "max_crawl_pages": {
          "anyOf": [
            {
              "description": "page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "os": {
          "anyOf": [
            {
              "description": "device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "people_also_ask_click_depth": {
          "anyOf": [
            {
              "description": "clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;Note your account will be billed $0.00015 extra for each click;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "remove_from_url": {
          "anyOf": [
            {
              "description": "remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:\"remove_from_url\": [\"srsltid\"]Note: if the target field is specified, the specified URL parameters will be removed before the search",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "se_domain": {
          "anyOf": [
            {
              "description": "search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "search_param": {
          "anyOf": [
            {
              "description": "additional parameters of the search queryoptional fieldget the list of available parameters and additional details hereNote: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "stop_crawl_on_match": {
          "anyOf": [
            {
              "description": "array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: \"stop_crawl_on_match\":[{\"match_value\":\"Asale.com\",\"match_type\":\"with_subdomains\"}] learn more about this parameter on our Help Center - Your account will be billed per each SERP crawled through the",
              "items": {
                "anyOf": [
                  {
                    "oneOf": [
                      {
                        "$ref": "#/$defs/SerpApiStopCrawlOnMatchInfo"
                      }
                    ],
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "tag": {
          "anyOf": [
            {
              "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "target": {
          "anyOf": [
            {
              "description": "target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as or or",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "target_search_mode": {
          "anyOf": [
            {
              "description": "target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "url": {
          "anyOf": [
            {
              "description": "direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZSNote: the following search engine parameters are n",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "items": {
        "anyOf": [
          {
            "oneOf": [
              {
                "$ref": "#/$defs/SerpGoogleOrganicLiveAdvancedRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}