jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-08 02:11:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/stocks/sia/stocks_data.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.4 KiB
Vendored
Raw Blame History

title, description
title description
stocks_data OpenBB SDK Function

stocks_data

Get stocks data based on a list of stocks and the finance key. The function searches for the

Source Code: [link]

openbb.stocks.sia.stocks_data(symbols: List[str] = None, finance_key: str = "ncf", stocks_data: dict = None, period: str = "annual", symbol: str = "USD")

Parameters

Name Type Description Default Optional
symbols list A list of tickers that will be used to collect data for. None True
finance_key str The finance key used to search within the SA_KEYS for the correct name of item
on the financial statement		 ncf True
stocks_data dict A dictionary that is empty on initialisation but filled once data is collected
for the first time.		 None True
period str Whether you want annually, quarterly or trailing financial statements. annual True
symbol str Choose in what currency you wish to convert each company's financial statement.
Default is USD (US Dollars).		 USD True

Returns

Type Description
dict Dictionary of filtered stocks data separated by financial statement