Files
OpenBB/website/content/sdk/reference/stocks/ta/summary.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

title, description, keywords
title description keywords
summary The page contains two essential open-source tools, FinBrain's model for technical summary reports and a viewer for those reports. Learn how to populate a technical summary and how to view a summary chart.
Open-source tools
FinBrain model
Technical summary reports
Summary chart
OpenBB's API
Stocks
Ticker symbol
Technical Analysis

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

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Get technical summary report provided by FinBrain's API

Source Code: [link]

openbb.stocks.ta.summary(symbol: str)

Parameters

Name Type Description Default Optional
symbol str Ticker symbol to get the technical summary None False

Returns

Type Description
str technical summary report

Print technical summary report provided by FinBrain's API

Source Code: [link]

openbb.stocks.ta.summary_chart(symbol: str)

Parameters

Name Type Description Default Optional
symbol str Ticker symbol to get the technical summary None False

Returns

This function does not return anything