jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-05 17:01:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/economy/search_index.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.2 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
search_index This Docusaurus page provides information about how to use the 'search_index' function from the OpenBB finance package. It explains the parameters and returns of this function, which helps to search indices by keyword in the finance database. Source code is also provided.
search_index
OpenBB finance package
finance database
keyword search
parameters
returns

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

Search indices by keyword. [Source: FinanceDatabase]

Source Code: [link]

openbb.economy.search_index(keyword: list, limit: int = 10)

Parameters

Name Type Description Default Optional
keyword list The keyword you wish to search for. This can include spaces. None False
limit int The amount of views you want to show, by default this is set to 10. 10 True

Returns

Type Description
pd.Dataframe Dataframe with the available options.