Contents
Documentation
Making a Request
Conducting a search is straightforward – you just need to send a GET HTTP request to the SerpSolution search endpoint. The essential parameters are ‘key’ (subscribe to obtain an API key) and ‘q’ (your search query).
For instance, if you want to look up the term “pizza”, your search request to SerpSolution would be as follows:
https://api.serpsolution.come/search?key=API_KEY&q=restaurant
Suppose we wish to narrow our search to find “pizza” specifically in London, UK. We can do this by utilizing the location parameter of SerpSolution in the following way:
https://api.serpsolution.come/search?key=API_KEY&q=restaurant&location=Paris,France
Now, let’s explore how to navigate through multiple pages of results using the ‘page’ and ‘num’ parameters. ‘page’ specifies the result page number (beginning with 1), while ‘num’ sets the quantity of results per page. For instance, to display the second page of results with 10 results on each page, our query would be structured as follows:
https://api.serpsolution.come/search?key=API_KEY&q=restaurant&location=Paris,France&page=3&num=7
Google SERP API
Search
https://api.serpsolution.come/search?key=API_KEY&q=tennis
Parameters
| Required parameters | Description |
|---|---|
| key | API key |
| q |
The "q" parameter specifies the search query you wish to conduct. It accepts any terms or phrases you would typically use in a standard Google search. |
| location | The "location" parameter determines the geographical starting point for your search. If there are several potential matches for the location you specify, the system will default to the most popular one. |
| Optional parameters | Description |
|---|---|
| lang | The "language parameter" sets the language for the Google search, using a two-letter code to specify the desired language. (en - English, es - Spanish...) |
| type |
Search Type: type (Optional) The 'type' parameter determines the specific kind of search you wish to conduct.
|
| safe | The parameter controls the filter settings for mature content. You can choose either 'active' to filter or 'off' to allow such content. By default, Google automatically blurs explicit material. |
| pag_start | This parameter sets the offset for search results, essentially skipping a specified number of results. It's primarily used for implementing pagination. For instance, a value of 0 (the default) displays the first page of results, 10 brings up the second page, 20 the third page, and so on. |
| max | This parameter specifies the maximum number of search results to be returned. For example, setting it to 20 (which is the default) will return 20 results, while setting it to 50 will return 50 results, and 100 will bring back 100 results. |
| dev | The parameter determines the type of device for obtaining search results. You can set it to 'desktop' (the default) for results as seen in a standard web browser, 'tablet' for results from a tablet browser (presently configured for iPads), or 'mobile' for results via a mobile browser (currently using iPhones). |
| autocorrect | The parameter controls whether to exclude results from an automatically corrected query if the original query contains a spelling error. Setting it to 0 will exclude such results, while 1 (the default setting) will include them. |
| no_cache | The parameter instructs SerpSolution to retrieve fresh Google results, bypassing any cached versions that might exist. Cached results are only served if the query and all parameters match exactly. Note that the cache has a lifespan of one hour before expiring. |
| output | The parameter specifies the format of the output you wish to receive. You can choose 'json' (which is the default setting) for a structured JSON representation of the results, or 'html' to obtain the raw HTML data that was retrieved. |
Images
Google Images are used when a request is made with the ‘type’ parameter set to ‘img’ in order to obtain image results.
https://api.serpsolution.come/search?key=API_KEY&type=img&q=labradoodle
Parameters
| Required parameters | Description |
|---|---|
| key | API key |
| q |
The "q" parameter specifies the search query you wish to conduct. It accepts any terms or phrases you would typically use in a standard Google search. |
| type | Set to 'img' |
| Parameter | Description |
|---|---|
| img_color | Enables you to specify the color of the returned images: black_and_white, transparent, red, orange, yellow, green, teal, blue, purple, pink, white, gray, black or brown |
| img_size | Allows you to set the size of the images. Values: icon, medium, large |
| img_type | Values: clipart, line, gif |
| img_page | Determines the page of results. For example, if img_page = 3, it will return images 200-299 |
Videos
The parameters for Google Videos are used when a request is made with the ‘type’ parameter set to ‘vid’ in order to obtain video results corresponding to a specific search term.
https://api.serpsolution.come/search?key=API_KEY&type=vid&q=football
| Required parameters | Description |
|---|---|
| key | API key |
| q |
The "q" parameter specifies the search query you wish to conduct. It accepts any terms or phrases you would typically use in a standard Google search. |
| type | Set to 'vid' |
Parameters
| Parameter | Description |
|---|---|
| location | Specifies the geographical location for executing the query. You can input any location in text form. Using a predefined SerpWow location automatically updates corresponding google_domain, gl, and hl parameters to match the location's domain, country, and language. This can be overridden with the location_auto parameter. |
| domain | Specifies the Google domain for running the search query, with a default of google.com. A full list of supported google_domain values is available. |
| gl | Sets the Google country for the query. Defaults to the United States (us) with a comprehensive list of supported gl values available. |
| hl | Defines the Google UI language for the search results. The default is English (en), and a list of supported hl values is available. |
| lr | Limits search results to websites in a specified language. A list of supported lr values is provided. |
| cr | Restricts results to websites from a specific country, with a list of supported cr values available. |
| time_period | Sets the time frame for search results, with options like last_hour, last_day, last_week, last_month, last_year, or custom. For custom, specify time_period_min and/or time_period_max. |
| time_period_min | Sets the start date for custom time_period searches, formatted as MM/DD/YYYY. |
| time_period_max | Sets the end date for custom time_period searches, formatted as MM/DD/YYYY. |
| nfpr | Controls the inclusion of auto-corrected query results. Set to 1 to exclude auto-corrected results, or 0 (default) to include them. |
| filter | Determines the status of filters for Similar Results and Omitted Results. Set to 1 (default) to enable these filters, or 0 to disable them. |
| safe | Controls the Safe Search setting for results. Set to 'active' to enable Safe Search, or 'off' to disable it. |
| page | Sets the page number for results, defaulting to 1. Combine with the num parameter for pagination. |
| max_page | Use to fetch multiple pages of results in a single request. The API will automatically go through pages and combine the results into one response. Refer to the Pagination documentation for more details. |
| num | Specifies the number of results per page. Combine with the page parameter to implement pagination. |
| tbs | Allows setting a specific string for the Google tbs parameter in the query. The tbs parameter is normally generated automatically, but can also be explicitly set. |
News
When conducting a news search using Google with the ‘typ’e set to ‘news‘, the search term is input using the ‘q‘ parameter.
The ‘time_period’ request parameter can be utilized to narrow down the news search to certain time frames.
To omit news results that have been altered from the original query by Google, set the ‘exclude_if_modified’ parameter to ‘true’ in your search request.
Yahoo SERP API
Search
To access the Yahoo SERP API, you need to use the ‘engine‘ parameter with the value ‘yahoo’. The other required parameters for a successful API call are the ‘key‘ and ‘q‘ parameters.
https://api.serpsolution.come/search?key=API_KEY&engine=yahoo&q=swimming
Parameters
| Required parameters | Description |
|---|---|
| key | API key |
| q |
The "q" parameter specifies the search query you wish to conduct. It accepts any terms or phrases you would typically use in a standard Google search. |
| Optional parameters | Description |
|---|---|
| lang | The "language parameter" sets the language for the Yahoo search, using a two-letter code to specify the desired language. (en - English, es - Spanish...) |
| type |
Search Type: type (Optional) The 'type' parameter determines the specific kind of search you wish to conduct.
|
| safe | The parameter controls the filter settings for mature content. You can choose either 'active' to filter or 'off' to allow such content. . |
| pag_start | This parameter sets the offset for search results, essentially skipping a specified number of results. It's primarily used for implementing pagination. For instance, a value of 0 (the default) displays the first page of results, 10 brings up the second page, 20 the third page, and so on. |
| max | This parameter specifies the maximum number of search results to be returned. For example, setting it to 20 (which is the default) will return 20 results, while setting it to 50 will return 50 results, and 100 will bring back 100 results. |
| dev | The parameter determines the type of device for obtaining search results. You can set it to 'desktop' (the default) for results as seen in a standard web browser, 'tablet' for results from a tablet browser (presently configured for iPads), or 'mobile' for results via a mobile browser (currently using iPhones). |
| autocorrect | The parameter controls whether to exclude results from an automatically corrected query if the original query contains a spelling error. Setting it to 0 will exclude such results, while 1 (the default setting) will include them. |
| no_cache | The parameter instructs SerpSolution to retrieve fresh Yahoo results, bypassing any cached versions that might exist. Cached results are only served if the query and all parameters match exactly. Note that the cache has a lifespan of one hour before expiring. |
| output | The parameter specifies the format of the output you wish to receive. You can choose 'json' (which is the default setting) for a structured JSON representation of the results, or 'html' to obtain the raw HTML data that was retrieved. |
Images
Yahoo Images are used when a request is made with the ‘type’ parameter set to ‘img’ in order to obtain image results.
https://api.serpsolution.come/search?key=API_KEY&engine=yahoo&=img&q=balloon
Parameters
| Required parameters | Description |
|---|---|
| key | API key |
| q |
The "q" parameter specifies the search query you wish to conduct. It accepts any terms or phrases you would typically use in a standard Google search. |
| type | Set to 'img' |
| Parameter | Description |
|---|---|
| img_color | Enables you to specify the color of the returned images: black_and_white, transparent, red, orange, yellow, green, teal, blue, purple, pink, white, gray, black or brown |
| img_size | Allows you to set the size of the images. Values: icon, medium, large |
| img_type | Values: clipart, line, gif |
| img_page | Determines the page of results. For example, if img_page = 3, it will return images 200-299 |
Videos
The parameters for Yahoo Videos are used when a request is made with the ‘type’ parameter set to ‘vid’ in order to obtain video results corresponding to a specific search term.
https://api.serpsolution.come/search?key=API_KEY&engine=yahoo&type=vid&q=football
| Parameter | Description |
|---|---|
| location | Specifies the geographical location for executing the query. You can input any location in text form. Using a predefined SerpWow location automatically updates corresponding google_domain, gl, and hl parameters to match the location's domain, country, and language. This can be overridden with the location_auto parameter. | gl | Sets the Yahoo country for the query. Defaults to the United States (us) with a comprehensive list of supported gl values available. |
| hl | Defines the Yahoo UI language for the search results. The default is English (en), and a list of supported hl values is available. |
| lr | Limits search results to websites in a specified language. A list of supported lr values is provided. |
| cr | Restricts results to websites from a specific country, with a list of supported cr values available. |
| time_period | Sets the time frame for search results, with options like last_hour, last_day, last_week, last_month, last_year, or custom. For custom, specify time_period_min and/or time_period_max. |
| time_period_min | Sets the start date for custom time_period searches, formatted as MM/DD/YYYY. |
| time_period_max | Sets the end date for custom time_period searches, formatted as MM/DD/YYYY. |
| nfpr | Controls the inclusion of auto-corrected query results. Set to 1 to exclude auto-corrected results, or 0 (default) to include them. |
| filter | Determines the status of filters for Similar Results and Omitted Results. Set to 1 (default) to enable these filters, or 0 to disable them. |
| safe | Controls the Safe Search setting for results. Set to 'active' to enable Safe Search, or 'off' to disable it. |
| page | Sets the page number for results, defaulting to 1. Combine with the num parameter for pagination. |
| max_page | Use to fetch multiple pages of results in a single request. The API will automatically go through pages and combine the results into one response. Refer to the Pagination documentation for more details. |
| num | Specifies the number of results per page. Combine with the page parameter to implement pagination. |
| tbs | Allows setting a specific string for the Yahoo tbs parameter in the query. The tbs parameter is normally generated automatically, but can also be explicitly set. |
Parameters
| Required parameters | Description |
|---|---|
| key | API key |
| q |
The "q" parameter specifies the search query you wish to conduct. It accepts any terms or phrases you would typically use in a standard Google search. |
| type | Set to 'vid' |
Shopping
Yahoo Shopping is used when a request is made with the ‘type’ parameter set to ‘shop’ in order to obtain image results. In addition to the traditional parameters, the Shopping API can also be utilized with special parameters.
Parameters
| Required parameters | Description |
|---|---|
| key | API key |
| q |
The "q" parameter specifies the search query you wish to conduct. It accepts any terms or phrases you would typically use in a standard Google search. |
| type | Set to 'shop' |
| Special parameters | Description |
|---|---|
| price_min | Lower limit for the price range query. |
| price_max | Upper limit for the price range query. . |
| sort_by |
This parameter is utilized to sort and enhance results with the following options:
|
| order_by | This parameter determines the order of the query results, either in a top-to-bottom or vice-versa style. Available options: 'asc' and 'desc'. |
| merchant | List of merchant IDs separated by commas |
Bing SERP API
Search
To access the Bing SERP API, you need to use the ‘engine‘ parameter with the value ‘bing’. The other required parameters for a successful API call are the ‘key‘ and ‘q‘ parameters.
https://api.serpsolution.come/search?key=API_KEY&engine=bing&q=pizza
Parameters
| Optional parameters | Description |
|---|---|
| lang | The "language parameter" sets the language for the Bing search, using a two-letter code to specify the desired language. (en - English, es - Spanish...) |
| safe | The parameter controls the filter settings for mature content. You can choose either 'active' to filter or 'off' to allow such content. . |
| pag_start | This parameter sets the offset for search results, essentially skipping a specified number of results. It's primarily used for implementing pagination. For instance, a value of 0 (the default) displays the first page of results, 10 brings up the second page, 20 the third page, and so on. |
| max | This parameter specifies the maximum number of search results to be returned. For example, setting it to 20 (which is the default) will return 20 results, while setting it to 50 will return 50 results, and 100 will bring back 100 results. |
| dev | The parameter determines the type of device for obtaining search results. You can set it to 'desktop' (the default) for results as seen in a standard web browser, 'tablet' for results from a tablet browser (presently configured for iPads), or 'mobile' for results via a mobile browser (currently using iPhones). |
| autocorrect | The parameter controls whether to exclude results from an automatically corrected query if the original query contains a spelling error. Setting it to 0 will exclude such results, while 1 (the default setting) will include them. |
| no_cache | The parameter instructs SerpSolution to retrieve fresh Yahoo results, bypassing any cached versions that might exist. Cached results are only served if the query and all parameters match exactly. Note that the cache has a lifespan of one hour before expiring. |
| output | The parameter specifies the format of the output you wish to receive. You can choose 'json' (which is the default setting) for a structured JSON representation of the results, or 'html' to obtain the raw HTML data that was retrieved. |
Yandex SERP API
Search
To access the Yandex SERP API, you need to use the ‘engine‘ parameter with the value ‘yandex’. The other required parameters for a successful API call are the ‘key‘ and ‘q‘ parameters.
https://api.serpsolution.come/search?key=API_KEY&engine=yandex&q=cars
Parameters
| Optional parameters | Description |
|---|---|
| lang | The "language parameter" sets the language for the Yandex search, using a two-letter code to specify the desired language. (en - English, es - Spanish...) |
| safe | The parameter controls the filter settings for mature content. You can choose either 'active' to filter or 'off' to allow such content. . |
| pag_start | This parameter sets the offset for search results, essentially skipping a specified number of results. It's primarily used for implementing pagination. For instance, a value of 0 (the default) displays the first page of results, 10 brings up the second page, 20 the third page, and so on. |
| max | This parameter specifies the maximum number of search results to be returned. For example, setting it to 20 (which is the default) will return 20 results, while setting it to 50 will return 50 results, and 100 will bring back 100 results. |
| dev | The parameter determines the type of device for obtaining search results. You can set it to 'desktop' (the default) for results as seen in a standard web browser, 'tablet' for results from a tablet browser (presently configured for iPads), or 'mobile' for results via a mobile browser (currently using iPhones). |
| autocorrect | The parameter controls whether to exclude results from an automatically corrected query if the original query contains a spelling error. Setting it to 0 will exclude such results, while 1 (the default setting) will include them. |
| no_cache | The parameter instructs SerpSolution to retrieve fresh Yahoo results, bypassing any cached versions that might exist. Cached results are only served if the query and all parameters match exactly. Note that the cache has a lifespan of one hour before expiring. |
| output | The parameter specifies the format of the output you wish to receive. You can choose 'json' (which is the default setting) for a structured JSON representation of the results, or 'html' to obtain the raw HTML data that was retrieved. |