Google Forum

Perform Search

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"

Request Example

curl -X POST "https://domain/api/v1/open/search" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "your_api_key_here",
    // ...
  }'

Response Format

All responses follow a standardized JSON structure:

{
  "code": 200,
  "msg": "Success",
  "reqId": "req_1234567890",
  "timestamp": "2025-01-08T10:30:00Z",
  "data": {
    // Response data object
  }
}

HTTP Status Codes

Code	Status	Description	Retry
200	OK	Request successful	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
`gl`	`string`	No	Search country code (e.g., us-United States, uk-United Kingdom, fr-France). Head to the Google countries page for a full list of supported Google countries.
`hl`	`string`	No	Search language code (e.g., en-English, es-Spanish, fr-French). Head to the Google languages page for a full list of supported Google languages.
`device`	`string`	No	Device type, currently only supports desktop version	desktop
`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

{
    "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	desktop
`json_endpoint`	`string`	Provide an interface endpoint for searching related JSON data, through which JSON-formatted search data can be obtained	desktop
`created_at`	`string`	The timestamp when the search request was created, recording the time when the search was initiated	desktop
`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	desktop
`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	desktop
`status`	`string`	Status of the search execution (e.g., Success)	desktop
`raw_html_file`	`string`	Identifier for the original HTML file	desktop
`total_time_taken`	`number`	The total time spent on the entire search process (including request sending, result parsing, and other stages)	desktop

search_information

object Contains information about the search results

Parameter	Type	Description	Applicable Terminal
`organic_results_state`	`string`	State of organic results	desktop
`time_taken_displayed`	`number`	TDisplay time (i.e., the time spent on displaying the search results)	desktop

search_parameters

object Contains the parameters used for the search

Parameter	Type	Description	Applicable Terminal
`q`	`string`	Keywords used for this query	desktop
`engine`	`string`	Search engine used for this query (e.g., google_web)	desktop
`html`	`string`	When HTML=0, returns JSON; when HTML=1, returns HTML; when HTML=2, returns both JSON and HTML	desktop
`device`	`string`	Device type used during search (e.g., desktop)	desktop
`google_domain`	`string`	Specifies the corresponding Google domain (e.g., google.com, etc., used to distinguish Google services in different regions/locales)	desktop
`udm`	`number`	18	desktop

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	desktop
`title`	`string`	Result title	desktop
`link`	`string[]`	List of web links for results	desktop
`source_logo`	`string`	Logo URL of the source (image address of the brand logo indicating content origin, typically in data:image/png;base64 format)	desktop
`reviews`	`string`	Comments or interaction data for the result	desktop
`snippet`	`string`	Summary snippet of the result	desktop
`date`	`string`	Content date (publication date or update date, typically in "YYYY-MM-DD" format)	desktop
`source`	`string[]`	List of source descriptions for the results	desktop
`other_result`	`object`	Supplementary related information for this result (including more granular associated content)	desktop
`other_result.link`	`string`	Related supplementary content URLs	desktop
`other_result.reviews`	`string`	Related supplementary content interaction data	desktop
`other_result.snippet`	`string`	Summary snippets for related supplementary content	desktop
`extra_result`	`object[]`	Additional results related to this result	desktop
`extra_result[].link`	`string`	URLs for additional results	desktop
`extra_result[].title`	`string`	Title of additional results	desktop
`extra_result[].reviews`	`string`	Interaction data of additional results	desktop
`extra_result[].date`	`string`	Release date of additional results	desktop

related_searches

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)	desktop
`query`	`string`	Position indicator for content blocks (indicating its ordering/placement within the overall layout or result list)	desktop
`link`	`string`	Target URL of the resource(the webpage redirected to upon clicking)	desktop

pagination

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

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

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