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/ba/regions.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

2.2 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
regions This page provides detailed instructions on how to utilize the regions functions from OpenBB finance terminal to retrieve and visualize stock interests by region using Google API. The documentation covers the parameters, return types, and source code for the functionalities.
Docusaurus
SEO metadata
regions
google api
stock's interest
openbb.stocks.ba.regions
openbb.stocks.ba.regions_chart
ticker symbol
dataframe

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

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

Get interest by region from google api [Source: google].

Source Code: [link]

openbb.stocks.ba.regions(symbol: str)

Parameters

Name Type Description Default Optional
symbol str Ticker symbol to look at None False

Returns

Type Description
pd.DataFrame Dataframe of interest by region

Plots bars of regions based on stock's interest. [Source: Google].

Source Code: [link]

openbb.stocks.ba.regions_chart(symbol: str, limit: int = 5, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
symbol str Ticker symbol None False
limit int Number of regions to show 5 True
export str Format to export data True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything