Common

common parameters get get /search the following parameters are used to configure your search api request they should be appended as querystring parameters to the search api get http request an example request is below http https //api valueserp com/search?api key=demo\&q=pizza\&location=united+states$ curl get https //api valueserp com/search \\ d api key="demo" \\ d q="pizza" \\ d location="united states"const axios = require('axios'); // set up the request parameters const params = { api key "demo", q "pizza", location "united states" } // make the http get request to value serp axios get('https //api valueserp com/search', { params }) then(response => { // print the json response from value serp console log(json stringify(response data, 0, 2)); }) catch(error => { // catch and print the error console log(error); })import requests import json \# set up the request parameters params = { 'api key' 'demo', 'q' 'pizza', 'location' 'united states' } \# make the http get request to value serp api result = requests get('https //api valueserp com/search', params) \# print the json response from value serp print(json dumps(api result json()))# set up the request parameters $querystring = http build query(\[ 'api key' => 'demo', 'q' => 'pizza', 'location' => 'united states' ]); \# make the http get request to value serp $ch = curl init(sprintf('%s?%s', 'https //api valueserp com/search', $querystring)); curl setopt($ch, curlopt returntransfer, true); curl setopt($ch, curlopt followlocation, true); \# the following options are required if you're using an outdated openssl version \# more details https //www openssl org/blog/blog/2021/09/13/letsencryptrootcertexpire/ curl setopt($ch, curlopt ssl verifyhost, false); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt timeout, 180); $api result = curl exec($ch); curl close($ch); \# print the json response from value serp echo $api result; parameter required description api key required the api key for your value serp account search type optional the type of request to make the value of the type parameter determines which additional parameters are available for example, if you make a request with search type= news then additional https //docs trajectdata com/valueserp/search api/searches/google/news , specific to news requests, are available valid values for search type are (not set) if the search type parameter is omitted then a regular web search is performed see additional https //docs trajectdata com/valueserp/search api/searches/google/search news perform a google news request see additional see additional https //docs trajectdata com/valueserp/search api/searches/google/news images perform a google images request see additional see additional https //docs trajectdata com/valueserp/search api/searches/google/images videos perform a google videos request see additional see additional https //docs trajectdata com/valueserp/search api/searches/google/images places perform a google places request see additional see additional https //docs trajectdata com/valueserp/search api/searches/google/places place details perform a google place details request to get further information on a given place see additional see additional https //docs trajectdata com/valueserp/search api/searches/google/place details shopping perform a google shopping search results see additional see additional https //docs trajectdata com/valueserp/search api/searches/google/shopping product perform a google product results for a single product see additional see additional https //docs trajectdata com/valueserp/search api/searches/google/product note that when making a search type=product request the product type parameter determines the type of product request, available values for product type are reviews retrieve reviews for a given product see additional see additional https //docs trajectdata com/valueserp/search api/searches/google/product reviews online sellers retrieve sellers for a given product see additional see additional https //docs trajectdata com/valueserp/search api/searches/google/product online sellers specifications retrieve data from the specifications page for a given product see additional see additional https //docs trajectdata com/valueserp/search api/searches/google/product specifications url optional specifies the url to open (instead of specifying a query using the q parameter) note to specify the type of parsing applied to the results from the url parameter, use the search type parameter note the url parameter must be url encoded the url parameter is not available for all search type values device optional determines the device to use to get results can be set to desktop (default) to use a regular desktop web browser, tablet to use a tablet browser (use the tablet type to choose the type of tablet device), or mobile to use a mobile browser (use the mobile type to choose the type of mobile device) note that not all search type values are parsed for each device (for example, some results are parsed in desktop only), see the individual results for more information mobile type optional applies when device=mobile and determines the type of mobile device used to get results can be set to iphone for an iphone mobile device, or android for an android mobile device tablet type optional applies when device=tablet and determines the type of tablet device used to get results can be set to ipad for an ipad device, or android for an android tablet device output optional determines the format in which results are returned can be set to json (default) to get the results as structured json, html to get the raw html retrieved or csv to return the results in csv format when using csv you can also use the csv fields parameter to specify which fields to return in the csv csv fields optional determines the fields that are returned when returning in csv mode (i e when the output parameter is set to csv ) should be specified as a comma seperated list of fields (in nested field, dot notation, format) for more information on the csv fields parameter please see the https //docs trajectdata com/valueserp/search api/reference/csv fields include html optional determines whether raw html is included in the response (this can increase the size of the response) can be set to true or false (the default) note when adding searches with include html=true to a batch the maximum number of searches is lower (100) because including the html within the response makes the batch result sets much larger the limit is in place to ensure result set files are of a manageable size if you have need to run a large number of searches all with include html=true then simply split the searches across multiple 100 search batches skip on incident optional instructs the api to not serve requests when a parsing incident is detected valid values are all (where the api will not serve a response if a "degraded" or "major" parsing incident is live) and major only (where the api will not serve a response is a "major" parsing incident is live, but will if a "degraded service" parsing incident is live) you can view service status via the https //valueserp statuspage io/ using skip on incident can be desirable if your system is making unsupervised requests to the api that you would like to gracefully fail in the event of an incident hide base64 images optional instructs the api to not include base64 images in the response base64 encoded images from serp pages can increase the size of the response considerably so sometimes it's desirable to have them excluded from the api response note that this parameter is set to hide base64 images=true by default when using batches (to minimise the size of the batch result sets) cookie optional the cookie string to send along with the request should be url encoded use this parameter to send custom cookies along with the request made it will be sent in the cookie http header made by the platform include fields optional a comma seperated list json field names to include in the json object the api returns you can specify the field names in dot notation i e include fields=pagination will only include the the pagination property in the response json use include fields if you only want to include specific fields in the api's json response exclude fields optional a comma seperated list of json field names to exclude from the json object the api returns you can specify the field names in dot notation i e exclude fields=pagination will remove the pagination property from the response json use exclude fields if there are specific fields you wish to exclude from the api's json response next steps https //docs trajectdata com/valueserp/search api/searches/google/search