Google Finance
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_finance |
|
q |
string |
Yes | Search query, supports regular Google search syntax (like inurl:, site:, intitle:) and advanced search parameters | |
window |
string |
No | Parameter is used for setting time range for the graph. It can be set to: 1D - 1 Day(default), 5D - 5 Days, 1M - 1 Month, 6M - 6 Months, YTD - Year to Date, 1Y - 1 Year, 5Y - 5 Years, MAX - Maximum | |
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 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | |
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 |
|---|---|---|---|
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) | |
google_domain |
string |
Specifies the corresponding Google domain (e.g., google.com, etc., used to distinguish Google services in different regions/locales) | |
html |
string |
When HTML=0, returns JSON; when HTML=1, returns HTML; when HTML=2, returns both JSON and HTML |
knowledge_graph
object Integrates multidimensional structured knowledge related to financial entities (such as listed companies, stocks, industries) to systematize the presentation of financial information.
| Parameter | Type | Description | Applicable Terminal |
|---|---|---|---|
key_stats |
object |
A repository of core statistical information comprising relevant concept tags and key statistical metrics | |
key_stats.tags |
object[] |
An array of relevant concept tags, with each element being a tag object | |
key_stats.tags[].text |
string |
The textual content of the tag object | |
key_stats.tags[].description |
string |
Detailed specifications of the tag object | |
key_stats.stats |
object[] |
An array of key statistical metrics, with each element being a metric object. | |
key_stats.stats[].label |
string |
The name of the metric object | |
key_stats.stats[].description |
string |
Description of the metric object | |
key_stats.stats[].value |
string |
The numerical value of the metric object | |
about |
object[] |
Basic information of the entity (e.g., enterprises, entities) | |
about[].title |
string |
Information section title | |
about[].description |
object |
A collection of brief introduction information of the entity | |
about[].description.snippet |
string |
Entity summary snippet | |
about[].description.link |
string |
Summary source link | |
about[].description.link_text |
string |
Link display text | |
about[].info |
obejct[] |
Array of entity key attributes, each element is a property object | |
about[].info[].label |
string |
Property label | |
about[].info[].value |
string |
Property value | |
about[].info[].link |
string |
Property details link |
markets
object Real-time market data: including key metrics such as stock price, change, intraday high/low points, market cap
| Parameter | Type | Description | Applicable Terminal |
|---|---|---|---|
stock |
string |
Stock/index identifier | |
link |
string |
Link to the Google Finance detail page for stock/index | |
name |
string |
Stock/index name | |
price |
string |
Stock/index price | |
price_movement |
object |
Price change data collection | |
price_movement.percentage |
string |
Percentage change | |
price_movement.value |
string |
Absolute change | |
price_movement.move |
string |
Direction of price change |
news_results
object[] Financial market and securities news (stocks, indices)
| Parameter | Type | Description | Applicable Terminal |
|---|---|---|---|
snippet |
string |
Summary snippet of the news, used to quickly present the core content of the article | |
link |
string |
Web link to the original news article, redirecting to the full news page | |
source |
string |
Source of the content (e.g., website name, media platform, or other origin identifiers) | |
date |
string |
Content date (publication date or update date, typically in "YYYY-MM-DD" format) | |
thumbnail |
string |
Thumbnail link (URL of small-sized preview image related to the content, used for quick visual recognition, including data:image/png;base64) |
discover_more
object[] The correlation logic between user interest preferences and the financial market, enabling personalized recommendations of potentially interesting financial assets
| Parameter | Type | Description | Applicable Terminal |
|---|---|---|---|
title |
string |
Title of the recommendation section, indicating the theme of the recommended content | |
items |
object[] |
Specific list of recommended financial assets | |
items[].stock |
string |
Unique identifier of the financial asset | |
items[].link |
string |
Link to the detailed page of the financial asset on Google Finance | |
items[].name |
string |
Financial asset name | |
items[].price |
string |
Current price of the financial asset | |
items[].extracted_price |
string |
Extracted price value | |
items[].price_movement |
object |
Collection of price change data | |
items[].price_movement.percentage |
string |
Percentage change in price | |
items[].price_movement.movement |
string |
Direction of price change |
summary
object Aggregated snapshot-style presentation of key information about financial instruments (such as stocks, indices, etc.)
| Parameter | Type | Description | Applicable Terminal |
|---|---|---|---|
title |
string |
Company or Instrument Name | |
stock |
string |
Ticker symbol | |
exchange |
string |
Stock exchange | |
price |
string |
Current stock price (with currency symbol) | |
extracted_price |
string |
Extracted raw price value | |
currency |
string |
Currency symbol | |
market |
object |
Collection of market trading information | |
market.trading |
string |
Trading hours | |
market.price |
string |
After-hours trading price | |
market.extracted_price |
string |
Raw after-hours trading price | |
market.currency |
string |
After-hours trading currency symbol | |
market.price_movement |
object |
Collection of after-hours price change data | |
market.price_movement.percentage |
string |
Percentage change in price | |
market.price_movement.value |
string |
Absolute value of price change | |
market.price_movement.movement |
string |
Direction of price change | |
extensions |
string[] |
Extended information array containing additional auxiliary data |
graph
object[] Visualize the price trends and trading data of financial instruments (such as stocks, indices, etc.)
| Parameter | Type | Description | Applicable Terminal |
|---|---|---|---|
price |
number |
Price value of financial instruments (such as stocks, indices, etc.) at the corresponding date and time | |
currency |
string |
Currency type used for the price | |
date |
string |
Specific date and time corresponding to the price | |
volume |
number |
Trading volume of the financial instrument at the corresponding date and time |
financials
object[] (Financial module) Integrate and present detailed financial data of publicly listed companies
| Parameter | Type | Description | Applicable Terminal |
|---|---|---|---|
title |
string |
Financial report heading | |
results |
object[] |
Financial report result set | |
results[].data |
string |
Date corresponding to the financial data | |
results[].period_type |
string |
Reporting period type of financial data |