Google Shopping

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"

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

curl -X POST "https://domain/api/v1/open/search" \
  -H "Content-Type: application/json" \
  -d '{
    "q": "coffee",
    "engine": "google_shopping",
    "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_shopping`	google
`tbm`	`string`	Yes	shop
`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
`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=28",
            "status": "Success"
        },
        "search_information": {
            "organic_results_state": "Showing results for exact spelling despite spelling suggestion",
            "time_taken_displayed": 0.042,
            "total_results": ""
        },
        "search_parameters": {
            "engine": "google_shopping",
            "html": "0",
            "google_domain": "www.google.com",
            "q": "coffee",
            "tbm": "shop"
        },
        "shopping_results": [
            {
                "position": 2,
                "title": "Bustelo Coffee Espresso",
                "source": "Walgreens.com",
                "source_logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAAgCAYAAABze",
                "product_id": "1780156926901513261",
                "product_link": "https://www.google.com/shopping/product/1780156926901513261?gl=us",
                "price": "$5.99",
                "thumbnail": "data:image/webp;base64,UklGRq4xAABXRUJQVIA4IKlxAABQoACdASogAREBPLEkj0",
                "rating": "4.7",
                "reviews": "7400",
                "extracted_price": 33,
                "extensions": [
                    "33% OFF"
                ],
                "tag": "33% OFF"
            }
        ],
        "pagination": {
            "next": "https://www.google.com/search?coffee&sca_esv=552fb68e3d08662a&gl=us&hl=en&udm=2&ei=1TvvaPazNr7c4-EPj-Cv4Q8&start="
        },
        "filters_results": [
          {
              "input_type": "link_with_icon",
              "options": [
                  {
                      "text": "Nearby",
                      "link": "https://www.google.com/search?q=coffee+nearby&gl=us&hl=en&udm=28&shoprs=CAEYAyoGY29mZmVlMgwlAxlGTmVhcmJ5GAJYt8sfYAI&sa=X&ved=2ahUKEwi38_uP7KWQAxX3zTgGHUIBKSAQ268JKAB6BAgKEAU"
                  }
              ]
          }
      ]
    },
    "msg": "string",
    "reqId": "string"
}

Complete Response Parameters Overview

search_metadata

object Contains metadata about the search execution

Parameter	Type	Description
`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
`organic_results_state`	`string`	State of organic results
`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
`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)
`tbm`	`string`	shop

shopping_results

object[] Google Shopping search, retrieving shopping-related content (e.g., product pricing, merchants, purchase links, etc.)

Parameter	Type	Description
`position`	`number`	The ranking position of the product in Google Shopping search results
`title`	`string`	Product Title
`source`	`string`	Source Website of the Product
`source_logo`	`string`	Source Attribution Logo URI‌ (Image address for content attribution identifier, typically in data:image/png;base64 format)
`product_id`	`string`	Product Unique Identifier (for distinguishing between different products)
`product_link`	`string`	Product Link (taking users to Google Shopping or the source website's product details page)
`price`	`string`	Display Price
`thumbnail`	`string`	Thumbnail link (address of a small preview image related to the content, used for quick visual identification, including data:image/png;base64)
`rating`	`string`	Customer Rating (star-based user evaluation of the product)
`reviews`	`string`	Review Count
`extracted_price`	`number`	Extracted Price-Related Values
`extensions`	`string[]`	Extended Product Information List
`tag`	`string`	‌Promotional Badges (Highlighting Discounts)

pagination

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

Parameter	Type	Description	Applicable Terminal
`next`	`string`	URL for the next page of search results

filters_results

object[] Filter Dimensions / Options‌ (such as by "Price Range", "Brand", "Merchant Type", "Product Category")

Parameter	Type	Description
`input_type`	`string`	‌Filter Option Presentation or Interaction Types
`options`	`object[]`	‌List of Specific Filter Options Under a Filter, Where Each Object in the Array Represents a Clickable Filter Option
`options[].text`	`string`	Display Text for Filter Options
`options[].link`	`string`	‌Target Link After Filter Selection