Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

added yfinance api to api zoo #161

Merged
merged 5 commits into from
Feb 4, 2024
Merged

added yfinance api to api zoo #161

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5691404
added yfinance api to api zoo
raywanb Jan 30, 2024
4234192
fixed username
raywanb Jan 30, 2024
ed556de
fixes
raywanb Jan 31, 2024
43493a1
Merge branch 'main' into main
raywanb Jan 31, 2024
81a3bdb
Rename raywanb.json to yfinance.json
ShishirPatil Feb 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
207 changes: 207 additions & 0 deletions data/apizoo/yfinance.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
[
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance Mass Download of Market Data API",
"api_call": "yf.download({tickers}, start={start_date}, end={end_date}, group_by={group_by})",
"api_version": "0.2.36",
"api_arguments": {
"tickers": "A list of stock tickers to download data for (separated by space)",
"start_date": "Start date for data retrieval (format: 'YYYY-MM-DD')",
"end_date": "End date for data retrieval (format: 'YYYY-MM-DD')",
"group_by": "Optional parameter to group data by 'ticker' (default) or 'column' (group data by column names)"
},
"functionality": "Mass download historical market data for multiple stocks from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\ntickers = 'SPY AAPL' \nstart_date = '2017-01-01' \nend_date = '2017-04-30' \ndata = yf.download(tickers, start=start_date, end=end_date, group_by='ticker')",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. You can use it to mass download data for multiple stock tickers at once, specifying a start and end date. By default, data is grouped by ticker, but you can also choose to group it by column names."
},
"questions": [
"Mass download historical market data for SPY and AAPL from January 1, 2017, to April 30, 2017, grouping data by ticker."
]
},
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance Get History Metadata API",
"api_call": "yfinance.Ticker({ticker}).history_metadata",
"api_version": "0.2.36",
"api_arguments": {
"ticker": "Stock ticker to download data for"
},
"functionality": "Get historical meta data from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\n# get historical market data \nhist = msft.history(period='1mo') \nprint(msft.history_metadata)",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It provides access to historical data with up to 1-minute granularity."
},
"questions": [
"How can I reliably download historical market data using yfinance?",
"Download AAPL's historical metadata"
]
},
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance Dividends Data API",
"api_call": "yfinance.Ticker({ticker}).dividends",
"api_version": "0.2.36",
"api_arguments": {
"ticker": "Stock ticker to download data for"
},
"functionality": "Get historical meta data from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.dividends)",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It provides access to historical data with up to 1-minute granularity."
},
"questions": ["Download MSFT's dividends data"]
},
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance Splits Data API",
"api_call": "yfinance.Ticker({ticker}).splits",
"api_version": "0.2.36",
"api_arguments": {
"ticker": "Stock ticker to download data for"
},
"functionality": "Get historical meta data from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.splits)",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It provides access to historical data with up to 1-minute granularity."
},
"questions": ["Download MSFT's split data"]
},
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance News API",
"api_call": "yfinance.Ticker({ticker}).news",
"api_version": "0.2.36",
"api_arguments": {
"ticker": "Stock ticker to retrieve news for"
},
"functionality": "Get the latest news articles related to a stock from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.news)",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to the latest news articles related to a specific stock."
},
"questions": [
"Retrieve the latest news articles related to Microsoft (MSFT)"
]
},
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance Options API",
"api_call": "yfinance.Ticker({ticker}).options",
"api_version": "0.2.36",
"api_arguments": {
"ticker": "Stock ticker to retrieve options data for"
},
"functionality": "Get information on available options contracts for a specific stock from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.options)",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to information on available options contracts for a specific stock."
},
"questions": [
"Retrieve information on available options contracts for Microsoft (MSFT)"
]
},
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance Income Statement API",
"api_call": "yfinance.Ticker({ticker}).financials",
"api_version": "0.2.36",
"api_arguments": {
"ticker": "Stock ticker to retrieve income statement data for"
},
"functionality": "Get the income statement data for a specific stock from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.financials)",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to income statement data for a specific stock."
},
"questions": ["Retrieve the income statement data for Microsoft (MSFT)"]
},
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance Actions API",
"api_call": "yfinance.Ticker({ticker}).actions",
"api_version": "0.2.36",
"api_arguments": {
"ticker": "Stock ticker to retrieve actions data for"
},
"functionality": "Get the actions data (dividends, stock splits) for a specific stock from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.actions)",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to actions data (like dividends and stock splits) for a specific stock."
},
"questions": ["Retrieve the actions data for Microsoft (MSFT)"]
},
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance Cash Flow API",
"api_call": "yfinance.Ticker({ticker}).cashflow",
"api_version": "0.2.36",
"api_arguments": {
"ticker": "Stock ticker to retrieve cash flow data for"
},
"functionality": "Get the cash flow data for a specific stock from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.cashflow)",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to cash flow data for a specific stock."
},
"questions": ["Retrieve the cash flow data for Microsoft (MSFT)"]
},
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance Balance Sheet API",
"api_call": "yfinance.Ticker({ticker}).balance_sheet",
"api_version": "0.2.36",
"api_arguments": {
"ticker": "Stock ticker to retrieve balance sheet data for"
},
"functionality": "Get the balance sheet data for a specific stock from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.balance_sheet)",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to balance sheet data for a specific stock."
},
"questions": ["Retrieve the balance sheet data for Microsoft (MSFT)"]
},
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance Recommendations API",
"api_call": "yfinance.Ticker({ticker}).recommendations",
"api_version": "0.2.36",
"api_arguments": {
"ticker": "Stock ticker to retrieve analyst recommendations data for"
},
"functionality": "Get the analyst recommendations data for a specific stock from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.recommendations)",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to analyst recommendations for a specific stock."
},
"questions": ["Retrieve the analyst recommendations data for Microsoft (MSFT)"]
},
{
"user_name": "raywanb",
"api_name": "yfinance - Yahoo Finance Major Holders API",
"api_call": "yfinance.Ticker({ticker}).major_holders",
"api_version": "0.2.36",
"api_arguments": {
"ticker": "Stock ticker to retrieve major holders information for"
},
"functionality": "Get the major holders information for a specific stock from Yahoo Finance",
"env_requirements": ["Python library: yfinance"],
"example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.major_holders)",
"meta_data": {
"description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to major holders information for a specific stock."
},
"questions": ["Retrieve the major holders information for Microsoft (MSFT)"]
}
]