jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/stocks/sia/stocks_data.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

1.8 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
stocks_data This page offers in-depth documentation on how to use the 'stocks_data' function in the OpenBBTerminal's stock analysis tool, detailing parameters, returns and source code.
stock data
finance key
financial statement
stock analysis
programming
code documentation

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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