mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
* [Critical] Sync `main` with `develop` (#6202) * feature/intrinio-equity-search: Adds Intrinio to `obb.equity.search()` (#5863) * intrinio equity search * integration tests * test --------- Co-authored-by: James Maslek <jmaslek11@gmail.com> * feature/yfinance-multi-ticker: Adds support to openbb-yfinance for multi-ticker download. (#5845) * yfinance multi-ticker support * multi-ticker support for market indices * crypto multi-ticker support * recapture tests * yfinance cache and tests * currency historical multi-ticker support * style things * black * missed a values --------- Co-authored-by: James Maslek <jmaslek11@gmail.com> * Feature/us-treasury-prices: Adds Treasury Prices to Fixed Income (#5776) * add treasury prices endpoint to fixed income router * adds tests * black * ruff * import statements * standard model imports * black * some cleanup * black * async router * make async * str outpuot * bytes object not string * docstring typo * multi-line f-string * encoding * duplicated conditional * black --------- Co-authored-by: James Maslek <jmaslek11@gmail.com> * feature/sec-etf-holdings: Adds ETF holdings from SEC provider (#5757) * add ETF holdings from SEC provider * black * helper function params * edge cases * ruff * add validator in company filings * remove xml field * update import * cleanup parsing * missing datetime import in company_filings * black * unused import * add missing py.typed files * feature/nasdaq-equity-search: Adds Nasdaq provider for `obb.equity.search()` (#5790) * add nasdaq to equity search * black * unused import * make async --------- Co-authored-by: James Maslek <jmaslek11@gmail.com> * Excel docs (#5870) * first test * remove old reference * bring this file back * generate sidebar and write empty mds * generate index.mdx * get description from cmd_lib * fix reference card error * rename file * generate markdown * regen * add last+hist * update pages with seo metadata * format types * small fix * css sux * add usage placeholder * set hidden by default * nah * add cmds and menus to reference * lint * fix/Users/diogosousa/opt/anaconda3/envs/platform/bin/python /Users/diogosousa/OpenBB/OpenBBTerminal/website/generate_excel_markdown.py * format mds * remove space * fix commands heading * redo folder structure * add back cmd description * move card to var * different main folder * clean * move vars * refer to editor * rename var * done * recreate folder structure * add section: syntax + minor adjustments * remove return type * remove return type * rename api to library * minor fix * remove api folder * remove api folder * formatting * improve basics * basics * fetch functions.json from website * complete basic * change syntax to use semi-colon * basics * basics * remove space in sig * remove sections * add metadata * Update formula builder * add tabs * Update index.md * complete basics and formula_builder * Update index.md * add windows screenshots * restructure folders * regenerate with latest add-in version * move Excel sidebar * rename function and add comment * now it's working * logic * rename folder * Update formula_builder.md * fix * hide excel for now * some explicit typing --------- Co-authored-by: tehcoderer <me@tehcoderer.com> * Make Pro Fetchers async by replacing `ThreadPoolExecutor` with `asyncio.gather` (#5822) * init * Update helpers.py * filter URL on raise * polygon, fmp done, update cassettes * updates * cleanup * revert tests for now * Update discovery_filings.py * Update helpers.py * add `async` overload to `Fetcher.extract_data` * update merged fred models * tests, improve fred series * Update insider_trading.py * insider * tests * intrinio * Update equity_historical.py * implement abstract async extract on Fetcher, with simple switch * cleanup * Update helpers.py * Update helpers.py * fix fmp historical deprecated urls * Revert "fix fmp historical deprecated urls" This reverts commit1a760a2473. * fix fmp `index.market` 1day url missing query params * Update test_fmp_market_indices_fetcher.yaml * field fixes * `extract_data_async` -> `aextract_data`, `async_request` -> `amake_request` * `async_requests` -> `amake_requests` * Update company_news.py * add sort to index `integration` params * add `client.py` tests * Update equity_search.py * Add lost v in platform api version string * Resolve linter errors here and there --------- Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> * Allow this to be run in parallel (#5872) * Limit mypy v3 linting to only the diff of the PR (#5878) * Use custom parametrize from news menu tests (#5873) * Use custom parametrize from news menu tests * Update Ultima unit test cassettes * Command Schema (#5874) * POC * Filter by provider * pass base_app as parameter * add typing + TODO * fix some typing * Fix unit tests --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> * Parameterize `obbject.to_df` with `index` and `sort_by` (#5877) * Parameterize obbject.to_df with index and sort_by * unit tests for obbject * keep using the date as default to use on basemode_to_df() --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Changes to the `obb.fixedincome.corporate.hqm()` output (#5876) * changes to the hqm output * typo --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Refactor method in RegistryMap (#5879) * refactor extract_info * add comment --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * remove Literal from providers in OBBject (#5882) Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Fix version (#5883) * Fix version * Fix linter on terminal * Refactor package builder (#5880) * breakdown builder + remove black * rebuild * rebuild * rebuild * rename method * format built code without black * we still lint if it's available * fix existing tests * add linter tests * add black to dev deps * auto_build as instance method * reorder methods * typing --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> * small refactor for simplification (#5886) Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Fix bug. Add router test. (#5888) * Fix bug. Add router test. * Simplify * separate pylint between platform + terminal (#5892) * separate pylint b/w platform + terminal * Explicitly set pylint check scope to files in the diff --------- Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> * sync descriptions (#5893) * Add REST API docs page with advanced settings configuration (#5890) * Don't mention docker in a list of python envs * Create a REST API page * Update docs to get api keys from the hub * Update installation instructions * Mention requirement of poetry and toml in source installation section * move rest page up to the top. and add url to google colab example notebook --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * fix a v3 syntax example (#5891) * Adds federal reserve data points (#5885) * Allow optional input for 2-month treasury rates and add FederalReserve rates model The commit includes two main changes. One being the modification to the standard treasury rate models, where the 2-month input field is now optional, and a default value is set to none. The other main change is the addition of a new module for the FederalReserve treasury rates model, which includes query parameters, a data model, and a data fetcher. * Add Money Measures models and commands This commit introduces new Money Measures models to handle money-related data, defines Money Measures commands in the economy router, and implements the Federal Reserve Money Measures model. The core model includes fields like start_date, end_date, and various components of the money supply. The new command added to the economy router allows the querying of these data. * Add Federal Reserve Money Measures test file This commit adds a test case file for the Federal Reserve Money Measures fetcher in the Federal Reserve module. The test case includes simulating a GET request and the corresponding expected response from the server. * Cleanup * Sneaky unformatted integration tests * its a dawg life for me ...... ruff * add the fed funds rate * didnt mean to commmit this * black * this is why we should pre commit kids * change install name * add providers to int tests * review comments + commit static * replace nan with None * fix float on None * get rid of nans for nulls for json handling * change `_` to `-` in readme pip install. * Update __init__.py docstring --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> * Check if outdated (#5898) * Add econometrics API tests (#5899) * Docs/excel update (#5889) * update xl docs * update syntax line * update again * Fix pylint scope (#5895) * Allow optional input for 2-month treasury rates and add FederalReserve rates model The commit includes two main changes. One being the modification to the standard treasury rate models, where the 2-month input field is now optional, and a default value is set to none. The other main change is the addition of a new module for the FederalReserve treasury rates model, which includes query parameters, a data model, and a data fetcher. * Add Money Measures models and commands This commit introduces new Money Measures models to handle money-related data, defines Money Measures commands in the economy router, and implements the Federal Reserve Money Measures model. The core model includes fields like start_date, end_date, and various components of the money supply. The new command added to the economy router allows the querying of these data. * Add Federal Reserve Money Measures test file This commit adds a test case file for the Federal Reserve Money Measures fetcher in the Federal Reserve module. The test case includes simulating a GET request and the corresponding expected response from the server. * Cleanup * Sneaky unformatted integration tests * its a dawg life for me ...... ruff * add the fed funds rate * didnt mean to commmit this * black * this is why we should pre commit kids * change install name * add providers to int tests * review comments + commit static * replace nan with None * fix float on None * get rid of nans for nulls for json handling * change `_` to `-` in readme pip install. * Update __init__.py docstring * Debug pylint * Adjust the fetch depth --------- Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * fix `from openbb import obb` asyncio lock in python REPL (#5896) Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * feature/financials - PR for working on structure of financial statements. (#5794) * balance sheet draft * balance_sheet draft * cash_flow draft * income_statement draft * intrinio financials * description * period field * ruff * income statement * field * label - gross profit ratio * cash flow statement * investing order * add option for caching to cashflow * add caching to balance and income * typos and update order for financial institutions * replace 0 values with None * add financial ratios from intrinio * black * missing test params * balance cassette * query param description * symbol list warning * black * handle BRK-A and symbols with a dash for Intrinio * fix typo error * add free cash flow to bottom of cash flow statement * amortization_expense * dev_install.py * undo dev_install.. wrong branch * cash flow order things * standardized cash flow * fields * integration tests * cash flow model validator * more polygon cash * black * black * Delete openbb_sdk/providers/polygon/openbb_polygon/utils/definitions.py wrong file * balance sheet * some cleanup * ruff * income statement * black * test params * financial ratios async update * recapture fmp and polygon tests * yFinance financials * yfinance tests * delete financial_statements standard model * intrinio balance sheet order * fiscal year standard param * remove file accidentally committed * add reported_financials end point * fiscal_year param for reported_financials * fix url * fmp test cassette * add safe-guard with warning for fiscal year before 2008 * periods can only be annual and quarter * url in docstring correction * add fiscal_year param to intrinio standardized financials and ratios * fix fmp ratios * black * rename fields as per Minh * rogue field * black * Fix typo in a docstring * Resolve linting errors * type ignore * disable=unused-argument * changing the arg name cc @minhhoang1023 --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * docs/legacy-install: Add warning at top of page - Instructions on this page are for installing the Terminal (#5904) * add warning at top of page - instructions are for installing the Terminal app * pip install openbb-nightly * hotfix/financials-field-maps: Updates A Couple FMP/Polygon Income Statement Fields (#5907) * update income statement fields * another polygon field * ratio -> margin * black * explicit fmp fields * add reported_currency for standardized intrinio * # pylint: disable=unused-argument * another unused-argument * black.. * patch tests * polygon income: eps -> basic earnings per share * re-capture terminal portfolio menu test --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Fix test (#5916) * Fix test * Skip ultima integration tests --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * hotfix/fmp-price-performance-zeros: Replace returned zero with None and normalize percent values. (#5918) * replace zeros with none and normalize percents * pylint unused argument * Update index.md (#5906) * Release/4.1.0 (#5901) * Hotfix/terminal tests (#5919) * skip supressed arguments * silent way of customly load on quote * specify source for call_load * docs/platform-faq: Start Platform FAQ page with bullet points on Platform vs SDK (#5914) * platform vs sdk faq page * add data and data providers faq section and some style cards * typo * makes changes as per reviews * openbb-nightly as a way to install everything * jupyter-lab instead of jupyter --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> * hotfix/backend - Initialize OpenBBFigure (#5912) * create backend * openbb_figure * black * pylint * pylint again --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> * hotfix/yf-futures-historical: yfinance historical futures multi-ticker support and symbol parsing (#5923) * multi-ticker support for yfinance futures historical * raise-missing-from * integration test params * equity_historical adjusted kwargs * pylint unused argument * Docs/excel examples (#5920) * regen excel md * add syntax + basic example * fix example * create json with docs map * update docs to latest functions.json + remove tiingo * remove space from examples * minor fix * remove spaces * remove spaces * bug fix: remove folder before generating * fix typo * add link to appsource * fix * Update templates.md * regenerate content * change docs colors * fix light mode * add back tiingo * update functions.json * templates go later * remove Library from reference * Make the excel markdown being generated at runtime * fix reference cards having commands under menu * remove excel/reference folder since this is built at runtime by gh-pages action * black formatting * improve title * add excel to the main page * add excel image bg * make excel sidebar show up next to pro * improve main page * small fix for platform page title * update basics page * add tip to autocomplete --------- Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * Re-record tests and fix symbol bug (#5924) * Re-record tests and fix symbol bug * nordvpn us ftw * @IgorWounds says "SPY >> IOO" --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Docs/bug fix (#5926) * fix pro link * fix wrong example * Introduces a limit argument for the `equity.fundamental.trailing_dividend_yield` endpoint (#5925) * introduces a limit argument for the equity.fundamental.trailing_dividend_yield endpoint * add default args to test * Add json_schema_extra to openapi.json (#5930) Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * feature/standardize-quote: Proposal to Standardize EquityQuote (#5922) * standardize EquityQuote * intrinio reference * rogue comma * pylint --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * hotfix/fmp-rev-segments: Adds Fiscal Period to busines/geographic segments revenue. (#5921) * add fiscal_period to revenue by geography and business line * data description and unused imports * update test cassette * Allow multiple symbols `equity.profile` (#5929) * allow multiple symbols * pylint * pylint ignore position * change callback to helper func --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Add filtering to AV historical price (#5928) * add filtering to av historical price * lints --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Fix vwap FMP error (#5936) * Fix vwap FMP error * Linting * Painlint * Add date filter + symbols to comp (#5931) * add date filter + symbols to comp * make sure year is in d * tests fix * Improving Platform's import time (#5894) * missing decorator * missing optional statements * us-gov to optional and right position * removing redundant call * lazy load mappings * docstrings * introducing the extension loader class * misleading docstring * using the extension loader on the router * using the extension loader on the credentials * docstrings * lazy load of entry points * checkout dev_install * using the extension loader to get the entry points instead of recalling the function * improved auth service and charting service * using the extension loader on the registry * typos * adding properties to extension loader for easy access * using the extension loader on the package builder * avoiding circular imports by using forward references * fix charting service tests * test for the extension loader * Update openbb_platform/core/openbb_core/app/model/credentials.py Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * Update openbb_platform/core/openbb_core/app/router.py Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * Update openbb_platform/core/openbb_core/provider/registry.py Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * adjustments --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * Disable auto_build on test run (#5937) * Disable auto_build on test run * Move to conftest * Update excel docs (#5940) * update basics * update reference generator * Categorize release notes based on labels for OpenBB Platform (#5943) * Categorize release notes based on labels for OpenBB Platform * Add environment variable for GitHub token in labels-PR.yml * Update labeler.yml to use "enhancement" label for feature branches --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Custom deprecation message in API endpoints and Python commands (#5942) * add custom deprecation message feature in routers * add custom deprecation message feature in package builder * using an actual DeprecationWarning instead * fix tests --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Hotfix/remove unused workflow (#5945) * Disable auto_build on test run * Remove unused workflow * Revert * Hotfix/fix typo (#5948) * Disable auto_build on test run * Fix typo * Revert * docs/data-models-url: Fix URLs on Development Page (#5944) * fix url to the standard models * github links * `equity.fundamental.dividends`: allow filter by date (#5932) * allow filter by date * ruff * pylint * fix tests --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Create Excel templates page (#5947) * create templates page * Update index.mdx * fix description * update card * remove clsx * Update index.mdx * Update index.mdx * Update index.mdx * Update index.mdx * min height * min height * improve excel docs and point towards hub --------- Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * hotfix/intrinio-dividends-limit: Fix Limit Param Alias (#5951) * fix limit param * pylint unused argument, recapture test cassette --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Docs/remove core refs (#5957) * remove references to core: PathHandler + ProviderInterface * remove unused function * add comment * regenerate * fix a few examples * add comment * rename file * Excel tutorials on the docs (#5956) * update workflows name to tutorial * update title * get barebones to bring in Excel videos * tutorial excel videos in * hotfix/float-values: Convert Intrinio balance sheet values to float type (#5961) * convert intrinio balance sheet values to float type * unused import * typo in alias dict * Update to OpenBB Add-in for Excel (#5965) * Log custom headers (#5966) * add custom headers * fix: send on startup and defaults * pylint * unittests * move government-us to community in dev_install (#5963) * fix: adds logic to check whther user is logged in on hub (#5941) Co-authored-by: Luqman <luqazino@gmail.com> * hotfix/fix-company-filings: Fixes too many mandatory fields. (#5909) * Fixes too many mandatory fields. * black * black again --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> * `equity.estimates.price_target` - Integrate with Benzinga (#5946) * deprecation message * fix lints * adding equity.estimates.ratings and fmp as its provider * unit tests for fmp * removing unused file * typos * add benzinga to AnalystRatings * revert changes to estimates router * moving it to price target instead * reverting changes * fmp support for multiple ticker * benzinga price target * ruffy * unused argument * fix type hints * tests for the new fetcher * new integration tests * fixing tests * missing std arg --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [DEPRECATION] `index.market` renamed to `index.price.historical` (#5962) * deprecate index.market and add index.price.historical * add index.historical standard model * add index.historical provider models * index extension tests * provider tests * linting * bug fix (#5969) * Uppercase excel reference (#5958) * uppercase reference * fix name header * add tab title * remove reference excel folder * add to gitignore excel reference files --------- Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * move templates (#5970) * Release 4.1.1. (#5964) * update dev_install * fix effr test * Update dev_install.py * fix fundamental balance test * fix equity price historical test * fix price target model * black * rebuild static files * update publish.md * fixed dev_install * update publishing doc * updated `openbb-core` to 1.1.1 * updated extensions * updated providers * updated `openbb` package * updated static extension map * updated publishing doc * fixed toml for `openbb-finra` * @jmaslek yfinance IS DEFAULT * updated static --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Fix link to discord channel (#5910) Co-authored-by: James Maslek <jmaslek11@gmail.com> * Fixing Posthog handler for thread safety (#5968) * fixing posthog handler for thread safety * removing loggging init from the global scope - per sensei juan --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Update labeler.yml and labels-PR.yml (#5974) * hotfix/ allow multiple `identify` calls (#5976) * allow multiple `identify` calls * Update posthog_handler.py * regex out any invisible control character from sales_conditions field (#5977) * docs/http-requests: Contributor Guide For Building HTTP Requests (#5973) * contributor guide for http requests * add a docstring * add section on get_querystring * extra space * add note for people installing PyPI in a zsh terminal shell --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * feature/add-yfinance-functions: Add equity.profile for yFinance (#5978) * equity profile for yFinance * pylint * equity quote * unused imports * remove yfinance from extras in toml (#5982) * Release OpenBB Platform v`4.1.3` (#5983) * fixing pyproject.toml * adding pandas-ta to technical package for publishing * bumping technical * test for pyproject toml * feature/cboe-async: Refactor Cboe for Async (#5900) * refactor cboe for async * codespell * unused imports * pylint * more pylint * platform metadata * classmethod decorator * test params * intrinio quote * test param names * date in test needs to be a datetime.date not string * make fmp unix timestamp tz-aware and normalize percent change * different way of parsing datetime string * recapture cboe equity historical test * unused import * index snapshot update * black * extension map * pylint * cboe pyproject.toml * proposal to standardize equity_quote * one more file * removing changes on static assets * index_historical * index_historical again * last_time -> last_timestamp * obsolete router path * fix tests * test param * restore market index deprecation that I forgot about * fixing tests --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Fix typo in website/README.md (#5980) * Fix typo in website/README.md * Update linting.yml * Update linting.yml * Update linting.yml * Change ref conditions * Update linting.yml --------- Co-authored-by: Luqman <luqman.bello@openbb.finance> Co-authored-by: Luqman <luqazino@gmail.com> * Hotfix/th etfs (#5959) * added etf trading hours * black formatter --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: Luqman <luqazino@gmail.com> * feature/finviz-provider: Adds Community Finviz Provider Extension (#5952) * add finviz provider * recapture tests * recapture tests again? * invalid test param * static packages * units_measurement -> unit_measurement * static packages as core only * openbb_core version bump in pyproject.toml * try adding user-agent to test response * fix tests * linting * provider model cosmetic changes * fix install script and typo in openbb toml * static * fix: re-record unittests * empty data error * definitions as a file --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> * Add support for multiple symbols on `obb.equity.price.historical` (#5984) * av - support for multiple symbols * tiingo - support for multiple symbols * include symbol only if necessary * update extension descriptions page (#5985) * remove useless file (#5991) * added symbol to headers (#5981) Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Fixing Docs Typos (#5955) * fixed typo * fixed stocka typo --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * fix nasdaq test cassettes (#5989) * don't include `custom_headers` in openapi schema (#5994) * hotfix/intrinio-index: Drop None Rows From intrinio Historical Index (#5987) * drop None rows from intrinio historical indexes * add empty data error * static assets * hotfix/insider-trading: Fix #5988 (#5990) * fix validation errors * empty strings * validator --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: teh_coderer <me@tehcoderer.com> * CI listing quick fix (#6002) * BIGGGG LINTING * fixing lints * fixing lints * black * very ruff * no export * fix hedge_view again * lints * platform lints * lints * black * black it @hjoaquim * fix some more linting --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Release `openbb-finviz` `1.0.0` to the public (#6000) * set version to `1.0.0` * Set correct dep version in main package * Add `finviz` to table * Auto Labelling for OpenBB Excel Docs Changes (#5998) * Update pull request labels * Update labeler.yml with new label for Excel files --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] - Support for custom examples in router commands (#5993) * Disable auto_build on test run * Add support for custom router examples * Revert odd file change * Fix API pollution * Refactor examples with @montezdesousa * Check if model is inside the PI * Fix * feat: add & fix examples (#6001) * feat: add & fix examples * fix: ruff + comment * feat: read parameter pool from file * feat: typing + unit test * Disable auto_build on test run * Add field order to OBBject * Revert * lint and revert * fix test --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> * hotfix/intrinio-options-date: Fix comparing values between str and datetime (#5997) * fix compare between str and datetime * unused argument * get_weekday * lint --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] - Field order added to the OBBject extra as preference (#5999) * Disable auto_build on test run * Add field order to OBBject * Improvements * Remove noxfile * Disable auto_build on test run * Add field order to OBBject * Revert * lint * Add docs * Not sure how this happened * lint * Update `openbb-devtools` (#6008) * update deps * unpinned package versions from gh linting action * codespell * updated black dependency * linting * linting * linting * pin codespell version * black * black again * install devtools in linting action * format w new black (#6009) * format w new black * format w new black * black again * black the terminal * ignoring unused arguments --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * remove reviewpad (#6010) * Remove Ultima provider (#6012) * Add OECD unemployment (+more) + data cache idea (#5917) * Add OECD unemployment + data cache idea * Docstring edits * Tests * Add composite leading indicator * i truested ruff --fix too much * Add short + long term interest rates * pylint * pylint2 * was not committing. my b * add csv cache + make it default. remove pyarrow from poetry * Clean up * Didnt run on this file. My bad * Why was this ignored /shrug * pylint --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Feature/improved pr template (#6018) * format w new black * Revert "format w new black" This reverts commit74b9619cc6. * better pr templates * developer template * [Feature] - Custom deprecation (#6005) * custom deprecation * custom deprecation * using the new deprecation * custom deprecation on the package builder * remove comment * ruff * black * static assets * tests * using parametrization instead * test for deprecated endpoints (#6014) * Deprecation warning on the reference docs (#6015) * typo/fix * bring back methods needed for markdown generation * add deprecation warning to docs * contributor docs for deprecating endpoints - tks @deeleeramone * small changes on publishing procedure per @the-praxs * moving the deprecation summary class to deprecation file instead * explanation on class variables * Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Update openbb_platform/openbb/package/index.py Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * deprecating on 4.3 instead @the-praxs --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * [BugFix] Fix package builder (#6022) * fix: remove specific imports * adjustments for correct deprecation * static assets --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * [Feature] Add support for multiple tags in `historical_attributes` and `latest_attributes` (#6013) * historical attributes standard model - * add support multiple tags * add `tag` field in data * add support for multiple tags in historical attributes * set correct return type in `callback` function * latest attributes standard model - * add support for multiple tags * add `tag` field in data * add support for multiple tags in latest attributes * add test params for the attributes endpoints * add support for multiple `symbol` and add `symbol` field in the data * modified code to fetch data from multiple symbols and throw warning as per @deeleeramone * add params for testing multiple symbols * linting * fix test params * fixed condition to check if its a `Dict` type * updated intrinio fetcher tests for the statements * updated static * [feature]: feature/overview-to-profile: Deprecate `equity.fundamental.overview()` and move to `equity.profile()` (#6011) * fmp overview to equity profile * deprecation warning * urls * wrangle fields * black * pylint unused argument * insert additional securityID fields to standard model * custom deprecation using OpenBBDeprecationWarning * typo - need to have the deprecated=True flag * static assets * fix non related test * minor adjustment - removing the need for the try/except block - using the get and pop removes the need for key existance checking. cc @deeleeramone --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> * [BugFix] - Remove duplicate code (#6025) Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * remove `SectorNews` from router and standard models (#6026) * feature/more-yfinance: Adds some more to openbb-yfinance (#5979) * equity profile for yFinance * pylint * equity quote * unused imports * price target consensus * add currency field * add share_statistics * don't append empty result to results * key executives * missing definition in key_executives * pylint * key metrics * add currency to key metrics * add etf_info * rename trailing_annual_dividend -> dividend_rate_ttm * add institutions count to share_statistics * add historical dividends * add logic for start-end dates to historical_dividends * recapture the test..? * funny test * filter on tests? * record test with clean cache..? * year_price_change -> price_return_1y in key_metrics * black * make descriptions clear for beta and dividend_yield fields * add description field to standard model * updated static * clear description of shares_implied_outstanding field * updated static for equity * clean descriptions --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * feature/commodities-lbma-fixing: Adds Commodity Extension and LBMA Gold/Silver daily fixing levels (#5760) * add commodity extension and add lbma fixing endpoint * dev_install.py * readme url * renovate the standard model * makes a query_params model for nasdaq data link * literal not optional * unused imports * missing test params * test cassette * DataLink query param description * test file import * actually fix import * from openbb_core.provider..... * ruff * another import statement * black * async router * move query_params * update version * version numbers * extension_map * satisfy pylint? * pylint * Update pyproject.toml * black * poetry lock * Update extension_map.json * Update __extensions__.py * Update module_map.json * clean descriptions --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Improve UX for `obb.news` (#5986) * adding date,start_date and end_date to std params * add date to special params which should've another type * change types to dateType * change helper to accomadate changes in types * date filtering * using the date filtering for all providers * date params on the std model instead * adding the right type * filtering dates on world news * integration tests * fix descriptions * static assets * black * Revert "black" This reverts commit7288b59f87. * lint * addressing @montezdesousa suggestion: removing qua 31 jan 2024 15:01:20 WET from standard models and using it only on benzing * tests accordingly * static assets * black --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: teh_coderer <me@tehcoderer.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] - Improve Standardization - `IndexHistorical` (#6030) * format w new black * Revert "format w new black" This reverts commit74b9619cc6. * small adjustment on the test * index historical * adjust tests accordingly * keep the test skipped * match tests w python * fix tests * keep the skip * fix test * [Feature] - Refactor Response Model (#6024) * Start refactor with @montezdesousa * feat: add response model inside openapi_extra * feat: find+replace return types * fix: ruff * Feature/api response by provider (#6029) * init * Update router.py * Update registry_map.py * check dicts * lint * exclude provider on data model for package build * `results_type_repr` logic for `Annotated`, ignore provider field in `_extract_data` --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> Co-authored-by: teh_coderer <me@tehcoderer.com> * [BugFix] - Improve Standardization - `CotSearch` (#6031) * format w new black * Revert "format w new black" This reverts commit74b9619cc6. * small adjustment on the test * index historical * adjust tests accordingly * keep the test skipped * match tests w python * use cache as std field * fix tests * fix tests * keep the skip * fix test * adding missing param * fix tests accordingly * Docs/byod (#5996) * add byod to reference * fix: rename add-in name * feat: add data conectors page * fix: additional notes * tiny tweaks * update functions.json and openapi.json * fix: fix bug in hedge controller * fix: another bug hedgecontroller * black --------- Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * Feature/ex-dividend: Renames "date" columns as "ex_dividend_date" for Dividend Calendar and Historical Dividends (#6006) * date -> ex_dividend_date * nasdaq historical dividends * black * pylint * intrinio alias_dict * dividend_currency -> currency * yfinance field name --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] - Adds a timezone to the Unix timestamp conversion to correct localization errors. (#6023) * fix: remove specific imports * make polygon historical tz-aware * undo including that commit * that PR wasn't supposed to be there. * pylint unused argument * fix polygon crypto historical intervals * pylint * new cassette * fix the rest of the polygon historical price query params * black * pylint.. * integration test param * appease daylight savings handling * paginate for crypto currency and index * black * raise EmptyDataError when no results instead of returning an empty list * ruff --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> * Hotfix/wrong pydantic validator (#6037) * format w new black * Revert "format w new black" This reverts commit74b9619cc6. * Use field_validator instead * fix openapi schema fields `to_snake` (#6036) * Fix data connectors link typo (#6038) * [BugFix] - Improve Standardization - `EquitySearch` (#6033) * format w new black * Revert "format w new black" This reverts commit74b9619cc6. * small adjustment on the test * index historical * adjust tests accordingly * keep the test skipped * match tests w python * use cache as std field * fix tests * fix tests * use_cache as std * adjust tests * keep the skip * re-record test * black * Docs / only display results for current platform (#6017) * Update index.js * Update index.js * yfinance * tzcache no longer exists * fixxy * ruff --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Andrew <andrew.kenreich@gmail.com> * Improve the docstrings (#6040) * Improve the docstrings (#6041) Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> * dont run base tests with v4 label (#6046) * Sync excel reference (#6039) * sync excel reference * fix: change delimiter to comma * feat: update data connectors * test skipping wf * Update unit-test.yml * Update unit-test.yml * test skipping wf * watch label changes * Update unit-test.yml * [Enhancement] - Improve `news` router docs and examples (#6047) * better docs * static assets * Feature/platform standardization notebook (#6049) * Add platform standardization overview notebook to examples * Add py.typed marker to openbb-fred * [Enhancement] - Improve `currency` router docs and examples (#6045) * currency search * reference rates * historical price * static assets --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * display warnings based on preference (#6051) * [Enhancement] - Improve `crypto` router docs and examples (#6048) * crypto search add validation for '-'-separated pairs * set default query value to None * improve /crypto description with custom examples * improve /crypto/price/historical description with custom examples * updated static for crypto menu * ignore line too long * linting --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Final Implementation of Changelog V2 (#6050) * Updated the release drafter to process the released changelog for OpenBB Platform * Update release drafter configuration * Add OpenBB Documentation Changes and Create Release * Update process_changelog.py path in draft-release.yml * Update release-drafter version and save changelog * Copy changelog with python * Update draft-release.yml to save Changelog * Update draft-release.yml * Encode and save Changelog to Base64 * Update Changelog saving method * Update Changelog format * Update CHANGELOG.md with release notes * Fix draft release workflow * Add cat command to print CHANGELOG.md * Add platform-drafter.yml and update release-drafter.yml and draft-release.yml * Commented out config-name in release-drafter step * Update branch name validation and process_changelog.py * Refactor process_changelog.py to improve readability and maintainability * Refactor process_changelog.py to handle file I/O errors and remove duplicate PR entries --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * improve discriminator logic, fix package return type docs (#6052) * improve discriminator logic, fix package return type docs * Update registry_map.py * build package * Update registry_map.py * defaults * Update registry_map.py --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Add LLM tools example notebook (#6053) * Add LLM tools example notebook * Update README, rename example notebook --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Remove the preference (#6055) Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * [Feature] - Standardise multiple symbols input (#6056) * feat: remove list of str * fix: update cpi * package builder + cpi * build * fix: update unittests * fix: check_item * fix: unittests * Improve the docstrings (#6057) * update economy router docstrings (#6058) Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] Fix OECD Long Term Interest Rate (#6060) * fix long term interest rate * pylint unused argument * [Bugfix] - Fix economic calendar country (#6059) * fix economic calendar country * lint --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [HotFix] Index Router Docstrings & `sp500_multiples()` Cleanup (#6063) * sp500 multiples cleanup * remove dict from standard model * static pacakge * pylint * [Feature] FMP Current Holdings (#6043) * add fmp current holdings to etf holdings * pylint unused argument --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] - Replace symbols in company/news (#6061) * feat: replace symbols in /news * fix: integration tests * fix: integration tests api * fix: typo * Update test_intrinio_fetchers.py * [Enhancement] Add function examples to router. (#6042) * options router * fixedincome router * futures router * missing comma * static assets * futures router --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Enhancement] Add function examples to Regulators Router (#6054) * options router * fixedincome router * futures router * missing comma * static assets * futures router * sec router * cftc router * black --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] Fix World News (#6064) * fix fmp * fix intrinio * fix biztoc * actually commit intrinio fix * fix tiingo * unused import * fix tests * black * ruff * benzinga empty strings * codespell * fix test? * more empty strings --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] - remove unused validators from standard models (#6067) * update standard models * lint * Update USD Liquidity Example Notebook for V4 (#5902) * Update USD Liquidity Example Notebook for V4 * delete some v3 text in the copperToGold * Update README.md * findSymbols preview image * Google Colab preview image * financialStatements preview * content tsx file * ### title * convert tsx to json * indent size * double quote keys.json * trailing commas * Update content.json * patch --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> * Fix QA Examples (#6072) * [Feature] - Ensure Bugfix branches can only do PRs to `develop` branches (#6073) * bugfix branch name checks and few fixes on the linting not to run on pushes to branches outside PRs * Update branch naming guidelines link --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Feature/charting obbject (#5938) * fix circular import issues on the obbject extension framework * settings available on the obbject * extension init * charting assets and code * introduce to_chart functionality * removes the to_chart method from obbject in detriment of the one from the obbject extension * Update openbb_platform/obbject_extensions/charting/charting/__init__.py Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * fix on the show method * adding the example to the to_chart docstring * copying the exsting README from charting extension - needs to be revamped * moving to openbb_charting instead * update the pyproject.toml file * pydocstyle * versions * better docstrings * making accessors public * removing unnecessary credentials variable cc @montezdesousa * removing access to extra/metadata and use designated private attrs instead * Fixes linting for the logging service (#5992) * lints * typing.Type instead * deprecating ChartingService to use the new extension instead - adding function discovery capabilities using it * tests for the obbject charting extension * removing charting service from command runner * filter functions not implemented in the module * remove charting service tests * removing charting service on the tests for int tests * charting integration tests * removing charting service file * removing old charting extension code * revamp builder * fix obbject tests * fix command_runner tests * removing openbb_figure_table * better website docs * reviewed readme * unsetting api key for posthog (pywry) windows * added debug_mode to the system settings * removing api key * update nightly script * fix tests * black * black * Revert "black" This reverts commit21d76ad689. * Revert "black" This reverts commit0904653fd7. * black for henrique * returning a list instead * better docstrings * removing unnecessary indicators docstring * typo * black * intentional access to protected member * changes to publish script * filtering deleted files * black * adding render argument * fixing the df_to_basemodel function: it should include the index in the columns either if flagged or if the index is named * adding the hability to add you own data to to_chart method * tests * black * disable protected access * accept kwargs to eg. save image * adjustment cc Igor * add if statement for protection * remove unused return typing * fix technical charting views * better error message cc @IgorWounds * better structure and fix test * Revert "better structure and fix test" This reverts commit612ea6117c. * Revert "better error message cc @IgorWounds" This reverts commit3d7ee53878. --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> * Fix CAPM example (#6075) * Start removing dead v3 commands for deprecation (#6070) * Yeet tokenterminal * Yeet crypto/onchain/hr and gwei * yeet luna * yeet coinglass * yeet dps/ctb * yeet reddit * yeet covid * actually not yeeting hide yfinance future warning * yeet options/hedge * not yeeting. i18n words * something happened on accident * still fixing * git reset/git checkout -f2516cfbc72website/content * still not sure whats going on * Edit workflow to not look at deleted files + change bootup message * Dont pin the workflow to my branch always lol * Remove askobb * [Feature] - Comma separated string and list inputs (#6062) * feat: balancesheet * feat: income statement * fix: cash flow statement * feat: financial ratios * feat: reported financials * feat: revenue business line * feat: revenue per geography * fix: warnings * Update balance_sheet.py * fix: remove warning imports * feat: balance sheet growth * feat: calendar ipo * feat: cashflow growth * feat: __validators__ * fix: typing * fix: validator msg * feat: trailing dividend_yield * feat: short volume * feat: share statistics * feat: price target + consensus * fix: update validator * feat: historical dividends * feat: key executives * fix: getattr directly * fix: type hint validator * fix: add default to getattr * typo * feat: otc * feat: options chains * fix: remove list validators * feat: add validator dict to fetchers * lint * update standard models * lint * feat: rename validator * fix: ownership * feat: query params description * fix: balance yfinance * key execs, income statement * remove change * fix: revenue geographic * fix: disable pylint * fix: unusual + balance * unit test validator * minor fix * explicit validators * update test * feat: multiple items allowed * rebuild * move check_single_value * crypto historical * order providers * fix typing * rename extra dict * marking multiple items allowed * Revert "marking multiple items allowed" This reverts commit7da04817e1. * error msg * fix: default provider runtime vs configuration * minor fix * docstring * revert default changes * get provider before executing cmd * fix container bug * clean filter * add comment * prevent bad defaults * update docstring * typing * fix * black * fix docstring generation * [Feature] - Mark multiple item fetchers (#6074) * feat: price target * bezinga company news * equity quote * marking multiple items allowed * more multiple items * black * rebuild * another batch * rebuild * another * cpi * move prop * rebuild --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * rename var * update msg * rename func * fix test * mypy * ruff --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * [Feature] Add Regional Data Endpoint from FRED (#6071) * add regional data endpoint from FRED * codespell * ruff * sort imports * add provder='fred' to integration test * thought I already sorted those imports.. * pylint.. * more test params.... * even more test params... * even more test params.... * static assets * reconfigure params * ruff * alias dict * recapture cassette * router doctstring --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] - Fix most integration tests (#6082) * Fix most integration tests * Lint * Fix price_target column for Benzinga (#6083) * Release/4.1.4 (#6081) * static assets * patch version increase * core update * bumping versions * bump finviz version * bump versions * bump versions on package.extension --------- Co-authored-by: James Maslek <jmaslek11@gmail.com> * Add dates to /quantitative as needed. (#6078) * Add dates to /quantitative as needed. Run new black * Fix tests * Pycharm is weird sometimes * uncommit * Add default window + error handling + mistake --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] Add end point: `etf.equity_exposure()` with FMP provider (#6079) * add etf.equity_exposure from FMP * empty data error * recapture cassette * pylint unused argument * Fix router example typo * fix test...? * static file to fix test? * fix test..? * __json_schema_extra__ * black --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> * [BugFix] Fix Equity Integration Tests (#6086) * fix equity integration tests * black * pylint * black * black * move df_apply to helpers * unused import * remove file that shouldn't have been added * oops. didn't remove a couple lines * [Enhancement] Add `analyst_search` to the Equity/Estimates Router (#6088) * standardize price_target * add analyst search * black * more black * ruff * linter, test parmas * last missing param * get rid of convert to upper * ruff * pylint * [BugFix] - Fix POST docstring examples (#6095) * Fix POST docstring examples. * Move router examples to command decorator * [BugFix] Fix `treasury_rates()` (#6092) * fix treasury_rates * drop rows with no data --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * clean up the remains from my yeeting (#6089) * clean up the remains from my yeeting * was not careful * Add ETF examples (#6102) Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * [BugFix] Fix integration tests (#6100) * fix int tests * fix obbject int tests * fix quant tests * fix index tests * use python 3.10 instead * remove cache * end_date < start_date * [Enhancement]: Add TMX data provider extension. (#5913) * dev install * add TMX provider extension * normalize ytm and coupopn_rate values * black * codespell * ruff * black again * pylint * ftw * undo what Pylint thinks is best * more black * renovate insider_trading standard model * fix tests * typo * tests * empty string * pylint unused argument * nans for some reason * black * static files * static files with openbb-tmx installed this time * yfinance TypeError..? * NA -> N/A * update for version bump * list exchange-calendars as tmx dependency * eod chains date -> eod_date * new line * not that file * more black * one more black * fix weird merge thing * ruff * index constituents params * insider trading * fixing things * black * black AGAIN * news integration params * the other missing param * ruff * historical dividends field update * add json_schema_extra * gainers * symbols -> symbol * company news symbol * unit test param * review items * wrangle a rogue field * index router example * company news thing - symbols -> symbol * field name map --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: James Maslek <jmaslek11@gmail.com> * [Feature] - OBB.GET (#6097) * create OBB.GET and data slicer page * remove quotes * format description * wording * functions.json * sidebar position * remove if stamente * [Docs] Remove Reference to `to_chart` in OBBject. (#6096) * remove reference to to_chart in OBBject. * put chart description back in OBBject properties * [Feature] - Create openbb assets folder (#6101) * create openbb assets folder * fix unittest * rebuild --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] Fixes to_df() where the date series contains multiple TZ-offsets. (#6099) * allow mixed utc offset in a tz-aware date column * enforce ascending from all providers for price.historical * fix tests * add comments and apply treatment to basemodel_from_df before JSON output * yfinance consistency * add unit test * add unit test * better test * ruff --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Update the quantitative extension to make more sense (#6087) * Split out a rolling submenu for the rolling functions * Make a performance and a stats submenu. * Test the statistics functions * lint * lint * dupe test * pylint * ruff * Try tests quick * black magic signature funcs * fix my custom tests * Fix the existing imports/urls * push the api update * okay I figured out whats going on * this should be all of them * Correct docstringing examples --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * [BugFix] Fix ECB Yield Curve (#6108) * fix ecb yield curve * standard model update * Update unit-test workflow to check for changes to openbb_platform (#6109) * [Bug fix] - Fix package mypy (#6110) * fix: package mypy * types * black * [Feature] - Equity router descriptions & examples (#6103) * feat: equity/calendar * feat: compare router * fix descriptions * darkpool + discovery * fix paragraph issues * fix descriptions * fundamental part 1 * fundamental part2 * transcipts * ownership * fix * price * shorts * Update darkpool_router.py * minor fix * shorts examples * examples * ruff * black --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] - Add `exception_handler` decorator to static (#611… * update byod docs * Update deploy to gh pages condition * Update CONTRIBUTING.md * regenerate docs * Allow `hotfix` branch to be merged with `develop` branch * Update branch name check to allow docs branch merge to main * Release/3.2.5 (#6214) * Fix bug. Add router test. (#5888) * Fix bug. Add router test. * Simplify * separate pylint between platform + terminal (#5892) * separate pylint b/w platform + terminal * Explicitly set pylint check scope to files in the diff --------- Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> * sync descriptions (#5893) * Add REST API docs page with advanced settings configuration (#5890) * Don't mention docker in a list of python envs * Create a REST API page * Update docs to get api keys from the hub * Update installation instructions * Mention requirement of poetry and toml in source installation section * move rest page up to the top. and add url to google colab example notebook --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * fix a v3 syntax example (#5891) * Adds federal reserve data points (#5885) * Allow optional input for 2-month treasury rates and add FederalReserve rates model The commit includes two main changes. One being the modification to the standard treasury rate models, where the 2-month input field is now optional, and a default value is set to none. The other main change is the addition of a new module for the FederalReserve treasury rates model, which includes query parameters, a data model, and a data fetcher. * Add Money Measures models and commands This commit introduces new Money Measures models to handle money-related data, defines Money Measures commands in the economy router, and implements the Federal Reserve Money Measures model. The core model includes fields like start_date, end_date, and various components of the money supply. The new command added to the economy router allows the querying of these data. * Add Federal Reserve Money Measures test file This commit adds a test case file for the Federal Reserve Money Measures fetcher in the Federal Reserve module. The test case includes simulating a GET request and the corresponding expected response from the server. * Cleanup * Sneaky unformatted integration tests * its a dawg life for me ...... ruff * add the fed funds rate * didnt mean to commmit this * black * this is why we should pre commit kids * change install name * add providers to int tests * review comments + commit static * replace nan with None * fix float on None * get rid of nans for nulls for json handling * change `_` to `-` in readme pip install. * Update __init__.py docstring --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> * Check if outdated (#5898) * Add econometrics API tests (#5899) * Docs/excel update (#5889) * update xl docs * update syntax line * update again * Fix pylint scope (#5895) * Allow optional input for 2-month treasury rates and add FederalReserve rates model The commit includes two main changes. One being the modification to the standard treasury rate models, where the 2-month input field is now optional, and a default value is set to none. The other main change is the addition of a new module for the FederalReserve treasury rates model, which includes query parameters, a data model, and a data fetcher. * Add Money Measures models and commands This commit introduces new Money Measures models to handle money-related data, defines Money Measures commands in the economy router, and implements the Federal Reserve Money Measures model. The core model includes fields like start_date, end_date, and various components of the money supply. The new command added to the economy router allows the querying of these data. * Add Federal Reserve Money Measures test file This commit adds a test case file for the Federal Reserve Money Measures fetcher in the Federal Reserve module. The test case includes simulating a GET request and the corresponding expected response from the server. * Cleanup * Sneaky unformatted integration tests * its a dawg life for me ...... ruff * add the fed funds rate * didnt mean to commmit this * black * this is why we should pre commit kids * change install name * add providers to int tests * review comments + commit static * replace nan with None * fix float on None * get rid of nans for nulls for json handling * change `_` to `-` in readme pip install. * Update __init__.py docstring * Debug pylint * Adjust the fetch depth --------- Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * fix `from openbb import obb` asyncio lock in python REPL (#5896) Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * feature/financials - PR for working on structure of financial statements. (#5794) * balance sheet draft * balance_sheet draft * cash_flow draft * income_statement draft * intrinio financials * description * period field * ruff * income statement * field * label - gross profit ratio * cash flow statement * investing order * add option for caching to cashflow * add caching to balance and income * typos and update order for financial institutions * replace 0 values with None * add financial ratios from intrinio * black * missing test params * balance cassette * query param description * symbol list warning * black * handle BRK-A and symbols with a dash for Intrinio * fix typo error * add free cash flow to bottom of cash flow statement * amortization_expense * dev_install.py * undo dev_install.. wrong branch * cash flow order things * standardized cash flow * fields * integration tests * cash flow model validator * more polygon cash * black * black * Delete openbb_sdk/providers/polygon/openbb_polygon/utils/definitions.py wrong file * balance sheet * some cleanup * ruff * income statement * black * test params * financial ratios async update * recapture fmp and polygon tests * yFinance financials * yfinance tests * delete financial_statements standard model * intrinio balance sheet order * fiscal year standard param * remove file accidentally committed * add reported_financials end point * fiscal_year param for reported_financials * fix url * fmp test cassette * add safe-guard with warning for fiscal year before 2008 * periods can only be annual and quarter * url in docstring correction * add fiscal_year param to intrinio standardized financials and ratios * fix fmp ratios * black * rename fields as per Minh * rogue field * black * Fix typo in a docstring * Resolve linting errors * type ignore * disable=unused-argument * changing the arg name cc @minhhoang1023 --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * docs/legacy-install: Add warning at top of page - Instructions on this page are for installing the Terminal (#5904) * add warning at top of page - instructions are for installing the Terminal app * pip install openbb-nightly * hotfix/financials-field-maps: Updates A Couple FMP/Polygon Income Statement Fields (#5907) * update income statement fields * another polygon field * ratio -> margin * black * explicit fmp fields * add reported_currency for standardized intrinio * # pylint: disable=unused-argument * another unused-argument * black.. * patch tests * polygon income: eps -> basic earnings per share * re-capture terminal portfolio menu test --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Fix test (#5916) * Fix test * Skip ultima integration tests --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * hotfix/fmp-price-performance-zeros: Replace returned zero with None and normalize percent values. (#5918) * replace zeros with none and normalize percents * pylint unused argument * Update index.md (#5906) * Release/4.1.0 (#5901) * Hotfix/terminal tests (#5919) * skip supressed arguments * silent way of customly load on quote * specify source for call_load * docs/platform-faq: Start Platform FAQ page with bullet points on Platform vs SDK (#5914) * platform vs sdk faq page * add data and data providers faq section and some style cards * typo * makes changes as per reviews * openbb-nightly as a way to install everything * jupyter-lab instead of jupyter --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> * hotfix/backend - Initialize OpenBBFigure (#5912) * create backend * openbb_figure * black * pylint * pylint again --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> * hotfix/yf-futures-historical: yfinance historical futures multi-ticker support and symbol parsing (#5923) * multi-ticker support for yfinance futures historical * raise-missing-from * integration test params * equity_historical adjusted kwargs * pylint unused argument * Docs/excel examples (#5920) * regen excel md * add syntax + basic example * fix example * create json with docs map * update docs to latest functions.json + remove tiingo * remove space from examples * minor fix * remove spaces * remove spaces * bug fix: remove folder before generating * fix typo * add link to appsource * fix * Update templates.md * regenerate content * change docs colors * fix light mode * add back tiingo * update functions.json * templates go later * remove Library from reference * Make the excel markdown being generated at runtime * fix reference cards having commands under menu * remove excel/reference folder since this is built at runtime by gh-pages action * black formatting * improve title * add excel to the main page * add excel image bg * make excel sidebar show up next to pro * improve main page * small fix for platform page title * update basics page * add tip to autocomplete --------- Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * Re-record tests and fix symbol bug (#5924) * Re-record tests and fix symbol bug * nordvpn us ftw * @IgorWounds says "SPY >> IOO" --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Docs/bug fix (#5926) * fix pro link * fix wrong example * Introduces a limit argument for the `equity.fundamental.trailing_dividend_yield` endpoint (#5925) * introduces a limit argument for the equity.fundamental.trailing_dividend_yield endpoint * add default args to test * Add json_schema_extra to openapi.json (#5930) Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * feature/standardize-quote: Proposal to Standardize EquityQuote (#5922) * standardize EquityQuote * intrinio reference * rogue comma * pylint --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * hotfix/fmp-rev-segments: Adds Fiscal Period to busines/geographic segments revenue. (#5921) * add fiscal_period to revenue by geography and business line * data description and unused imports * update test cassette * Allow multiple symbols `equity.profile` (#5929) * allow multiple symbols * pylint * pylint ignore position * change callback to helper func --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Add filtering to AV historical price (#5928) * add filtering to av historical price * lints --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Fix vwap FMP error (#5936) * Fix vwap FMP error * Linting * Painlint * Add date filter + symbols to comp (#5931) * add date filter + symbols to comp * make sure year is in d * tests fix * Improving Platform's import time (#5894) * missing decorator * missing optional statements * us-gov to optional and right position * removing redundant call * lazy load mappings * docstrings * introducing the extension loader class * misleading docstring * using the extension loader on the router * using the extension loader on the credentials * docstrings * lazy load of entry points * checkout dev_install * using the extension loader to get the entry points instead of recalling the function * improved auth service and charting service * using the extension loader on the registry * typos * adding properties to extension loader for easy access * using the extension loader on the package builder * avoiding circular imports by using forward references * fix charting service tests * test for the extension loader * Update openbb_platform/core/openbb_core/app/model/credentials.py Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * Update openbb_platform/core/openbb_core/app/router.py Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * Update openbb_platform/core/openbb_core/provider/registry.py Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * adjustments --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * Disable auto_build on test run (#5937) * Disable auto_build on test run * Move to conftest * Update excel docs (#5940) * update basics * update reference generator * Categorize release notes based on labels for OpenBB Platform (#5943) * Categorize release notes based on labels for OpenBB Platform * Add environment variable for GitHub token in labels-PR.yml * Update labeler.yml to use "enhancement" label for feature branches --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Custom deprecation message in API endpoints and Python commands (#5942) * add custom deprecation message feature in routers * add custom deprecation message feature in package builder * using an actual DeprecationWarning instead * fix tests --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Hotfix/remove unused workflow (#5945) * Disable auto_build on test run * Remove unused workflow * Revert * Hotfix/fix typo (#5948) * Disable auto_build on test run * Fix typo * Revert * docs/data-models-url: Fix URLs on Development Page (#5944) * fix url to the standard models * github links * `equity.fundamental.dividends`: allow filter by date (#5932) * allow filter by date * ruff * pylint * fix tests --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Create Excel templates page (#5947) * create templates page * Update index.mdx * fix description * update card * remove clsx * Update index.mdx * Update index.mdx * Update index.mdx * Update index.mdx * min height * min height * improve excel docs and point towards hub --------- Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * hotfix/intrinio-dividends-limit: Fix Limit Param Alias (#5951) * fix limit param * pylint unused argument, recapture test cassette --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Docs/remove core refs (#5957) * remove references to core: PathHandler + ProviderInterface * remove unused function * add comment * regenerate * fix a few examples * add comment * rename file * Excel tutorials on the docs (#5956) * update workflows name to tutorial * update title * get barebones to bring in Excel videos * tutorial excel videos in * hotfix/float-values: Convert Intrinio balance sheet values to float type (#5961) * convert intrinio balance sheet values to float type * unused import * typo in alias dict * Update to OpenBB Add-in for Excel (#5965) * Log custom headers (#5966) * add custom headers * fix: send on startup and defaults * pylint * unittests * move government-us to community in dev_install (#5963) * fix: adds logic to check whther user is logged in on hub (#5941) Co-authored-by: Luqman <luqazino@gmail.com> * hotfix/fix-company-filings: Fixes too many mandatory fields. (#5909) * Fixes too many mandatory fields. * black * black again --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> * `equity.estimates.price_target` - Integrate with Benzinga (#5946) * deprecation message * fix lints * adding equity.estimates.ratings and fmp as its provider * unit tests for fmp * removing unused file * typos * add benzinga to AnalystRatings * revert changes to estimates router * moving it to price target instead * reverting changes * fmp support for multiple ticker * benzinga price target * ruffy * unused argument * fix type hints * tests for the new fetcher * new integration tests * fixing tests * missing std arg --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [DEPRECATION] `index.market` renamed to `index.price.historical` (#5962) * deprecate index.market and add index.price.historical * add index.historical standard model * add index.historical provider models * index extension tests * provider tests * linting * bug fix (#5969) * Uppercase excel reference (#5958) * uppercase reference * fix name header * add tab title * remove reference excel folder * add to gitignore excel reference files --------- Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * move templates (#5970) * Release 4.1.1. (#5964) * update dev_install * fix effr test * Update dev_install.py * fix fundamental balance test * fix equity price historical test * fix price target model * black * rebuild static files * update publish.md * fixed dev_install * update publishing doc * updated `openbb-core` to 1.1.1 * updated extensions * updated providers * updated `openbb` package * updated static extension map * updated publishing doc * fixed toml for `openbb-finra` * @jmaslek yfinance IS DEFAULT * updated static --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Fix link to discord channel (#5910) Co-authored-by: James Maslek <jmaslek11@gmail.com> * Fixing Posthog handler for thread safety (#5968) * fixing posthog handler for thread safety * removing loggging init from the global scope - per sensei juan --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Update labeler.yml and labels-PR.yml (#5974) * hotfix/ allow multiple `identify` calls (#5976) * allow multiple `identify` calls * Update posthog_handler.py * regex out any invisible control character from sales_conditions field (#5977) * docs/http-requests: Contributor Guide For Building HTTP Requests (#5973) * contributor guide for http requests * add a docstring * add section on get_querystring * extra space * add note for people installing PyPI in a zsh terminal shell --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * feature/add-yfinance-functions: Add equity.profile for yFinance (#5978) * equity profile for yFinance * pylint * equity quote * unused imports * remove yfinance from extras in toml (#5982) * Release OpenBB Platform v`4.1.3` (#5983) * fixing pyproject.toml * adding pandas-ta to technical package for publishing * bumping technical * test for pyproject toml * feature/cboe-async: Refactor Cboe for Async (#5900) * refactor cboe for async * codespell * unused imports * pylint * more pylint * platform metadata * classmethod decorator * test params * intrinio quote * test param names * date in test needs to be a datetime.date not string * make fmp unix timestamp tz-aware and normalize percent change * different way of parsing datetime string * recapture cboe equity historical test * unused import * index snapshot update * black * extension map * pylint * cboe pyproject.toml * proposal to standardize equity_quote * one more file * removing changes on static assets * index_historical * index_historical again * last_time -> last_timestamp * obsolete router path * fix tests * test param * restore market index deprecation that I forgot about * fixing tests --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Fix typo in website/README.md (#5980) * Fix typo in website/README.md * Update linting.yml * Update linting.yml * Update linting.yml * Change ref conditions * Update linting.yml --------- Co-authored-by: Luqman <luqman.bello@openbb.finance> Co-authored-by: Luqman <luqazino@gmail.com> * Hotfix/th etfs (#5959) * added etf trading hours * black formatter --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: Luqman <luqazino@gmail.com> * feature/finviz-provider: Adds Community Finviz Provider Extension (#5952) * add finviz provider * recapture tests * recapture tests again? * invalid test param * static packages * units_measurement -> unit_measurement * static packages as core only * openbb_core version bump in pyproject.toml * try adding user-agent to test response * fix tests * linting * provider model cosmetic changes * fix install script and typo in openbb toml * static * fix: re-record unittests * empty data error * definitions as a file --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> * Add support for multiple symbols on `obb.equity.price.historical` (#5984) * av - support for multiple symbols * tiingo - support for multiple symbols * include symbol only if necessary * update extension descriptions page (#5985) * remove useless file (#5991) * added symbol to headers (#5981) Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Fixing Docs Typos (#5955) * fixed typo * fixed stocka typo --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * fix nasdaq test cassettes (#5989) * don't include `custom_headers` in openapi schema (#5994) * hotfix/intrinio-index: Drop None Rows From intrinio Historical Index (#5987) * drop None rows from intrinio historical indexes * add empty data error * static assets * hotfix/insider-trading: Fix #5988 (#5990) * fix validation errors * empty strings * validator --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: teh_coderer <me@tehcoderer.com> * CI listing quick fix (#6002) * BIGGGG LINTING * fixing lints * fixing lints * black * very ruff * no export * fix hedge_view again * lints * platform lints * lints * black * black it @hjoaquim * fix some more linting --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * Release `openbb-finviz` `1.0.0` to the public (#6000) * set version to `1.0.0` * Set correct dep version in main package * Add `finviz` to table * Auto Labelling for OpenBB Excel Docs Changes (#5998) * Update pull request labels * Update labeler.yml with new label for Excel files --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] - Support for custom examples in router commands (#5993) * Disable auto_build on test run * Add support for custom router examples * Revert odd file change * Fix API pollution * Refactor examples with @montezdesousa * Check if model is inside the PI * Fix * feat: add & fix examples (#6001) * feat: add & fix examples * fix: ruff + comment * feat: read parameter pool from file * feat: typing + unit test * Disable auto_build on test run * Add field order to OBBject * Revert * lint and revert * fix test --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> * hotfix/intrinio-options-date: Fix comparing values between str and datetime (#5997) * fix compare between str and datetime * unused argument * get_weekday * lint --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] - Field order added to the OBBject extra as preference (#5999) * Disable auto_build on test run * Add field order to OBBject * Improvements * Remove noxfile * Disable auto_build on test run * Add field order to OBBject * Revert * lint * Add docs * Not sure how this happened * lint * Update `openbb-devtools` (#6008) * update deps * unpinned package versions from gh linting action * codespell * updated black dependency * linting * linting * linting * pin codespell version * black * black again * install devtools in linting action * format w new black (#6009) * format w new black * format w new black * black again * black the terminal * ignoring unused arguments --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * remove reviewpad (#6010) * Remove Ultima provider (#6012) * Add OECD unemployment (+more) + data cache idea (#5917) * Add OECD unemployment + data cache idea * Docstring edits * Tests * Add composite leading indicator * i truested ruff --fix too much * Add short + long term interest rates * pylint * pylint2 * was not committing. my b * add csv cache + make it default. remove pyarrow from poetry * Clean up * Didnt run on this file. My bad * Why was this ignored /shrug * pylint --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Feature/improved pr template (#6018) * format w new black * Revert "format w new black" This reverts commit74b9619cc6. * better pr templates * developer template * [Feature] - Custom deprecation (#6005) * custom deprecation * custom deprecation * using the new deprecation * custom deprecation on the package builder * remove comment * ruff * black * static assets * tests * using parametrization instead * test for deprecated endpoints (#6014) * Deprecation warning on the reference docs (#6015) * typo/fix * bring back methods needed for markdown generation * add deprecation warning to docs * contributor docs for deprecating endpoints - tks @deeleeramone * small changes on publishing procedure per @the-praxs * moving the deprecation summary class to deprecation file instead * explanation on class variables * Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Update openbb_platform/openbb/package/index.py Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Update website/content/platform/development/contributor-guidelines/deprecating_endpoints.md Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * deprecating on 4.3 instead @the-praxs --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * [BugFix] Fix package builder (#6022) * fix: remove specific imports * adjustments for correct deprecation * static assets --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * [Feature] Add support for multiple tags in `historical_attributes` and `latest_attributes` (#6013) * historical attributes standard model - * add support multiple tags * add `tag` field in data * add support for multiple tags in historical attributes * set correct return type in `callback` function * latest attributes standard model - * add support for multiple tags * add `tag` field in data * add support for multiple tags in latest attributes * add test params for the attributes endpoints * add support for multiple `symbol` and add `symbol` field in the data * modified code to fetch data from multiple symbols and throw warning as per @deeleeramone * add params for testing multiple symbols * linting * fix test params * fixed condition to check if its a `Dict` type * updated intrinio fetcher tests for the statements * updated static * [feature]: feature/overview-to-profile: Deprecate `equity.fundamental.overview()` and move to `equity.profile()` (#6011) * fmp overview to equity profile * deprecation warning * urls * wrangle fields * black * pylint unused argument * insert additional securityID fields to standard model * custom deprecation using OpenBBDeprecationWarning * typo - need to have the deprecated=True flag * static assets * fix non related test * minor adjustment - removing the need for the try/except block - using the get and pop removes the need for key existance checking. cc @deeleeramone --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> * [BugFix] - Remove duplicate code (#6025) Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * remove `SectorNews` from router and standard models (#6026) * feature/more-yfinance: Adds some more to openbb-yfinance (#5979) * equity profile for yFinance * pylint * equity quote * unused imports * price target consensus * add currency field * add share_statistics * don't append empty result to results * key executives * missing definition in key_executives * pylint * key metrics * add currency to key metrics * add etf_info * rename trailing_annual_dividend -> dividend_rate_ttm * add institutions count to share_statistics * add historical dividends * add logic for start-end dates to historical_dividends * recapture the test..? * funny test * filter on tests? * record test with clean cache..? * year_price_change -> price_return_1y in key_metrics * black * make descriptions clear for beta and dividend_yield fields * add description field to standard model * updated static * clear description of shares_implied_outstanding field * updated static for equity * clean descriptions --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * feature/commodities-lbma-fixing: Adds Commodity Extension and LBMA Gold/Silver daily fixing levels (#5760) * add commodity extension and add lbma fixing endpoint * dev_install.py * readme url * renovate the standard model * makes a query_params model for nasdaq data link * literal not optional * unused imports * missing test params * test cassette * DataLink query param description * test file import * actually fix import * from openbb_core.provider..... * ruff * another import statement * black * async router * move query_params * update version * version numbers * extension_map * satisfy pylint? * pylint * Update pyproject.toml * black * poetry lock * Update extension_map.json * Update __extensions__.py * Update module_map.json * clean descriptions --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Improve UX for `obb.news` (#5986) * adding date,start_date and end_date to std params * add date to special params which should've another type * change types to dateType * change helper to accomadate changes in types * date filtering * using the date filtering for all providers * date params on the std model instead * adding the right type * filtering dates on world news * integration tests * fix descriptions * static assets * black * Revert "black" This reverts commit7288b59f87. * lint * addressing @montezdesousa suggestion: removing qua 31 jan 2024 15:01:20 WET from standard models and using it only on benzing * tests accordingly * static assets * black --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: teh_coderer <me@tehcoderer.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] - Improve Standardization - `IndexHistorical` (#6030) * format w new black * Revert "format w new black" This reverts commit74b9619cc6. * small adjustment on the test * index historical * adjust tests accordingly * keep the test skipped * match tests w python * fix tests * keep the skip * fix test * [Feature] - Refactor Response Model (#6024) * Start refactor with @montezdesousa * feat: add response model inside openapi_extra * feat: find+replace return types * fix: ruff * Feature/api response by provider (#6029) * init * Update router.py * Update registry_map.py * check dicts * lint * exclude provider on data model for package build * `results_type_repr` logic for `Annotated`, ignore provider field in `_extract_data` --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> Co-authored-by: teh_coderer <me@tehcoderer.com> * [BugFix] - Improve Standardization - `CotSearch` (#6031) * format w new black * Revert "format w new black" This reverts commit74b9619cc6. * small adjustment on the test * index historical * adjust tests accordingly * keep the test skipped * match tests w python * use cache as std field * fix tests * fix tests * keep the skip * fix test * adding missing param * fix tests accordingly * Docs/byod (#5996) * add byod to reference * fix: rename add-in name * feat: add data conectors page * fix: additional notes * tiny tweaks * update functions.json and openapi.json * fix: fix bug in hedge controller * fix: another bug hedgecontroller * black --------- Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * Feature/ex-dividend: Renames "date" columns as "ex_dividend_date" for Dividend Calendar and Historical Dividends (#6006) * date -> ex_dividend_date * nasdaq historical dividends * black * pylint * intrinio alias_dict * dividend_currency -> currency * yfinance field name --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] - Adds a timezone to the Unix timestamp conversion to correct localization errors. (#6023) * fix: remove specific imports * make polygon historical tz-aware * undo including that commit * that PR wasn't supposed to be there. * pylint unused argument * fix polygon crypto historical intervals * pylint * new cassette * fix the rest of the polygon historical price query params * black * pylint.. * integration test param * appease daylight savings handling * paginate for crypto currency and index * black * raise EmptyDataError when no results instead of returning an empty list * ruff --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> * Hotfix/wrong pydantic validator (#6037) * format w new black * Revert "format w new black" This reverts commit74b9619cc6. * Use field_validator instead * fix openapi schema fields `to_snake` (#6036) * Fix data connectors link typo (#6038) * [BugFix] - Improve Standardization - `EquitySearch` (#6033) * format w new black * Revert "format w new black" This reverts commit74b9619cc6. * small adjustment on the test * index historical * adjust tests accordingly * keep the test skipped * match tests w python * use cache as std field * fix tests * fix tests * use_cache as std * adjust tests * keep the skip * re-record test * black * Docs / only display results for current platform (#6017) * Update index.js * Update index.js * yfinance * tzcache no longer exists * fixxy * ruff --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Andrew <andrew.kenreich@gmail.com> * Improve the docstrings (#6040) * Improve the docstrings (#6041) Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> * dont run base tests with v4 label (#6046) * Sync excel reference (#6039) * sync excel reference * fix: change delimiter to comma * feat: update data connectors * test skipping wf * Update unit-test.yml * Update unit-test.yml * test skipping wf * watch label changes * Update unit-test.yml * [Enhancement] - Improve `news` router docs and examples (#6047) * better docs * static assets * Feature/platform standardization notebook (#6049) * Add platform standardization overview notebook to examples * Add py.typed marker to openbb-fred * [Enhancement] - Improve `currency` router docs and examples (#6045) * currency search * reference rates * historical price * static assets --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * display warnings based on preference (#6051) * [Enhancement] - Improve `crypto` router docs and examples (#6048) * crypto search add validation for '-'-separated pairs * set default query value to None * improve /crypto description with custom examples * improve /crypto/price/historical description with custom examples * updated static for crypto menu * ignore line too long * linting --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Final Implementation of Changelog V2 (#6050) * Updated the release drafter to process the released changelog for OpenBB Platform * Update release drafter configuration * Add OpenBB Documentation Changes and Create Release * Update process_changelog.py path in draft-release.yml * Update release-drafter version and save changelog * Copy changelog with python * Update draft-release.yml to save Changelog * Update draft-release.yml * Encode and save Changelog to Base64 * Update Changelog saving method * Update Changelog format * Update CHANGELOG.md with release notes * Fix draft release workflow * Add cat command to print CHANGELOG.md * Add platform-drafter.yml and update release-drafter.yml and draft-release.yml * Commented out config-name in release-drafter step * Update branch name validation and process_changelog.py * Refactor process_changelog.py to improve readability and maintainability * Refactor process_changelog.py to handle file I/O errors and remove duplicate PR entries --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * improve discriminator logic, fix package return type docs (#6052) * improve discriminator logic, fix package return type docs * Update registry_map.py * build package * Update registry_map.py * defaults * Update registry_map.py --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Add LLM tools example notebook (#6053) * Add LLM tools example notebook * Update README, rename example notebook --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Remove the preference (#6055) Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * [Feature] - Standardise multiple symbols input (#6056) * feat: remove list of str * fix: update cpi * package builder + cpi * build * fix: update unittests * fix: check_item * fix: unittests * Improve the docstrings (#6057) * update economy router docstrings (#6058) Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] Fix OECD Long Term Interest Rate (#6060) * fix long term interest rate * pylint unused argument * [Bugfix] - Fix economic calendar country (#6059) * fix economic calendar country * lint --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [HotFix] Index Router Docstrings & `sp500_multiples()` Cleanup (#6063) * sp500 multiples cleanup * remove dict from standard model * static pacakge * pylint * [Feature] FMP Current Holdings (#6043) * add fmp current holdings to etf holdings * pylint unused argument --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] - Replace symbols in company/news (#6061) * feat: replace symbols in /news * fix: integration tests * fix: integration tests api * fix: typo * Update test_intrinio_fetchers.py * [Enhancement] Add function examples to router. (#6042) * options router * fixedincome router * futures router * missing comma * static assets * futures router --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Enhancement] Add function examples to Regulators Router (#6054) * options router * fixedincome router * futures router * missing comma * static assets * futures router * sec router * cftc router * black --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] Fix World News (#6064) * fix fmp * fix intrinio * fix biztoc * actually commit intrinio fix * fix tiingo * unused import * fix tests * black * ruff * benzinga empty strings * codespell * fix test? * more empty strings --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] - remove unused validators from standard models (#6067) * update standard models * lint * Update USD Liquidity Example Notebook for V4 (#5902) * Update USD Liquidity Example Notebook for V4 * delete some v3 text in the copperToGold * Update README.md * findSymbols preview image * Google Colab preview image * financialStatements preview * content tsx file * ### title * convert tsx to json * indent size * double quote keys.json * trailing commas * Update content.json * patch --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> * Fix QA Examples (#6072) * [Feature] - Ensure Bugfix branches can only do PRs to `develop` branches (#6073) * bugfix branch name checks and few fixes on the linting not to run on pushes to branches outside PRs * Update branch naming guidelines link --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Feature/charting obbject (#5938) * fix circular import issues on the obbject extension framework * settings available on the obbject * extension init * charting assets and code * introduce to_chart functionality * removes the to_chart method from obbject in detriment of the one from the obbject extension * Update openbb_platform/obbject_extensions/charting/charting/__init__.py Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * fix on the show method * adding the example to the to_chart docstring * copying the exsting README from charting extension - needs to be revamped * moving to openbb_charting instead * update the pyproject.toml file * pydocstyle * versions * better docstrings * making accessors public * removing unnecessary credentials variable cc @montezdesousa * removing access to extra/metadata and use designated private attrs instead * Fixes linting for the logging service (#5992) * lints * typing.Type instead * deprecating ChartingService to use the new extension instead - adding function discovery capabilities using it * tests for the obbject charting extension * removing charting service from command runner * filter functions not implemented in the module * remove charting service tests * removing charting service on the tests for int tests * charting integration tests * removing charting service file * removing old charting extension code * revamp builder * fix obbject tests * fix command_runner tests * removing openbb_figure_table * better website docs * reviewed readme * unsetting api key for posthog (pywry) windows * added debug_mode to the system settings * removing api key * update nightly script * fix tests * black * black * Revert "black" This reverts commit21d76ad689. * Revert "black" This reverts commit0904653fd7. * black for henrique * returning a list instead * better docstrings * removing unnecessary indicators docstring * typo * black * intentional access to protected member * changes to publish script * filtering deleted files * black * adding render argument * fixing the df_to_basemodel function: it should include the index in the columns either if flagged or if the index is named * adding the hability to add you own data to to_chart method * tests * black * disable protected access * accept kwargs to eg. save image * adjustment cc Igor * add if statement for protection * remove unused return typing * fix technical charting views * better error message cc @IgorWounds * better structure and fix test * Revert "better structure and fix test" This reverts commit612ea6117c. * Revert "better error message cc @IgorWounds" This reverts commit3d7ee53878. --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> * Fix CAPM example (#6075) * Start removing dead v3 commands for deprecation (#6070) * Yeet tokenterminal * Yeet crypto/onchain/hr and gwei * yeet luna * yeet coinglass * yeet dps/ctb * yeet reddit * yeet covid * actually not yeeting hide yfinance future warning * yeet options/hedge * not yeeting. i18n words * something happened on accident * still fixing * git reset/git checkout -f2516cfbc72website/content * still not sure whats going on * Edit workflow to not look at deleted files + change bootup message * Dont pin the workflow to my branch always lol * Remove askobb * [Feature] - Comma separated string and list inputs (#6062) * feat: balancesheet * feat: income statement * fix: cash flow statement * feat: financial ratios * feat: reported financials * feat: revenue business line * feat: revenue per geography * fix: warnings * Update balance_sheet.py * fix: remove warning imports * feat: balance sheet growth * feat: calendar ipo * feat: cashflow growth * feat: __validators__ * fix: typing * fix: validator msg * feat: trailing dividend_yield * feat: short volume * feat: share statistics * feat: price target + consensus * fix: update validator * feat: historical dividends * feat: key executives * fix: getattr directly * fix: type hint validator * fix: add default to getattr * typo * feat: otc * feat: options chains * fix: remove list validators * feat: add validator dict to fetchers * lint * update standard models * lint * feat: rename validator * fix: ownership * feat: query params description * fix: balance yfinance * key execs, income statement * remove change * fix: revenue geographic * fix: disable pylint * fix: unusual + balance * unit test validator * minor fix * explicit validators * update test * feat: multiple items allowed * rebuild * move check_single_value * crypto historical * order providers * fix typing * rename extra dict * marking multiple items allowed * Revert "marking multiple items allowed" This reverts commit7da04817e1. * error msg * fix: default provider runtime vs configuration * minor fix * docstring * revert default changes * get provider before executing cmd * fix container bug * clean filter * add comment * prevent bad defaults * update docstring * typing * fix * black * fix docstring generation * [Feature] - Mark multiple item fetchers (#6074) * feat: price target * bezinga company news * equity quote * marking multiple items allowed * more multiple items * black * rebuild * another batch * rebuild * another * cpi * move prop * rebuild --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * rename var * update msg * rename func * fix test * mypy * ruff --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> * [Feature] Add Regional Data Endpoint from FRED (#6071) * add regional data endpoint from FRED * codespell * ruff * sort imports * add provder='fred' to integration test * thought I already sorted those imports.. * pylint.. * more test params.... * even more test params... * even more test params.... * static assets * reconfigure params * ruff * alias dict * recapture cassette * router doctstring --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] - Fix most integration tests (#6082) * Fix most integration tests * Lint * Fix price_target column for Benzinga (#6083) * Release/4.1.4 (#6081) * static assets * patch version increase * core update * bumping versions * bump finviz version * bump versions * bump versions on package.extension --------- Co-authored-by: James Maslek <jmaslek11@gmail.com> * Add dates to /quantitative as needed. (#6078) * Add dates to /quantitative as needed. Run new black * Fix tests * Pycharm is weird sometimes * uncommit * Add default window + error handling + mistake --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] Add end point: `etf.equity_exposure()` with FMP provider (#6079) * add etf.equity_exposure from FMP * empty data error * recapture cassette * pylint unused argument * Fix router example typo * fix test...? * static file to fix test? * fix test..? * __json_schema_extra__ * black --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> * [BugFix] Fix Equity Integration Tests (#6086) * fix equity integration tests * black * pylint * black * black * move df_apply to helpers * unused import * remove file that shouldn't have been added * oops. didn't remove a couple lines * [Enhancement] Add `analyst_search` to the Equity/Estimates Router (#6088) * standardize price_target * add analyst search * black * more black * ruff * linter, test parmas * last missing param * get rid of convert to upper * ruff * pylint * [BugFix] - Fix POST docstring examples (#6095) * Fix POST docstring examples. * Move router examples to command decorator * [BugFix] Fix `treasury_rates()` (#6092) * fix treasury_rates * drop rows with no data --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * clean up the remains from my yeeting (#6089) * clean up the remains from my yeeting * was not careful * Add ETF examples (#6102) Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * [BugFix] Fix integration tests (#6100) * fix int tests * fix obbject int tests * fix quant tests * fix index tests * use python 3.10 instead * remove cache * end_date < start_date * [Enhancement]: Add TMX data provider extension. (#5913) * dev install * add TMX provider extension * normalize ytm and coupopn_rate values * black * codespell * ruff * black again * pylint * ftw * undo what Pylint thinks is best * more black * renovate insider_trading standard model * fix tests * typo * tests * empty string * pylint unused argument * nans for some reason * black * static files * static files with openbb-tmx installed this time * yfinance TypeError..? * NA -> N/A * update for version bump * list exchange-calendars as tmx dependency * eod chains date -> eod_date * new line * not that file * more black * one more black * fix weird merge thing * ruff * index constituents params * insider trading * fixing things * black * black AGAIN * news integration params * the other missing param * ruff * historical dividends field update * add json_schema_extra * gainers * symbols -> symbol * company news symbol * unit test param * review items * wrangle a rogue field * index router example * company news thing - symbols -> symbol * field name map --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: James Maslek <jmaslek11@gmail.com> * [Feature] - OBB.GET (#6097) * create OBB.GET and data slicer page * remove quotes * format description * wording * functions.json * sidebar position * remove if stamente * [Docs] Remove Reference to `to_chart` in OBBject. (#6096) * remove reference to to_chart in OBBject. * put chart description back in OBBject properties * [Feature] - Create openbb assets folder (#6101) * create openbb assets folder * fix unittest * rebuild --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] Fixes to_df() where the date series contains multiple TZ-offsets. (#6099) * allow mixed utc offset in a tz-aware date column * enforce ascending from all providers for price.historical * fix tests * add comments and apply treatment to basemodel_from_df before JSON output * yfinance consistency * add unit test * add unit test * better test * ruff --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Update the quantitative extension to make more sense (#6087) * Split out a rolling submenu for the rolling functions * Make a performance and a stats submenu. * Test the statistics functions * lint * lint * dupe test * pylint * ruff * Try tests quick * black magic signature funcs * fix my custom tests * Fix the existing imports/urls * push the api update * okay I figured out whats going on * this should be all of them * Correct docstringing examples --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * [BugFix] Fix ECB Yield Curve (#6108) * fix ecb yield curve * standard model update * Update unit-test workflow to check for changes to openbb_platform (#6109) * [Bug fix] - Fix package mypy (#6110) * fix: package mypy * types * black * [Feature] - Equity router descriptions & examples (#6103) * feat: equity/calendar * feat: compare router * fix descriptions * darkpool + discovery * fix paragraph issues * fix descriptions * fundamental part 1 * fundamental part2 * transcipts * ownership * fix * price * shorts * Update darkpool_router.py * minor fix * shorts examples * examples * ruff * black --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Feature] - Add `exception_handler` decorator to static (#6112) * add exception handler decorator * add exception handler decorator code * updated static * rebuild to fix docstring indentation --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> * update extensions list (#6114) * add missing field descriptions to yfinance equity price historical (#6116) Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * remove charting extension env var (#6118) * [BugFix] Fix Company News (#6111) * fix company news * update tests * multiple symbols for polygon * don't include pageSize in Benzinga querystring, fixed as 100 * remove extra space * black * unused imports * make benzinga test cassette smaller * missing params * clear empty strings --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [BugFix] Allow Multiple Symbols in `equity.fundamental.metrics()` from `yfinance` (#6124) * allow multiple symbols in key_metrics from yfinance * field order thing * remove unnecessary function (#6125) * [Docs] Update OpenBB Copilot docs (#6106) * WIP: Tweak description. * WIP: Experimenting with react-player * WIP: Add copilot docs. * fixes videos width/height * WIP: Refine videos and copy. * WIP: Add last videos and sections. * Add bring-your-own-copilot section. * Tweak grammar. * Add copilot link. * Fix typos. --------- Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> * [Enhancement] Add Previous Close to DATA_DESCRIPTIONS (#6120) * add data description for previous close * ..just the one * update the model tripped by this change --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * added australia as a country also (#6131) * [Bug fix] - Fix regulator cik map standard model (#6129) * Fix regulator cik map standard model * fix description * Update cik_map.py * increase timeout to 30 (#6115) Co-authored-by: James Maslek <jmaslek11@gmail.com> * clean up some v3 deps (#6105) * clean up some v3 deps * forgot we need to do the requirements txt files * not sure it matters, but run ruff + black * am addicted to bug fixes --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * [Bug fix] - explicit multiple items docstring (#6127) * explicit multiple items docstring * rebuiild * rebuild again --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * [Feature] Pretty Pydantic `ValidationError` exceptions (#6130) * fix validator in fmp IndexHistorical model * make ValidationError pretty * modify arg error * linting fmp IndexHistorical * black * remove unused code * tmx etf info (#6132) Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * [Feature] - Platform V4 Markdown Generator V2 (#6094) * add recent `openapi.json` * fix data types in models * removed `openapi.json` * set default date value as None in PolygonCurrencyPairs class * add function to generate reference.json file * reworked function to improve readability * reword function to add seo metadata * add functions for creating markdown sections * add code to extract data card markdown title * add additional functions for generating index and data models file * extract first sentence of the description for cards * code cleanup and documentation * linting * linting polygon models * add openbb import statement in create_reference_markdown_examples function * add POST method functions * cleanup; reworked generate_reference_index_files function * moved development section to 7th position in the sidebar * fix POST function params default value add standard flag to QueryParams and Data fields cleanup * add type expansion from package_builder.MethodDefinition * sort data models cards alphabetically make printing less verbose * make MAX_CARDS global display less content in cards in Commannds section * cleanup * Remove '_' from the cards under Commands section * " to ' in econometrics/causality * replace ' with " in ReferenceCard for reference dir index files * remove extra . from the quantile function description * shoutout to @deeleeramone for finding POST method description bug! * set correct value for standard field * handle BaseModel types in provider data fields * unit tests for the platform markdown generator v2 * yeet 'Default' and 'Optional' columns in the 'Data' section * last minute bug fix * add info for multiple symbols * make multiple items info same as platform static * organize sections properly * sort reference sub-directories alphabetically * extra space in 'OBBject extra' description * add type expansion for fields with multiple items POST method cleanup --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * [Docs] Adds Example Notebook for the Implied Earnings Move (#6128) * adds example notebook for the implied earnings move * remove commented out line --------- Co-authored-by: James Maslek <jmaslek11@gmail.com> * [Feature] - Sync with new openapi.json (#6137) * feat: create data tabs * fix: uncomment * fix: remove unecessary comment * sort side bar * comment * uncomment * use .dev functions.json + clean traverse * fix futures example * fix example * point to .co * Fix the v3 markdown generation workflow (#6138) * fix workflow * debug time * see if the docs generate at least * ahhhh i found it * getting there * put the test first * some keys cleanup * small change to error message * remove ultima + althub * update functions.json (#6140) * move twitter keys * fix intraday check in charting ta_class (#6119) Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> * [BugFix] Display EconDB as source for macro (#6143) * [BugFix] Disable Intrinio `InstitutionalOwnership` model (#6142) * disable fetcher in init and fetcher tests * disable provider test params from equity python and api tests * updated static * add more examples into findSymbols (#6139) Co-authored-by: James Maslek <jmaslek11@gmail.com> * [BugFix] Fix SEC ETF Holdings Parsing Exception (#6121) * fix etf holdings * linting * black --------- Co-authored-by: James Maslek <jmaslek11@gmail.com> * Docs/update xl docs (#6145) * remove print * update obb.get docs * example * md lint * fix g… --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: tehcoderer <me@tehcoderer.com> Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> Co-authored-by: Luqman <luqazino@gmail.com> Co-authored-by: minhhoang1023 <40023817+minhhoang1023@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: Ayrton Parkinson <ayrton.parkinson1@gmail.com> Co-authored-by: northern-64bit <75195383+northern-64bit@users.noreply.github.com> Co-authored-by: Luqman <luqman.bello@openbb.finance> Co-authored-by: Eric Li <38477812+EricLi-Dev@users.noreply.github.com> Co-authored-by: Andrew <andrew.kenreich@gmail.com> Co-authored-by: Michael Struwig <mnicstruwig@gmail.com> Co-authored-by: capital0 <72140796+capital0@users.noreply.github.com> Co-authored-by: Ben Van Doren <benvandoren@users.noreply.github.com> Co-authored-by: Adi Sai <adithya.sairam1@gmail.com> Co-authored-by: Sandip Saha <sandipsmoto@gmail.com> Co-authored-by: Adwait <111136306+AdwaitSalankar@users.noreply.github.com> Co-authored-by: Abhishek Amar <66067391+abhishek-amar@users.noreply.github.com> Co-authored-by: professssor <62937125+professssor@users.noreply.github.com> Co-authored-by: Farookh Zaheer Siddiqui <129654632+FarukhS52@users.noreply.github.com> Co-authored-by: MAX SHESTOV <57421753+maxxsh@users.noreply.github.com> Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: Mohamad Fadil <fadil.parves@gmail.com> Co-authored-by: Ramazan <guvencramazan@outlook.com> Co-authored-by: joshuabuildsthings <joshuabuildsthings@users.noreply.github.com> Co-authored-by: wojda <114031148+polooner@users.noreply.github.com> Co-authored-by: Bim Phomthong <118195204+bimbolimbo@users.noreply.github.com> Co-authored-by: Ramazan <guvencramazan@yandex.com> Co-authored-by: omahs <73983677+omahs@users.noreply.github.com>
4760 lines
161 KiB
JSON
Vendored
4760 lines
161 KiB
JSON
Vendored
{
|
|
"functions": [
|
|
{
|
|
"description": "Bring Your Own Data: single widget, own backend or native integration setup in OpenBB Terminal Pro.",
|
|
"helpUrl": "https://docs.openbb.co/excel/data-connectors",
|
|
"id": "BYOD",
|
|
"name": "BYOD",
|
|
"parameters": [
|
|
{
|
|
"description": "Name of the widget to get data for.",
|
|
"name": "widget",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Name of the backend to use, required for widgets in custom backends or native integrations (e.g. database, snowflake).",
|
|
"name": "backend",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Symbol to get data for, if applicable.",
|
|
"name": "symbol",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Date to get data for, if applicable.",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Optional parameters as (n rows by 2 columns) range selection or array constant (e.g. {\"key1\",\"value1\"}; {\"key2\",\"value2\"}).",
|
|
"dimensionality": "matrix",
|
|
"name": "optional",
|
|
"optional": true,
|
|
"type": "any"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Slice data from a range.",
|
|
"helpUrl": "https://docs.openbb.co/excel/data-slicer",
|
|
"id": "GET",
|
|
"name": "GET",
|
|
"parameters": [
|
|
{
|
|
"description": "Array to slice.",
|
|
"dimensionality": "matrix",
|
|
"name": "array",
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Range of row labels or indices.",
|
|
"dimensionality": "matrix",
|
|
"name": "rows",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Range of column labels or indices.",
|
|
"dimensionality": "matrix",
|
|
"name": "columns",
|
|
"optional": true,
|
|
"type": "any"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get historical price data for cryptocurrency pair(s) within a provider.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/crypto/price/historical",
|
|
"id": "CRYPTO.PRICE.HISTORICAL",
|
|
"name": "CRYPTO.PRICE.HISTORICAL",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, polygon, tiingo, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Number of days to look back. (provider: fmp)",
|
|
"name": "timeseries",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Data granularity. (provider: fmp, polygon, tiingo)",
|
|
"name": "interval",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Sort order of the data. (provider: polygon)",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. (provider: polygon)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] (provider: tiingo)",
|
|
"dimensionality": "matrix",
|
|
"name": "exchanges",
|
|
"optional": true,
|
|
"type": "any"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Search available cryptocurrency pairs within a provider.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/crypto/search",
|
|
"id": "CRYPTO.SEARCH",
|
|
"name": "CRYPTO.SEARCH",
|
|
"parameters": [
|
|
{
|
|
"description": "Search query.",
|
|
"name": "query",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Currency Historical Price. Currency historical data.\n\nCurrency historical prices refer to the past exchange rates of one currency against\nanother over a specific period.\nThis data provides insight into the fluctuations and trends in the foreign exchange market,\nhelping analysts, traders, and economists understand currency performance,\nevaluate economic health, and make predictions about future movements.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/currency/price/historical",
|
|
"id": "CURRENCY.PRICE.HISTORICAL",
|
|
"name": "CURRENCY.PRICE.HISTORICAL",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): polygon.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, polygon, tiingo, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Data granularity. (provider: fmp, polygon, tiingo)",
|
|
"name": "interval",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Sort order of the data. (provider: polygon)",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. (provider: polygon)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Current, official, currency reference rates.\n\nForeign exchange reference rates are the exchange rates set by a major financial institution or regulatory body,\nserving as a benchmark for the value of currencies around the world.\nThese rates are used as a standard to facilitate international trade and financial transactions,\nensuring consistency and reliability in currency conversion.\nThey are typically updated on a daily basis and reflect the market conditions at a specific time.\nCentral banks and financial institutions often use these rates to guide their own exchange rates,\nimpacting global trade, loans, and investments.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/currency/reference_rates",
|
|
"id": "CURRENCY.REFERENCE_RATES",
|
|
"name": "CURRENCY.REFERENCE_RATES",
|
|
"parameters": [
|
|
{
|
|
"description": "Options: ecb, defaults to ecb.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Currency Search.\n\nSearch available currency pairs.\nCurrency pairs are the national currencies from two countries coupled for trading on\nthe foreign exchange (FX) marketplace.\nBoth currencies will have exchange rates on which the trade will have its position basis.\nAll trading within the forex market, whether selling, buying, or trading, will take place through currency pairs.\n(ref: Investopedia)\nMajor currency pairs include pairs such as EUR/USD, USD/JPY, GBP/USD, etc.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/currency/search",
|
|
"id": "CURRENCY.SEARCH",
|
|
"name": "CURRENCY.SEARCH",
|
|
"parameters": [
|
|
{
|
|
"description": "Options: fmp, intrinio, polygon, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Symbol of the pair to search. (provider: polygon)",
|
|
"name": "symbol",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "A specific date to get data for. (provider: polygon)",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Search for terms within the ticker and/or company name. (provider: polygon)",
|
|
"name": "search",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)",
|
|
"name": "active",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Order data by ascending or descending. (provider: polygon)",
|
|
"name": "order",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Sort field used for ordering. (provider: polygon)",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. (provider: polygon)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the complete options chain for a ticker.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/derivatives/options/chains",
|
|
"id": "DERIVATIVES.OPTIONS.CHAINS",
|
|
"name": "DERIVATIVES.OPTIONS.CHAINS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: intrinio, defaults to intrinio.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The end-of-day date for options chains data. (provider: intrinio)",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the complete options chain for a ticker.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/derivatives/options/unusual",
|
|
"id": "DERIVATIVES.OPTIONS.UNUSUAL",
|
|
"name": "DERIVATIVES.OPTIONS.UNUSUAL",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. (the underlying symbol)",
|
|
"name": "symbol",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: intrinio, defaults to intrinio.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The source of the data. Either realtime or delayed. (provider: intrinio)",
|
|
"name": "source",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Balance of Payments Reports.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/balance_of_payments",
|
|
"id": "ECONOMY.BALANCE_OF_PAYMENTS",
|
|
"name": "ECONOMY.BALANCE_OF_PAYMENTS",
|
|
"parameters": [
|
|
{
|
|
"description": "Options: ecb, defaults to ecb.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The report type, the level of detail in the data. (provider: ecb)",
|
|
"name": "report_type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The frequency of the data. Monthly is valid only for ['main', 'summary']. (provider: ecb)",
|
|
"name": "frequency",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb)",
|
|
"name": "country",
|
|
"optional": true,
|
|
"type": "any"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the upcoming, or historical, economic calendar of global events.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/calendar",
|
|
"id": "ECONOMY.CALENDAR",
|
|
"name": "ECONOMY.CALENDAR",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, tradingeconomics, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Country of the event. Multiple items allowed. (provider: tradingeconomics)",
|
|
"name": "country",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Importance of the event. (provider: tradingeconomics)",
|
|
"name": "importance",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Grouping of events (provider: tradingeconomics)",
|
|
"name": "group",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "The composite leading indicator (CLI) is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\nCLIs show short-term economic movements in qualitative rather than quantitative terms.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/composite_leading_indicator",
|
|
"id": "ECONOMY.COMPOSITE_LEADING_INDICATOR",
|
|
"name": "ECONOMY.COMPOSITE_LEADING_INDICATOR",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: oecd, defaults to oecd.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Country to get GDP for. (provider: oecd)",
|
|
"name": "country",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Consumer Price Index (CPI). Returns either the rescaled index value, or a rate of change (inflation).",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/cpi",
|
|
"id": "ECONOMY.CPI",
|
|
"name": "ECONOMY.CPI",
|
|
"parameters": [
|
|
{
|
|
"description": "The country to get data. Multiple items allowed for provider(s): fred.",
|
|
"name": "country",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The unit of measurement for the data.\nOptions:\n- `growth_previous`: Percent growth from the previous period.\nIf monthly data, this is month-over-month, etc\n- `growth_same`: Percent growth from the same period in the previous year.\nIf looking at monthly data, this would be year-over-year, etc.\n- `index_2015`: Rescaled index value, such that the value in 2015 is 100.",
|
|
"name": "units",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The frequency of the data.\nOptions: `monthly`, `quarter`, and `annual`.",
|
|
"name": "frequency",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether you wish to obtain harmonized data.",
|
|
"name": "harmonized",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Query the Geo Fred API for regional economic data by series group.\nThe series group ID is found by using `fred_search` and the `series_id` parameter.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_regional",
|
|
"id": "ECONOMY.FRED_REGIONAL",
|
|
"name": "ECONOMY.FRED_REGIONAL",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): fred.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "When True, the symbol provided is for a series_group, else it is for a series ID. (provider: fred)",
|
|
"name": "is_series_group",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "The type of regional data. Parameter is only valid when `is_series_group` is True. (provider: fred)",
|
|
"name": "region_type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True. (provider: fred)",
|
|
"name": "season",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True. (provider: fred)",
|
|
"name": "units",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Frequency aggregation to convert high frequency data to lower frequency.\nParameter is only valid when `is_series_group` is True.\na = Annual\nsa= Semiannual\nq = Quarterly\nm = Monthly\nw = Weekly\nd = Daily\nwef = Weekly, Ending Friday\nweth = Weekly, Ending Thursday\nwew = Weekly, Ending Wednesday\nwetu = Weekly, Ending Tuesday\nwem = Weekly, Ending Monday\nwesu = Weekly, Ending Sunday\nwesa = Weekly, Ending Saturday\nbwew = Biweekly, Ending Wednesday\nbwem = Biweekly, Ending Monday\n(provider: fred)",
|
|
"name": "frequency",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "A key that indicates the aggregation method used for frequency aggregation.\nThis parameter has no affect if the frequency parameter is not set.\nOnly valid when `is_series_group` is True.\navg = Average\nsum = Sum\neop = End of Period\n(provider: fred)",
|
|
"name": "aggregation_method",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Transformation type. Only valid when `is_series_group` is True.\nlin = Levels (No transformation)\nchg = Change\nch1 = Change from Year Ago\npch = Percent Change\npc1 = Percent Change from Year Ago\npca = Compounded Annual Rate of Change\ncch = Continuously Compounded Rate of Change\ncca = Continuously Compounded Annual Rate of Change\nlog = Natural Log\n(provider: fred)",
|
|
"name": "transform",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Search for FRED series or economic releases by ID or string.\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_search",
|
|
"id": "ECONOMY.FRED_SEARCH",
|
|
"name": "ECONOMY.FRED_SEARCH",
|
|
"parameters": [
|
|
{
|
|
"description": "The search word(s).",
|
|
"name": "query",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True. (provider: fred)",
|
|
"name": "is_release",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "A specific release ID to target. (provider: fred)",
|
|
"name": "release_id",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. (1-1000) (provider: fred)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Offset the results in conjunction with limit. (provider: fred)",
|
|
"name": "offset",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by an attribute. (provider: fred)",
|
|
"name": "filter_variable",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "String value to filter the variable by. Used in conjunction with filter_variable. (provider: fred)",
|
|
"name": "filter_value",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' (provider: fred)",
|
|
"name": "tag_names",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series. (provider: fred)",
|
|
"name": "exclude_tag_names",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas. (provider: fred)",
|
|
"name": "series_id",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get data by series ID from FRED.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_series",
|
|
"id": "ECONOMY.FRED_SERIES",
|
|
"name": "ECONOMY.FRED_SERIES",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): fred.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fred, intrinio, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Frequency aggregation to convert high frequency data to lower frequency.\nNone = No change\na = Annual\nq = Quarterly\nm = Monthly\nw = Weekly\nd = Daily\nwef = Weekly, Ending Friday\nweth = Weekly, Ending Thursday\nwew = Weekly, Ending Wednesday\nwetu = Weekly, Ending Tuesday\nwem = Weekly, Ending Monday\nwesu = Weekly, Ending Sunday\nwesa = Weekly, Ending Saturday\nbwew = Biweekly, Ending Wednesday\nbwem = Biweekly, Ending Monday\n(provider: fred)",
|
|
"name": "frequency",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "A key that indicates the aggregation method used for frequency aggregation.\nThis parameter has no affect if the frequency parameter is not set.\navg = Average\nsum = Sum\neop = End of Period\n(provider: fred)",
|
|
"name": "aggregation_method",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Transformation type\nNone = No transformation\nchg = Change\nch1 = Change from Year Ago\npch = Percent Change\npc1 = Percent Change from Year Ago\npca = Compounded Annual Rate of Change\ncch = Continuously Compounded Rate of Change\ncca = Continuously Compounded Annual Rate of Change\nlog = Natural Log\n(provider: fred)",
|
|
"name": "transform",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Returns all pages of data from the API call at once. (provider: intrinio)",
|
|
"name": "all_pages",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)",
|
|
"name": "sleep",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Forecasted GDP Data.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/gdp/forecast",
|
|
"id": "ECONOMY.GDP.FORECAST",
|
|
"name": "ECONOMY.GDP.FORECAST",
|
|
"parameters": [
|
|
{
|
|
"description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Type of GDP to get forecast of. Either nominal or real.",
|
|
"name": "type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: oecd, defaults to oecd.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Country to get GDP for. (provider: oecd)",
|
|
"name": "country",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Nominal GDP Data.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/gdp/nominal",
|
|
"id": "ECONOMY.GDP.NOMINAL",
|
|
"name": "ECONOMY.GDP.NOMINAL",
|
|
"parameters": [
|
|
{
|
|
"description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita.",
|
|
"name": "units",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: oecd, defaults to oecd.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Country to get GDP for. (provider: oecd)",
|
|
"name": "country",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Real GDP Data.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/gdp/real",
|
|
"id": "ECONOMY.GDP.REAL",
|
|
"name": "ECONOMY.GDP.REAL",
|
|
"parameters": [
|
|
{
|
|
"description": "The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).)",
|
|
"name": "units",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: oecd, defaults to oecd.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Country to get GDP for. (provider: oecd)",
|
|
"name": "country",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Long-term interest rates refer to government bonds maturing in ten years.\nRates are mainly determined by the price charged by the lender, the risk from the borrower and the\nfall in the capital value. Long-term interest rates are generally averages of daily rates,\nmeasured as a percentage. These interest rates are implied by the prices at which the government bonds are\ntraded on financial markets, not the interest rates at which the loans were issued.\nIn all cases, they refer to bonds whose capital repayment is guaranteed by governments.\nLong-term interest rates are one of the determinants of business investment.\nLow long-term interest rates encourage investment in new equipment and high interest rates discourage it.\nInvestment is, in turn, a major source of economic growth.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/long_term_interest_rate",
|
|
"id": "ECONOMY.LONG_TERM_INTEREST_RATE",
|
|
"name": "ECONOMY.LONG_TERM_INTEREST_RATE",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: oecd, defaults to oecd.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Country to get GDP for. (provider: oecd)",
|
|
"name": "country",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Frequency to get interest rate for for. (provider: oecd)",
|
|
"name": "frequency",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Money Measures (M1/M2 and components). The Federal Reserve publishes as part of the H.6 Release.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/money_measures",
|
|
"id": "ECONOMY.MONEY_MEASURES",
|
|
"name": "ECONOMY.MONEY_MEASURES",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether to return seasonally adjusted data.",
|
|
"name": "adjusted",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Options: federal_reserve, defaults to federal_reserve.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Market Risk Premium by country.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/risk_premium",
|
|
"id": "ECONOMY.RISK_PREMIUM",
|
|
"name": "ECONOMY.RISK_PREMIUM",
|
|
"parameters": [
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Short-term interest rates are the rates at which short-term borrowings are effected between\nfinancial institutions or the rate at which short-term government paper is issued or traded in the market.\nShort-term interest rates are generally averages of daily rates, measured as a percentage.\nShort-term interest rates are based on three-month money market rates where available.\nTypical standardised names are \"money market rate\" and \"treasury bill rate\".",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/short_term_interest_rate",
|
|
"id": "ECONOMY.SHORT_TERM_INTEREST_RATE",
|
|
"name": "ECONOMY.SHORT_TERM_INTEREST_RATE",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: oecd, defaults to oecd.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Country to get GDP for. (provider: oecd)",
|
|
"name": "country",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Frequency to get interest rate for for. (provider: oecd)",
|
|
"name": "frequency",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Global unemployment data.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/economy/unemployment",
|
|
"id": "ECONOMY.UNEMPLOYMENT",
|
|
"name": "ECONOMY.UNEMPLOYMENT",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: oecd, defaults to oecd.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Country to get GDP for. (provider: oecd)",
|
|
"name": "country",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Sex to get unemployment for. (provider: oecd)",
|
|
"name": "sex",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Frequency to get unemployment for. (provider: oecd)",
|
|
"name": "frequency",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Age group to get unemployment for. Total indicates 15 years or over (provider: oecd)",
|
|
"name": "age",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether to get seasonally adjusted unemployment. Defaults to False. (provider: oecd)",
|
|
"name": "seasonal_adjustment",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get historical and upcoming dividend payments. Includes dividend amount, ex-dividend and payment dates.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/dividend",
|
|
"id": "EQUITY.CALENDAR.DIVIDEND",
|
|
"name": "EQUITY.CALENDAR.DIVIDEND",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get historical and upcoming company earnings releases. Includes earnings per share (EPS) and revenue data.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/earnings",
|
|
"id": "EQUITY.CALENDAR.EARNINGS",
|
|
"name": "EQUITY.CALENDAR.EARNINGS",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get historical and upcoming initial public offerings (IPOs).",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/ipo",
|
|
"id": "EQUITY.CALENDAR.IPO",
|
|
"name": "EQUITY.CALENDAR.IPO",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: intrinio, defaults to intrinio.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio)",
|
|
"name": "status",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio)",
|
|
"name": "offer_amount_greater_than",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio)",
|
|
"name": "offer_amount_less_than",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get historical and upcoming stock split operations.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/splits",
|
|
"id": "EQUITY.CALENDAR.SPLITS",
|
|
"name": "EQUITY.CALENDAR.SPLITS",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the closest peers for a given company.\n\nPeers consist of companies trading on the same exchange, operating within the same sector\nand with comparable market capitalizations.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/compare/peers",
|
|
"id": "EQUITY.COMPARE.PEERS",
|
|
"name": "EQUITY.COMPARE.PEERS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/discovery/filings",
|
|
"id": "EQUITY.DISCOVERY.FILINGS",
|
|
"name": "EQUITY.DISCOVERY.FILINGS",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.",
|
|
"name": "form_type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Flag for whether or not the filing is done. (provider: fmp)",
|
|
"name": "isDone",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Search for specific analysts and get their forecast track record.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/analyst_search",
|
|
"id": "EQUITY.ESTIMATES.ANALYST_SEARCH",
|
|
"name": "EQUITY.ESTIMATES.ANALYST_SEARCH",
|
|
"parameters": [
|
|
{
|
|
"description": "A comma separated list of analyst names to bring back. Omitting will bring back all available analysts.",
|
|
"name": "analyst_name",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "A comma separated list of firm names to bring back. Omitting will bring back all available firms.",
|
|
"name": "firm_name",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: benzinga, defaults to benzinga.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "A comma separated list of analyst IDs to bring back. (provider: benzinga)",
|
|
"name": "analyst_ids",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "A comma separated list of firm IDs to bring back. (provider: benzinga)",
|
|
"name": "firm_ids",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Number of results returned. Limit 1000. (provider: benzinga)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. (provider: benzinga)",
|
|
"name": "page",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. (provider: benzinga)",
|
|
"name": "fields",
|
|
"optional": true,
|
|
"type": "any"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get consensus price target and recommendation.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/consensus",
|
|
"id": "EQUITY.ESTIMATES.CONSENSUS",
|
|
"name": "EQUITY.ESTIMATES.CONSENSUS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get historical analyst estimates for earnings and revenue.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/historical",
|
|
"id": "EQUITY.ESTIMATES.HISTORICAL",
|
|
"name": "EQUITY.ESTIMATES.HISTORICAL",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time period of the data to return.",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get analyst price targets by company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/price_target",
|
|
"id": "EQUITY.ESTIMATES.PRICE_TARGET",
|
|
"name": "EQUITY.ESTIMATES.PRICE_TARGET",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga.",
|
|
"name": "symbol",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: benzinga, fmp, defaults to benzinga.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters. (provider: benzinga)",
|
|
"name": "page",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Date for calendar data, shorthand for date_from and date_to. (provider: benzinga)",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format. (provider: benzinga)",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format. (provider: benzinga)",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD. (provider: benzinga)",
|
|
"name": "updated",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated (provider: benzinga)",
|
|
"name": "importance",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by a specific action_company. (provider: benzinga)",
|
|
"name": "action",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple items allowed. (provider: benzinga)",
|
|
"name": "analyst_ids",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Comma-separated list of firm IDs. Multiple items allowed. (provider: benzinga)",
|
|
"name": "firm_ids",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple items allowed. (provider: benzinga)",
|
|
"name": "fields",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Include upgrades and downgrades in the response. (provider: fmp)",
|
|
"name": "with_grade",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the balance sheet for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/balance",
|
|
"id": "EQUITY.FUNDAMENTAL.BALANCE",
|
|
"name": "EQUITY.FUNDAMENTAL.BALANCE",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time period of the data to return.",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, polygon, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)",
|
|
"name": "fiscal_year",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filing date of the financial statement. (provider: polygon)",
|
|
"name": "filing_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date less than the given date. (provider: polygon)",
|
|
"name": "filing_date_lt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date less than or equal to the given date. (provider: polygon)",
|
|
"name": "filing_date_lte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date greater than the given date. (provider: polygon)",
|
|
"name": "filing_date_gt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date greater than or equal to the given date. (provider: polygon)",
|
|
"name": "filing_date_gte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date of the financial statement. (provider: polygon)",
|
|
"name": "period_of_report_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date less than the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_lt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date less than or equal to the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_lte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date greater than the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_gt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date greater than or equal to the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_gte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether to include the sources of the financial statement. (provider: polygon)",
|
|
"name": "include_sources",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Order of the financial statement. (provider: polygon)",
|
|
"name": "order",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Sort of the financial statement. (provider: polygon)",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the growth of a company's balance sheet items over time.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/balance_growth",
|
|
"id": "EQUITY.FUNDAMENTAL.BALANCE_GROWTH",
|
|
"name": "EQUITY.FUNDAMENTAL.BALANCE_GROWTH",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the cash flow statement for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/cash",
|
|
"id": "EQUITY.FUNDAMENTAL.CASH",
|
|
"name": "EQUITY.FUNDAMENTAL.CASH",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time period of the data to return.",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, polygon, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)",
|
|
"name": "fiscal_year",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filing date of the financial statement. (provider: polygon)",
|
|
"name": "filing_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date less than the given date. (provider: polygon)",
|
|
"name": "filing_date_lt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date less than or equal to the given date. (provider: polygon)",
|
|
"name": "filing_date_lte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date greater than the given date. (provider: polygon)",
|
|
"name": "filing_date_gt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date greater than or equal to the given date. (provider: polygon)",
|
|
"name": "filing_date_gte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date of the financial statement. (provider: polygon)",
|
|
"name": "period_of_report_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date less than the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_lt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date less than or equal to the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_lte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date greater than the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_gt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date greater than or equal to the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_gte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether to include the sources of the financial statement. (provider: polygon)",
|
|
"name": "include_sources",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Order of the financial statement. (provider: polygon)",
|
|
"name": "order",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Sort of the financial statement. (provider: polygon)",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "any"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the growth of a company's cash flow statement items over time.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/cash_growth",
|
|
"id": "EQUITY.FUNDAMENTAL.CASH_GROWTH",
|
|
"name": "EQUITY.FUNDAMENTAL.CASH_GROWTH",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get historical dividend data for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/dividends",
|
|
"id": "EQUITY.FUNDAMENTAL.DIVIDENDS",
|
|
"name": "EQUITY.FUNDAMENTAL.DIVIDENDS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. (provider: intrinio)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get historical employee count data for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/employee_count",
|
|
"id": "EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT",
|
|
"name": "EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/filings",
|
|
"id": "EQUITY.FUNDAMENTAL.FILINGS",
|
|
"name": "EQUITY.FUNDAMENTAL.FILINGS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, sec, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Type of the SEC filing form. (provider: sec)",
|
|
"name": "form_type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Sort the data in ascending or descending order. (provider: fmp)",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format. (provider: intrinio)",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format. (provider: intrinio)",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio)",
|
|
"name": "thea_enabled",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec)",
|
|
"name": "cik",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Whether or not to use cache. If True, cache will store for one day. (provider: sec)",
|
|
"name": "use_cache",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the historical values of a data tag from Intrinio.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/historical_attributes",
|
|
"id": "EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES",
|
|
"name": "EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.",
|
|
"name": "tag",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The frequency of the data.",
|
|
"name": "frequency",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by type, when applicable.",
|
|
"name": "tag_type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Sort order.",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: intrinio, defaults to intrinio.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get historical earnings per share data for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/historical_eps",
|
|
"id": "EQUITY.FUNDAMENTAL.HISTORICAL_EPS",
|
|
"name": "EQUITY.FUNDAMENTAL.HISTORICAL_EPS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. (provider: fmp)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get historical stock splits for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/historical_splits",
|
|
"id": "EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS",
|
|
"name": "EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the income statement for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/income",
|
|
"id": "EQUITY.FUNDAMENTAL.INCOME",
|
|
"name": "EQUITY.FUNDAMENTAL.INCOME",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time period of the data to return.",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, polygon, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)",
|
|
"name": "fiscal_year",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filing date of the financial statement. (provider: polygon)",
|
|
"name": "filing_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date less than the given date. (provider: polygon)",
|
|
"name": "filing_date_lt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date less than or equal to the given date. (provider: polygon)",
|
|
"name": "filing_date_lte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date greater than the given date. (provider: polygon)",
|
|
"name": "filing_date_gt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filing date greater than or equal to the given date. (provider: polygon)",
|
|
"name": "filing_date_gte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date of the financial statement. (provider: polygon)",
|
|
"name": "period_of_report_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date less than the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_lt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date less than or equal to the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_lte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date greater than the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_gt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of report date greater than or equal to the given date. (provider: polygon)",
|
|
"name": "period_of_report_date_gte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether to include the sources of the financial statement. (provider: polygon)",
|
|
"name": "include_sources",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Order of the financial statement. (provider: polygon)",
|
|
"name": "order",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Sort of the financial statement. (provider: polygon)",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the growth of a company's income statement items over time.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/income_growth",
|
|
"id": "EQUITY.FUNDAMENTAL.INCOME_GROWTH",
|
|
"name": "EQUITY.FUNDAMENTAL.INCOME_GROWTH",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Time period of the data to return.",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the latest value of a data tag from Intrinio.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/latest_attributes",
|
|
"id": "EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES",
|
|
"name": "EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.",
|
|
"name": "tag",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: intrinio, defaults to intrinio.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get executive management team data for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/management",
|
|
"id": "EQUITY.FUNDAMENTAL.MANAGEMENT",
|
|
"name": "EQUITY.FUNDAMENTAL.MANAGEMENT",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get executive management team compensation for a given company over time.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/management_compensation",
|
|
"id": "EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION",
|
|
"name": "EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get fundamental metrics for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/metrics",
|
|
"id": "EQUITY.FUNDAMENTAL.METRICS",
|
|
"name": "EQUITY.FUNDAMENTAL.METRICS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time period of the data to return.",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Include trailing twelve months (TTM) data. (provider: fmp)",
|
|
"name": "with_ttm",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get equity valuation multiples for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/multiples",
|
|
"id": "EQUITY.FUNDAMENTAL.MULTIPLES",
|
|
"name": "EQUITY.FUNDAMENTAL.MULTIPLES",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get company general business and stock data for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/overview",
|
|
"id": "EQUITY.FUNDAMENTAL.OVERVIEW",
|
|
"name": "EQUITY.FUNDAMENTAL.OVERVIEW",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get an extensive set of financial and accounting ratios for a given company over time.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/ratios",
|
|
"id": "EQUITY.FUNDAMENTAL.RATIOS",
|
|
"name": "EQUITY.FUNDAMENTAL.RATIOS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time period of the data to return.",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Include trailing twelve months (TTM) data. (provider: fmp, intrinio)",
|
|
"name": "with_ttm",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)",
|
|
"name": "fiscal_year",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get financial statements as reported by the company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/reported_financials",
|
|
"id": "EQUITY.FUNDAMENTAL.REPORTED_FINANCIALS",
|
|
"name": "EQUITY.FUNDAMENTAL.REPORTED_FINANCIALS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time period of the data to return.",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The type of financial statement - i.e, balance, income, cash.",
|
|
"name": "statement_type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: intrinio, defaults to intrinio.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)",
|
|
"name": "fiscal_year",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the revenue geographic breakdown for a given company over time.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/revenue_per_geography",
|
|
"id": "EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY",
|
|
"name": "EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time period of the data to return.",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Structure of the returned data.",
|
|
"name": "structure",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the revenue breakdown by business segment for a given company over time.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/revenue_per_segment",
|
|
"id": "EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT",
|
|
"name": "EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time period of the data to return.",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Structure of the returned data.",
|
|
"name": "structure",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Search Intrinio data tags to search in latest or historical attributes.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/search_attributes",
|
|
"id": "EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES",
|
|
"name": "EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES",
|
|
"parameters": [
|
|
{
|
|
"description": "Query to search for.",
|
|
"name": "query",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: intrinio, defaults to intrinio.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the 1 year trailing dividend yield for a given company over time.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/trailing_dividend_yield",
|
|
"id": "EQUITY.FUNDAMENTAL.TRAILING_DIVIDEND_YIELD",
|
|
"name": "EQUITY.FUNDAMENTAL.TRAILING_DIVIDEND_YIELD",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. Default is 252, the number of trading days in a year.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: tiingo, defaults to tiingo.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get earnings call transcripts for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/transcript",
|
|
"id": "EQUITY.FUNDAMENTAL.TRANSCRIPT",
|
|
"name": "EQUITY.FUNDAMENTAL.TRANSCRIPT",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Year of the earnings call transcript.",
|
|
"name": "year",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Date of the earnings call transcript. (provider: fmp)",
|
|
"name": "earnings_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/market_snapshots",
|
|
"id": "EQUITY.MARKET_SNAPSHOTS",
|
|
"name": "EQUITY.MARKET_SNAPSHOTS",
|
|
"parameters": [
|
|
{
|
|
"description": "Options: fmp, polygon, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The market to fetch data for. (provider: fmp)",
|
|
"name": "market",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get data about trading by a company's management team and board of directors.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/insider_trading",
|
|
"id": "EQUITY.OWNERSHIP.INSIDER_TRADING",
|
|
"name": "EQUITY.OWNERSHIP.INSIDER_TRADING",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Type of the transaction. (provider: fmp)",
|
|
"name": "transactionType",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format. (provider: intrinio)",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format. (provider: intrinio)",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Type of ownership. (provider: intrinio)",
|
|
"name": "ownership_type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Field to sort by. (provider: intrinio)",
|
|
"name": "sort_by",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get data about institutional ownership for a given company over time.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/institutional",
|
|
"id": "EQUITY.OWNERSHIP.INSTITUTIONAL",
|
|
"name": "EQUITY.OWNERSHIP.INSTITUTIONAL",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Include current quarter data. (provider: fmp)",
|
|
"name": "include_current_quarter",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "A specific date to get data for. (provider: fmp)",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. (provider: intrinio)",
|
|
"name": "page_size",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get data about major holders for a given company over time.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/major_holders",
|
|
"id": "EQUITY.OWNERSHIP.MAJOR_HOLDERS",
|
|
"name": "EQUITY.OWNERSHIP.MAJOR_HOLDERS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "A specific date to get data for.",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Page number of the data to fetch.",
|
|
"name": "page",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Number of records to return. (Ignores page if set. Default: None) (provider: fmp)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get data about share float for a given company.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/share_statistics",
|
|
"id": "EQUITY.OWNERSHIP.SHARE_STATISTICS",
|
|
"name": "EQUITY.OWNERSHIP.SHARE_STATISTICS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/price/historical",
|
|
"id": "EQUITY.PRICE.HISTORICAL",
|
|
"name": "EQUITY.PRICE.HISTORICAL",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time interval of the data to return.",
|
|
"name": "interval",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, polygon, tiingo, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Number of days to look back (Only for interval 1d). (provider: fmp);\nThe number of results to return per page. (provider: intrinio);\nThe number of data entries to return. (provider: polygon)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Sort the data in ascending or descending order. (provider: fmp);\nSort order of the data. (provider: polygon)",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio)",
|
|
"name": "start_time",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio)",
|
|
"name": "end_time",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Timezone of the data, in the IANA format (Continent/City). (provider: intrinio)",
|
|
"name": "timezone",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The source of the data. (provider: intrinio)",
|
|
"name": "source",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)",
|
|
"name": "sleep",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Output time series is adjusted by historical split and dividend events. (provider: polygon)",
|
|
"name": "adjusted",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the National Best Bid and Offer for a given stock.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/price/nbbo",
|
|
"id": "EQUITY.PRICE.NBBO",
|
|
"name": "EQUITY.PRICE.NBBO",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: polygon, defaults to polygon.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols. (provider: polygon)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges. (provider: polygon)",
|
|
"name": "timestamp",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Query by datetime, less than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\nYYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour.\n(provider: polygon)",
|
|
"name": "timestamp_lt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Query by datetime, greater than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\nYYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour.\n(provider: polygon)",
|
|
"name": "timestamp_gt",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Query by datetime, less than or equal to.\nEither a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\nYYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour.\n(provider: polygon)",
|
|
"name": "timestamp_lte",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Query by datetime, greater than or equal to.\nEither a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\nYYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour.\n(provider: polygon)",
|
|
"name": "timestamp_gte",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get price performance data for a given stock. This includes price changes for different time periods.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/price/performance",
|
|
"id": "EQUITY.PRICE.PERFORMANCE",
|
|
"name": "EQUITY.PRICE.PERFORMANCE",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/price/quote",
|
|
"id": "EQUITY.PRICE.QUOTE",
|
|
"name": "EQUITY.PRICE.QUOTE",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): fmp, intrinio.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Source of the data. (provider: intrinio)",
|
|
"name": "source",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get general information about a company. This includes company name, industry, sector and price data.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/profile",
|
|
"id": "EQUITY.PROFILE",
|
|
"name": "EQUITY.PROFILE",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Screen for companies meeting various criteria. These criteria include\nmarket cap, price, beta, volume, and dividend yield.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/screener",
|
|
"id": "EQUITY.SCREENER",
|
|
"name": "EQUITY.SCREENER",
|
|
"parameters": [
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filter by market cap greater than this value. (provider: fmp)",
|
|
"name": "mktcap_min",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by market cap less than this value. (provider: fmp)",
|
|
"name": "mktcap_max",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by price greater than this value. (provider: fmp)",
|
|
"name": "price_min",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by price less than this value. (provider: fmp)",
|
|
"name": "price_max",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by a beta greater than this value. (provider: fmp)",
|
|
"name": "beta_min",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by a beta less than this value. (provider: fmp)",
|
|
"name": "beta_max",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by volume greater than this value. (provider: fmp)",
|
|
"name": "volume_min",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by volume less than this value. (provider: fmp)",
|
|
"name": "volume_max",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by dividend amount greater than this value. (provider: fmp)",
|
|
"name": "dividend_min",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Filter by dividend amount less than this value. (provider: fmp)",
|
|
"name": "dividend_max",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "If true, returns only ETFs. (provider: fmp)",
|
|
"name": "is_etf",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "If false, returns only inactive tickers. (provider: fmp)",
|
|
"name": "is_active",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Filter by sector. (provider: fmp)",
|
|
"name": "sector",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filter by industry. (provider: fmp)",
|
|
"name": "industry",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filter by country, as a two-letter country code. (provider: fmp)",
|
|
"name": "country",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Filter by exchange. (provider: fmp)",
|
|
"name": "exchange",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Limit the number of results to return. (provider: fmp)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Search for stock symbol, CIK, LEI, or company name.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/search",
|
|
"id": "EQUITY.SEARCH",
|
|
"name": "EQUITY.SEARCH",
|
|
"parameters": [
|
|
{
|
|
"description": "Search query.",
|
|
"name": "query",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether to search by ticker symbol.",
|
|
"name": "is_symbol",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Whether to use the cache or not.",
|
|
"name": "use_cache",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Options: intrinio, sec, defaults to intrinio.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. (provider: intrinio)",
|
|
"name": "active",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. (provider: intrinio)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Whether to direct the search to the list of mutual funds and ETFs. (provider: sec)",
|
|
"name": "is_fund",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get reported Fail-to-deliver (FTD) data.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/equity/shorts/fails_to_deliver",
|
|
"id": "EQUITY.SHORTS.FAILS_TO_DELIVER",
|
|
"name": "EQUITY.SHORTS.FAILS_TO_DELIVER",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: sec, defaults to sec.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Limit the number of reports to parse, from most recent.\nApproximately 24 reports per year, going back to 2009.\n(provider: sec)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Skip N number of reports from current. A value of 1 will skip the most recent report.\n(provider: sec)",
|
|
"name": "skip_reports",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "ETF Country weighting.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/etf/countries",
|
|
"id": "ETF.COUNTRIES",
|
|
"name": "ETF.COUNTRIES",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the exposure to ETFs for a specific stock.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/etf/equity_exposure",
|
|
"id": "ETF.EQUITY_EXPOSURE",
|
|
"name": "ETF.EQUITY_EXPOSURE",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the holdings for an individual ETF.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/etf/holdings",
|
|
"id": "ETF.HOLDINGS",
|
|
"name": "ETF.HOLDINGS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. (ETF)",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, sec, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF. (provider: fmp);\nA specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The CIK of the filing entity. Overrides symbol. (provider: fmp)",
|
|
"name": "cik",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether or not to use cache for the request. (provider: sec)",
|
|
"name": "use_cache",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Use this function to get the holdings dates, if available.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/etf/holdings_date",
|
|
"id": "ETF.HOLDINGS_DATE",
|
|
"name": "ETF.HOLDINGS_DATE",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. (ETF)",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The CIK of the filing entity. Overrides symbol. (provider: fmp)",
|
|
"name": "cik",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Get the recent price performance of each ticker held in the ETF.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/etf/holdings_performance",
|
|
"id": "ETF.HOLDINGS_PERFORMANCE",
|
|
"name": "ETF.HOLDINGS_PERFORMANCE",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "ETF Information Overview.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/etf/info",
|
|
"id": "ETF.INFO",
|
|
"name": "ETF.INFO",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Price performance as a return, over different periods. This is a proxy for `equity.price.performance`.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/etf/price_performance",
|
|
"id": "ETF.PRICE_PERFORMANCE",
|
|
"name": "ETF.PRICE_PERFORMANCE",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Search for ETFs.\n\nAn empty query returns the full list of ETFs from the provider.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/etf/search",
|
|
"id": "ETF.SEARCH",
|
|
"name": "ETF.SEARCH",
|
|
"parameters": [
|
|
{
|
|
"description": "Search query.",
|
|
"name": "query",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The exchange code the ETF trades on. (provider: fmp)",
|
|
"name": "exchange",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether the ETF is actively trading. (provider: fmp)",
|
|
"name": "is_active",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "ETF Sector weighting.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/etf/sectors",
|
|
"id": "ETF.SECTORS",
|
|
"name": "ETF.SECTORS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. (ETF)",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Commercial Paper.\n\nCommercial paper (CP) consists of short-term, promissory notes issued primarily by corporations.\nMaturities range up to 270 days but average about 30 days.\nMany companies use CP to raise cash needed for current transactions,\nand many find it to be a lower-cost alternative to bank loans.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/corporate/commercial_paper",
|
|
"id": "FIXEDINCOME.CORPORATE.COMMERCIAL_PAPER",
|
|
"name": "FIXEDINCOME.CORPORATE.COMMERCIAL_PAPER",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The maturity.",
|
|
"name": "maturity",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The category.",
|
|
"name": "category",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The grade.",
|
|
"name": "grade",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "High Quality Market Corporate Bond.\n\nThe HQM yield curve represents the high quality corporate bond market, i.e.,\ncorporate bonds rated AAA, AA, or A. The HQM curve contains two regression terms.\nThese terms are adjustment factors that blend AAA, AA, and A bonds into a single HQM yield curve\nthat is the market-weighted average (MWA) quality of high quality bonds.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/corporate/hqm",
|
|
"id": "FIXEDINCOME.CORPORATE.HQM",
|
|
"name": "FIXEDINCOME.CORPORATE.HQM",
|
|
"parameters": [
|
|
{
|
|
"description": "A specific date to get data for.",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The yield curve type.",
|
|
"name": "yield_curve",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "ICE BofA US Corporate Bond Indices.\n\nThe ICE BofA US Corporate Index tracks the performance of US dollar denominated investment grade corporate debt\npublicly issued in the US domestic market. Qualifying securities must have an investment grade rating (based on an\naverage of Moody\u2019s, S&P and Fitch), at least 18 months to final maturity at the time of issuance, at least one year\nremaining term to final maturity as of the rebalance date, a fixed coupon schedule and a minimum amount\noutstanding of $250 million. The ICE BofA US Corporate Index is a component of the US Corporate Master Index.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/corporate/ice_bofa",
|
|
"id": "FIXEDINCOME.CORPORATE.ICE_BOFA",
|
|
"name": "FIXEDINCOME.CORPORATE.ICE_BOFA",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The type of series.",
|
|
"name": "index_type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The type of category. (provider: fred)",
|
|
"name": "category",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The type of area. (provider: fred)",
|
|
"name": "area",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The type of grade. (provider: fred)",
|
|
"name": "grade",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether to include options in the results. (provider: fred)",
|
|
"name": "options",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Moody Corporate Bond Index.\n\nMoody's Aaa and Baa are investment bonds that acts as an index of\nthe performance of all bonds given an Aaa or Baa rating by Moody's Investors Service respectively.\nThese corporate bonds often are used in macroeconomics as an alternative to the federal ten-year\nTreasury Bill as an indicator of the interest rate.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/corporate/moody",
|
|
"id": "FIXEDINCOME.CORPORATE.MOODY",
|
|
"name": "FIXEDINCOME.CORPORATE.MOODY",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The type of series.",
|
|
"name": "index_type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The type of spread. (provider: fred)",
|
|
"name": "spread",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Spot Rates.\n\nThe spot rates for any maturity is the yield on a bond that provides a single payment at that maturity.\nThis is a zero coupon bond.\nBecause each spot rate pertains to a single cashflow, it is the relevant interest rate\nconcept for discounting a pension liability at the same maturity.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/corporate/spot_rates",
|
|
"id": "FIXEDINCOME.CORPORATE.SPOT_RATES",
|
|
"name": "FIXEDINCOME.CORPORATE.SPOT_RATES",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The maturities in years.",
|
|
"dimensionality": "matrix",
|
|
"name": "maturity",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "The category.",
|
|
"dimensionality": "matrix",
|
|
"name": "category",
|
|
"optional": true,
|
|
"type": "any"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Euro Area Yield Curve.\n\nGets euro area yield curve data from ECB.\n\nThe graphic depiction of the relationship between the yield on bonds of the same credit quality but different\nmaturities is known as the yield curve. In the past, most market participants have constructed yield curves from\nthe observations of prices and yields in the Treasury market. Two reasons account for this tendency. First,\nTreasury securities are viewed as free of default risk, and differences in creditworthiness do not affect yield\nestimates. Second, as the most active bond market, the Treasury market offers the fewest problems of illiquidity\nor infrequent trading. The key function of the Treasury yield curve is to serve as a benchmark for pricing bonds\nand setting yields in other sectors of the debt market.\n\nIt is clear that the market\u2019s expectations of future rate changes are one important determinant of the\nyield-curve shape. For example, a steeply upward-sloping curve may indicate market expectations of near-term Fed\ntightening or of rising inflation. However, it may be too restrictive to assume that the yield differences across\nbonds with different maturities only reflect the market\u2019s rate expectations. The well-known pure expectations\nhypothesis has such an extreme implication. The pure expectations hypothesis asserts that all government bonds\nhave the same near-term expected return (as the nominally riskless short-term bond) because the return-seeking\nactivity of risk-neutral traders removes all expected return differentials across bonds.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/government/eu_yield_curve",
|
|
"id": "FIXEDINCOME.GOVERNMENT.EU_YIELD_CURVE",
|
|
"name": "FIXEDINCOME.GOVERNMENT.EU_YIELD_CURVE",
|
|
"parameters": [
|
|
{
|
|
"description": "A specific date to get data for.",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: ecb, defaults to ecb.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The rating type, either 'aaa' or 'all_ratings'. (provider: ecb)",
|
|
"name": "rating",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The yield curve type. (provider: ecb)",
|
|
"name": "yield_curve_type",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Government Treasury Rates.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/government/treasury_rates",
|
|
"id": "FIXEDINCOME.GOVERNMENT.TREASURY_RATES",
|
|
"name": "FIXEDINCOME.GOVERNMENT.TREASURY_RATES",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: federal_reserve, fmp, defaults to federal_reserve.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "US Yield Curve. Get United States yield curve.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/government/us_yield_curve",
|
|
"id": "FIXEDINCOME.GOVERNMENT.US_YIELD_CURVE",
|
|
"name": "FIXEDINCOME.GOVERNMENT.US_YIELD_CURVE",
|
|
"parameters": [
|
|
{
|
|
"description": "A specific date to get data for. Defaults to the most recent FRED entry.",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Get inflation adjusted rates.",
|
|
"name": "inflation_adjusted",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/ameribor",
|
|
"id": "FIXEDINCOME.RATE.AMERIBOR",
|
|
"name": "FIXEDINCOME.RATE.AMERIBOR",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of AMERIBOR rate. (provider: fred)",
|
|
"name": "parameter",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/dpcredit",
|
|
"id": "FIXEDINCOME.RATE.DPCREDIT",
|
|
"name": "FIXEDINCOME.RATE.DPCREDIT",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "FRED series ID of DWPCR data. (provider: fred)",
|
|
"name": "parameter",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/ecb",
|
|
"id": "FIXEDINCOME.RATE.ECB",
|
|
"name": "FIXEDINCOME.RATE.ECB",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The type of interest rate.",
|
|
"name": "interest_rate_type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/effr",
|
|
"id": "FIXEDINCOME.RATE.EFFR",
|
|
"name": "FIXEDINCOME.RATE.EFFR",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: federal_reserve, fred, defaults to federal_reserve.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of FED rate. (provider: fred)",
|
|
"name": "parameter",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/effr_forecast",
|
|
"id": "FIXEDINCOME.RATE.EFFR_FORECAST",
|
|
"name": "FIXEDINCOME.RATE.EFFR_FORECAST",
|
|
"parameters": [
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Flag to show long run projections (provider: fred)",
|
|
"name": "long_run",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/estr",
|
|
"id": "FIXEDINCOME.RATE.ESTR",
|
|
"name": "FIXEDINCOME.RATE.ESTR",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of ESTR rate. (provider: fred)",
|
|
"name": "parameter",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/iorb",
|
|
"id": "FIXEDINCOME.RATE.IORB",
|
|
"name": "FIXEDINCOME.RATE.IORB",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/sonia",
|
|
"id": "FIXEDINCOME.RATE.SONIA",
|
|
"name": "FIXEDINCOME.RATE.SONIA",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of SONIA rate. (provider: fred)",
|
|
"name": "parameter",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Secured Overnight Financing Rate.\n\nThe Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of\nborrowing cash overnight collateralizing by Treasury securities.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/sofr",
|
|
"id": "FIXEDINCOME.SOFR",
|
|
"name": "FIXEDINCOME.SOFR",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Period of SOFR rate. (provider: fred)",
|
|
"name": "period",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Treasury Constant Maturity.\n\nGet data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/spreads/tcm",
|
|
"id": "FIXEDINCOME.SPREADS.TCM",
|
|
"name": "FIXEDINCOME.SPREADS.TCM",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The maturity",
|
|
"name": "maturity",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Select Treasury Constant Maturity.\n\nGet data for Selected Treasury Constant Maturity Minus Federal Funds Rate\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/spreads/tcm_effr",
|
|
"id": "FIXEDINCOME.SPREADS.TCM_EFFR",
|
|
"name": "FIXEDINCOME.SPREADS.TCM_EFFR",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The maturity",
|
|
"name": "maturity",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/spreads/treasury_effr",
|
|
"id": "FIXEDINCOME.SPREADS.TREASURY_EFFR",
|
|
"name": "FIXEDINCOME.SPREADS.TREASURY_EFFR",
|
|
"parameters": [
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The maturity",
|
|
"name": "maturity",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fred, defaults to fred.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "All indices available from a given provider.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/index/available",
|
|
"id": "INDEX.AVAILABLE",
|
|
"name": "INDEX.AVAILABLE",
|
|
"parameters": [
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Index Constituents.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/index/constituents",
|
|
"id": "INDEX.CONSTITUENTS",
|
|
"name": "INDEX.CONSTITUENTS",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Historical Market Indices.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/index/market",
|
|
"id": "INDEX.MARKET",
|
|
"name": "INDEX.MARKET",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, polygon, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Number of days to look back. (provider: fmp)",
|
|
"name": "timeseries",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Data granularity. (provider: fmp)",
|
|
"name": "interval",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Sort the data in ascending or descending order. (provider: fmp);\nSort order. (provider: intrinio);\nSort order of the data. (provider: polygon)",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Index tag. (provider: intrinio)",
|
|
"name": "tag",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Index type. (provider: intrinio)",
|
|
"name": "type",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return. (provider: intrinio, polygon)",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)",
|
|
"name": "sleep",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Timespan of the data. (provider: polygon)",
|
|
"name": "timespan",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether the data is adjusted. (provider: polygon)",
|
|
"name": "adjusted",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Multiplier of the timespan. (provider: polygon)",
|
|
"name": "multiplier",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Historical Index Levels.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/index/price/historical",
|
|
"id": "INDEX.PRICE.HISTORICAL",
|
|
"name": "INDEX.PRICE.HISTORICAL",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio, polygon.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Time interval of the data to return.",
|
|
"name": "interval",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Sort the data in ascending or descending order.",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: fmp, intrinio, polygon, defaults to fmp.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Number of days to look back. (provider: fmp)",
|
|
"name": "timeseries",
|
|
"optional": true,
|
|
"type": "number"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Company News. Get news for one or more companies.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/news/company",
|
|
"id": "NEWS.COMPANY",
|
|
"name": "NEWS.COMPANY",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo.",
|
|
"name": "symbol",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The number of data entries to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Options: benzinga, fmp, intrinio, polygon, tiingo, defaults to benzinga.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "A specific date to get data for. (provider: benzinga)",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)",
|
|
"name": "display",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Number of seconds since the news was updated. (provider: benzinga)",
|
|
"name": "updated_since",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Number of seconds since the news was published. (provider: benzinga)",
|
|
"name": "published_since",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Key to sort the news by. (provider: benzinga)",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Order to sort the news by. (provider: benzinga);\nSort order of the articles. (provider: polygon)",
|
|
"name": "order",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The company's ISIN. (provider: benzinga)",
|
|
"name": "isin",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The company's CUSIP. (provider: benzinga)",
|
|
"name": "cusip",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Channels of the news to retrieve. (provider: benzinga)",
|
|
"name": "channels",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Topics of the news to retrieve. (provider: benzinga)",
|
|
"name": "topics",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Authors of the news to retrieve. (provider: benzinga)",
|
|
"name": "authors",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Content types of the news to retrieve. (provider: benzinga)",
|
|
"name": "content_types",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Page number of the results. Use in combination with limit. (provider: fmp)",
|
|
"name": "page",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Page offset, used in conjunction with limit. (provider: tiingo)",
|
|
"name": "offset",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "A comma-separated list of the domains requested. (provider: tiingo)",
|
|
"name": "source",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "World News. Global news data.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/news/world",
|
|
"id": "NEWS.WORLD",
|
|
"name": "NEWS.WORLD",
|
|
"parameters": [
|
|
{
|
|
"description": "The number of data entries to return. The number of articles to return.",
|
|
"name": "limit",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Start date of the data, in YYYY-MM-DD format.",
|
|
"name": "start_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "End date of the data, in YYYY-MM-DD format.",
|
|
"name": "end_date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: benzinga, fmp, intrinio, tiingo, defaults to benzinga.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "A specific date to get data for. (provider: benzinga)",
|
|
"name": "date",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)",
|
|
"name": "display",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Number of seconds since the news was updated. (provider: benzinga)",
|
|
"name": "updated_since",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Number of seconds since the news was published. (provider: benzinga)",
|
|
"name": "published_since",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "Key to sort the news by. (provider: benzinga)",
|
|
"name": "sort",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Order to sort the news by. (provider: benzinga)",
|
|
"name": "order",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The ISIN of the news to retrieve. (provider: benzinga)",
|
|
"name": "isin",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "The CUSIP of the news to retrieve. (provider: benzinga)",
|
|
"name": "cusip",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Channels of the news to retrieve. (provider: benzinga)",
|
|
"name": "channels",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Topics of the news to retrieve. (provider: benzinga)",
|
|
"name": "topics",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Authors of the news to retrieve. (provider: benzinga)",
|
|
"name": "authors",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Content types of the news to retrieve. (provider: benzinga)",
|
|
"name": "content_types",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Page offset, used in conjunction with limit. (provider: tiingo)",
|
|
"name": "offset",
|
|
"optional": true,
|
|
"type": "number"
|
|
},
|
|
{
|
|
"description": "A comma-separated list of the domains requested. (provider: tiingo)",
|
|
"name": "source",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Map a ticker symbol to a CIK number.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/cik_map",
|
|
"id": "REGULATORS.SEC.CIK_MAP",
|
|
"name": "REGULATORS.SEC.CIK_MAP",
|
|
"parameters": [
|
|
{
|
|
"description": "Symbol to get data for.",
|
|
"name": "symbol",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Options: sec, defaults to sec.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Search SEC-regulated institutions by name and return a list of results with CIK numbers.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/institutions_search",
|
|
"id": "REGULATORS.SEC.INSTITUTIONS_SEARCH",
|
|
"name": "REGULATORS.SEC.INSTITUTIONS_SEARCH",
|
|
"parameters": [
|
|
{
|
|
"description": "Search query.",
|
|
"name": "query",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether or not to use cache. If True, cache will store for seven days.",
|
|
"name": "use_cache",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Options: sec, defaults to sec.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "The RSS feed provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/rss_litigation",
|
|
"id": "REGULATORS.SEC.RSS_LITIGATION",
|
|
"name": "REGULATORS.SEC.RSS_LITIGATION",
|
|
"parameters": [
|
|
{
|
|
"description": "Options: sec, defaults to sec.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "A tool for navigating the directory of SEC XML schema files by year.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/schema_files",
|
|
"id": "REGULATORS.SEC.SCHEMA_FILES",
|
|
"name": "REGULATORS.SEC.SCHEMA_FILES",
|
|
"parameters": [
|
|
{
|
|
"description": "Search query.",
|
|
"name": "query",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether or not to use cache. If True, cache will store for seven days.",
|
|
"name": "use_cache",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Options: sec, defaults to sec.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Enter an optional URL path to fetch the next level. (provider: sec)",
|
|
"name": "url",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Search for Industry Titles, Reporting Office, and SIC Codes. An empty query string returns all results.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/sic_search",
|
|
"id": "REGULATORS.SEC.SIC_SEARCH",
|
|
"name": "REGULATORS.SEC.SIC_SEARCH",
|
|
"parameters": [
|
|
{
|
|
"description": "Search query.",
|
|
"name": "query",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether or not to use cache. If True, cache will store for seven days.",
|
|
"name": "use_cache",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Options: sec, defaults to sec.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
},
|
|
{
|
|
"description": "Map a CIK number to a ticker symbol, leading 0s can be omitted or included.",
|
|
"helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/symbol_map",
|
|
"id": "REGULATORS.SEC.SYMBOL_MAP",
|
|
"name": "REGULATORS.SEC.SYMBOL_MAP",
|
|
"parameters": [
|
|
{
|
|
"description": "Search query.",
|
|
"name": "query",
|
|
"optional": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Whether or not to use cache. If True, cache will store for seven days.",
|
|
"name": "use_cache",
|
|
"optional": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"description": "Options: sec, defaults to sec.",
|
|
"name": "provider",
|
|
"optional": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"result": {
|
|
"dimensionality": "matrix"
|
|
}
|
|
}
|
|
]
|
|
} |