Skip to content

Google Shopping

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_local google
tbm string Yes shop
q string Yes Search query, supports regular Google search syntax (like inurl:, site:, intitle:) and advanced search parameters
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
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 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
total_results string Total results count (the total number of results returned by this search) 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
tbm string shop desktop

shopping_results

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

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

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 desktop

filters_results

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

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