Skip to content

Google Web Page

Overview

Method Endpoint Version Description
POST /api/v1/open/search v1 Google Search API endpoint for retrieving search results

Request Headers

Header Type Required Description
Content-Type string Yes Must be set to application/json
Accept string No Response format (defaults to application/json)

Authentication

API Key Authentication

  • Pass the API key as a request parameter: api_key=your_api_key
  • Example: "api_key": "your_api_key_here"

HTTP Status Codes

Code Status Description Retry
200 OK Request successful No

Response Codes

Code Description Retry
200 Request successful No
400100 Unsupported search engine No
400200 The search service is temporarily unavailable. Please try again later No
400300 ForUserQuery contains prohibited content No
400400 No results found, please adjust keywords and try again No
400500 Authorization failed, please check your API credentials No
400600 The request frequency is too high, please try again later No
400700 You have reached the daily search limit No
400710 Insufficient Balance No

Request Example

1
2
3
4
5
6
7
8
curl -X POST "https://domain/api/v1/open/search" \
  -H "Content-Type: application/json" \
  -d '{
    "q": "coffee",
    "engine": "google_web",
    "html": "0",
    "api_key": "your_api_key_here"
}'

Request Parameters

Parameter Type Required Description Default
api_key string Yes API key for authentication
engine string Yes Search engine type, currently engine value is google_web google
q string Yes Search query, supports regular Google search syntax (like inurl:, site:, intitle:) and advanced search parameters
date string No Time range filter: h-last hour, d-last day, w-last week, m-last month, y-last year
start number No Result offset for pagination (0-first page, 10-second page, 20-third page)
google_domain string No Google domain, defaults to google.com google.com
html string No Whether to return HTML format, 1-yes, 0-no 0

Response Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
{
    "code": 200,
    "data": {
        "search_metadata": {
            "raw_html_file": "oss_html",
            "total_time_taken": 2.032416469,
            "id": "1983336358118166528",
            "json_endpoint": "oss_json",
            "created_at": "2025-10-29 08:53:31",
            "processed_at": "2025-10-29 08:53:33",
            "google_url": "https://www.google.com/search?q=test&udm=14",
            "status": "Success"
        },
        "search_information": {
            "organic_results_state": "",
            "page_number": 1,
            "time_taken_displayed": 0.63,
            "total_results": ""
        },
        "search_parameters": {
            "engine": "google_web",
            "html": "0",
            "device": "desktop",
            "google_domain": "www.google.com",
            "q": "test",
            "udm": 14
        },
        "organic_results": [
            {
                "position": 1,
                "title": "",
                "link": [
                    ""
                ],
                "displayed_link": "",
                "source_logo": [
                    "data:image/png;base64,"
                ],
                "snippet": "",
                "source": [
                    ""
                ],
                "snippet_highlighted_words": [
                    ""
                ],
                "label_list": [
                    {
                        "text": "",
                        "link": ""
                    }
                ]
            }
        ],
        "pagination": {
            "current": 1,
            "next": "",
            "other_pages": {
                "1": "https://www.google.com/search"
            }
        },
        "last_page": "10"
    },
    "msg": "string",
    "reqId": "string"
}

Complete Response Parameters Overview

search_metadata

object Contains metadata about the search execution

Parameter Type Description Applicable Terminal
id string Unique identifier for the search request
json_endpoint string Provide an interface endpoint for searching related JSON data, through which JSON-formatted search data can be obtained
created_at string The timestamp when the search request was created, recording the time when the search was initiated
processed_at string The timestamp when the search results were processed and became available for return, recording the time point from processing to completion of the search
google_url string The Google search URL, which contains the search keyword "coffee" along with language parameters (hl=en for English), regional parameters (gl=us for the United States), and other search parameters, used to redirect to the corresponding Google search page
status string Status of the search execution (e.g., Success)
raw_html_file string Identifier for the original HTML file
total_time_taken number The total time spent on the entire search process (including request sending, result parsing, and other stages)

search_information

object Contains information about the search results

Parameter Type Description Applicable Terminal
organic_results_state string State of organic results
page_number number Current page number (indicating the current pagination index of the search results, used for browsing search results by pages)
time_taken_displayed number TDisplay time (i.e., the time spent on displaying the search results)
total_results string Total results count (the total number of results returned by this search)

search_parameters

object Contains the parameters used for the search

Parameter Type Description Applicable Terminal
q string Keywords used for this query
engine string Search engine used for this query (e.g., google_web)
lr string No Parameter defines one or multiple languages to limit the search to. It uses lang_{two-letter language code} to specify languages and | as a delimiter. (e.g., lang_fr|lang_de will only search French and German pages). Head to the Google lr languages page for a full list of supported languages.
html string When HTML=0, returns JSON; when HTML=1, returns HTML; when HTML=2, returns both JSON and HTML
google_domain string Specifies the corresponding Google domain (e.g., google.com, etc., used to distinguish Google services in different regions/locales)
udm number Google Search type identifier

organic_results

object[] A collection of naturally sorted web results that match the search keywords. See specific parameter explanations for details.

Parameter Type Description Applicable Terminal
position number The ranking of this result in the organic search results
title string Title of the search result
link[] string[] Array of links associated with the result
displayed_link string Display link (simplified and formatted link used for page display, easy to read)
source_logo[] string[] Source logo link (the image address of the content source brand logo, usually in the format data:image/png;base64)
snippet string Snippet of the search result summary
source[] string[] Source of the content (such as website name, media platform, or other source identifiers)
snippet_highlighted_words[] string[] Array of highlighted keywords in the summary
label_list[] object[] Array of tags and extended links related to the result
label_list[].text string Text content of the tag
label_list[].link string Target web link corresponding to the tag
thumbnail string Thumbnail link (address of a small preview image related to the content, used for quick visual identification, including data:image/png;base64)

pagination

object Pagination information (parameters or display logic that control the pagination of search results). See specific parameter explanations for details.

Parameter Type Description Applicable Terminal
current number Current page number
next string Link to the next page (can directly jump to the next page of search results)
other_pages object An object containing navigation links to other pages (such as page 2, page 3, etc.)

last_page

string Last page number (the "last page" identifier in paginated searches). See specific parameter explanations for details.

Parameter Type Description Applicable Terminal
last_page string Last page number(the "last page" identifier in paginated searches)