Google Play
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 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_play |
|
q |
string |
Yes | Search query, supports regular Google search syntax (like inurl:, site:, intitle:) and advanced search parameters | |
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. | |
store_device |
string |
No | Parameter defines the device for sorting results. This parameter cannot be used with apps_category or q parameters. Available options: phone - Phone device (default), tablet - Tablet device, tv - TV device, chromebook - Chromebook device, watch - Watch device, car - Car device | |
age |
string |
No | Parameter defines age subcategory. age works, and should only be used with, apps_category=FAMILY(Kids Apps). It can be set to: AGE_RANGE1 - Ages up to 5, AGE_RANGE2 - Ages 6-8, AGE_RANGE3 - Ages 9-12. The default value for age is:, - All ages up to 12 | |
html |
string |
No | Whether to return HTML format, 1-yes, 0-no | 0 |
Response Example
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) | |
query_displayed |
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) | |
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) |
organic_results
object[] Google Play Store allows users to browse, download, install, and update a wide variety of applications.
| Parameter | Type | Description | Applicable Terminal |
|---|---|---|---|
title |
string |
Content title | |
link |
string[] |
An array of links pointing to content | |
thumbnail |
string[] |
An array of thumbnail image URLs used to display small-sized preview images of the content | |
description |
string |
Content description text | |
product_id |
string |
Unique identifier (ID) of the product | |
rating |
string |
Product rating | |
author |
string |
Author or developer of the product | |
category |
string |
Product category | |
dowmloads |
string |
Product download count | |
feature_image |
string |
Featured image link | |
video |
string |
Link to related video |
related_searches
object[] Related searches: search result suggestions provided to optimize queries and explore
| Parameter | Type | Description | Applicable Terminal |
|---|---|---|---|
link |
string |
Link to related search results that redirects to the corresponding Google Play Store search page | |
text |
string |
Text description of the related search result, used to display the thematic content of the related search |