YH Finance API Documentation

1. Overview

The YH Finance API provides access to a wide range of financial information available on finance.yahoo.com. It allows developers to query for details such as finance summary, stocks, quotes, movers, and more.

2. Tools and Their Descriptions

2.1 conversations/list (Deprecated)

• Description: List conversations relating to a symbol

2.2 stock/get-esg-scores

• Description: Get scores related to a symbol

2.3 stock/get-fees-and-expenses

• Description: Get fees and expenses related to a symbol

2.4 stock/v2/get-timeseries

• Description: Get Quarterly data in Financials tab

2.5 stock/v2/get-summary (Deprecated)

• Description: Get data in Summary section. Use.../market/v2/get-quotes instead

2.6 stock/v3/get-upgrades-downgrades

• Description: Get upgrades downgrades histories related to a symbol

2.7 stock/v2/get-financials (Deprecated)

• Description: Get Income Statement, Annual data in Financials tab. Use.../stock/v2/get-timeseries and.../stock/get-fundamentals instead. If you want to get Quarterly data, use.../stock/v2/get-timeseries endpoint instead

2.8 stock/get-events-calendar

• Description: Get events calendar related to a symbol

2.9 stock/v2/get-upgrades-downgrades (Deprecated)

• Description: Get upgrades and downgrades data

2.10 stock/get-fundamentals

• Description: Get fundamentals data

2.11 stock/v3/get-holders

• Description: Get holders related to a symbol

2.12 stock/v3/get-chart

• Description: Get data to draw full screen chart

2.13 stock/get-futures-chain

• Description: Get futures chain

2.14 stock/get-recommendation-trend

• Description: Get recommended trending information

2.15 stock/v2/get-insights

• Description: Get brief reports relating to a symbol

2.16 stock/get-top-holdings

• Description: Get top holdings related to a symbol

2.17 stock/v2/get-options (Deprecated)

• Description: Get data in Options section

2.18 stock/v4/get-statistics

• Description: Get statistics related to a symbol

2.19 stock/v2/get-similarities (Deprecated)

• Description: Get similar and recommended symbols relating to specified one

2.20 stock/get-esg-score-for-peers (Deprecated)

• Description: Get ESG Risk scores for peers related to a symbol

2.21 stock/v2/get-holdings (Deprecated)

• Description: Get data in Holdings tab (it must be Mutual fun stock to have this tab displayed)

2.22 stock/v3/get-balance-sheet (Deprecated)

• Description: Get data in Balance Sheet tab in Financials section

2.23 stock/v2/get-balance-sheet (Deprecated)

• Description: Get data in Balance Sheet tab in Financials section. Use.../stock/v2/get-timeseries and.../stock/get-fundamentals instead

2.24 stock/v2/get-profile (Deprecated)

• Description: Get data in Profile tab

2.25 stock/get-what-analysts-are-saying

• Description: Get "what analysts are saying" section

2.26 stock/get-company-outlook

• Description: Get company outlook

2.27 stock/get-earnings

• Description: Get earnings related to a symbol

2.28 stock/get-sec-filings

• Description: Get sec filings related to a symbol

2.29 stock/v2/get-statistics (Deprecated)

• Description: Get data in Statistics tab. This endpoint was deprecated, use.../stock/get-fundamentals instead

2.30 stock/v2/get-insider-transactions (Deprecated)

• Description: Get data in Insider Transactions tab in Holders section

2.31 stock/v2/get-analysis (Deprecated)

• Description: Get data in Analysis section

2.32 stock/v3/get-statistics (Deprecated)

• Description: Get data in Statistics tab. This endpoint was deprecated, use.../stock/get-fundamentals instead

2.33 stock/get-recent-updates

• Description: Get recent updates related to a symbol

2.34 stock/v2/get-chart

• Description: Get data to draw full screen chart

2.35 stock/v2/get-insider-roster (Deprecated)

• Description: Get data in Insider Roster tab in Holders section

2.36 stock/v2/get-cash-flow (Deprecated)

• Description: Get cash flow tab information in Financials tab. Use.../stock/v2/get-timeseries and.../stock/get-fundamentals instead

2.37 stock/v3/get-insights

• Description: Get brief reports relating to a symbol

2.38 stock/v2/get-recommendations

• Description: Get similar symbols relating to specified one

2.39 stock/v2/get-holders (Deprecated)

• Description: Get data in Major Holders tab in Holders section

2.40 stock/v3/get-options

• Description: Get option prices

2.41 stock/v3/get-profile

• Description: Get ticker's profile

2.42 stock/v3/get-historical-data (Deprecated)

• Description: Get data in Historical Data tab. This endpoint was deprecated, use.../stock/get-fundamentals instead

2.43 screeners/get-filters

• Description: Get optional filters for later use in …/screeners/list endpoint

2.44 conversations/v2/list

• Description: List conversations relating to a symbol

2.45 conversations/count

• Description: Count total conversations relating to a symbol

2.46 calendar/get-events

• Description: Get events happening in a period of time

2.47 calendar/count-events

• Description: Count the number of events happening in a period of time

2.48 screeners/list

• Description: List gainers, losers, most active stickers, mutual fund, ETF, etc… from different categories, exchanges, etc with optional filters

2.49 screeners/get-symbols-by-predefined

• Description: Get symbols related to a predefined screener

2.50 screeners/list-by-ticker

• Description: Get screener IDs related to a ticker

2.51 market/get-charts (Deprecated)

• Description: Get data to draw chart for a specific symbol and its comparisons

2.52 market/get-popular-watchlists

• Description: Get popular watchlists in the market

2.53 market/get-trending-tickers

• Description: Get latest trending tickers in the market

2.54 market/get-earnings

• Description: Get recent earnings in the market

2.55 market/v2/get-summary

• Description: Get live summary information of market by region

2.56 market/get-spark

• Description: Used with.../market/get-trending-tickers endpoint together to draw brief chart

2.57 market/v2/get-movers

• Description: The live day gainers / losers / actives in specific region

2.58 market/v2/get-quotes

• Description: Get live price quotes

2.59 market/get-tickers-by-quote-type

• Description: Get tickers grouped by quote types

2.60 news/v2/list

• Description: List latest general news or video feeds or news relating to a symbol (by using's' parameter), the result may be empty if there is no news in that region

2.61 news/v2/get-details

• Description: Read the specific news in details

2.62 market/get-watchlist-performance

• Description: Get performance information of specific watchlist

2.63 market/get-watchlist-detail

• Description: Get detail information of specific watchlist

2.64 auto-complete

• Description: Get auto complete suggestions by term or phrase

3. Usage Examples

Each tool has its own specific usage pattern. For example, to get the ESG scores related to a symbol using the stock/get-esg-scores tool, you would need to provide the relevant symbol as a parameter in the API request. Similarly, for getting live price quotes using the market/v2/get-quotes tool, appropriate parameters related to the market and symbols need to be set in the request.

The general format for making API requests would be something like: https://api.yhfinance.com/tool_name?parameters

Where tool_name is the specific tool name (e.g., stock/get-esg-scores) and parameters are the necessary inputs for that tool such as the symbol, time period, etc. depending on the tool's requirements.

4. Deprecated Tools

Some tools are marked as deprecated. When using the API, it is recommended to avoid using the deprecated tools as they may be removed or their functionality may change in the future. Instead, use the recommended alternative tools as described in their respective descriptions. For example, for getting data in the Summary section, use market/v2/get-quotes instead of the deprecated stock/v2/get-summary.

5. Rate Limiting and API Keys

Details regarding rate limiting and API keys are not provided in the given information. It is advisable to check the official API documentation or contact the API provider for any specific rate limiting rules and requirements regarding API keys if they are applicable.

6. Error Handling

Error handling mechanisms are not described in the provided details. However, in a real - world scenario, proper error handling should be implemented when making API requests. This may include handling HTTP status codes, error messages returned by the API, and retrying requests in case of transient errors.

7. Data Formats

The data formats returned by each tool are also not detailed here. In general, the data could be in JSON format, which is a common format for API responses. Developers should be prepared to handle and parse the data according to the expected format based on the tool's purpose. For example, data related to financial summaries might be in a structured JSON object containing relevant financial metrics.