Skip to content

Google Forum

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 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_forum google
q string Yes Search query, supports regular Google search syntax (like inurl:, site:, intitle:) and advanced search parameters
google_domain string No Google domain, defaults to google.com google.com
date string No Time range filter: h-last hour, d-last day, w-last week, m-last month, y-last year
start number No Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., 0 (default) is the first page of results, 10 is the 2nd page of results, 20 is the 3rd page of results, etc.).
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
{
    "code": 200,
    "data": {
        "search_metadata": {
            "raw_html_file": "oss_html",
            "total_time_taken": 2.032416469,
            "id": "1985902431212408832",
            "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=coffee&udm=18",
            "status": "Success"
        },
        "search_information": {
          "organic_results_state": "Showing results for exact spelling despite spelling suggestion",
          "time_taken_displayed": 0.033
        },
        "search_parameters": {
            "engine": "google_forum",
            "html": "0",
            "google_domain": "www.google.com",
            "q": "coffee", 
            "udm": 18
        },
        "organic_results": [
          {
            "position": 1,
            "title": "My fellow Americans, what kind of coffee do you drink?",
            "link": [
              "https://www.reddit.com/r/AskAnAmerican/comments/1o7e5l4/my_fellow_americans_what_kind_of_coffee_do_you/"
            ],
            "source_logo": [
              "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAAcCAMAABF0y+mAAAAA"
            ],
            "reviews": "870+ comments · 10 hours ago",
            "snippet": "Drip coffee is definitely the most popular style of coffee for ease of brewing. However, espresso coffees are definitely becoming more ...",
            "source": [
              "Reddit · r/AskAnAmerican"
            ],
            "other_result": {
              "link": "https://www.reddit.com/r/AskAnAmerican/comments/1o7e5l4/my_fellow_americans_what_kind_of_coffee_do_you/njmyhyi/",
              "reviews": "879 answers",
              "snippet": "· Top answer: Drip coffee is definitely the most popular style of coffee for ease of brewing. However, ..."
            },
            "extra_result": [
              {
                "link": "https://www.reddit.com/r/Coffee/comments/17kgxdf/coffee_where_to_start/",
                "title": "Coffee - where to start??",
                "reviews": "61 answers",
                "date": "Oct 31, 2023"
              }
            ]
          }
        ],
        "related_searches": [
            {
                "block_position": 1,
                "query": "Americano coffee",
                "link": "https://www.google.com/search?sca_esv=9734a983a01cfe31&gl=us&hl=en&udm=18&q=Americano+coffee&sa=X&ved=2ahUKEwjU6t_lzqeQAxUxSWwGHde3NwkQ1QJ6BAg1EAE"
            }
        ],
        "pagination": {
          "current": 1,
          "next": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=10&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8NMDegQIGRAW",
          "other_pages": {
            "2": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=10&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAE",
            "3": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=20&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAG",
            "4": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=30&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAI",
            "5": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=40&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAK",
            "6": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=50&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAM",
            "7": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=60&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAO",
            "8": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=70&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAQ",
            "9": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=80&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAS",
            "10": "https://www.google.com/search?q=coffee&lr=lang_en&sca_esv=4b752b0057153c0c&gl=us&hl=en&tbs=lr:lang_1en&ei=yaXxaLu2FpKNseMPh9Pu2QI&start=90&sa=N&sstk=Af77f_e5ATQiBR2g6i0PioPRhVCJRwe-Uvg3QfRx8PbRJCfhhwu1aHhL5hYp9LpnSHWs0YchGN0UJXWAj7kHwSz1pB75iAOYOpi4Pg&ved=2ahUKEwj7vs__k6qQAxWSRmwGHYepOysQ8tMDegQIGRAU"
          }
        },
        "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
time_taken_displayed number TDisplay time (i.e., the time spent on displaying the search results)

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)
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 18

organic_results

object[] Forum Results (content sourced from community discussions, posts, and user contributions)

Parameter Type Description Applicable Terminal
position number Ranking position of the result in natural search results
title string Result title
link string[] List of web links for results
source_logo string Logo URL of the source (image address of the brand logo indicating content origin, typically in data:image/png;base64 format)
reviews string Comments or interaction data for the result
snippet string Summary snippet of the result
date string Content date (publication date or update date, typically in "YYYY-MM-DD" format)
source string[] List of source descriptions for the results
other_result object Supplementary related information for this result (including more granular associated content)
other_result.link string Related supplementary content URLs
other_result.reviews string Related supplementary content interaction data
other_result.snippet string Summary snippets for related supplementary content
extra_result object[] Additional results related to this result
extra_result[].link string URLs for additional results
extra_result[].title string Title of additional results
extra_result[].reviews string Interaction data of additional results
extra_result[].date string Release date of additional results

object[] Search term, other related search terms recommended by the system, diversifying/adjusting search direction, exploring similar/related topics

Parameter Type Description Applicable Terminal
block_position number Position indicator for content blocks (indicating its ordering/placement within the overall layout or result list)
query string Position indicator for content blocks (indicating its ordering/placement within the overall layout or result list)
link string Target URL of the resource(the webpage redirected to upon clicking)

pagination

object (Pagination) related fields used to describe pagination navigation information for search results

Parameter Type Description Applicable Terminal
current number Current page number
next string Next page navigation link (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 (Pagination) related fields used to describe pagination navigation information for search results

Parameter Type Description Applicable Terminal
last_page string Last page (the "last page" indicator when paginating search results)