From b9c866c756b984eff68a89568ec963f7392ae651 Mon Sep 17 00:00:00 2001 From: Henrique Joaquim Date: Wed, 19 Jun 2024 10:10:48 +0100 Subject: [PATCH] Merge `main` with `develop` (#6515) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * add snowflake integration video (#6339) * [HotFix] Fix broken URLs in docs page. (#6368) * Fix broken URLs * use full URL to other docs pages. * [Release] 4.2.0 (#6422) * [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 * 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 * 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 * [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 * update functions.json (#6140) * fix intraday check in charting ta_class (#6119) Co-authored-by: Henrique Joaquim * [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 * [BugFix] Fix SEC ETF Holdings Parsing Exception (#6121) * fix etf holdings * linting * black --------- Co-authored-by: James Maslek * Docs/update xl docs (#6145) * remove print * update obb.get docs * example * md lint * fix get reference (#6147) * [BugFix] Filter OECD data using `start_date` and `end_date` parameters (#6144) * move constant dicts to constants.py filter by start_date and end_date * black * black again again * Merge 'main' into 'develop' (#6151) * Release/3.2.4 (#5696) * test * ultima description (#5541) * Updating showcase page (#5543) * updating showcase page * use sdk instead * add new bot command autopost docs (#5530) add new bot command autopost docs to docs.openbb.co Co-authored-by: James Maslek * Hotfix/ultima improvements (#5553) * tweaks for monetization * fix linting issue * fix: Modify 'load' behavior to append data to existing sheet (#5503) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Fixed 'worksheet not found' error during export to an existing sheet * Changes: * Now if the sheet exists in the xlsx file it will ask the user if he wants to replace/append/create new sheet --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * added platform API integration test to Nightly build (#5571) * Add columns to `stocks/search` (#5565) * Add columns to `stocks/search` isin, cusip, figi, composite_figi, shareclass_figi * Update test_search[False].txt * Update test_search[True].txt * Delete tests/openbb_terminal/stocks/cassettes/test_stocks_helper/test_search.yaml * Create test_search.yaml --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * updating ultima urls (#5587) * fix: A value is trying to be set on a copy of a slice from a DataFrame #5582 (#5591) * Update README.md (#5598) * Hotfix/econometrics export filename fix (#5508) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Added --export option for exporting to a desired file in /econometrics menu * Added a -f/--file option to provide the filename for export. Made -t/--type and -f/--file mutually exclusive. If -f is not given, -t is required and the filename will be generated based on the time and module. * Revert `helper_funcs.py` to original state * Made some arguments not required. * Minor changes asked by @deeleeramone * No sheet name * black --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * FIX #5600 Updated the Twitter logo to X logo (#5601) * Change Ultima paragraph (#5624) * change ultima paragraph * remove old paragraph * Update CONTRIBUTING.md (#5623) * mobile line-brake fixed (#5604) In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments. Co-authored-by: James Maslek * Docs/terminalpro and improvement (#5622) * add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich * Add light blue banner, blue when clicking sidebar + fix link in docusaurus.config.js (#5627) * typo * pro docs tab coloring * sidebar selection blue * redirecting missing * fix docs (#5646) * Fix the redirect for intro to the correct url for docs (#5658) * fix the redirect for intro to the correct url for docs * fix code linting --------- Co-authored-by: James Maslek * Improve Pro documentation further (#5641) * small improvement * Fix TutorialVideo for mobile view * main page terminal pro docs * jose whelp * placeholder index file that needs to be removed * fix: fixes sidebar, removes unused index.md * update link to api keys * update api keys link * fix hyperlinks in terminal helper * fix a few more links * fix some more links * linter * black linter * improve main docs page for each product * small refactor * header to take to main page of product * run OpenAI script to generate SEO for pro content --------- Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> * Update folders.md * Update integrate-your-own-backend.md * Update index.md * Update settings.md (#5665) * fix front matter (#5667) * #5633 adding comma every 1000 (#5652) * #5633 adding comma every 1000 * pylint --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Hotfix/reports model render report sanitize inputs (#5669) * Adding more robust special character handling to create_output_path(). Addresses https://github.com/OpenBB-finance/OpenBBTerminal/issues/5299 * Running black linter on code to conform to OBB style guides. --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * hotfix/fix-gov-histcont: Fix #5650 - /stocks/gov/histcont (#5676) * fix histcont * some cleanup * remove sort line * 12-31 not 12-12 * columns_keep_types * remove space in regex (#5675) * Pin openai (#5685) * Clarified stocks/ta empty recom object message (#5468) * Clarified stocks/ta empty recom object message * black * lint --------- Co-authored-by: James Maslek * improved market cap value extraction (#5169) * improved market cap value extraction * pylint --------- Co-authored-by: James Maslek * 3.2.3->3.2.4 * Changelogs * new changelog --------- Co-authored-by: Henrique Joaquim Co-authored-by: Andrew Co-authored-by: Adi Sai Co-authored-by: Sandip Saha Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Luqman 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: DidierRLopes 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 Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: Mohamad Fadil Co-authored-by: Ramazan Co-authored-by: joshuabuildsthings Co-authored-by: wojda <114031148+polooner@users.noreply.github.com> Co-authored-by: Bim Phomthong <118195204+bimbolimbo@users.noreply.github.com> * Release/4.0.1 (#5840) * test * ultima description (#5541) * Updating showcase page (#5543) * updating showcase page * use sdk instead * add new bot command autopost docs (#5530) add new bot command autopost docs to docs.openbb.co Co-authored-by: James Maslek * Hotfix/ultima improvements (#5553) * tweaks for monetization * fix linting issue * fix: Modify 'load' behavior to append data to existing sheet (#5503) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Fixed 'worksheet not found' error during export to an existing sheet * Changes: * Now if the sheet exists in the xlsx file it will ask the user if he wants to replace/append/create new sheet --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * added platform API integration test to Nightly build (#5571) * Add columns to `stocks/search` (#5565) * Add columns to `stocks/search` isin, cusip, figi, composite_figi, shareclass_figi * Update test_search[False].txt * Update test_search[True].txt * Delete tests/openbb_terminal/stocks/cassettes/test_stocks_helper/test_search.yaml * Create test_search.yaml --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * updating ultima urls (#5587) * fix: A value is trying to be set on a copy of a slice from a DataFrame #5582 (#5591) * Update README.md (#5598) * Hotfix/econometrics export filename fix (#5508) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Added --export option for exporting to a desired file in /econometrics menu * Added a -f/--file option to provide the filename for export. Made -t/--type and -f/--file mutually exclusive. If -f is not given, -t is required and the filename will be generated based on the time and module. * Revert `helper_funcs.py` to original state * Made some arguments not required. * Minor changes asked by @deeleeramone * No sheet name * black --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * FIX #5600 Updated the Twitter logo to X logo (#5601) * Change Ultima paragraph (#5624) * change ultima paragraph * remove old paragraph * Update CONTRIBUTING.md (#5623) * mobile line-brake fixed (#5604) In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments. Co-authored-by: James Maslek * Docs/terminalpro and improvement (#5622) * add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich * Add light blue banner, blue when clicking sidebar + fix link in docusaurus.config.js (#5627) * typo * pro docs tab coloring * sidebar selection blue * redirecting missing * fix docs (#5646) * Fix the redirect for intro to the correct url for docs (#5658) * fix the redirect for intro to the correct url for docs * fix code linting --------- Co-authored-by: James Maslek * Improve Pro documentation further (#5641) * small improvement * Fix TutorialVideo for mobile view * main page terminal pro docs * jose whelp * placeholder index file that needs to be removed * fix: fixes sidebar, removes unused index.md * update link to api keys * update api keys link * fix hyperlinks in terminal helper * fix a few more links * fix some more links * linter * black linter * improve main docs page for each product * small refactor * header to take to main page of product * run OpenAI script to generate SEO for pro content --------- Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> * Update folders.md * Update integrate-your-own-backend.md * Update index.md * Update settings.md (#5665) * fix front matter (#5667) * #5633 adding comma every 1000 (#5652) * #5633 adding comma every 1000 * pylint --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Hotfix/reports model render report sanitize inputs (#5669) * Adding more robust special character handling to create_output_path(). Addresses https://github.com/OpenBB-finance/OpenBBTerminal/issues/5299 * Running black linter on code to conform to OBB style guides. --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * hotfix/fix-gov-histcont: Fix #5650 - /stocks/gov/histcont (#5676) * fix histcont * some cleanup * remove sort line * 12-31 not 12-12 * columns_keep_types * remove space in regex (#5675) * Pin openai (#5685) * Clarified stocks/ta empty recom object message (#5468) * Clarified stocks/ta empty recom object message * black * lint --------- Co-authored-by: James Maslek * improved market cap value extraction (#5169) * improved market cap value extraction * pylint --------- Co-authored-by: James Maslek * Release/3.2.4 (#5704) * 3.2.3->3.2.4 * Changelogs * new changelog * OpenBB Platform v4 (#5225) * change location * check something * add cache * fixed auth w/@IgorWounds and @montezdesousa * fixes for econometrics * include Darren auth suggestions * some routers included if dev + chg hub backend var * coverage router should not be here * update docker readme * forgot to check auth here * Change extension imports * update docstrings and readme * headers function wasnt being called, just referenced * relative import * econometrics add headers everywhere * Fix QA * Fix TA * Fix test * Fix python interface QA and TA * Lint * Cleanup * Change path * make the changes and some etf models * tests for command_runner * ruff * solving naming issues on pytest * Update some docstrings, fix typos and lint * solving econometrics instantiating wrong openbb * chaging the way pytest runs * messing around with the imports * ruff * Change template to add platform considerations (#5533) * change template to add platform considerations * @the-praxs suggestions * solving __pycache__ issue * removing typo * ci yml * making linters happy (i guess) * Improve Omega Ratio and docstrings * chaging pro validation hash * ruff * Fix OLS Summary and lint * Add OECD Provider for economy extension (#5534) * Add record to docs * update a couple of cboe models * Fix econometrics bugs. Make tests pass. Lint. * black * ruff * pydantic v2: remove deprecated Extra * pydantic v2: self.dict -> self.model_dump * revert pydantic * revert the revert * try 1: pin urllib3 < 2 * Revert "try 1: pin urllib3 < 2" This reverts commit 3736c311cb6aa9e653dcb5db733798408b72a82e. * Revert dep * Fix * re-lock * Skip all tests when doing cspell in pre-commit * Resolve linter errors * Add OECD to install script * Add OECD * Resolve more linter errors * Exclude static files of v4 python from ruff * More linting * Another attempt to resolve even more linting errors * Change how Literal is used * ticker. symbol. consistent. @piiq * change ticker field in Stock Search to is_symbol * Update Cboe model for stocks_search -> is_symbol parameter. * Fix issue * Lint * Small QA to rename SDK to Platform (#5544) * SDK -> Platform in docs * renamed in core * renamed in openbb `init` * `sdk` variable renamed as `platform` --------- Co-authored-by: hjoaquim * `validator` -> `field_validator` in standard models * Standard convention for multi-ticker symbols (#5549) * standardize symbol input param in forex and crypto historical data * static * linting * Fix stock_search integration test params * Update dependencies and linting on the CI (#5550) * Remove ruff and black from platform dependencies * Update codespell configuration * Lint python code * Add toml and tomli to root dev dependencies * Update requirements.txt files * Fix buggy docstring in python package methods (#5548) * fix buggy docstring for methods * remove space * fix typing * avoid name collision with validator * Revert "avoid name collision with validator" This reverts commit 8a30a44555d97132f6bddcbc4a4facdd97ecc591. * typing * rebuild * python 3.8, ParamSpec not available * lint * ruff noqa * Merge with develop (#5551) * Charting extension integration tests (#5547) * initial proposal for integration tests on the charting extension * int tests for charting generation * python generator * ruff * boilerplate templates * python tests * tests for the api * using body instead so data don't get redefined * unit tests for coverage * ruff * docstrings * unnecessary access to keys() * Add trading economics economic calendar * dev install * Data Models disposition on the website (#5538) * pydantic v4 * flat structure * md files * Revert "md files" This reverts commit bd2170e2adf82fed3a35d34fad6a2e3ba3ae1d49. * improve command descriptions * nice title and description * human readble data model names on left panel * implementation details section * content markdown files * markdown versioned files * showcase page * updates --------- Co-authored-by: tehcoderer * everything except tests * fix `datetime.date` import in fetcher test * modified url to remove `api_key` placeholder * record test * api key is called c here * fixed fetcher test for api key * recorded tests * refactor * life is ruff * codespell * Make Intrinio options chains great again (#5540) * add multithreading * cleanup * linting * use dateutil.parser * removed `TICKER_EXCEPTIONS` * modified `date` and `type` fields in standard model * set alias for `date` and `type` to match standards * static * static * Hotfix/fix post tests (#5555) * Fix econometrics * Fix ta * Fix qa. Remove intrinio to not be rate limited * Lint * Fix typo * obbject tests (#5558) * obbject tests * ruff * fix dev_install * fix unittests * black on nox * black on nox * nox * fix fetcher test so it can compare dates * fix intrinio tests * ruff * change to model_dum() instead (#5561) * Passing tests (#5560) * Passing tests * fix options * Fix most tests and bugs * fix forex missing params * make symbol upper in polygon fx pairs * fix fixedincome integration tests (#5564) * Fixing charting api integration tests (#5562) * fixing charting api integration tests * black * fix stocks less five API fails * fix the 5 failing stocks integration tests * recapture fmp stock news unit test * fix fmp forex api test * couple more forex integration fixes * changing the request to always use the legacy session. @jmaslek this is was broken for 3.8 and 3.9; with this change apparently all versions work - lemme know if you see any issue with this change * ruff * fix ta * add missing param * fix testers for the api * fix globalnews to use images instead of image * remove unncessary pandas import * econcal int tests * update gitignore * fix get_querystring to support lists * add missing parameters --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Henrique Joaquim * Stock Historical standardization and UX improvements (#5457) * polygon add interval standard param * attempt at standardization * Alpha Vantage params standardization * rename `get_intervals` and fixed bug for extracting wrong value * missed changing it in `extract_data` * linting * polygon cleanup * modified `start_date` & `end_date` type to `datetime` from `dateType` * standardized intrinio stock historical params * fixed yfinance * linting * revert start and end date to dateType from datetime * fix alpha vantage * changed param * fix intrinio infinite loop * `validator` is `field_validator` * revert time params and fixed intervals * `outputsize` alias set in `Field` * set interval description using in-build dict * yfinance stock param standardization * static * intrinio cleanup * Polygon add api params as `PrivateAttr` * modified yfinance params to `PrivateAttr` * intrinio remove overriding date params * fixed description for AV adjusted param * fix alpha vantage intraday not working * re-record and pass unit tests * pass integration tests * Update test --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Fix econcal endpoint (#5567) * fix econcal for python interface * fix econcal tests * fix non supported json output * Fixes FMP index endpoint to get 1 day interval data (#5535) * fix FMP endpoint for getting index data for `1day` interval * fix `open` type to prevent validation error * modifed `validator` to `field_validator` * type of fields is `StrictFloat` * re-record and pass test * linting * `validator` -> `field_validator`, a3'd everything * Fix regression in tests. Lint * updating the integration test actions * Fix typo * Fix typo * Fix import * Publish versions `a3` to Pypi (#5568) * bump versions and script to publish * small improvements * uncomment exception * openbb * publishing guidelines * improve docs * add providers to economy api * make symbol required in stock_quote * Fix keys * Fix oecd * add comma * revert * Add quotes * Sleep * Improve tests * Improve * Feature/query transform (#5566) * inject query into transform_data * swap query and data * update missing fetchers * last test failing * sig test fetcher * black * av add `query` to `transform_data` call * transform_data: missing refactoring * fix uvicorn command in the doc * Automated examples (#5576) * Automated examples * Fix bug * Lint * static assets built on 3.8 * Revert "static assets built on 3.8" This reverts commit fb82ff7bd9af92ed676d8f8047c31e74daf7b8b2. * remove assets * static assets on 3.8 * static assets on 3.8 * Wrap in quotes * Improve wrap * minor fix * rebuild 3.8 * Fix bug * Fix edge case * Lint * rebuild --------- Co-authored-by: hjoaquim Co-authored-by: Diogo Sousa * use SecretStr for sensitive fields (#5578) * use SecretStr for sensitive fields * fix * docstring * Add tests for provider (#5583) * Add tests for provider * Test standard models * Lint * Fix standard model issues. Co-authored-by: @the-praxs * linting * `symbol` -> `is_symbol` in `economy.index_search` * static --------- Co-authored-by: Pratyush Shukla * feature/v4-biztoc-provider: Adds Biztoc provider and GlobalNews (#5546) * add biztoc provider * duplicate field * black * request headers * recapture test * move stuff around * add integration tests * duplicate OECD entry in dev_install * duplicate entry for oecd in pyproject.toml * Add Biztoc to workflow * update readme: credentials * Add Preferences to README * improve tests * fix biztoc * obbject pylint * Bug fix: serializ SecretStr before dumping to json * export credentials as json (#5592) * Check for wrong, changed, or outdated params. (#5597) * Improving `economy.cpi` for the FRED data (#5602) * remove multiindex using coding magic * Update field descriptions --------- Co-authored-by: Theodore Aptekarev * Improve error message. * Improve * Test tests (#5607) * Test tests * Add test * 4.0.0a4 PyPI publishing (#5608) * changes to publish * fix mini conflict * typo * cleaned `descriptions.py` * fix description in `cpi.py` * Add ETF extension to v4 (#5609) * Add etf extension with search data model * Add FMP ETF search * Add fetcher tests * Add ETF historical price from yfinance (#5610) * Add etf extension with search data model * Add FMP ETF search * Add fetcher tests * Add etf historical price standard model and route * Add etf historical data from yfinance * Add unit tests * Fix linter error. Organize imports * Update test data * Revert common descriptions erased by CPI PR * remove `symbol` from data for `stocks.ca.peers` * Test docstrings (#5613) * Test docstrings * fix minor bugs w/@IgorWounds * static only w/@IgorWounds * fix `importance` param in `economy.econcal` * right static only w/@IgorWounds * Fix econcal and add tests to noxfile * fix econcal static * re-record --------- Co-authored-by: Pratyush Shukla * Clean up the newly created ETF extension (#5611) * Add ETF to dev_install bundle * Add integration tests for openbb-etf * Patch integration test generator scripts to produce lintable code * Add py.typed markers for extensions * user preferences descriptions (#5593) * user preferences descriptions * typo * Feature/v4-sec-provider: Add SEC provider to V4 (#5556) * coerce string type, add default=None * add sec provider and FTD function * update description * ruff * data model definitions in standard model already * duplicate oecd entries in dev_install and pyproject * actually commit * integration test * add stock search to SEC * add company filings for SEC provider * integration tests * remove duplicated line * ruff * **kwargs in Transform Data * some helper functions for later * black * add helper for mutual fund and etf lookup * add some SEC lookup helpers to a new regulators extension * black * ruff * fix test param * take institution filter out of sec stock_search * ruff * remove URL that codespell doesn't like * add cik-to-ticker map * add litigations rss feed * make openbb-regulators a dependency of openbb-sec * add SIC search * improve ftd and remove BeautifulSoup from SEC dependencies * fix parsing the zip files pre-2009 * ruff * update descriptions * recapture ftd test * tests params * typo * change limit param to 1 in test_sec_stock_ftd * Add didiers to_records method (#5588) * Add didiers to_records * unused import * Bring back polars + do what igor suggested * Make the output consistent with what it was. * Black ? * spelling. oops. almost like we have a pre commit or something * Feature/v4-price-performance: % returns for various horizons, comparable across multiple tickers. (#5618) * coerce string type, add default=None * add price_performance endpoint from FMP * black * extra period in docstring * ruff * forgot one file * Feature/ipo-calendar: V4 IPO Calendar (#5605) * coerce string type, add default=None * add intrinio ipo calendar * fix typo * sort __init__ * fix description * make requested changes * update test params * black * test updates * etf integration * Add disc router and WSJ provider * OBBject extensions (#5612) * changes to core * bug? * docstring * doc * Update credentials.py * fix model_dump * create extensions * fix docstring * doc * revert change query_exc * doc * fix container test * redirect obbject test patch * doc * rename method * move decorator to extension file * rename method extend_obbject * changes in creds model * avoid credential racing * doc * rename prop * doc * doc * remove comment * comment some code * free extension names * docstring * doc * docs * Hotfix/fix-v4-economic-calendar: Add FMP to Econ Calendar and fix some TE bugs (#5580) * coerce string type, add default=None * adds fmp to economic calendar and fixes some things with TE * ruff * etf integration test * missing provider for test * rename te cassette to economic_calendar * fix test * rename tests --------- Co-authored-by: James Maslek * Add stocks disc endpoints (#5630) * Add stocks disc endpoints * Explicit * Lint * Add tests * Bump timeout * Feature/disc router (#5616) * Add disc router and WSJ provider * Lint * Lint * Move endpoints under ETF router * Update etf_performance.py * Add ETF info and sector exposure from FMP (#5620) * Add ETF info from FMP * Add integration tests * Add unit tests * Add etf sectors endpoint * Add etf sectors fmp endpoint * Omit nested sector list from fmp info data * Update tests and test data * Update test data * Specify provider explicitly in integration tests * Update tests * Skip yfinance etf historical test * Fix linter errors after the merge * Fix more linter errors * Fix failing and add missing tests * Fix integration tests * Fix calendar ipo tests * Add ETF holdings and holding report dates from FMP (#5629) * Add ETF info from FMP * Add integration tests * Add unit tests * Add etf sectors endpoint * Add etf sectors fmp endpoint * Omit nested sector list from fmp info data * Update tests and test data * Update test data * Specify provider explicitly in integration tests * Update tests * Skip yfinance etf historical test * Add etf holdings and holdings date routes and standard models * Add fmp holdings and holding dates fetchers * Update holdings fetcher to properly handle date object inputs * Add unit tests * Add integration tests * Black after merge * Fix test input data format * Disc router for equities. (#5640) * Disc router for equities. * add tests * Bug fixes in financial statements (#5537) * `validator` to `field_validator` in standard models * Polygon add `ttm` to `period` param * Revert "Polygon add `ttm` to `period` param" * Polygon add `ttm` to param `period` * `EarningsCallTranscript` standard model removed `quarter` param * use `tag` instead of `name` for correct field name * fix url for intrinio income statement * modified intrinio cash flow `transform_data` function * set optional data fields and validate dates * fix insider trading not fetching recent data * linting * refactoring * refactoring * set param alias in fmp stock insider provider model * get all quarter data for intrinio * add `limit` param to `stocks.fa.ins` * refactoring and linting * removed additional comment * linting * re-recorded and fix tests * cash flow standard model field type to `StrictFloat` * Intrinio cash flow model fixed to get all quarters' data * linting * refactoring * financial statement standard model field type to `StrictFloat` * Intrinio financial statement model get all quarter data * set `period` type to `Optional[str]` * add `period` param to balance sheet provider models * add `period` param to cash flow provider models * use alias in model dump * remove `ttm` from `period` param * revamped intrinio financials * fixed incorrect description for `limit` param * modified tests for `balance`, `cash` and `income` * re-recorded tests * skipped intrinio financial statement fetcher tests * Add ETF county weighting command with FMP data (#5645) * Remove code that wrongfully infers the filing date as end of quarter * Add etf countries command with fmp data * Add countries command to etf router * Update sector and country weighting fmp models * Fix docstring typo * Add unit tests and update mock data * Add integration tests for etf.countries * Bring back missing integration tests * Fix economic calendar integration tests * fix missing data in intrinio financials * removed inutile params from Polygon financial statement models * Intrinio IPO overhaul * tests fixed and re-recorded * Add ETF holdings performance with FMP data (#5659) * Add etf holdings performance endpoint * Add tests * Fix failing polygon fetcher tests * Split long holdings lists into chunks and update test data * Change chunk length to 500 tickers * Add stock search from FMP (#5642) Co-authored-by: Theodore Aptekarev * Feature/v4 pypi (#5579) * improvements to the publish script * move scripts * initial script that builds the package * adjustments on the docs * test pypi workflow * add hour and minute to version * black * ruff * duplicate file * moving files instead * build throught the script instead * update nox file * integration tests workflow * change workflow * fix dev_install * fix in sed cmd * testing the platform only * commenting out the publishing * fix run commands * improvements to the publish script and doc * fix publish script * updating the script and the workflow * feature/v4-pypi nightly (#5589) * init * Update nightly.py * cleanup * init file * not referencing dev_utils * updating obb platform key * revert * Increase warmup time * project name on pyproject and adding the --pre flag on readme * moving to the build folder * fix noxfile * reflecting the moves on the import statements * fix pyproject path * ruff * fix paths * fix super typo * update workflows * moving the pypi terminal files into its folder --------- Co-authored-by: teh_coderer Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Theodore Aptekarev * economy.calendar nasdaq (#5628) * add quandl econcal * unittest * add integration tests * replace   * fix bug TE importance * small fix * remove stuff from quandl * add nasdaq provider * add nasdaq to install files * Update test_economy_api.py * test * quandl leftovers * remove quandl econcal test * lint * replace   * ruff * lint * update nasdaq gmt * validate countries * here * no need for this * fix calendar tests * static * static * remove error * static * readme + website * readme * remove changes TE * typo * fix unittest * fix tests * Update __init__.py * Update economic_calendar.py * revamped model and added helpers for date range --------- Co-authored-by: Pratyush Shukla * Feature/v4-dividend-calendar: Adds Nasdaq dividend calendar and moves the command out of fundamental_analysis (#5672) * add nasdaq dividend calendar and move out of fundamental_analysis * black * ruff * add random-user-agent to pyproject.toml * add nasdaq ipo calendar * add nasdaq flag for SPO to IPO calendar * add spo test param * black * dividend test * fix transform_query - nasdaq_calendar_ipo * bring back different headers for ipo calendar * remove references to test * Add disc endpoints (#5660) * Add Quandl top retail * Add tests * Add Seeking Alpha * Add Filings * Change Provider * Fix test * Add dev_install * static * static correct * y u forget me * updated deps * static --------- Co-authored-by: Pratyush Shukla * using dev install (#5673) * Expanding the `fixedincome` menu (#5655) * models and fetcher * making the fetcher visible * std model * adding the command * improvements to the models * typo * adding the command * imrpovements to dwpcr * standard model for ecb int rates * adding the fetcher for fred * standard model of ice bofa * add ice_bofa command * ruff * ice bofa fetcher * moody std model * moody * std model * add cp command * unused import * cp * spot * ruff * hqm * tmc * ffrmc * tbffr * ruff * typing fixes * buggy dates * fred fetcher tests * ruff * adding ecb as a provider * adding new provider related stuff * adding the new command eu_ycvr * models * test for ecb fetcher * Feature/v4 fixedincome int tests (#5661) * integration tests * happy ruff * mini adjustment * ruff * typo * verbose type * fix tests * docstrings everywhere and an happy pydocstyle * fix tests * Feature/user-cache-dir: Add User Preference for the Cache Directory (#5621) * add user preference for storing cached data * ruff * fix tests? * fix test key error..? * etf integration test fix * add cache dir to SEC * black * improve docs structure for V4 (#5586) * improve docs structure for V4 * moving over changes * Add Docs to the navbar * add some, re-order sidebar * fix sentence * add docs install to source instructions * insert a couple of links, fix a typo * big terminal docs usage revamps * improve toggle component for tutorials * get rid of TOCs for all terminal docs for consistency and simplicity * improve platform docs * improve bot docs content structure * remove index from bot docs * improve ON THIS PAGE to only display TOC if at least 1 element * make edit this page text and icon on same line * add author and date to docs * add basic syntax page to usage * sidebar order for usage section * move api start command to the top with the import python import * some install page additions * small improvement * refactor routines section * Update introduction-to-routines.md * Update pipeline-of-commands.md * Update introduction-to-routines.md * Update routines-for-power-users.md * Update community-routines.md * update keyboard hotkey macros * askobb page * Update askobb-feature.md * Update index.md * Update index.md * Update index.md * Update index.md * fix images * remove HeadTitle from all files where it exist * get rid of extra spacing in markdown * small update * small edit * need index at the start because of main path when homepage of docs * use openAI to create SEO for front matter on my behalf * remove table of content from sdk page * finish improving metadata SEO for SDK docs * update duplicate header * update HeadTitle to be more specific on product * remove index from bot telegram reference * delete duplicated title for platform reference * another update * Hotfix/econometrics export filename fix (#5508) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Added --export option for exporting to a desired file in /econometrics menu * Added a -f/--file option to provide the filename for export. Made -t/--type and -f/--file mutually exclusive. If -f is not given, -t is required and the filename will be generated based on the time and module. * Revert `helper_funcs.py` to original state * Made some arguments not required. * Minor changes asked by @deeleeramone * No sheet name * black --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * FIX #5600 Updated the Twitter logo to X logo (#5601) * Change Ultima paragraph (#5624) * change ultima paragraph * remove old paragraph * Update CONTRIBUTING.md (#5623) * mobile line-brake fixed (#5604) In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments. Co-authored-by: James Maslek * start PR so screenshots can get attached via GitHub website * Update qa.md * Docs/terminalpro and improvement (#5622) * add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich * Add light blue banner, blue when clicking sidebar + fix link in docusaurus.config.js (#5627) * typo * pro docs tab coloring * sidebar selection blue * redirecting missing * Update crypto introduction.md * titles * another title * Update crypto dd.md * Update defi.md * Update disc.md * Update nft.md * Update onchain.md * Update ov.md * Update introduction.md updates URL * Update introduction.md add HeadTitle * Update ba.md * Update comparison.md * Update dark-pool-shorts.md * Update disc.md * fix docs (#5646) * Update fa.md * Update gov.md * Update ins.md * Update tradinghours.md * Delete website/content/terminal/menus/stocks/options/screener.md * Update Options introduction.md * Update screener head title * Update screener TOC * Update econometrics.md * Update economy head title * Update etf.md * codespell * Fix the redirect for intro to the correct url for docs (#5658) * fix the redirect for intro to the correct url for docs * fix code linting --------- Co-authored-by: James Maslek * Contributing guidelines (#5615) * intro section * what's expected sections * improve sections * improve sections and move how to add a data point * moving qa under contributor * better intro * moving the sharing section * better expectations * small intro to the contributor guidelines * moving things under the contributor section * there is no pre commits on the platform yet * dependency management * best practices for extensions * typo * collapse options subfolder * codespell * Improve Pro documentation further (#5641) * small improvement * Fix TutorialVideo for mobile view * main page terminal pro docs * jose whelp * placeholder index file that needs to be removed * fix: fixes sidebar, removes unused index.md * update link to api keys * update api keys link * fix hyperlinks in terminal helper * fix a few more links * fix some more links * linter * black linter * improve main docs page for each product * small refactor * header to take to main page of product * run OpenAI script to generate SEO for pro content --------- Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> * Update folders.md * Update integrate-your-own-backend.md * Update index.md * Update fixedincome.md * url * Update forecast.md * Update settings.md (#5665) * Update forex.md * fix front matter (#5667) * Fix conflict markers that got into markdown during previous merges * Fix front matter list formatting * Fix typo * small thing * fix hyperlinks * Update .codespell.ignore * output_type options * Architectural considerations * Update sidebar to hide pro section by default * Minor copy changes * TET pattern * import statements * clarification on preferences * Minor copy changes * Lint markdown and python * fix: open index on collapsible root elements * remove old content * options title * Fix linting errors * Refactor sidebar label to url mapping condition --------- Co-authored-by: andrewkenreich Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: hjoaquim Co-authored-by: Sandip Saha Co-authored-by: James Maslek 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 Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: Mohamad Fadil Co-authored-by: Theodore Aptekarev * Add multi-ticker support to etf_countries (#5670) * add multi-ticker support to etf_countries * remove commented-out lines * normalized percent points * percent -> percentage * Fix Nasdaq Econ Calendar Fetcher (#5668) * fix nasdaq econ cal request * more html tags * add random-user-agent to pyproject * another edge case - 24H -> 00:00 * Feature/v4-unusual-options: Adds unusual options endpoint. (#5677) * add unusual options fro Intrinio * test params * move sorting * Change type * update FMP fetcher to use the V4 endpoint (#5681) * Fix price performance not parsed correctly when there is only 1 ticker (#5678) * Add crypto search standard model and FMP data for it (#5679) * Apply renaming to news data (#5684) * inegration complete * reformatted for black * fix ruff issues * revised integration * changes to versions in pyproject.toml and updated lock files * Rename models * Update tests * Fix typos here and there * Update routers * Apply rename to ultima * Properly mock api key * Mock ultima api key --------- Co-authored-by: Adi Sai * Feature/v4-market-snapshots: Adds full market snapshots (#5473) * add stocks market snapshots from fmp * add fmp fetcher test * unused imports * add polygon to market_snapshots * update fmp market_snapshots * black * pydantic2 things * updates * change validate_obj to model_validate * polygon cleanup * tests * descriptions * black * data description * minor adjustments, using less local variables, improving readability and removing pandas * better structure * minor adjustments * lint * fix int tests --------- Co-authored-by: hjoaquim * Add NBBO Quotes, with historical, to `obb.stocks.quote()` (#5617) * coerce string type, add default=None * add polygon stock quote * limit cleanup * add greater/less than to params * limit param * black * tests * fix tests * test_etf * rename model and function to NBBO * add standard model for nbbo * improve standardization * not redifining builtin max * fix input params * integration test params * removing unused import Co-authored-by: Pratyush Shukla * revamped code * re-recorded nbbo test * added symbol validator * added alias in field * Stock news -> Company news --------- Co-authored-by: hjoaquim Co-authored-by: Pratyush Shukla Co-authored-by: Theodore Aptekarev * hotfix/update-quandl-to-nasdaq: Merge Quandl + Nasdaq (#5682) * merge quandl nd nasdaq * dev_install.py * test param name * economy python integration test * Add more input types to data processing commands (#5453) * adding more supported types to data processing commands * ruff * removing unused import * docstrings * data processing types covertion * data description * test filters * ruff * fix package builder tests * ruff * removing print * Add stocks/dps module (#5638) * short volume * pyproject missed * add sec short interest with days to cover * Add FINRA OTC endopoint * some tests * rest of unit tests * Integratin test scripts * dev install * linters caught by pre commit * lines too long * Last test files * maybe it needs a lock file? * thanks pratty * Maybe ill actually listen to pratty next time * sec test date freeze * I cant hit buttons * re record tests * tests 3 * Stockgrid test * regen int test * more testing * lint * moved these fns * dis killing me * one more test * last one * Update integration tests * Fix tests picking up wrong dps route --------- Co-authored-by: Theodore Aptekarev * Rename Forex to Currency (#5687) * restore fields as optional (#5686) * Rename Crypto (#5689) * added `crypto.price.historical` * static * fix tests * fix incorrect label * Move model from sec to finra (#5692) * Update toml * fixed deps * add openbb-etf lock file * cleanup * cleanup (#5694) * Rename Fixed Income (#5695) * Rename Fixed Income * Add routers * Rename stocks to equity (#5688) * Rename stocks folder * Rename openbb_stocks package * Rename routers * Reroute equity menu * Update routes based on feedback * StockNews -> EquityNews * StockInfo -> EquityProfile * Rename Equity calendars * Equity peers rename * Rename discovery * Rename fundamental * Rename price command models * Rename shorts * Update charting router * Fix seeking alpha upcoming release date * Fix linting errors * Update tests * Fix tests * Skip econometrics api tests because it's python only * Update integration tests and test data * Historical analyst estimates * Skip cboe options chain test. Unable to record vcr cassette * re-record cboe cassettes * Document CBOE unit test creation caveats --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Feature/files-for-igor: Adding a few standard models for Igor (#5699) * add some standard models for Igor * codespell * update descriptions * Add devtools metapackage (#5703) * Add openbb-devtools metapackage * adding devtools to the dev_install script --------- Co-authored-by: hjoaquim * Rename econometrics commands to be more verbose (#5702) * Expose command to model map (#5706) * Rename ta qa (#5708) * Rename ta folder * Rename ta to technical * Rename qa folder * Rename qa to quantitative * Rename the actual routes in quantitative * Equity cleanup (#5707) * cleanup * static * renaming to equity cc @the-praxs * Proof reading --------- Co-authored-by: hjoaquim Co-authored-by: Theodore Aptekarev * Don't enforce imperative for first word of the docstring * Remove ultima from default extensions * Rename `economy` and create `index` extension (#5705) * renamed economy and re-recorded tests * static * market indices * european indices * fred indices * index constituents * tests * correct package name * oops * static * linting * Move COT commands to regulators * Rename economy.list to available_indices * Rename GDP models and clean up * Fix charting tests * Drop _indices from available_indices command * Fix obbject to_dict test --------- Co-authored-by: Theodore Aptekarev * Rename etf/disc (#5715) * Docs/v4-working-docs: PR to Work on V4 Docs (#5693) * Revert changes related to pydantic2 made into v3 code * Revert fred model changes in v3 * Revert pydantic2 databento model changes in v2 * Update some names and v3 lock file * Clean up openbb/package before the beta release * Platform publishing procedure (#5701) * update instructions * introducing the version script * publish message * fix platform path * reflecting version changes * getting version from installed packages instead * removing toml from dependencies * Changes to get `a7` out (#5697) * changes to get a7 out * etf menu on the pyproject.toml * poetry lock * bump `openbb-etf` to `a5` to match version * updated deps * removing ultima * removing references to a4 cc @the-praxs * Bump index menu version * poetry lock --------- Co-authored-by: Pratyush Shukla Co-authored-by: Theodore Aptekarev * Update publishing instructions * Bump core dependencies in extensions and providers * Add changes to the publish script following the beta release * Update the versions in static extension map and openbb metapackage --------- Co-authored-by: James Maslek Co-authored-by: Pratyush Shukla Co-authored-by: hjoaquim Co-authored-by: Diogo Sousa Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply… * Release/4.2.1 (#6456) * 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 * [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 * update functions.json (#6140) * fix intraday check in charting ta_class (#6119) Co-authored-by: Henrique Joaquim * [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 * [BugFix] Fix SEC ETF Holdings Parsing Exception (#6121) * fix etf holdings * linting * black --------- Co-authored-by: James Maslek * Docs/update xl docs (#6145) * remove print * update obb.get docs * example * md lint * fix get reference (#6147) * [BugFix] Filter OECD data using `start_date` and `end_date` parameters (#6144) * move constant dicts to constants.py filter by start_date and end_date * black * black again again * Merge 'main' into 'develop' (#6151) * Release/3.2.4 (#5696) * test * ultima description (#5541) * Updating showcase page (#5543) * updating showcase page * use sdk instead * add new bot command autopost docs (#5530) add new bot command autopost docs to docs.openbb.co Co-authored-by: James Maslek * Hotfix/ultima improvements (#5553) * tweaks for monetization * fix linting issue * fix: Modify 'load' behavior to append data to existing sheet (#5503) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Fixed 'worksheet not found' error during export to an existing sheet * Changes: * Now if the sheet exists in the xlsx file it will ask the user if he wants to replace/append/create new sheet --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * added platform API integration test to Nightly build (#5571) * Add columns to `stocks/search` (#5565) * Add columns to `stocks/search` isin, cusip, figi, composite_figi, shareclass_figi * Update test_search[False].txt * Update test_search[True].txt * Delete tests/openbb_terminal/stocks/cassettes/test_stocks_helper/test_search.yaml * Create test_search.yaml --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * updating ultima urls (#5587) * fix: A value is trying to be set on a copy of a slice from a DataFrame #5582 (#5591) * Update README.md (#5598) * Hotfix/econometrics export filename fix (#5508) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Added --export option for exporting to a desired file in /econometrics menu * Added a -f/--file option to provide the filename for export. Made -t/--type and -f/--file mutually exclusive. If -f is not given, -t is required and the filename will be generated based on the time and module. * Revert `helper_funcs.py` to original state * Made some arguments not required. * Minor changes asked by @deeleeramone * No sheet name * black --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * FIX #5600 Updated the Twitter logo to X logo (#5601) * Change Ultima paragraph (#5624) * change ultima paragraph * remove old paragraph * Update CONTRIBUTING.md (#5623) * mobile line-brake fixed (#5604) In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments. Co-authored-by: James Maslek * Docs/terminalpro and improvement (#5622) * add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich * Add light blue banner, blue when clicking sidebar + fix link in docusaurus.config.js (#5627) * typo * pro docs tab coloring * sidebar selection blue * redirecting missing * fix docs (#5646) * Fix the redirect for intro to the correct url for docs (#5658) * fix the redirect for intro to the correct url for docs * fix code linting --------- Co-authored-by: James Maslek * Improve Pro documentation further (#5641) * small improvement * Fix TutorialVideo for mobile view * main page terminal pro docs * jose whelp * placeholder index file that needs to be removed * fix: fixes sidebar, removes unused index.md * update link to api keys * update api keys link * fix hyperlinks in terminal helper * fix a few more links * fix some more links * linter * black linter * improve main docs page for each product * small refactor * header to take to main page of product * run OpenAI script to generate SEO for pro content --------- Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> * Update folders.md * Update integrate-your-own-backend.md * Update index.md * Update settings.md (#5665) * fix front matter (#5667) * #5633 adding comma every 1000 (#5652) * #5633 adding comma every 1000 * pylint --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Hotfix/reports model render report sanitize inputs (#5669) * Adding more robust special character handling to create_output_path(). Addresses https://github.com/OpenBB-finance/OpenBBTerminal/issues/5299 * Running black linter on code to conform to OBB style guides. --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * hotfix/fix-gov-histcont: Fix #5650 - /stocks/gov/histcont (#5676) * fix histcont * some cleanup * remove sort line * 12-31 not 12-12 * columns_keep_types * remove space in regex (#5675) * Pin openai (#5685) * Clarified stocks/ta empty recom object message (#5468) * Clarified stocks/ta empty recom object message * black * lint --------- Co-authored-by: James Maslek * improved market cap value extraction (#5169) * improved market cap value extraction * pylint --------- Co-authored-by: James Maslek * 3.2.3->3.2.4 * Changelogs * new changelog --------- Co-authored-by: Henrique Joaquim Co-authored-by: Andrew Co-authored-by: Adi Sai Co-authored-by: Sandip Saha Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Luqman 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: DidierRLopes 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 Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: Mohamad Fadil Co-authored-by: Ramazan Co-authored-by: joshuabuildsthings Co-authored-by: wojda <114031148+polooner@users.noreply.github.com> Co-authored-by: Bim Phomthong <118195204+bimbolimbo@users.noreply.github.com> * Release/4.0.1 (#5840) * test * ultima description (#5541) * Updating showcase page (#5543) * updating showcase page * use sdk instead * add new bot command autopost docs (#5530) add new bot command autopost docs to docs.openbb.co Co-authored-by: James Maslek * Hotfix/ultima improvements (#5553) * tweaks for monetization * fix linting issue * fix: Modify 'load' behavior to append data to existing sheet (#5503) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Fixed 'worksheet not found' error during export to an existing sheet * Changes: * Now if the sheet exists in the xlsx file it will ask the user if he wants to replace/append/create new sheet --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * added platform API integration test to Nightly build (#5571) * Add columns to `stocks/search` (#5565) * Add columns to `stocks/search` isin, cusip, figi, composite_figi, shareclass_figi * Update test_search[False].txt * Update test_search[True].txt * Delete tests/openbb_terminal/stocks/cassettes/test_stocks_helper/test_search.yaml * Create test_search.yaml --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * updating ultima urls (#5587) * fix: A value is trying to be set on a copy of a slice from a DataFrame #5582 (#5591) * Update README.md (#5598) * Hotfix/econometrics export filename fix (#5508) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Added --export option for exporting to a desired file in /econometrics menu * Added a -f/--file option to provide the filename for export. Made -t/--type and -f/--file mutually exclusive. If -f is not given, -t is required and the filename will be generated based on the time and module. * Revert `helper_funcs.py` to original state * Made some arguments not required. * Minor changes asked by @deeleeramone * No sheet name * black --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * FIX #5600 Updated the Twitter logo to X logo (#5601) * Change Ultima paragraph (#5624) * change ultima paragraph * remove old paragraph * Update CONTRIBUTING.md (#5623) * mobile line-brake fixed (#5604) In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments. Co-authored-by: James Maslek * Docs/terminalpro and improvement (#5622) * add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich * Add light blue banner, blue when clicking sidebar + fix link in docusaurus.config.js (#5627) * typo * pro docs tab coloring * sidebar selection blue * redirecting missing * fix docs (#5646) * Fix the redirect for intro to the correct url for docs (#5658) * fix the redirect for intro to the correct url for docs * fix code linting --------- Co-authored-by: James Maslek * Improve Pro documentation further (#5641) * small improvement * Fix TutorialVideo for mobile view * main page terminal pro docs * jose whelp * placeholder index file that needs to be removed * fix: fixes sidebar, removes unused index.md * update link to api keys * update api keys link * fix hyperlinks in terminal helper * fix a few more links * fix some more links * linter * black linter * improve main docs page for each product * small refactor * header to take to main page of product * run OpenAI script to generate SEO for pro content --------- Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> * Update folders.md * Update integrate-your-own-backend.md * Update index.md * Update settings.md (#5665) * fix front matter (#5667) * #5633 adding comma every 1000 (#5652) * #5633 adding comma every 1000 * pylint --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Hotfix/reports model render report sanitize inputs (#5669) * Adding more robust special character handling to create_output_path(). Addresses https://github.com/OpenBB-finance/OpenBBTerminal/issues/5299 * Running black linter on code to conform to OBB style guides. --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * hotfix/fix-gov-histcont: Fix #5650 - /stocks/gov/histcont (#5676) * fix histcont * some cleanup * remove sort line * 12-31 not 12-12 * columns_keep_types * remove space in regex (#5675) * Pin openai (#5685) * Clarified stocks/ta empty recom object message (#5468) * Clarified stocks/ta empty recom object message * black * lint --------- Co-authored-by: James Maslek * improved market cap value extraction (#5169) * improved market cap value extraction * pylint --------- Co-authored-by: James Maslek * Release/3.2.4 (#5704) * 3.2.3->3.2.4 * Changelogs * new changelog * OpenBB Platform v4 (#5225) * change location * check something * add cache * fixed auth w/@IgorWounds and @montezdesousa * fixes for econometrics * include Darren auth suggestions * some routers included if dev + chg hub backend var * coverage router should not be here * update docker readme * forgot to check auth here * Change extension imports * update docstrings and readme * headers function wasnt being called, just referenced * relative import * econometrics add headers everywhere * Fix QA * Fix TA * Fix test * Fix python interface QA and TA * Lint * Cleanup * Change path * make the changes and some etf models * tests for command_runner * ruff * solving naming issues on pytest * Update some docstrings, fix typos and lint * solving econometrics instantiating wrong openbb * chaging the way pytest runs * messing around with the imports * ruff * Change template to add platform considerations (#5533) * change template to add platform considerations * @the-praxs suggestions * solving __pycache__ issue * removing typo * ci yml * making linters happy (i guess) * Improve Omega Ratio and docstrings * chaging pro validation hash * ruff * Fix OLS Summary and lint * Add OECD Provider for economy extension (#5534) * Add record to docs * update a couple of cboe models * Fix econometrics bugs. Make tests pass. Lint. * black * ruff * pydantic v2: remove deprecated Extra * pydantic v2: self.dict -> self.model_dump * revert pydantic * revert the revert * try 1: pin urllib3 < 2 * Revert "try 1: pin urllib3 < 2" This reverts commit 3736c311cb6aa9e653dcb5db733798408b72a82e. * Revert dep * Fix * re-lock * Skip all tests when doing cspell in pre-commit * Resolve linter errors * Add OECD to install script * Add OECD * Resolve more linter errors * Exclude static files of v4 python from ruff * More linting * Another attempt to resolve even more linting errors * Change how Literal is used * ticker. symbol. consistent. @piiq * change ticker field in Stock Search to is_symbol * Update Cboe model for stocks_search -> is_symbol parameter. * Fix issue * Lint * Small QA to rename SDK to Platform (#5544) * SDK -> Platform in docs * renamed in core * renamed in openbb `init` * `sdk` variable renamed as `platform` --------- Co-authored-by: hjoaquim * `validator` -> `field_validator` in standard models * Standard convention for multi-ticker symbols (#5549) * standardize symbol input param in forex and crypto historical data * static * linting * Fix stock_search integration test params * Update dependencies and linting on the CI (#5550) * Remove ruff and black from platform dependencies * Update codespell configuration * Lint python code * Add toml and tomli to root dev dependencies * Update requirements.txt files * Fix buggy docstring in python package methods (#5548) * fix buggy docstring for methods * remove space * fix typing * avoid name collision with validator * Revert "avoid name collision with validator" This reverts commit 8a30a44555d97132f6bddcbc4a4facdd97ecc591. * typing * rebuild * python 3.8, ParamSpec not available * lint * ruff noqa * Merge with develop (#5551) * Charting extension integration tests (#5547) * initial proposal for integration tests on the charting extension * int tests for charting generation * python generator * ruff * boilerplate templates * python tests * tests for the api * using body instead so data don't get redefined * unit tests for coverage * ruff * docstrings * unnecessary access to keys() * Add trading economics economic calendar * dev install * Data Models disposition on the website (#5538) * pydantic v4 * flat structure * md files * Revert "md files" This reverts commit bd2170e2adf82fed3a35d34fad6a2e3ba3ae1d49. * improve command descriptions * nice title and description * human readble data model names on left panel * implementation details section * content markdown files * markdown versioned files * showcase page * updates --------- Co-authored-by: tehcoderer * everything except tests * fix `datetime.date` import in fetcher test * modified url to remove `api_key` placeholder * record test * api key is called c here * fixed fetcher test for api key * recorded tests * refactor * life is ruff * codespell * Make Intrinio options chains great again (#5540) * add multithreading * cleanup * linting * use dateutil.parser * removed `TICKER_EXCEPTIONS` * modified `date` and `type` fields in standard model * set alias for `date` and `type` to match standards * static * static * Hotfix/fix post tests (#5555) * Fix econometrics * Fix ta * Fix qa. Remove intrinio to not be rate limited * Lint * Fix typo * obbject tests (#5558) * obbject tests * ruff * fix dev_install * fix unittests * black on nox * black on nox * nox * fix fetcher test so it can compare dates * fix intrinio tests * ruff * change to model_dum() instead (#5561) * Passing tests (#5560) * Passing tests * fix options * Fix most tests and bugs * fix forex missing params * make symbol upper in polygon fx pairs * fix fixedincome integration tests (#5564) * Fixing charting api integration tests (#5562) * fixing charting api integration tests * black * fix stocks less five API fails * fix the 5 failing stocks integration tests * recapture fmp stock news unit test * fix fmp forex api test * couple more forex integration fixes * changing the request to always use the legacy session. @jmaslek this is was broken for 3.8 and 3.9; with this change apparently all versions work - lemme know if you see any issue with this change * ruff * fix ta * add missing param * fix testers for the api * fix globalnews to use images instead of image * remove unncessary pandas import * econcal int tests * update gitignore * fix get_querystring to support lists * add missing parameters --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Henrique Joaquim * Stock Historical standardization and UX improvements (#5457) * polygon add interval standard param * attempt at standardization * Alpha Vantage params standardization * rename `get_intervals` and fixed bug for extracting wrong value * missed changing it in `extract_data` * linting * polygon cleanup * modified `start_date` & `end_date` type to `datetime` from `dateType` * standardized intrinio stock historical params * fixed yfinance * linting * revert start and end date to dateType from datetime * fix alpha vantage * changed param * fix intrinio infinite loop * `validator` is `field_validator` * revert time params and fixed intervals * `outputsize` alias set in `Field` * set interval description using in-build dict * yfinance stock param standardization * static * intrinio cleanup * Polygon add api params as `PrivateAttr` * modified yfinance params to `PrivateAttr` * intrinio remove overriding date params * fixed description for AV adjusted param * fix alpha vantage intraday not working * re-record and pass unit tests * pass integration tests * Update test --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Fix econcal endpoint (#5567) * fix econcal for python interface * fix econcal tests * fix non supported json output * Fixes FMP index endpoint to get 1 day interval data (#5535) * fix FMP endpoint for getting index data for `1day` interval * fix `open` type to prevent validation error * modifed `validator` to `field_validator` * type of fields is `StrictFloat` * re-record and pass test * linting * `validator` -> `field_validator`, a3'd everything * Fix regression in tests. Lint * updating the integration test actions * Fix typo * Fix typo * Fix import * Publish versions `a3` to Pypi (#5568) * bump versions and script to publish * small improvements * uncomment exception * openbb * publishing guidelines * improve docs * add providers to economy api * make symbol required in stock_quote * Fix keys * Fix oecd * add comma * revert * Add quotes * Sleep * Improve tests * Improve * Feature/query transform (#5566) * inject query into transform_data * swap query and data * update missing fetchers * last test failing * sig test fetcher * black * av add `query` to `transform_data` call * transform_data: missing refactoring * fix uvicorn command in the doc * Automated examples (#5576) * Automated examples * Fix bug * Lint * static assets built on 3.8 * Revert "static assets built on 3.8" This reverts commit fb82ff7bd9af92ed676d8f8047c31e74daf7b8b2. * remove assets * static assets on 3.8 * static assets on 3.8 * Wrap in quotes * Improve wrap * minor fix * rebuild 3.8 * Fix bug * Fix edge case * Lint * rebuild --------- Co-authored-by: hjoaquim Co-authored-by: Diogo Sousa * use SecretStr for sensitive fields (#5578) * use SecretStr for sensitive fields * fix * docstring * Add tests for provider (#5583) * Add tests for provider * Test standard models * Lint * Fix standard model issues. Co-authored-by: @the-praxs * linting * `symbol` -> `is_symbol` in `economy.index_search` * static --------- Co-authored-by: Pratyush Shukla * feature/v4-biztoc-provider: Adds Biztoc provider and GlobalNews (#5546) * add biztoc provider * duplicate field * black * request headers * recapture test * move stuff around * add integration tests * duplicate OECD entry in dev_install * duplicate entry for oecd in pyproject.toml * Add Biztoc to workflow * update readme: credentials * Add Preferences to README * improve tests * fix biztoc * obbject pylint * Bug fix: serializ SecretStr before dumping to json * export credentials as json (#5592) * Check for wrong, changed, or outdated params. (#5597) * Improving `economy.cpi` for the FRED data (#5602) * remove multiindex using coding magic * Update field descriptions --------- Co-authored-by: Theodore Aptekarev * Improve error message. * Improve * Test tests (#5607) * Test tests * Add test * 4.0.0a4 PyPI publishing (#5608) * changes to publish * fix mini conflict * typo * cleaned `descriptions.py` * fix description in `cpi.py` * Add ETF extension to v4 (#5609) * Add etf extension with search data model * Add FMP ETF search * Add fetcher tests * Add ETF historical price from yfinance (#5610) * Add etf extension with search data model * Add FMP ETF search * Add fetcher tests * Add etf historical price standard model and route * Add etf historical data from yfinance * Add unit tests * Fix linter error. Organize imports * Update test data * Revert common descriptions erased by CPI PR * remove `symbol` from data for `stocks.ca.peers` * Test docstrings (#5613) * Test docstrings * fix minor bugs w/@IgorWounds * static only w/@IgorWounds * fix `importance` param in `economy.econcal` * right static only w/@IgorWounds * Fix econcal and add tests to noxfile * fix econcal static * re-record --------- Co-authored-by: Pratyush Shukla * Clean up the newly created ETF extension (#5611) * Add ETF to dev_install bundle * Add integration tests for openbb-etf * Patch integration test generator scripts to produce lintable code * Add py.typed markers for extensions * user preferences descriptions (#5593) * user preferences descriptions * typo * Feature/v4-sec-provider: Add SEC provider to V4 (#5556) * coerce string type, add default=None * add sec provider and FTD function * update description * ruff * data model definitions in standard model already * duplicate oecd entries in dev_install and pyproject * actually commit * integration test * add stock search to SEC * add company filings for SEC provider * integration tests * remove duplicated line * ruff * **kwargs in Transform Data * some helper functions for later * black * add helper for mutual fund and etf lookup * add some SEC lookup helpers to a new regulators extension * black * ruff * fix test param * take institution filter out of sec stock_search * ruff * remove URL that codespell doesn't like * add cik-to-ticker map * add litigations rss feed * make openbb-regulators a dependency of openbb-sec * add SIC search * improve ftd and remove BeautifulSoup from SEC dependencies * fix parsing the zip files pre-2009 * ruff * update descriptions * recapture ftd test * tests params * typo * change limit param to 1 in test_sec_stock_ftd * Add didiers to_records method (#5588) * Add didiers to_records * unused import * Bring back polars + do what igor suggested * Make the output consistent with what it was. * Black ? * spelling. oops. almost like we have a pre commit or something * Feature/v4-price-performance: % returns for various horizons, comparable across multiple tickers. (#5618) * coerce string type, add default=None * add price_performance endpoint from FMP * black * extra period in docstring * ruff * forgot one file * Feature/ipo-calendar: V4 IPO Calendar (#5605) * coerce string type, add default=None * add intrinio ipo calendar * fix typo * sort __init__ * fix description * make requested changes * update test params * black * test updates * etf integration * Add disc router and WSJ provider * OBBject extensions (#5612) * changes to core * bug? * docstring * doc * Update credentials.py * fix model_dump * create extensions * fix docstring * doc * revert change query_exc * doc * fix container test * redirect obbject test patch * doc * rename method * move decorator to extension file * rename method extend_obbject * changes in creds model * avoid credential racing * doc * rename prop * doc * doc * remove comment * comment some code * free extension names * docstring * doc * docs * Hotfix/fix-v4-economic-calendar: Add FMP to Econ Calendar and fix some TE bugs (#5580) * coerce string type, add default=None * adds fmp to economic calendar and fixes some things with TE * ruff * etf integration test * missing provider for test * rename te cassette to economic_calendar * fix test * rename tests --------- Co-authored-by: James Maslek * Add stocks disc endpoints (#5630) * Add stocks disc endpoints * Explicit * Lint * Add tests * Bump timeout * Feature/disc router (#5616) * Add disc router and WSJ provider * Lint * Lint * Move endpoints under ETF router * Update etf_performance.py * Add ETF info and sector exposure from FMP (#5620) * Add ETF info from FMP * Add integration tests * Add unit tests * Add etf sectors endpoint * Add etf sectors fmp endpoint * Omit nested sector list from fmp info data * Update tests and test data * Update test data * Specify provider explicitly in integration tests * Update tests * Skip yfinance etf historical test * Fix linter errors after the merge * Fix more linter errors * Fix failing and add missing tests * Fix integration tests * Fix calendar ipo tests * Add ETF holdings and holding report dates from FMP (#5629) * Add ETF info from FMP * Add integration tests * Add unit tests * Add etf sectors endpoint * Add etf sectors fmp endpoint * Omit nested sector list from fmp info data * Update tests and test data * Update test data * Specify provider explicitly in integration tests * Update tests * Skip yfinance etf historical test * Add etf holdings and holdings date routes and standard models * Add fmp holdings and holding dates fetchers * Update holdings fetcher to properly handle date object inputs * Add unit tests * Add integration tests * Black after merge * Fix test input data format * Disc router for equities. (#5640) * Disc router for equities. * add tests * Bug fixes in financial statements (#5537) * `validator` to `field_validator` in standard models * Polygon add `ttm` to `period` param * Revert "Polygon add `ttm` to `period` param" * Polygon add `ttm` to param `period` * `EarningsCallTranscript` standard model removed `quarter` param * use `tag` instead of `name` for correct field name * fix url for intrinio income statement * modified intrinio cash flow `transform_data` function * set optional data fields and validate dates * fix insider trading not fetching recent data * linting * refactoring * refactoring * set param alias in fmp stock insider provider model * get all quarter data for intrinio * add `limit` param to `stocks.fa.ins` * refactoring and linting * removed additional comment * linting * re-recorded and fix tests * cash flow standard model field type to `StrictFloat` * Intrinio cash flow model fixed to get all quarters' data * linting * refactoring * financial statement standard model field type to `StrictFloat` * Intrinio financial statement model get all quarter data * set `period` type to `Optional[str]` * add `period` param to balance sheet provider models * add `period` param to cash flow provider models * use alias in model dump * remove `ttm` from `period` param * revamped intrinio financials * fixed incorrect description for `limit` param * modified tests for `balance`, `cash` and `income` * re-recorded tests * skipped intrinio financial statement fetcher tests * Add ETF county weighting command with FMP data (#5645) * Remove code that wrongfully infers the filing date as end of quarter * Add etf countries command with fmp data * Add countries command to etf router * Update sector and country weighting fmp models * Fix docstring typo * Add unit tests and update mock data * Add integration tests for etf.countries * Bring back missing integration tests * Fix economic calendar integration tests * fix missing data in intrinio financials * removed inutile params from Polygon financial statement models * Intrinio IPO overhaul * tests fixed and re-recorded * Add ETF holdings performance with FMP data (#5659) * Add etf holdings performance endpoint * Add tests * Fix failing polygon fetcher tests * Split long holdings lists into chunks and update test data * Change chunk length to 500 tickers * Add stock search from FMP (#5642) Co-authored-by: Theodore Aptekarev * Feature/v4 pypi (#5579) * improvements to the publish script * move scripts * initial script that builds the package * adjustments on the docs * test pypi workflow * add hour and minute to version * black * ruff * duplicate file * moving files instead * build throught the script instead * update nox file * integration tests workflow * change workflow * fix dev_install * fix in sed cmd * testing the platform only * commenting out the publishing * fix run commands * improvements to the publish script and doc * fix publish script * updating the script and the workflow * feature/v4-pypi nightly (#5589) * init * Update nightly.py * cleanup * init file * not referencing dev_utils * updating obb platform key * revert * Increase warmup time * project name on pyproject and adding the --pre flag on readme * moving to the build folder * fix noxfile * reflecting the moves on the import statements * fix pyproject path * ruff * fix paths * fix super typo * update workflows * moving the pypi terminal files into its folder --------- Co-authored-by: teh_coderer Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Theodore Aptekarev * economy.calendar nasdaq (#5628) * add quandl econcal * unittest * add integration tests * replace   * fix bug TE importance * small fix * remove stuff from quandl * add nasdaq provider * add nasdaq to install files * Update test_economy_api.py * test * quandl leftovers * remove quandl econcal test * lint * replace   * ruff * lint * update nasdaq gmt * validate countries * here * no need for this * fix calendar tests * static * static * remove error * static * readme + website * readme * remove changes TE * typo * fix unittest * fix tests * Update __init__.py * Update economic_calendar.py * revamped model and added helpers for date range --------- Co-authored-by: Pratyush Shukla * Feature/v4-dividend-calendar: Adds Nasdaq dividend calendar and moves the command out of fundamental_analysis (#5672) * add nasdaq dividend calendar and move out of fundamental_analysis * black * ruff * add random-user-agent to pyproject.toml * add nasdaq ipo calendar * add nasdaq flag for SPO to IPO calendar * add spo test param * black * dividend test * fix transform_query - nasdaq_calendar_ipo * bring back different headers for ipo calendar * remove references to test * Add disc endpoints (#5660) * Add Quandl top retail * Add tests * Add Seeking Alpha * Add Filings * Change Provider * Fix test * Add dev_install * static * static correct * y u forget me * updated deps * static --------- Co-authored-by: Pratyush Shukla * using dev install (#5673) * Expanding the `fixedincome` menu (#5655) * models and fetcher * making the fetcher visible * std model * adding the command * improvements to the models * typo * adding the command * imrpovements to dwpcr * standard model for ecb int rates * adding the fetcher for fred * standard model of ice bofa * add ice_bofa command * ruff * ice bofa fetcher * moody std model * moody * std model * add cp command * unused import * cp * spot * ruff * hqm * tmc * ffrmc * tbffr * ruff * typing fixes * buggy dates * fred fetcher tests * ruff * adding ecb as a provider * adding new provider related stuff * adding the new command eu_ycvr * models * test for ecb fetcher * Feature/v4 fixedincome int tests (#5661) * integration tests * happy ruff * mini adjustment * ruff * typo * verbose type * fix tests * docstrings everywhere and an happy pydocstyle * fix tests * Feature/user-cache-dir: Add User Preference for the Cache Directory (#5621) * add user preference for storing cached data * ruff * fix tests? * fix test key error..? * etf integration test fix * add cache dir to SEC * black * improve docs structure for V4 (#5586) * improve docs structure for V4 * moving over changes * Add Docs to the navbar * add some, re-order sidebar * fix sentence * add docs install to source instructions * insert a couple of links, fix a typo * big terminal docs usage revamps * improve toggle component for tutorials * get rid of TOCs for all terminal docs for consistency and simplicity * improve platform docs * improve bot docs content structure * remove index from bot docs * improve ON THIS PAGE to only display TOC if at least 1 element * make edit this page text and icon on same line * add author and date to docs * add basic syntax page to usage * sidebar order for usage section * move api start command to the top with the import python import * some install page additions * small improvement * refactor routines section * Update introduction-to-routines.md * Update pipeline-of-commands.md * Update introduction-to-routines.md * Update routines-for-power-users.md * Update community-routines.md * update keyboard hotkey macros * askobb page * Update askobb-feature.md * Update index.md * Update index.md * Update index.md * Update index.md * fix images * remove HeadTitle from all files where it exist * get rid of extra spacing in markdown * small update * small edit * need index at the start because of main path when homepage of docs * use openAI to create SEO for front matter on my behalf * remove table of content from sdk page * finish improving metadata SEO for SDK docs * update duplicate header * update HeadTitle to be more specific on product * remove index from bot telegram reference * delete duplicated title for platform reference * another update * Hotfix/econometrics export filename fix (#5508) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Added --export option for exporting to a desired file in /econometrics menu * Added a -f/--file option to provide the filename for export. Made -t/--type and -f/--file mutually exclusive. If -f is not given, -t is required and the filename will be generated based on the time and module. * Revert `helper_funcs.py` to original state * Made some arguments not required. * Minor changes asked by @deeleeramone * No sheet name * black --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * FIX #5600 Updated the Twitter logo to X logo (#5601) * Change Ultima paragraph (#5624) * change ultima paragraph * remove old paragraph * Update CONTRIBUTING.md (#5623) * mobile line-brake fixed (#5604) In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments. Co-authored-by: James Maslek * start PR so screenshots can get attached via GitHub website * Update qa.md * Docs/terminalpro and improvement (#5622) * add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich * Add light blue banner, blue when clicking sidebar + fix link in docusaurus.config.js (#5627) * typo * pro docs tab coloring * sidebar selection blue * redirecting missing * Update crypto introduction.md * titles * another title * Update crypto dd.md * Update defi.md * Update disc.md * Update nft.md * Update onchain.md * Update ov.md * Update introduction.md updates URL * Update introduction.md add HeadTitle * Update ba.md * Update comparison.md * Update dark-pool-shorts.md * Update disc.md * fix docs (#5646) * Update fa.md * Update gov.md * Update ins.md * Update tradinghours.md * Delete website/content/terminal/menus/stocks/options/screener.md * Update Options introduction.md * Update screener head title * Update screener TOC * Update econometrics.md * Update economy head title * Update etf.md * codespell * Fix the redirect for intro to the correct url for docs (#5658) * fix the redirect for intro to the correct url for docs * fix code linting --------- Co-authored-by: James Maslek * Contributing guidelines (#5615) * intro section * what's expected sections * improve sections * improve sections and move how to add a data point * moving qa under contributor * better intro * moving the sharing section * better expectations * small intro to the contributor guidelines * moving things under the contributor section * there is no pre commits on the platform yet * dependency management * best practices for extensions * typo * collapse options subfolder * codespell * Improve Pro documentation further (#5641) * small improvement * Fix TutorialVideo for mobile view * main page terminal pro docs * jose whelp * placeholder index file that needs to be removed * fix: fixes sidebar, removes unused index.md * update link to api keys * update api keys link * fix hyperlinks in terminal helper * fix a few more links * fix some more links * linter * black linter * improve main docs page for each product * small refactor * header to take to main page of product * run OpenAI script to generate SEO for pro content --------- Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> * Update folders.md * Update integrate-your-own-backend.md * Update index.md * Update fixedincome.md * url * Update forecast.md * Update settings.md (#5665) * Update forex.md * fix front matter (#5667) * Fix conflict markers that got into markdown during previous merges * Fix front matter list formatting * Fix typo * small thing * fix hyperlinks * Update .codespell.ignore * output_type options * Architectural considerations * Update sidebar to hide pro section by default * Minor copy changes * TET pattern * import statements * clarification on preferences * Minor copy changes * Lint markdown and python * fix: open index on collapsible root elements * remove old content * options title * Fix linting errors * Refactor sidebar label to url mapping condition --------- Co-authored-by: andrewkenreich Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: hjoaquim Co-authored-by: Sandip Saha Co-authored-by: James Maslek 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 Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: Mohamad Fadil Co-authored-by: Theodore Aptekarev * Add multi-ticker support to etf_countries (#5670) * add multi-ticker support to etf_countries * remove commented-out lines * normalized percent points * percent -> percentage * Fix Nasdaq Econ Calendar Fetcher (#5668) * fix nasdaq econ cal request * more html tags * add random-user-agent to pyproject * another edge case - 24H -> 00:00 * Feature/v4-unusual-options: Adds unusual options endpoint. (#5677) * add unusual options fro Intrinio * test params * move sorting * Change type * update FMP fetcher to use the V4 endpoint (#5681) * Fix price performance not parsed correctly when there is only 1 ticker (#5678) * Add crypto search standard model and FMP data for it (#5679) * Apply renaming to news data (#5684) * inegration complete * reformatted for black * fix ruff issues * revised integration * changes to versions in pyproject.toml and updated lock files * Rename models * Update tests * Fix typos here and there * Update routers * Apply rename to ultima * Properly mock api key * Mock ultima api key --------- Co-authored-by: Adi Sai * Feature/v4-market-snapshots: Adds full market snapshots (#5473) * add stocks market snapshots from fmp * add fmp fetcher test * unused imports * add polygon to market_snapshots * update fmp market_snapshots * black * pydantic2 things * updates * change validate_obj to model_validate * polygon cleanup * tests * descriptions * black * data description * minor adjustments, using less local variables, improving readability and removing pandas * better structure * minor adjustments * lint * fix int tests --------- Co-authored-by: hjoaquim * Add NBBO Quotes, with historical, to `obb.stocks.quote()` (#5617) * coerce string type, add default=None * add polygon stock quote * limit cleanup * add greater/less than to params * limit param * black * tests * fix tests * test_etf * rename model and function to NBBO * add standard model for nbbo * improve standardization * not redifining builtin max * fix input params * integration test params * removing unused import Co-authored-by: Pratyush Shukla * revamped code * re-recorded nbbo test * added symbol validator * added alias in field * Stock news -> Company news --------- Co-authored-by: hjoaquim Co-authored-by: Pratyush Shukla Co-authored-by: Theodore Aptekarev * hotfix/update-quandl-to-nasdaq: Merge Quandl + Nasdaq (#5682) * merge quandl nd nasdaq * dev_install.py * test param name * economy python integration test * Add more input types to data processing commands (#5453) * adding more supported types to data processing commands * ruff * removing unused import * docstrings * data processing types covertion * data description * test filters * ruff * fix package builder tests * ruff * removing print * Add stocks/dps module (#5638) * short volume * pyproject missed * add sec short interest with days to cover * Add FINRA OTC endopoint * some tests * rest of unit tests * Integratin test scripts * dev install * linters caught by pre commit * lines too long * Last test files * maybe it needs a lock file? * thanks pratty * Maybe ill actually listen to pratty next time * sec test date freeze * I cant hit buttons * re record tests * tests 3 * Stockgrid test * regen int test * more testing * lint * moved these fns * dis killing me * one more test * last one * Update integration tests * Fix tests picking up wrong dps route --------- Co-authored-by: Theodore Aptekarev * Rename Forex to Currency (#5687) * restore fields as optional (#5686) * Rename Crypto (#5689) * added `crypto.price.historical` * static * fix tests * fix incorrect label * Move model from sec to finra (#5692) * Update toml * fixed deps * add openbb-etf lock file * cleanup * cleanup (#5694) * Rename Fixed Income (#5695) * Rename Fixed Income * Add routers * Rename stocks to equity (#5688) * Rename stocks folder * Rename openbb_stocks package * Rename routers * Reroute equity menu * Update routes based on feedback * StockNews -> EquityNews * StockInfo -> EquityProfile * Rename Equity calendars * Equity peers rename * Rename discovery * Rename fundamental * Rename price command models * Rename shorts * Update charting router * Fix seeking alpha upcoming release date * Fix linting errors * Update tests * Fix tests * Skip econometrics api tests because it's python only * Update integration tests and test data * Historical analyst estimates * Skip cboe options chain test. Unable to record vcr cassette * re-record cboe cassettes * Document CBOE unit test creation caveats --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Feature/files-for-igor: Adding a few standard models for Igor (#5699) * add some standard models for Igor * codespell * update descriptions * Add devtools metapackage (#5703) * Add openbb-devtools metapackage * adding devtools to the dev_install script --------- Co-authored-by: hjoaquim * Rename econometrics commands to be more verbose (#5702) * Expose command to model map (#5706) * Rename ta qa (#5708) * Rename ta folder * Rename ta to technical * Rename qa folder * Rename qa to quantitative * Rename the actual routes in quantitative * Equity cleanup (#5707) * cleanup * static * renaming to equity cc @the-praxs * Proof reading --------- Co-authored-by: hjoaquim Co-authored-by: Theodore Aptekarev * Don't enforce imperative for first word of the docstring * Remove ultima from default extensions * Rename `economy` and create `index` extension (#5705) * renamed economy and re-recorded tests * static * market indices * european indices * fred indices * index constituents * tests * correct package name * oops * static * linting * Move COT commands to regulators * Rename economy.list to available_indices * Rename GDP models and clean up * Fix charting tests * Drop _indices from available_indices command * Fix obbject to_dict test --------- Co-authored-by: Theodore Aptekarev * Rename etf/disc (#5715) * Docs/v4-working-docs: PR to Work on V4 Docs (#5693) * Revert changes related to pydantic2 made into v3 code * Revert fred model changes in v3 * Revert pydantic2 databento model changes in v2 * Update some names and v3 lock file * Clean up openbb/package before the beta release * Platform publishing procedure (#5701) * update instructions * introducing the version script * publish message * fix platform path * reflecting version changes * getting version from installed packages instead * removing toml from dependencies * Changes to get `a7` out (#5697) * changes to get a7 out * etf menu on the pyproject.toml * poetry lock * bump `openbb-etf` to `a5` to match version * updated deps * removing ultima * removing references to a4 cc @the-praxs * Bump index menu version * poetry lock --------- Co-authored-by: Pratyush Shukla Co-authored-by: Theodore Aptekarev * Update publishing instructions * Bump core dependencies in extensions and providers * Add changes to the publish script following the beta release * Update the versions in static extension map and openbb metapackage --------- Co-authored-by: James Maslek Co-authored-by: Pratyush Shukla Co-authored-by: hjoaquim Co-authored-by: Diogo Sousa Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: tehcoderer Co-authored-by: DidierRLopes Co-authored-by: andrewkenreich Co-authored-by: Sandip Saha 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 Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: Mohamad Fadil Co-authored-by: Adi Sai * Hotfix/pypi openbb terminal (#5719) * renaming the project * documentation changes * Finishing touches to the publishing procedure (#5728) * finishing touches to the publishing procedure * grammar improvements * Run tests on develop (#5725) * Run tests on develop * Add a check that files changes in platform * Seprate Intrinio financials data tags into a different command (#5723) * add `ebit` field in income statement standard model * only add required data tags * remove calculations data * use `name` key instead of `tag` key * set `period` as required in data * remove `period` and `cik` from provider models * add `equity/fundamental/search_financial_attributes` with tests * clean descriptions file * add `equity/fundamental/financial_attributes` with tests * set `value` as `Optional` * Fix threadpool test error (#5734) * Remove ultima from deps (#5736) * remove ultima from deps * skip ultima test * black * change skip location * try except statement to avoid error on the ci * new currency reference rates pr (#5724) * point files to linters (#5739) * remove news from equity (#5741) * Add tiingo provider (#5740) * first commit * things * Add news endpoints * CryptoHistorical * Add currency and trailing dividend yield * things working * deps * fix pre commit things * tests? * black on the tests * pratty told me to add it * integration tests * added helpers * crypto revamped * currency revamped * trailing dividend yield revamped * equity historical revamped * company news overhauled * global news overhauled * remove `tags` param from news models * crypto correct `exchanges` description * james smh * re-recorded fetcher tests * fixed integration tests * econometrics smh * james smh again --------- Co-authored-by: Pratyush Shukla * Add `derivatives` extension for `futures` and `options` (#5742) * removed options and futures * add derivatives extension * cleanup * bug #5649 (#5722) * bug #5649 * fixing --a upmom, downmom --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Rename the fmp search -> screener (#5744) * Rename the fmp search -> screener * misses some * i cant copy paste * docs/fix-urls: Updates the Terminal About URLs to match `/develop` (#5720) * update Terminal about URLs and some other broken links * ruff * intro * changing the heading levels * dependency management sections * structure * developer guides * structure * contributor guides * keywords and descriptions * broken urls * cool cards * Cool cards (#5727) * tidy up terminal/content * some more tidy up * fix styling for platform that was missing * more tidy up * improve color for dark and light mode * create new reference card for more basic cards * rename back to menus * implement all index.md for terminal, except reference * improve bot title * more refactoring * fix remaining index * header styling * more styling * heheheheheheeh * Revert "heheheheheheeh" This reverts commit 7d095fcfd258efb7e82b75b4663b5360785195f3. * Ccards (#5733) * links * more links * improved styling and chevron aligned to title * fix index.mdx urls for Terminal * update package.json * update index.mdx * fix generation * spelling * toolkit_extensions * update data extensions * couple of links * add tiingo to data extensions list --------- Co-authored-by: hjoaquim Co-authored-by: andrewkenreich Co-authored-by: DidierRLopes Co-authored-by: James Maslek * Stock leftover cleanup (#5745) * change to equity in `.md` files * `HistoricalStockSplits`->`HistoricalSplits` * `StockInsiderTrading`->`InsiderTrading` * sorry fmp * `EquityHistorical` cleanup * `EquityNBBO` cleanup * .md leftover * the last of stocks * Hotfix/urllib to dev group (#5732) * use the urllib3 dependency on the dev group instead * adapt the version script for the nightlies - if it's a nightly the package distribution name will have a different name * add dev dependencies to the dev installation bc of the ci * updating the import on validate_call according to: https://docs.pydantic.dev/latest/concepts/validation_decorator/ the way we were importing it breaks if pydanti… * [Docs] Guides for Metadata and AnnotatedResult (#6457) * [Docs] Redirect contributing URL (#6460) * redirect url * order * [Release] 4.2.2 (#6480) * Docs/update xl docs (#6145) * remove print * update obb.get docs * example * md lint * fix get reference (#6147) * [BugFix] Filter OECD data using `start_date` and `end_date` parameters (#6144) * move constant dicts to constants.py filter by start_date and end_date * black * black again again * Merge 'main' into 'develop' (#6151) * Release/3.2.4 (#5696) * test * ultima description (#5541) * Updating showcase page (#5543) * updating showcase page * use sdk instead * add new bot command autopost docs (#5530) add new bot command autopost docs to docs.openbb.co Co-authored-by: James Maslek * Hotfix/ultima improvements (#5553) * tweaks for monetization * fix linting issue * fix: Modify 'load' behavior to append data to existing sheet (#5503) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Fixed 'worksheet not found' error during export to an existing sheet * Changes: * Now if the sheet exists in the xlsx file it will ask the user if he wants to replace/append/create new sheet --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * added platform API integration test to Nightly build (#5571) * Add columns to `stocks/search` (#5565) * Add columns to `stocks/search` isin, cusip, figi, composite_figi, shareclass_figi * Update test_search[False].txt * Update test_search[True].txt * Delete tests/openbb_terminal/stocks/cassettes/test_stocks_helper/test_search.yaml * Create test_search.yaml --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * updating ultima urls (#5587) * fix: A value is trying to be set on a copy of a slice from a DataFrame #5582 (#5591) * Update README.md (#5598) * Hotfix/econometrics export filename fix (#5508) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Added --export option for exporting to a desired file in /econometrics menu * Added a -f/--file option to provide the filename for export. Made -t/--type and -f/--file mutually exclusive. If -f is not given, -t is required and the filename will be generated based on the time and module. * Revert `helper_funcs.py` to original state * Made some arguments not required. * Minor changes asked by @deeleeramone * No sheet name * black --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * FIX #5600 Updated the Twitter logo to X logo (#5601) * Change Ultima paragraph (#5624) * change ultima paragraph * remove old paragraph * Update CONTRIBUTING.md (#5623) * mobile line-brake fixed (#5604) In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments. Co-authored-by: James Maslek * Docs/terminalpro and improvement (#5622) * add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich * Add light blue banner, blue when clicking sidebar + fix link in docusaurus.config.js (#5627) * typo * pro docs tab coloring * sidebar selection blue * redirecting missing * fix docs (#5646) * Fix the redirect for intro to the correct url for docs (#5658) * fix the redirect for intro to the correct url for docs * fix code linting --------- Co-authored-by: James Maslek * Improve Pro documentation further (#5641) * small improvement * Fix TutorialVideo for mobile view * main page terminal pro docs * jose whelp * placeholder index file that needs to be removed * fix: fixes sidebar, removes unused index.md * update link to api keys * update api keys link * fix hyperlinks in terminal helper * fix a few more links * fix some more links * linter * black linter * improve main docs page for each product * small refactor * header to take to main page of product * run OpenAI script to generate SEO for pro content --------- Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> * Update folders.md * Update integrate-your-own-backend.md * Update index.md * Update settings.md (#5665) * fix front matter (#5667) * #5633 adding comma every 1000 (#5652) * #5633 adding comma every 1000 * pylint --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Hotfix/reports model render report sanitize inputs (#5669) * Adding more robust special character handling to create_output_path(). Addresses https://github.com/OpenBB-finance/OpenBBTerminal/issues/5299 * Running black linter on code to conform to OBB style guides. --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * hotfix/fix-gov-histcont: Fix #5650 - /stocks/gov/histcont (#5676) * fix histcont * some cleanup * remove sort line * 12-31 not 12-12 * columns_keep_types * remove space in regex (#5675) * Pin openai (#5685) * Clarified stocks/ta empty recom object message (#5468) * Clarified stocks/ta empty recom object message * black * lint --------- Co-authored-by: James Maslek * improved market cap value extraction (#5169) * improved market cap value extraction * pylint --------- Co-authored-by: James Maslek * 3.2.3->3.2.4 * Changelogs * new changelog --------- Co-authored-by: Henrique Joaquim Co-authored-by: Andrew Co-authored-by: Adi Sai Co-authored-by: Sandip Saha Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Luqman 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: DidierRLopes 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 Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: Mohamad Fadil Co-authored-by: Ramazan Co-authored-by: joshuabuildsthings Co-authored-by: wojda <114031148+polooner@users.noreply.github.com> Co-authored-by: Bim Phomthong <118195204+bimbolimbo@users.noreply.github.com> * Release/4.0.1 (#5840) * test * ultima description (#5541) * Updating showcase page (#5543) * updating showcase page * use sdk instead * add new bot command autopost docs (#5530) add new bot command autopost docs to docs.openbb.co Co-authored-by: James Maslek * Hotfix/ultima improvements (#5553) * tweaks for monetization * fix linting issue * fix: Modify 'load' behavior to append data to existing sheet (#5503) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Fixed 'worksheet not found' error during export to an existing sheet * Changes: * Now if the sheet exists in the xlsx file it will ask the user if he wants to replace/append/create new sheet --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * added platform API integration test to Nightly build (#5571) * Add columns to `stocks/search` (#5565) * Add columns to `stocks/search` isin, cusip, figi, composite_figi, shareclass_figi * Update test_search[False].txt * Update test_search[True].txt * Delete tests/openbb_terminal/stocks/cassettes/test_stocks_helper/test_search.yaml * Create test_search.yaml --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * updating ultima urls (#5587) * fix: A value is trying to be set on a copy of a slice from a DataFrame #5582 (#5591) * Update README.md (#5598) * Hotfix/econometrics export filename fix (#5508) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Added --export option for exporting to a desired file in /econometrics menu * Added a -f/--file option to provide the filename for export. Made -t/--type and -f/--file mutually exclusive. If -f is not given, -t is required and the filename will be generated based on the time and module. * Revert `helper_funcs.py` to original state * Made some arguments not required. * Minor changes asked by @deeleeramone * No sheet name * black --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * FIX #5600 Updated the Twitter logo to X logo (#5601) * Change Ultima paragraph (#5624) * change ultima paragraph * remove old paragraph * Update CONTRIBUTING.md (#5623) * mobile line-brake fixed (#5604) In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments. Co-authored-by: James Maslek * Docs/terminalpro and improvement (#5622) * add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich * Add light blue banner, blue when clicking sidebar + fix link in docusaurus.config.js (#5627) * typo * pro docs tab coloring * sidebar selection blue * redirecting missing * fix docs (#5646) * Fix the redirect for intro to the correct url for docs (#5658) * fix the redirect for intro to the correct url for docs * fix code linting --------- Co-authored-by: James Maslek * Improve Pro documentation further (#5641) * small improvement * Fix TutorialVideo for mobile view * main page terminal pro docs * jose whelp * placeholder index file that needs to be removed * fix: fixes sidebar, removes unused index.md * update link to api keys * update api keys link * fix hyperlinks in terminal helper * fix a few more links * fix some more links * linter * black linter * improve main docs page for each product * small refactor * header to take to main page of product * run OpenAI script to generate SEO for pro content --------- Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> * Update folders.md * Update integrate-your-own-backend.md * Update index.md * Update settings.md (#5665) * fix front matter (#5667) * #5633 adding comma every 1000 (#5652) * #5633 adding comma every 1000 * pylint --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Hotfix/reports model render report sanitize inputs (#5669) * Adding more robust special character handling to create_output_path(). Addresses https://github.com/OpenBB-finance/OpenBBTerminal/issues/5299 * Running black linter on code to conform to OBB style guides. --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * hotfix/fix-gov-histcont: Fix #5650 - /stocks/gov/histcont (#5676) * fix histcont * some cleanup * remove sort line * 12-31 not 12-12 * columns_keep_types * remove space in regex (#5675) * Pin openai (#5685) * Clarified stocks/ta empty recom object message (#5468) * Clarified stocks/ta empty recom object message * black * lint --------- Co-authored-by: James Maslek * improved market cap value extraction (#5169) * improved market cap value extraction * pylint --------- Co-authored-by: James Maslek * Release/3.2.4 (#5704) * 3.2.3->3.2.4 * Changelogs * new changelog * OpenBB Platform v4 (#5225) * change location * check something * add cache * fixed auth w/@IgorWounds and @montezdesousa * fixes for econometrics * include Darren auth suggestions * some routers included if dev + chg hub backend var * coverage router should not be here * update docker readme * forgot to check auth here * Change extension imports * update docstrings and readme * headers function wasnt being called, just referenced * relative import * econometrics add headers everywhere * Fix QA * Fix TA * Fix test * Fix python interface QA and TA * Lint * Cleanup * Change path * make the changes and some etf models * tests for command_runner * ruff * solving naming issues on pytest * Update some docstrings, fix typos and lint * solving econometrics instantiating wrong openbb * chaging the way pytest runs * messing around with the imports * ruff * Change template to add platform considerations (#5533) * change template to add platform considerations * @the-praxs suggestions * solving __pycache__ issue * removing typo * ci yml * making linters happy (i guess) * Improve Omega Ratio and docstrings * chaging pro validation hash * ruff * Fix OLS Summary and lint * Add OECD Provider for economy extension (#5534) * Add record to docs * update a couple of cboe models * Fix econometrics bugs. Make tests pass. Lint. * black * ruff * pydantic v2: remove deprecated Extra * pydantic v2: self.dict -> self.model_dump * revert pydantic * revert the revert * try 1: pin urllib3 < 2 * Revert "try 1: pin urllib3 < 2" This reverts commit 3736c311cb6aa9e653dcb5db733798408b72a82e. * Revert dep * Fix * re-lock * Skip all tests when doing cspell in pre-commit * Resolve linter errors * Add OECD to install script * Add OECD * Resolve more linter errors * Exclude static files of v4 python from ruff * More linting * Another attempt to resolve even more linting errors * Change how Literal is used * ticker. symbol. consistent. @piiq * change ticker field in Stock Search to is_symbol * Update Cboe model for stocks_search -> is_symbol parameter. * Fix issue * Lint * Small QA to rename SDK to Platform (#5544) * SDK -> Platform in docs * renamed in core * renamed in openbb `init` * `sdk` variable renamed as `platform` --------- Co-authored-by: hjoaquim * `validator` -> `field_validator` in standard models * Standard convention for multi-ticker symbols (#5549) * standardize symbol input param in forex and crypto historical data * static * linting * Fix stock_search integration test params * Update dependencies and linting on the CI (#5550) * Remove ruff and black from platform dependencies * Update codespell configuration * Lint python code * Add toml and tomli to root dev dependencies * Update requirements.txt files * Fix buggy docstring in python package methods (#5548) * fix buggy docstring for methods * remove space * fix typing * avoid name collision with validator * Revert "avoid name collision with validator" This reverts commit 8a30a44555d97132f6bddcbc4a4facdd97ecc591. * typing * rebuild * python 3.8, ParamSpec not available * lint * ruff noqa * Merge with develop (#5551) * Charting extension integration tests (#5547) * initial proposal for integration tests on the charting extension * int tests for charting generation * python generator * ruff * boilerplate templates * python tests * tests for the api * using body instead so data don't get redefined * unit tests for coverage * ruff * docstrings * unnecessary access to keys() * Add trading economics economic calendar * dev install * Data Models disposition on the website (#5538) * pydantic v4 * flat structure * md files * Revert "md files" This reverts commit bd2170e2adf82fed3a35d34fad6a2e3ba3ae1d49. * improve command descriptions * nice title and description * human readble data model names on left panel * implementation details section * content markdown files * markdown versioned files * showcase page * updates --------- Co-authored-by: tehcoderer * everything except tests * fix `datetime.date` import in fetcher test * modified url to remove `api_key` placeholder * record test * api key is called c here * fixed fetcher test for api key * recorded tests * refactor * life is ruff * codespell * Make Intrinio options chains great again (#5540) * add multithreading * cleanup * linting * use dateutil.parser * removed `TICKER_EXCEPTIONS` * modified `date` and `type` fields in standard model * set alias for `date` and `type` to match standards * static * static * Hotfix/fix post tests (#5555) * Fix econometrics * Fix ta * Fix qa. Remove intrinio to not be rate limited * Lint * Fix typo * obbject tests (#5558) * obbject tests * ruff * fix dev_install * fix unittests * black on nox * black on nox * nox * fix fetcher test so it can compare dates * fix intrinio tests * ruff * change to model_dum() instead (#5561) * Passing tests (#5560) * Passing tests * fix options * Fix most tests and bugs * fix forex missing params * make symbol upper in polygon fx pairs * fix fixedincome integration tests (#5564) * Fixing charting api integration tests (#5562) * fixing charting api integration tests * black * fix stocks less five API fails * fix the 5 failing stocks integration tests * recapture fmp stock news unit test * fix fmp forex api test * couple more forex integration fixes * changing the request to always use the legacy session. @jmaslek this is was broken for 3.8 and 3.9; with this change apparently all versions work - lemme know if you see any issue with this change * ruff * fix ta * add missing param * fix testers for the api * fix globalnews to use images instead of image * remove unncessary pandas import * econcal int tests * update gitignore * fix get_querystring to support lists * add missing parameters --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Henrique Joaquim * Stock Historical standardization and UX improvements (#5457) * polygon add interval standard param * attempt at standardization * Alpha Vantage params standardization * rename `get_intervals` and fixed bug for extracting wrong value * missed changing it in `extract_data` * linting * polygon cleanup * modified `start_date` & `end_date` type to `datetime` from `dateType` * standardized intrinio stock historical params * fixed yfinance * linting * revert start and end date to dateType from datetime * fix alpha vantage * changed param * fix intrinio infinite loop * `validator` is `field_validator` * revert time params and fixed intervals * `outputsize` alias set in `Field` * set interval description using in-build dict * yfinance stock param standardization * static * intrinio cleanup * Polygon add api params as `PrivateAttr` * modified yfinance params to `PrivateAttr` * intrinio remove overriding date params * fixed description for AV adjusted param * fix alpha vantage intraday not working * re-record and pass unit tests * pass integration tests * Update test --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Fix econcal endpoint (#5567) * fix econcal for python interface * fix econcal tests * fix non supported json output * Fixes FMP index endpoint to get 1 day interval data (#5535) * fix FMP endpoint for getting index data for `1day` interval * fix `open` type to prevent validation error * modifed `validator` to `field_validator` * type of fields is `StrictFloat` * re-record and pass test * linting * `validator` -> `field_validator`, a3'd everything * Fix regression in tests. Lint * updating the integration test actions * Fix typo * Fix typo * Fix import * Publish versions `a3` to Pypi (#5568) * bump versions and script to publish * small improvements * uncomment exception * openbb * publishing guidelines * improve docs * add providers to economy api * make symbol required in stock_quote * Fix keys * Fix oecd * add comma * revert * Add quotes * Sleep * Improve tests * Improve * Feature/query transform (#5566) * inject query into transform_data * swap query and data * update missing fetchers * last test failing * sig test fetcher * black * av add `query` to `transform_data` call * transform_data: missing refactoring * fix uvicorn command in the doc * Automated examples (#5576) * Automated examples * Fix bug * Lint * static assets built on 3.8 * Revert "static assets built on 3.8" This reverts commit fb82ff7bd9af92ed676d8f8047c31e74daf7b8b2. * remove assets * static assets on 3.8 * static assets on 3.8 * Wrap in quotes * Improve wrap * minor fix * rebuild 3.8 * Fix bug * Fix edge case * Lint * rebuild --------- Co-authored-by: hjoaquim Co-authored-by: Diogo Sousa * use SecretStr for sensitive fields (#5578) * use SecretStr for sensitive fields * fix * docstring * Add tests for provider (#5583) * Add tests for provider * Test standard models * Lint * Fix standard model issues. Co-authored-by: @the-praxs * linting * `symbol` -> `is_symbol` in `economy.index_search` * static --------- Co-authored-by: Pratyush Shukla * feature/v4-biztoc-provider: Adds Biztoc provider and GlobalNews (#5546) * add biztoc provider * duplicate field * black * request headers * recapture test * move stuff around * add integration tests * duplicate OECD entry in dev_install * duplicate entry for oecd in pyproject.toml * Add Biztoc to workflow * update readme: credentials * Add Preferences to README * improve tests * fix biztoc * obbject pylint * Bug fix: serializ SecretStr before dumping to json * export credentials as json (#5592) * Check for wrong, changed, or outdated params. (#5597) * Improving `economy.cpi` for the FRED data (#5602) * remove multiindex using coding magic * Update field descriptions --------- Co-authored-by: Theodore Aptekarev * Improve error message. * Improve * Test tests (#5607) * Test tests * Add test * 4.0.0a4 PyPI publishing (#5608) * changes to publish * fix mini conflict * typo * cleaned `descriptions.py` * fix description in `cpi.py` * Add ETF extension to v4 (#5609) * Add etf extension with search data model * Add FMP ETF search * Add fetcher tests * Add ETF historical price from yfinance (#5610) * Add etf extension with search data model * Add FMP ETF search * Add fetcher tests * Add etf historical price standard model and route * Add etf historical data from yfinance * Add unit tests * Fix linter error. Organize imports * Update test data * Revert common descriptions erased by CPI PR * remove `symbol` from data for `stocks.ca.peers` * Test docstrings (#5613) * Test docstrings * fix minor bugs w/@IgorWounds * static only w/@IgorWounds * fix `importance` param in `economy.econcal` * right static only w/@IgorWounds * Fix econcal and add tests to noxfile * fix econcal static * re-record --------- Co-authored-by: Pratyush Shukla * Clean up the newly created ETF extension (#5611) * Add ETF to dev_install bundle * Add integration tests for openbb-etf * Patch integration test generator scripts to produce lintable code * Add py.typed markers for extensions * user preferences descriptions (#5593) * user preferences descriptions * typo * Feature/v4-sec-provider: Add SEC provider to V4 (#5556) * coerce string type, add default=None * add sec provider and FTD function * update description * ruff * data model definitions in standard model already * duplicate oecd entries in dev_install and pyproject * actually commit * integration test * add stock search to SEC * add company filings for SEC provider * integration tests * remove duplicated line * ruff * **kwargs in Transform Data * some helper functions for later * black * add helper for mutual fund and etf lookup * add some SEC lookup helpers to a new regulators extension * black * ruff * fix test param * take institution filter out of sec stock_search * ruff * remove URL that codespell doesn't like * add cik-to-ticker map * add litigations rss feed * make openbb-regulators a dependency of openbb-sec * add SIC search * improve ftd and remove BeautifulSoup from SEC dependencies * fix parsing the zip files pre-2009 * ruff * update descriptions * recapture ftd test * tests params * typo * change limit param to 1 in test_sec_stock_ftd * Add didiers to_records method (#5588) * Add didiers to_records * unused import * Bring back polars + do what igor suggested * Make the output consistent with what it was. * Black ? * spelling. oops. almost like we have a pre commit or something * Feature/v4-price-performance: % returns for various horizons, comparable across multiple tickers. (#5618) * coerce string type, add default=None * add price_performance endpoint from FMP * black * extra period in docstring * ruff * forgot one file * Feature/ipo-calendar: V4 IPO Calendar (#5605) * coerce string type, add default=None * add intrinio ipo calendar * fix typo * sort __init__ * fix description * make requested changes * update test params * black * test updates * etf integration * Add disc router and WSJ provider * OBBject extensions (#5612) * changes to core * bug? * docstring * doc * Update credentials.py * fix model_dump * create extensions * fix docstring * doc * revert change query_exc * doc * fix container test * redirect obbject test patch * doc * rename method * move decorator to extension file * rename method extend_obbject * changes in creds model * avoid credential racing * doc * rename prop * doc * doc * remove comment * comment some code * free extension names * docstring * doc * docs * Hotfix/fix-v4-economic-calendar: Add FMP to Econ Calendar and fix some TE bugs (#5580) * coerce string type, add default=None * adds fmp to economic calendar and fixes some things with TE * ruff * etf integration test * missing provider for test * rename te cassette to economic_calendar * fix test * rename tests --------- Co-authored-by: James Maslek * Add stocks disc endpoints (#5630) * Add stocks disc endpoints * Explicit * Lint * Add tests * Bump timeout * Feature/disc router (#5616) * Add disc router and WSJ provider * Lint * Lint * Move endpoints under ETF router * Update etf_performance.py * Add ETF info and sector exposure from FMP (#5620) * Add ETF info from FMP * Add integration tests * Add unit tests * Add etf sectors endpoint * Add etf sectors fmp endpoint * Omit nested sector list from fmp info data * Update tests and test data * Update test data * Specify provider explicitly in integration tests * Update tests * Skip yfinance etf historical test * Fix linter errors after the merge * Fix more linter errors * Fix failing and add missing tests * Fix integration tests * Fix calendar ipo tests * Add ETF holdings and holding report dates from FMP (#5629) * Add ETF info from FMP * Add integration tests * Add unit tests * Add etf sectors endpoint * Add etf sectors fmp endpoint * Omit nested sector list from fmp info data * Update tests and test data * Update test data * Specify provider explicitly in integration tests * Update tests * Skip yfinance etf historical test * Add etf holdings and holdings date routes and standard models * Add fmp holdings and holding dates fetchers * Update holdings fetcher to properly handle date object inputs * Add unit tests * Add integration tests * Black after merge * Fix test input data format * Disc router for equities. (#5640) * Disc router for equities. * add tests * Bug fixes in financial statements (#5537) * `validator` to `field_validator` in standard models * Polygon add `ttm` to `period` param * Revert "Polygon add `ttm` to `period` param" * Polygon add `ttm` to param `period` * `EarningsCallTranscript` standard model removed `quarter` param * use `tag` instead of `name` for correct field name * fix url for intrinio income statement * modified intrinio cash flow `transform_data` function * set optional data fields and validate dates * fix insider trading not fetching recent data * linting * refactoring * refactoring * set param alias in fmp stock insider provider model * get all quarter data for intrinio * add `limit` param to `stocks.fa.ins` * refactoring and linting * removed additional comment * linting * re-recorded and fix tests * cash flow standard model field type to `StrictFloat` * Intrinio cash flow model fixed to get all quarters' data * linting * refactoring * financial statement standard model field type to `StrictFloat` * Intrinio financial statement model get all quarter data * set `period` type to `Optional[str]` * add `period` param to balance sheet provider models * add `period` param to cash flow provider models * use alias in model dump * remove `ttm` from `period` param * revamped intrinio financials * fixed incorrect description for `limit` param * modified tests for `balance`, `cash` and `income` * re-recorded tests * skipped intrinio financial statement fetcher tests * Add ETF county weighting command with FMP data (#5645) * Remove code that wrongfully infers the filing date as end of quarter * Add etf countries command with fmp data * Add countries command to etf router * Update sector and country weighting fmp models * Fix docstring typo * Add unit tests and update mock data * Add integration tests for etf.countries * Bring back missing integration tests * Fix economic calendar integration tests * fix missing data in intrinio financials * removed inutile params from Polygon financial statement models * Intrinio IPO overhaul * tests fixed and re-recorded * Add ETF holdings performance with FMP data (#5659) * Add etf holdings performance endpoint * Add tests * Fix failing polygon fetcher tests * Split long holdings lists into chunks and update test data * Change chunk length to 500 tickers * Add stock search from FMP (#5642) Co-authored-by: Theodore Aptekarev * Feature/v4 pypi (#5579) * improvements to the publish script * move scripts * initial script that builds the package * adjustments on the docs * test pypi workflow * add hour and minute to version * black * ruff * duplicate file * moving files instead * build throught the script instead * update nox file * integration tests workflow * change workflow * fix dev_install * fix in sed cmd * testing the platform only * commenting out the publishing * fix run commands * improvements to the publish script and doc * fix publish script * updating the script and the workflow * feature/v4-pypi nightly (#5589) * init * Update nightly.py * cleanup * init file * not referencing dev_utils * updating obb platform key * revert * Increase warmup time * project name on pyproject and adding the --pre flag on readme * moving to the build folder * fix noxfile * reflecting the moves on the import statements * fix pyproject path * ruff * fix paths * fix super typo * update workflows * moving the pypi terminal files into its folder --------- Co-authored-by: teh_coderer Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Theodore Aptekarev * economy.calendar nasdaq (#5628) * add quandl econcal * unittest * add integration tests * replace   * fix bug TE importance * small fix * remove stuff from quandl * add nasdaq provider * add nasdaq to install files * Update test_economy_api.py * test * quandl leftovers * remove quandl econcal test * lint * replace   * ruff * lint * update nasdaq gmt * validate countries * here * no need for this * fix calendar tests * static * static * remove error * static * readme + website * readme * remove changes TE * typo * fix unittest * fix tests * Update __init__.py * Update economic_calendar.py * revamped model and added helpers for date range --------- Co-authored-by: Pratyush Shukla * Feature/v4-dividend-calendar: Adds Nasdaq dividend calendar and moves the command out of fundamental_analysis (#5672) * add nasdaq dividend calendar and move out of fundamental_analysis * black * ruff * add random-user-agent to pyproject.toml * add nasdaq ipo calendar * add nasdaq flag for SPO to IPO calendar * add spo test param * black * dividend test * fix transform_query - nasdaq_calendar_ipo * bring back different headers for ipo calendar * remove references to test * Add disc endpoints (#5660) * Add Quandl top retail * Add tests * Add Seeking Alpha * Add Filings * Change Provider * Fix test * Add dev_install * static * static correct * y u forget me * updated deps * static --------- Co-authored-by: Pratyush Shukla * using dev install (#5673) * Expanding the `fixedincome` menu (#5655) * models and fetcher * making the fetcher visible * std model * adding the command * improvements to the models * typo * adding the command * imrpovements to dwpcr * standard model for ecb int rates * adding the fetcher for fred * standard model of ice bofa * add ice_bofa command * ruff * ice bofa fetcher * moody std model * moody * std model * add cp command * unused import * cp * spot * ruff * hqm * tmc * ffrmc * tbffr * ruff * typing fixes * buggy dates * fred fetcher tests * ruff * adding ecb as a provider * adding new provider related stuff * adding the new command eu_ycvr * models * test for ecb fetcher * Feature/v4 fixedincome int tests (#5661) * integration tests * happy ruff * mini adjustment * ruff * typo * verbose type * fix tests * docstrings everywhere and an happy pydocstyle * fix tests * Feature/user-cache-dir: Add User Preference for the Cache Directory (#5621) * add user preference for storing cached data * ruff * fix tests? * fix test key error..? * etf integration test fix * add cache dir to SEC * black * improve docs structure for V4 (#5586) * improve docs structure for V4 * moving over changes * Add Docs to the navbar * add some, re-order sidebar * fix sentence * add docs install to source instructions * insert a couple of links, fix a typo * big terminal docs usage revamps * improve toggle component for tutorials * get rid of TOCs for all terminal docs for consistency and simplicity * improve platform docs * improve bot docs content structure * remove index from bot docs * improve ON THIS PAGE to only display TOC if at least 1 element * make edit this page text and icon on same line * add author and date to docs * add basic syntax page to usage * sidebar order for usage section * move api start command to the top with the import python import * some install page additions * small improvement * refactor routines section * Update introduction-to-routines.md * Update pipeline-of-commands.md * Update introduction-to-routines.md * Update routines-for-power-users.md * Update community-routines.md * update keyboard hotkey macros * askobb page * Update askobb-feature.md * Update index.md * Update index.md * Update index.md * Update index.md * fix images * remove HeadTitle from all files where it exist * get rid of extra spacing in markdown * small update * small edit * need index at the start because of main path when homepage of docs * use openAI to create SEO for front matter on my behalf * remove table of content from sdk page * finish improving metadata SEO for SDK docs * update duplicate header * update HeadTitle to be more specific on product * remove index from bot telegram reference * delete duplicated title for platform reference * another update * Hotfix/econometrics export filename fix (#5508) * fix: Modify 'load' behavior to append data to existing sheet Details: - Added logic to detect existing sheet and append data if present. - There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number. Resolves: #5472 * Added --export option for exporting to a desired file in /econometrics menu * Added a -f/--file option to provide the filename for export. Made -t/--type and -f/--file mutually exclusive. If -f is not given, -t is required and the filename will be generated based on the time and module. * Revert `helper_funcs.py` to original state * Made some arguments not required. * Minor changes asked by @deeleeramone * No sheet name * black --------- Co-authored-by: James Maslek Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * FIX #5600 Updated the Twitter logo to X logo (#5601) * Change Ultima paragraph (#5624) * change ultima paragraph * remove old paragraph * Update CONTRIBUTING.md (#5623) * mobile line-brake fixed (#5604) In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments. Co-authored-by: James Maslek * start PR so screenshots can get attached via GitHub website * Update qa.md * Docs/terminalpro and improvement (#5622) * add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich * Add light blue banner, blue when clicking sidebar + fix link in docusaurus.config.js (#5627) * typo * pro docs tab coloring * sidebar selection blue * redirecting missing * Update crypto introduction.md * titles * another title * Update crypto dd.md * Update defi.md * Update disc.md * Update nft.md * Update onchain.md * Update ov.md * Update introduction.md updates URL * Update introduction.md add HeadTitle * Update ba.md * Update comparison.md * Update dark-pool-shorts.md * Update disc.md * fix docs (#5646) * Update fa.md * Update gov.md * Update ins.md * Update tradinghours.md * Delete website/content/terminal/menus/stocks/options/screener.md * Update Options introduction.md * Update screener head title * Update screener TOC * Update econometrics.md * Update economy head title * Update etf.md * codespell * Fix the redirect for intro to the correct url for docs (#5658) * fix the redirect for intro to the correct url for docs * fix code linting --------- Co-authored-by: James Maslek * Contributing guidelines (#5615) * intro section * what's expected sections * improve sections * improve sections and move how to add a data point * moving qa under contributor * better intro * moving the sharing section * better expectations * small intro to the contributor guidelines * moving things under the contributor section * there is no pre commits on the platform yet * dependency management * best practices for extensions * typo * collapse options subfolder * codespell * Improve Pro documentation further (#5641) * small improvement * Fix TutorialVideo for mobile view * main page terminal pro docs * jose whelp * placeholder index file that needs to be removed * fix: fixes sidebar, removes unused index.md * update link to api keys * update api keys link * fix hyperlinks in terminal helper * fix a few more links * fix some more links * linter * black linter * improve main docs page for each product * small refactor * header to take to main page of product * run OpenAI script to generate SEO for pro content --------- Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> * Update folders.md * Update integrate-your-own-backend.md * Update index.md * Update fixedincome.md * url * Update forecast.md * Update settings.md (#5665) * Update forex.md * fix front matter (#5667) * Fix conflict markers that got into markdown during previous merges * Fix front matter list formatting * Fix typo * small thing * fix hyperlinks * Update .codespell.ignore * output_type options * Architectural considerations * Update sidebar to hide pro section by default * Minor copy changes * TET pattern * import statements * clarification on preferences * Minor copy changes * Lint markdown and python * fix: open index on collapsible root elements * remove old content * options title * Fix linting errors * Refactor sidebar label to url mapping condition --------- Co-authored-by: andrewkenreich Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: hjoaquim Co-authored-by: Sandip Saha Co-authored-by: James Maslek 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 Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: Mohamad Fadil Co-authored-by: Theodore Aptekarev * Add multi-ticker support to etf_countries (#5670) * add multi-ticker support to etf_countries * remove commented-out lines * normalized percent points * percent -> percentage * Fix Nasdaq Econ Calendar Fetcher (#5668) * fix nasdaq econ cal request * more html tags * add random-user-agent to pyproject * another edge case - 24H -> 00:00 * Feature/v4-unusual-options: Adds unusual options endpoint. (#5677) * add unusual options fro Intrinio * test params * move sorting * Change type * update FMP fetcher to use the V4 endpoint (#5681) * Fix price performance not parsed correctly when there is only 1 ticker (#5678) * Add crypto search standard model and FMP data for it (#5679) * Apply renaming to news data (#5684) * inegration complete * reformatted for black * fix ruff issues * revised integration * changes to versions in pyproject.toml and updated lock files * Rename models * Update tests * Fix typos here and there * Update routers * Apply rename to ultima * Properly mock api key * Mock ultima api key --------- Co-authored-by: Adi Sai * Feature/v4-market-snapshots: Adds full market snapshots (#5473) * add stocks market snapshots from fmp * add fmp fetcher test * unused imports * add polygon to market_snapshots * update fmp market_snapshots * black * pydantic2 things * updates * change validate_obj to model_validate * polygon cleanup * tests * descriptions * black * data description * minor adjustments, using less local variables, improving readability and removing pandas * better structure * minor adjustments * lint * fix int tests --------- Co-authored-by: hjoaquim * Add NBBO Quotes, with historical, to `obb.stocks.quote()` (#5617) * coerce string type, add default=None * add polygon stock quote * limit cleanup * add greater/less than to params * limit param * black * tests * fix tests * test_etf * rename model and function to NBBO * add standard model for nbbo * improve standardization * not redifining builtin max * fix input params * integration test params * removing unused import Co-authored-by: Pratyush Shukla * revamped code * re-recorded nbbo test * added symbol validator * added alias in field * Stock news -> Company news --------- Co-authored-by: hjoaquim Co-authored-by: Pratyush Shukla Co-authored-by: Theodore Aptekarev * hotfix/update-quandl-to-nasdaq: Merge Quandl + Nasdaq (#5682) * merge quandl nd nasdaq * dev_install.py * test param name * economy python integration test * Add more input types to data processing commands (#5453) * adding more supported types to data processing commands * ruff * removing unused import * docstrings * data processing types covertion * data description * test filters * ruff * fix package builder tests * ruff * removing print * Add stocks/dps module (#5638) * short volume * pyproject missed * add sec short interest with days to cover * Add FINRA OTC endopoint * some tests * rest of unit tests * Integratin test scripts * dev install * linters caught by pre commit * lines too long * Last test files * maybe it needs a lock file? * thanks pratty * Maybe ill actually listen to pratty next time * sec test date freeze * I cant hit buttons * re record tests * tests 3 * Stockgrid test * regen int test * more testing * lint * moved these fns * dis killing me * one more test * last one * Update integration tests * Fix tests picking up wrong dps route --------- Co-authored-by: Theodore Aptekarev * Rename Forex to Currency (#5687) * restore fields as optional (#5686) * Rename Crypto (#5689) * added `crypto.price.historical` * static * fix tests * fix incorrect label * Move model from sec to finra (#5692) * Update toml * fixed deps * add openbb-etf lock file * cleanup * cleanup (#5694) * Rename Fixed Income (#5695) * Rename Fixed Income * Add routers * Rename stocks to equity (#5688) * Rename stocks folder * Rename openbb_stocks package * Rename routers * Reroute equity menu * Update routes based on feedback * StockNews -> EquityNews * StockInfo -> EquityProfile * Rename Equity calendars * Equity peers rename * Rename discovery * Rename fundamental * Rename price command models * Rename shorts * Update charting router * Fix seeking alpha upcoming release date * Fix linting errors * Update tests * Fix tests * Skip econometrics api tests because it's python only * Update integration tests and test data * Historical analyst estimates * Skip cboe options chain test. Unable to record vcr cassette * re-record cboe cassettes * Document CBOE unit test creation caveats --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Feature/files-for-igor: Adding a few standard models for Igor (#5699) * add some standard models for Igor * codespell * update descriptions * Add devtools metapackage (#5703) * Add openbb-devtools metapackage * adding devtools to the dev_install script --------- Co-authored-by: hjoaquim * Rename econometrics commands to be more verbose (#5702) * Expose command to model map (#5706) * Rename ta qa (#5708) * Rename ta folder * Rename ta to technical * Rename qa folder * Rename qa to quantitative * Rename the actual routes in quantitative * Equity cleanup (#5707) * cleanup * static * renaming to equity cc @the-praxs * Proof reading --------- Co-authored-by: hjoaquim Co-authored-by: Theodore Aptekarev * Don't enforce imperative for first word of the docstring * Remove ultima from default extensions * Rename `economy` and create `index` extension (#5705) * renamed economy and re-recorded tests * static * market indices * european indices * fred indices * index constituents * tests * correct package name * oops * static * linting * Move COT commands to regulators * Rename economy.list to available_indices * Rename GDP models and clean up * Fix charting tests * Drop _indices from available_indices command * Fix obbject to_dict test --------- Co-authored-by: Theodore Aptekarev * Rename etf/disc (#5715) * Docs/v4-working-docs: PR to Work on V4 Docs (#5693) * Revert changes related to pydantic2 made into v3 code * Revert fred model changes in v3 * Revert pydantic2 databento model changes in v2 * Update some names and v3 lock file * Clean up openbb/package before the beta release * Platform publishing procedure (#5701) * update instructions * introducing the version script * publish message * fix platform path * reflecting version changes * getting version from installed packages instead * removing toml from dependencies * Changes to get `a7` out (#5697) * changes to get a7 out * etf menu on the pyproject.toml * poetry lock * bump `openbb-etf` to `a5` to match version * updated deps * removing ultima * removing references to a4 cc @the-praxs * Bump index menu version * poetry lock --------- Co-authored-by: Pratyush Shukla Co-authored-by: Theodore Aptekarev * Update publishing instructions * Bump core dependencies in extensions and providers * Add changes to the publish script following the beta release * Update the versions in static extension map and openbb metapackage --------- Co-authored-by: James Maslek Co-authored-by: Pratyush Shukla Co-authored-by: hjoaquim Co-authored-by: Diogo Sousa Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: tehcoderer Co-authored-by: DidierRLopes Co-authored-by: andrewkenreich Co-authored-by: Sandip Saha 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 Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: Mohamad Fadil Co-authored-by: Adi Sai * Hotfix/pypi openbb terminal (#5719) * renaming the project * documentation changes * Finishing touches to the publishing procedure (#5728) * finishing touches to the publishing procedure * grammar improvements * Run tests on develop (#5725) * Run tests on develop * Add a check that files changes in platform * Seprate Intrinio financials data tags into a different command (#5723) * add `ebit` field in income statement standard model * only add required data tags * remove calculations data * use `name` key instead of `tag` key * set `period` as required in data * remove `period` and `cik` from provider models * add `equity/fundamental/search_financial_attributes` with tests * clean descriptions file * add `equity/fundamental/financial_attributes` with tests * set `value` as `Optional` * Fix threadpool test error (#5734) * Remove ultima from deps (#5736) * remove ultima from deps * skip ultima test * black * change skip location * try except statement to avoid error on the ci * new currency reference rates pr (#5724) * point files to linters (#5739) * remove news from equity (#5741) * Add tiingo provider (#5740) * first commit * things * Add news endpoints * CryptoHistorical * Add currency and trailing dividend yield * things working * deps * fix pre commit things * tests? * black on the tests * pratty told me to add it * integration tests * added helpers * crypto revamped * currency revamped * trailing dividend yield revamped * equity historical revamped * company news overhauled * global news overhauled * remove `tags` param from news models * crypto correct `exchanges` description * james smh * re-recorded fetcher tests * fixed integration tests * econometrics smh * james smh again --------- Co-authored-by: Pratyush Shukla * Add `derivatives` extension for `futures` and `options` (#5742) * removed options and futures * add derivatives extension * cleanup * bug #5649 (#5722) * bug #5649 * fixing --a upmom, downmom --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Rename the fmp search -> screener (#5744) * Rename the fmp search -> screener * misses some * i cant copy paste * docs/fix-urls: Updates the Terminal About URLs to match `/develop` (#5720) * update Terminal about URLs and some other broken links * ruff * intro * changing the heading levels * dependency management sections * structure * developer guides * structure * contributor guides * keywords and descriptions * broken urls * cool cards * Cool cards (#5727) * tidy up terminal/content * some more tidy up * fix styling for platform that was missing * more tidy up * improve color for dark and light mode * create new reference card for more basic cards * rename back to menus * implement all index.md for terminal, except reference * improve bot title * more refactoring * fix remaining index * header styling * more styling * heheheheheheeh * Revert "heheheheheheeh" This reverts commit 7d095fcfd258efb7e82b75b4663b5360785195f3. * Ccards (#5733) * links * more links * improved styling and chevron aligned to title * fix index.mdx urls for Terminal * update package.json * update index.mdx * fix generation * spelling * toolkit_extensions * update data extensions * couple of links * add tiingo to data extensions list --------- Co-authored-by: hjoaquim Co-authored-by: andrewkenreich Co-authored-by: DidierRLopes Co-authored-by: James Maslek * Stock leftover cleanup (#5745) * change to equity in `.md` files * `HistoricalStockSplits`->`HistoricalSplits` * `StockInsiderTrading`->`InsiderTrading` * sorry fmp * `EquityHistorical` cleanup * `EquityNBBO` cleanup * .md leftover * the last of stocks * Hotfix/urllib to dev group (#5732) * use the urllib3 dependency on the dev group instead * adapt the version script for the nightlies - if it's a nightly the package distribution name will have a different name * add dev dependencies to the dev installation bc of the ci * updating the import on validate_call according to: https://docs.pydantic.dev/latest/concepts/validation_decorator/ the way we were importing it breaks if pydantic=2.5 @montezdesousa * loosing urllib3 version specification on the provider and adding it to platform dev deps * rmeoving urllib from top level deps; and removing --with dev flag * changing to ^ instead * Revert "changing to ^ instead" This reverts commit 7300904e9f3adba372b106d381b70ae06e28795a. * unnecessary dep --------- Co-authored-by: Theodore Aptekarev Co-authored-by: James Maslek * feature/v4-bop - Add ECB Balance of Payments (Replaces #5716) (#5726) * add ecb balance of payments * missing __init__.py files * Nasdaq calendar earnings and fix FMP calendar earnings (#5718) Co-authored-by: James Maslek * feature/us-treasury-auctions: Adds Treasury Auctions endpoint and provider for US Government Data. (#5746) * add government_us provider and treasury auctions endpoint * black * add param for cusip * move logic for setting default start/end date * Update hub<>platform credentials map (#5749) * update hub<>platform credentials map * typo * Add API settings schema to system settings (#5743) Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * Skip checking creds (#5737) * skip checking creds * fix bug * ok mypy * add comment * rename required_credentials * fix * fix top_retail bug * don't require creds in some nasdaq fetchers * black * this was not here before * fix tests * update fetcher test * update contributing guidelines * Fix Quote (#5752) * Fix Quote * fixed return type and model validation --------- Co-authored-by: Pratyush Shukla * Wrap up renaming global news to world news on a model level (#5750) * Wrap up renaming global news to world news on a model level * cleanup --------- Co-authored-by: Pratyush Shukla * Remove eod from docstrings (#5751) * Wrap up renaming global news to world news on a model level * Remove "end of day" from historical price model docstrings --------- Co-authored-by: Pratyush Shukla * Massive docstring cleanup (#5755) * sec router remove command * standard models cleanup * fmp cleanup * av cleanup * benzinga cleanup * biztoc cleanup * cboe cleanup * ecb cleanup * finra cleanup * fred cleanup * us cleanup * intrinio cleanup * nasdaq cleanup * oecd cleanup * polygon cleanup * sec cleanup * seeking alpha cleanup * stockgrid cleanup * tiingo cleanup * tradingeconomics cleanup * ultima cleanup * wsj cleanup * yfinance cleanup * sec router lint * fix date query param description * Updates system and api settings (#5753) * remove uncessary import on rest api * remove FrozenField and add api.version * allow setup from json * remove id tag * computed field is better * formatting --------- Co-authored-by: Theodore Aptekarev * Squeeze build time (#5756) * squeeze build time * bug fix * fix test * typo? * rebuild * keep tradingeconomics * docs/working-docs: Working V4 Docs PR (#5747) * post-install clarification, fix links * more links * change word * toolkit cleanup * rename 'contributing' to 'development' * update extensions * some urls * Update sdk-platform and v4-develop in urls (#5730) * Update sdk-platform and v4-develop in urls * Seprate Intrinio financials data tags into a different command (#5723) * add `ebit` field in income statement standard model * only add required data tags * remove calculations data * use `name` key instead of `tag` key * set `period` as required in data * remove `period` an… * [Docs] Fix Broken URLs (#6494) * fix broken urls * couple more * remove poetry install openbb_platform from docs generation. * Try it this way. * [Docs] Excel docs update (#6504) * update xl docs * update xl files * revert to dev version --------- 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 Co-authored-by: Luqman Co-authored-by: Pratyush Shukla Co-authored-by: Michael Struwig Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: capital0 <72140796+capital0@users.noreply.github.com> Co-authored-by: Ben Van Doren Co-authored-by: Andrew Co-authored-by: Adi Sai Co-authored-by: Sandip Saha 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: DidierRLopes 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 Co-authored-by: Mohamad Fadil Co-authored-by: Ramazan Co-authored-by: joshuabuildsthings Co-authored-by: wojda <114031148+polooner@users.noreply.github.com> Co-authored-by: Bim Phomthong <118195204+bimbolimbo@users.noreply.github.com> Co-authored-by: Theodore Aptekarev Co-authored-by: tehcoderer Co-authored-by: Ramazan Co-authored-by: omahs <73983677+omahs@users.noreply.github.com> Co-authored-by: minhhoang1023 <40023817+minhhoang1023@users.noreply.github.com> Co-authored-by: Ayrton Parkinson Co-authored-by: northern-64bit <75195383+northern-64bit@users.noreply.github.com> Co-authored-by: Luqman Co-authored-by: Eric Li <38477812+EricLi-Dev@users.noreply.github.com> Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com> Co-authored-by: Disorder AA Co-authored-by: Diogo Sousa --- .pylintrc | 2 +- website/content/cli/configuration.md | 4 +- website/content/cli/data-sources.md | 2 +- website/content/cli/installation.md | 31 +- website/content/excel/functions.json | 3811 +--- website/content/excel/openapi.json | 15729 ++++++++++++---- website/content/excel/openbb-functions.json | 173 + .../platform/developer_guide/index.mdx | 42 +- website/content/platform/installation.mdx | 1 - .../user_guides/add_toolkit_extension.mdx | 2 +- .../platform/user_guides/basic_syntax.mdx | 44 +- .../platform/user_guides/extensions.mdx | 311 + website/generate_excel_markdown.py | 94 +- 13 files changed, 12270 insertions(+), 7976 deletions(-) create mode 100644 website/content/excel/openbb-functions.json create mode 100644 website/content/platform/user_guides/extensions.mdx diff --git a/.pylintrc b/.pylintrc index 7dafd86d99e..f0e59929841 100644 --- a/.pylintrc +++ b/.pylintrc @@ -54,7 +54,7 @@ confidence= # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call # disable=too-many-instance-attributes,len-as-condition,too-few-public-methods,anomalous-backslash-in-string,no-else-return,simplifiable-if-statement,too-many-arguments,duplicate-code,no-name-in-module,no-member,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,missing-docstring,invalid-name,bad-whitespace,consider-using-enumerate,unexpected-keyword-arg -disable=useless-return,missing-docstring,invalid-name,import-error,broad-except,unnecessary-lambda,missing-timeout,duplicate-code,consider-using-generator,unbalanced-tuple-unpacking,use-list-literal,no-name-in-module,use-sequence-for-iteration,use-dict-literal,unspecified-encoding,unsubscriptable-object,broad-exception-raised +disable=useless-return,missing-docstring,invalid-name,import-error,broad-except,unnecessary-lambda,missing-timeout,duplicate-code,consider-using-generator,unbalanced-tuple-unpacking,use-list-literal,no-name-in-module,use-sequence-for-iteration,use-dict-literal,unspecified-encoding,unsubscriptable-object,broad-exception-raised,possibly-used-before-assignment # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option diff --git a/website/content/cli/configuration.md b/website/content/cli/configuration.md index 9ade9e69d4b..90216554af7 100644 --- a/website/content/cli/configuration.md +++ b/website/content/cli/configuration.md @@ -18,12 +18,12 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; -In addition to the OpenBB Platform's `user_settings.json` file, described [here](/platform/usage/settings_and_environment_variables), there are settings and environment variables affecting the CLI only. +In addition to the OpenBB Platform's `user_settings.json` file, described [here](/platform/user_guides/settings_and_environment_variables), there are settings and environment variables affecting the CLI only. :::important API credentials are defined in the `user_settings.json` file. -Find all data providers [here](/platform/extensions/data_extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials). +Find all data providers [here](/platform/user_guides/extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials). Define default data sources by following the pattern outlined [here](data-sources) ::: diff --git a/website/content/cli/data-sources.md b/website/content/cli/data-sources.md index aa79329da1f..7ded01b8bea 100644 --- a/website/content/cli/data-sources.md +++ b/website/content/cli/data-sources.md @@ -26,7 +26,7 @@ Many commands have multiple data sources associated with it. This page describes :::important API credentials are defined in the `user_settings.json` file. -Find all data providers [here](/platform/extensions/data_extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials). +Find all data providers [here](/platform/user_guides/extensions/), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials). ::: ## Data Source In-Command diff --git a/website/content/cli/installation.md b/website/content/cli/installation.md index b26cb516659..abde7a52b96 100644 --- a/website/content/cli/installation.md +++ b/website/content/cli/installation.md @@ -25,9 +25,24 @@ The OpenBB Platform CLI is a wrapper around the [Platform](/platform), and shoul Please refer to the [OpenBB Platform install documentation](/platform/installation) for instructions and more information. :::info -If the OpenBB Platform is not already installed, the `openbb-cli` package will install the default components. +If the OpenBB Platform is not already installed, the `openbb-cli` package will install all available components. ::: +### Windows + +The machine may need to have an installation of Visual C++ Build Tools available. Download the elements highlighted in the images below. + +
+"Microsoft Visual C++ 14.0 or greater is required" + +Download and install [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), restart the machine, then continue. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/ceb57be0-6dae-42f2-aca6-bf62ce7d6135) + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f8aef8fc-a080-4164-bd36-460714ec44f3) + +
+ ### Linux Requirements Linux users will need to take additional steps prior to installation. @@ -71,26 +86,20 @@ Welcome to OpenBB Platform CLI v1.0.0 Follow the instructions [here](/platform/installation#source) to clone the GitHub repo and install the OpenBB Platform from the source code. -Next, navigate into the folder: `~/OpenBBTerminal/cli` +Next, navigate into the folder: `~/OpenBBTerminal/openbb_platform` :::tip -The Python environment should have `toml` and `poetry` installed. +The Python environment should have `poetry` installed. ```bash -pip install toml poetry +pip install poetry ``` ::: Finally, enter: ```console -poetry install -``` - -Alternatively, install locally with `pip`: - -```bash -pip install -e . +python dev_install.py -e --cli ``` ## Installing New Modules diff --git a/website/content/excel/functions.json b/website/content/excel/functions.json index 1cebe7a1928..c86e1b29f05 100644 --- a/website/content/excel/functions.json +++ b/website/content/excel/functions.json @@ -72,81 +72,6 @@ "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 comma separated 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, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Time interval of the data to return. (provider: fmp);\nTime interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y (provider: polygon)", - "name": "interval", - "optional": true, - "type": "string" - }, - { - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (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": "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", @@ -154,7 +79,7 @@ "name": "CURRENCY.PRICE.HISTORICAL", "parameters": [ { - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, @@ -171,104 +96,10 @@ "type": "string" }, { - "description": "Options: fmp, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Time interval of the data to return. (provider: fmp);\nTime interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y (provider: polygon)", + "description": "Time interval of the data to return. Options: 1m, 5m, 15m, 30m, 1h, 4h or 1d.", "name": "interval", "optional": true, "type": "string" - }, - { - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (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": { @@ -282,7 +113,7 @@ "name": "CURRENCY.SNAPSHOTS", "parameters": [ { - "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp.", + "description": "The base currency symbol. Multiple comma separated items allowed.", "name": "base", "optional": true, "type": "string" @@ -298,146 +129,6 @@ "name": "counter_currencies", "optional": true, "type": "any" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "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/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": "Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began. (provider: intrinio)", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date. (provider: intrinio)", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "The type of unusual activity to query for. (provider: intrinio)", - "name": "trade_type", - "optional": true, - "type": "string" - }, - { - "description": "The sentiment type to query for. (provider: intrinio)", - "name": "sentiment", - "optional": true, - "type": "string" - }, - { - "description": "The inclusive minimum total value for the unusual activity. (provider: intrinio)", - "name": "min_value", - "optional": true, - "type": "number" - }, - { - "description": "The inclusive maximum total value for the unusual activity. (provider: intrinio)", - "name": "max_value", - "optional": true, - "type": "number" - }, - { - "description": "The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance. (provider: intrinio)", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "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": { @@ -463,812 +154,28 @@ "type": "string" }, { - "description": "Options: fmp, tradingeconomics, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)", + "description": "Country of the event. Multiple comma separated items allowed.", "name": "country", "optional": true, "type": "string" }, { - "description": "Importance of the event. (provider: tradingeconomics)", + "description": "Importance of the event. Options: Low, Medium, High.", "name": "importance", "optional": true, "type": "string" }, { - "description": "Grouping of events (provider: tradingeconomics)", + "description": "Grouping of events. Options: interest_rate, inflation, bonds, consumer, gdp, government, housing, labour, markets, money, prices, trade, business.", "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 comma separated 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.", - "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", + "description": "Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed.", + "name": "calendar_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 comma separated 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": { @@ -1285,118 +192,6 @@ "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": "Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga.", - "name": "analyst_name", - "optional": true, - "type": "string" - }, - { - "description": "Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga.", - "name": "firm_name", - "optional": true, - "type": "string" - }, - { - "description": "Options: benzinga, defaults to benzinga.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga)", - "name": "analyst_ids", - "optional": true, - "type": "string" - }, - { - "description": "Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga)", - "name": "firm_ids", - "optional": true, - "type": "string" - }, - { - "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": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: benzinga)", - "name": "fields", - "optional": true, - "type": "string" } ], "result": { @@ -1410,13 +205,8 @@ "name": "EQUITY.ESTIMATES.CONSENSUS", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", "optional": true, "type": "string" } @@ -1432,24 +222,18 @@ "name": "EQUITY.ESTIMATES.HISTORICAL", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Time period of the data to return. (provider: fmp)", + "description": "Time period of the data to return. Options: quarter, annual.", "name": "period", "optional": true, "type": "string" }, { - "description": "The number of data entries to return. (provider: fmp)", + "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" @@ -1466,7 +250,7 @@ "name": "EQUITY.ESTIMATES.PRICE_TARGET", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "optional": true, "type": "string" @@ -1484,67 +268,67 @@ "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)", + "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.", "name": "page", "optional": true, "type": "number" }, { - "description": "Date for calendar data, shorthand for date_from and date_to. (provider: benzinga)", + "description": "Date for calendar data, shorthand for date_from and date_to.", "name": "date", "optional": true, "type": "string" }, { - "description": "Start date of the data, in YYYY-MM-DD format. (provider: benzinga)", + "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. (provider: benzinga)", + "description": "End date of the data, in YYYY-MM-DD format.", "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)", + "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.", "name": "updated", "optional": true, "type": "any" }, { - "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated (provider: benzinga)", + "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", "name": "importance", "optional": true, "type": "number" }, { - "description": "Filter by a specific action_company. (provider: benzinga)", + "description": "Filter by a specific action_company. Options: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates, terminates, removes, suspends, firm_dissolved.", "name": "action", "optional": true, "type": "string" }, { - "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed. (provider: benzinga)", + "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed.", "name": "analyst_ids", "optional": true, "type": "any" }, { - "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed. (provider: benzinga)", + "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed.", "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 comma separated items allowed. (provider: benzinga)", + "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 comma separated items allowed.", "name": "fields", "optional": true, "type": "any" }, { - "description": "Include upgrades and downgrades in the response. (provider: fmp)", + "description": "Include upgrades and downgrades in the response.", "name": "with_grade", "optional": true, "type": "boolean" @@ -1576,124 +360,6 @@ "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": { @@ -1722,124 +388,6 @@ "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": { @@ -1868,40 +416,6 @@ "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": { @@ -1921,13 +435,7 @@ "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)", + "description": "Filter by form type. Check the data provider for available types.", "name": "form_type", "optional": true, "type": "string" @@ -1937,99 +445,6 @@ "name": "limit", "optional": true, "type": "number" - }, - { - "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 comma separated items allowed for provider(s): intrinio.", - "name": "symbol", - "type": "string" - }, - { - "description": "Intrinio data tag ID or code. Multiple comma separated 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": { @@ -2048,13 +463,7 @@ "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. (provider: fmp)", + "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" @@ -2074,12 +483,6 @@ "description": "Symbol to get data for.", "name": "symbol", "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" } ], "result": { @@ -2108,157 +511,6 @@ "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 comma separated items allowed for provider(s): intrinio.", - "name": "symbol", - "type": "string" - }, - { - "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio.", - "name": "tag", - "type": "string" - }, - { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" } ], "result": { @@ -2275,40 +527,6 @@ "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 comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Year of the compensation. (provider: fmp)", - "name": "year", - "optional": true, - "type": "number" } ], "result": { @@ -2322,7 +540,7 @@ "name": "EQUITY.FUNDAMENTAL.METRICS", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, @@ -2339,13 +557,7 @@ "type": "number" }, { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Include trailing twelve months (TTM) data. (provider: fmp)", + "description": "Include trailing twelve months (TTM) data.", "name": "with_ttm", "optional": true, "type": "boolean" @@ -2355,28 +567,6 @@ "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 comma separated 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", @@ -2387,12 +577,6 @@ "description": "Symbol to get data for.", "name": "symbol", "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" } ], "result": { @@ -2406,7 +590,7 @@ "name": "EQUITY.FUNDAMENTAL.RATIOS", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, @@ -2423,68 +607,10 @@ "type": "number" }, { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Include trailing twelve months (TTM) data. (provider: fmp)", + "description": "Include trailing twelve months (TTM) data.", "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": { @@ -2513,12 +639,6 @@ "name": "structure", "optional": true, "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" } ], "result": { @@ -2547,40 +667,6 @@ "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": { @@ -2602,75 +688,6 @@ "description": "Year of the earnings call transcript.", "name": "year", "type": "number" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "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, intrinio, 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" - }, - { - "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400' (provider: intrinio)", - "name": "date", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "The Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/form_13f", - "id": "EQUITY.OWNERSHIP.FORM_13F", - "name": "EQUITY.OWNERSHIP.FORM_13F", - "parameters": [ - { - "description": "Symbol to get data for. A CIK or Symbol can be used.", - "name": "symbol", - "type": "string" - }, - { - "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", - "name": "date", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: sec, defaults to sec.", - "name": "provider", - "optional": true, - "type": "string" } ], "result": { @@ -2695,39 +712,9 @@ "type": "number" }, { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Type of the transaction. (provider: fmp)", + "description": "Type of the transaction. Options: award, conversion, return, expire_short, in_kind, gift, expire_long, discretionary, other, small, exempt, otm, purchase, sale, tender, will, itm, trust.", "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" } ], @@ -2747,19 +734,13 @@ "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Include current quarter data. (provider: fmp)", + "description": "Include current quarter data.", "name": "include_current_quarter", "optional": true, "type": "boolean" }, { - "description": "A specific date to get data for. (provider: fmp)", + "description": "A specific date to get data for.", "name": "date", "optional": true, "type": "string" @@ -2791,12 +772,6 @@ "name": "page", "optional": true, "type": "number" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" } ], "result": { @@ -2813,12 +788,6 @@ "description": "Symbol to get data for.", "name": "symbol", "type": "string" - }, - { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" } ], "result": { @@ -2832,12 +801,12 @@ "name": "EQUITY.PRICE.HISTORICAL", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, { - "description": "Time interval of the data to return.", + "description": "Time interval of the data to return. Options: 1m, 5m, 15m, 30m, 1h, 4h or 1d.", "name": "interval", "optional": true, "type": "string" @@ -2853,118 +822,6 @@ "name": "end_date", "optional": true, "type": "string" - }, - { - "description": "Options: fmp, intrinio, polygon, defaults to fmp.", - "name": "provider", - "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": "The adjustment factor to apply. Default is splits only. (provider: polygon)", - "name": "adjustment", - "optional": true, - "type": "string" - }, - { - "description": "Include Pre and Post market data. (provider: polygon)", - "name": "extended_hours", - "optional": true, - "type": "boolean" - }, - { - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (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 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, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (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, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)", - "name": "timestamp_gt", - "optional": true, - "type": "string" - }, - { - "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)", - "name": "timestamp_lte", - "optional": true, - "type": "string" - }, - { - "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)", - "name": "timestamp_gte", - "optional": true, - "type": "string" } ], "result": { @@ -2978,15 +835,9 @@ "name": "EQUITY.PRICE.PERFORMANCE", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" } ], "result": { @@ -3000,21 +851,9 @@ "name": "EQUITY.PRICE.QUOTE", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "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": { @@ -3028,353 +867,9 @@ "name": "EQUITY.PROFILE", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "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 comma separated 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 comma separated 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 Historical Market Price.", - "helpUrl": "https://docs.openbb.co/excel/reference/etf/historical", - "id": "ETF.HISTORICAL", - "name": "ETF.HISTORICAL", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon.", - "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, defaults to fmp.", - "name": "provider", - "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": "The adjustment factor to apply. Default is splits only. (provider: polygon)", - "name": "adjustment", - "optional": true, - "type": "string" - }, - { - "description": "Include Pre and Post market data. (provider: polygon)", - "name": "extended_hours", - "optional": true, - "type": "boolean" - }, - { - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (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": { @@ -3393,78 +888,10 @@ "type": "string" }, { - "description": "Options: fmp, intrinio, 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)", + "description": "A specific date to get data for.", "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 comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" } ], "result": { @@ -3478,15 +905,9 @@ "name": "ETF.INFO", "parameters": [ { - "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio.", + "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed.", "name": "symbol", "type": "string" - }, - { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" } ], "result": { @@ -3494,855 +915,13 @@ } }, { - "description": "Price performance as a return, over different periods.", - "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 comma separated 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": "The type of returns to return, a trailing or calendar window. (provider: intrinio)", - "name": "return_type", - "optional": true, - "type": "string" - }, - { - "description": "The adjustment factor, 'splits_only' will return pure price performance. (provider: intrinio)", - "name": "adjustment", - "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, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The exchange code the ETF trades on. (provider: fmp);\nTarget a specific exchange by providing the MIC code. (provider: intrinio)", - "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": "Maturities in years. Multiple comma separated items allowed for provider(s): fred.", - "name": "maturity", - "optional": true, - "type": "any" - }, - { - "description": "Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred.", - "name": "category", - "optional": true, - "type": "string" - }, - { - "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.", + "description": "Get 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. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, @@ -4363,76 +942,6 @@ "name": "interval", "optional": true, "type": "string" - }, - { - "description": "Options: fmp, intrinio, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. (provider: intrinio, polygon)", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)", - "name": "sort", - "optional": true, - "type": "string" - } - ], - "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 comma separated items allowed for provider(s): fmp, 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": "Options: fmp, intrinio, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. (provider: intrinio, polygon)", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)", - "name": "sort", - "optional": true, - "type": "string" } ], "result": { @@ -4446,7 +955,7 @@ "name": "NEWS.COMPANY", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "optional": true, "type": "string" @@ -4470,88 +979,70 @@ "type": "number" }, { - "description": "Options: benzinga, fmp, intrinio, polygon, defaults to benzinga.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "A specific date to get data for. (provider: benzinga)", + "description": "A specific date to get data for.", "name": "date", "optional": true, "type": "string" }, { - "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)", + "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). Options: headline, abstract, full.", "name": "display", "optional": true, "type": "string" }, { - "description": "Number of seconds since the news was updated. (provider: benzinga)", + "description": "Number of seconds since the news was updated.", "name": "updated_since", "optional": true, "type": "number" }, { - "description": "Number of seconds since the news was published. (provider: benzinga)", + "description": "Number of seconds since the news was published.", "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)", + "description": "Order to sort the news by. Options: asc, desc.", "name": "order", "optional": true, "type": "string" }, { - "description": "The company's ISIN. (provider: benzinga)", + "description": "The company's ISIN.", "name": "isin", "optional": true, "type": "string" }, { - "description": "The company's CUSIP. (provider: benzinga)", + "description": "The company's CUSIP.", "name": "cusip", "optional": true, "type": "string" }, { - "description": "Channels of the news to retrieve. (provider: benzinga)", + "description": "Channels of the news to retrieve.", "name": "channels", "optional": true, "type": "string" }, { - "description": "Topics of the news to retrieve. (provider: benzinga)", + "description": "Topics of the news to retrieve.", "name": "topics", "optional": true, "type": "string" }, { - "description": "Authors of the news to retrieve. (provider: benzinga)", + "description": "Authors of the news to retrieve.", "name": "authors", "optional": true, "type": "string" }, { - "description": "Content types of the news to retrieve. (provider: benzinga)", + "description": "Content types of the news to retrieve.", "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" } ], "result": { @@ -4583,79 +1074,67 @@ "type": "string" }, { - "description": "Options: benzinga, fmp, intrinio, defaults to benzinga.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "A specific date to get data for. (provider: benzinga)", + "description": "A specific date to get data for.", "name": "date", "optional": true, "type": "string" }, { - "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)", + "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). Options: headline, abstract, full.", "name": "display", "optional": true, "type": "string" }, { - "description": "Number of seconds since the news was updated. (provider: benzinga)", + "description": "Number of seconds since the news was updated.", "name": "updated_since", "optional": true, "type": "number" }, { - "description": "Number of seconds since the news was published. (provider: benzinga)", + "description": "Number of seconds since the news was published.", "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)", + "description": "Order to sort the news by. Options: asc, desc.", "name": "order", "optional": true, "type": "string" }, { - "description": "The ISIN of the news to retrieve. (provider: benzinga)", + "description": "The ISIN of the news to retrieve.", "name": "isin", "optional": true, "type": "string" }, { - "description": "The CUSIP of the news to retrieve. (provider: benzinga)", + "description": "The CUSIP of the news to retrieve.", "name": "cusip", "optional": true, "type": "string" }, { - "description": "Channels of the news to retrieve. (provider: benzinga)", + "description": "Channels of the news to retrieve.", "name": "channels", "optional": true, "type": "string" }, { - "description": "Topics of the news to retrieve. (provider: benzinga)", + "description": "Topics of the news to retrieve.", "name": "topics", "optional": true, "type": "string" }, { - "description": "Authors of the news to retrieve. (provider: benzinga)", + "description": "Authors of the news to retrieve.", "name": "authors", "optional": true, "type": "string" }, { - "description": "Content types of the news to retrieve. (provider: benzinga)", + "description": "Content types of the news to retrieve.", "name": "content_types", "optional": true, "type": "string" @@ -4664,166 +1143,6 @@ "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", - "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" - } } ] } \ No newline at end of file diff --git a/website/content/excel/openapi.json b/website/content/excel/openapi.json index 7185ffd852e..b5ad0664e11 100644 --- a/website/content/excel/openapi.json +++ b/website/content/excel/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "OpenBB Platform API", - "description": "This is the OpenBB Platform API.", + "description": "Investment research for everyone, anywhere.", "termsOfService": "http://example.com/terms/", "contact": { "name": "OpenBB Team", @@ -13,7 +13,7 @@ "name": "MIT", "url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/LICENSE" }, - "version": "4.1.6" + "version": "4.2.1" }, "paths": { "/api/v1/crypto/price/historical": { @@ -50,10 +50,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.", - "multiple_items_allowed": [ - "fmp", - "polygon" - ], + "fmp": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon." @@ -377,10 +379,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.", - "multiple_items_allowed": [ - "fmp", - "polygon" - ], + "fmp": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon." @@ -588,7 +592,7 @@ } }, { - "name": "symbol", + "name": "query", "in": "query", "required": false, "schema": { @@ -600,141 +604,10 @@ "type": "null" } ], - "title": "polygon", - "description": "Symbol of the pair to search. (provider: polygon)" + "description": "Query to search for currency pairs.", + "title": "Query" }, - "description": "Symbol of the pair to search. (provider: polygon)" - }, - { - "name": "date", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "A specific date to get data for. (provider: polygon)" - }, - "description": "A specific date to get data for. (provider: polygon)" - }, - { - "name": "search", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "Search for terms within the ticker and/or company name. (provider: polygon)", - "default": "" - }, - "description": "Search for terms within the ticker and/or company name. (provider: polygon)" - }, - { - "name": "active", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)", - "default": true - }, - "description": "Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)" - }, - { - "name": "order", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "enum": [ - "asc", - "desc" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "Order data by ascending or descending. (provider: polygon)", - "default": "asc" - }, - "description": "Order data by ascending or descending. (provider: polygon)" - }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "enum": [ - "ticker", - "name", - "market", - "locale", - "currency_symbol", - "currency_name", - "base_currency_symbol", - "base_currency_name", - "last_updated_utc", - "delisted_utc" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "Sort field used for ordering. (provider: polygon)", - "default": "" - }, - "description": "Sort field used for ordering. (provider: polygon)" - }, - { - "name": "limit", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer", - "exclusiveMinimum": 0 - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "The number of data entries to return. (provider: polygon)", - "default": 1000 - }, - "description": "The number of data entries to return. (provider: polygon)" + "description": "Query to search for currency pairs." } ], "responses": { @@ -787,35 +660,25 @@ { "scope": "api", "parameters": { - "provider": "intrinio" + "provider": "fmp" }, - "provider": "intrinio" + "provider": "fmp" }, { "scope": "api", - "description": "Search for 'EURUSD' currency pair using 'intrinio' as provider.", + "description": "Search for 'EUR' currency pair using 'intrinio' as provider.", "parameters": { "provider": "intrinio", - "symbol": "EURUSD" + "query": "EUR" }, "provider": "intrinio" }, - { - "scope": "api", - "description": "Search for actively traded currency pairs on the queried date using 'polygon' as provider.", - "parameters": { - "provider": "polygon", - "date": "2024-01-02", - "active": 1.0 - }, - "provider": "polygon" - }, { "scope": "api", "description": "Search for terms using 'polygon' as provider.", "parameters": { "provider": "polygon", - "search": "Euro zone" + "query": "EUR" }, "provider": "polygon" } @@ -828,7 +691,7 @@ "currency" ], "summary": "Reference Rates", - "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.", + "description": "Get 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.", "operationId": "currency_reference_rates", "security": [ { @@ -925,14 +788,13 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { "enum": [ - "fmp" + "fmp", + "polygon" ], - "const": "fmp", "type": "string", - "default": "fmp", "title": "Provider" } }, @@ -942,14 +804,17 @@ "required": false, "schema": { "type": "string", - "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon.", + "fmp": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "default": "usd", "title": "Base" }, - "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp." + "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon." }, { "name": "quote_type", @@ -973,15 +838,15 @@ "required": false, "schema": { "anyOf": [ + { + "type": "string" + }, { "type": "array", "items": { "type": "string" } }, - { - "type": "string" - }, { "type": "null" } @@ -1324,10 +1189,10 @@ "schema": { "anyOf": [ { - "type": "number" + "type": "integer" }, { - "type": "integer" + "type": "number" }, { "type": "null" @@ -1345,10 +1210,10 @@ "schema": { "anyOf": [ { - "type": "number" + "type": "integer" }, { - "type": "integer" + "type": "number" }, { "type": "null" @@ -1438,6 +1303,7 @@ { "scope": "api", "parameters": { + "symbol": "TSLA", "provider": "intrinio" }, "provider": "intrinio" @@ -1460,7 +1326,7 @@ "economy" ], "summary": "Forecast", - "description": "Forecasted GDP Data.", + "description": "Get Forecasted GDP Data.", "operationId": "economy_gdp_forecast", "security": [ { @@ -1693,7 +1559,7 @@ "economy" ], "summary": "Nominal", - "description": "Nominal GDP Data.", + "description": "Get Nominal GDP Data.", "operationId": "economy_gdp_nominal", "security": [ { @@ -1900,7 +1766,7 @@ "economy" ], "summary": "Real", - "description": "Real GDP Data.", + "description": "Get Real GDP Data.", "operationId": "economy_gdp_real", "security": [ { @@ -2193,9 +2059,208 @@ ], "title": "tradingeconomics", "description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)", - "multiple_items_allowed": [ - "tradingeconomics" - ] + "choices": [ + "afghanistan", + "albania", + "algeria", + "andorra", + "angola", + "antigua_and_barbuda", + "argentina", + "armenia", + "aruba", + "australia", + "austria", + "azerbaijan", + "bahamas", + "bahrain", + "bangladesh", + "barbados", + "belarus", + "belgium", + "belize", + "benin", + "bermuda", + "bhutan", + "bolivia", + "bosnia_and_herzegovina", + "botswana", + "brazil", + "brunei", + "bulgaria", + "burkina_faso", + "burundi", + "cambodia", + "cameroon", + "canada", + "cape_verde", + "cayman_islands", + "central_african_republic", + "chad", + "chile", + "china", + "colombia", + "comoros", + "congo", + "costa_rica", + "croatia", + "cuba", + "cyprus", + "czech_republic", + "denmark", + "djibouti", + "dominica", + "dominican_republic", + "east_timor", + "ecuador", + "egypt", + "el_salvador", + "equatorial_guinea", + "eritrea", + "estonia", + "ethiopia", + "euro_area", + "faroe_islands", + "fiji", + "finland", + "france", + "gabon", + "gambia", + "georgia", + "germany", + "ghana", + "greece", + "grenada", + "guatemala", + "guinea", + "guinea_bissau", + "guyana", + "haiti", + "honduras", + "hong_kong", + "hungary", + "iceland", + "india", + "indonesia", + "iran", + "iraq", + "ireland", + "isle_of_man", + "israel", + "italy", + "ivory_coast", + "jamaica", + "japan", + "jordan", + "kazakhstan", + "kenya", + "kiribati", + "kosovo", + "kuwait", + "kyrgyzstan", + "laos", + "latvia", + "lebanon", + "lesotho", + "liberia", + "libya", + "liechtenstein", + "lithuania", + "luxembourg", + "macao", + "madagascar", + "malawi", + "malaysia", + "maldives", + "mali", + "malta", + "mauritania", + "mauritius", + "mexico", + "moldova", + "monaco", + "mongolia", + "montenegro", + "morocco", + "mozambique", + "myanmar", + "namibia", + "nepal", + "netherlands", + "new_caledonia", + "new_zealand", + "nicaragua", + "niger", + "nigeria", + "north_korea", + "north_macedonia", + "norway", + "oman", + "pakistan", + "palestine", + "panama", + "papua_new_guinea", + "paraguay", + "peru", + "philippines", + "poland", + "portugal", + "puerto_rico", + "qatar", + "republic_of_the_congo", + "romania", + "russia", + "rwanda", + "samoa", + "sao_tome_and_principe", + "saudi_arabia", + "senegal", + "serbia", + "seychelles", + "sierra_leone", + "singapore", + "slovakia", + "slovenia", + "solomon_islands", + "somalia", + "south_africa", + "south_korea", + "south_sudan", + "spain", + "sri_lanka", + "sudan", + "suriname", + "swaziland", + "sweden", + "switzerland", + "syria", + "taiwan", + "tajikistan", + "tanzania", + "thailand", + "togo", + "tonga", + "trinidad_and_tobago", + "tunisia", + "turkey", + "turkmenistan", + "uganda", + "ukraine", + "united_arab_emirates", + "united_kingdom", + "united_states", + "uruguay", + "uzbekistan", + "vanuatu", + "venezuela", + "vietnam", + "yemen", + "zambia", + "zimbabwe" + ], + "tradingeconomics": { + "multiple_items_allowed": true + } }, "description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)" }, @@ -2207,9 +2272,9 @@ "anyOf": [ { "enum": [ - "Low", - "Medium", - "High" + "low", + "medium", + "high" ], "type": "string" }, @@ -2218,7 +2283,12 @@ } ], "title": "tradingeconomics", - "description": "Importance of the event. (provider: tradingeconomics)" + "description": "Importance of the event. (provider: tradingeconomics)", + "choices": [ + "low", + "medium", + "high" + ] }, "description": "Importance of the event. (provider: tradingeconomics)" }, @@ -2230,7 +2300,7 @@ "anyOf": [ { "enum": [ - "interest rate", + "interest_rate", "inflation", "bonds", "consumer", @@ -2251,9 +2321,48 @@ } ], "title": "tradingeconomics", - "description": "Grouping of events (provider: tradingeconomics)" + "description": "Grouping of events. (provider: tradingeconomics)", + "choices": [ + "interest_rate", + "inflation", + "bonds", + "consumer", + "gdp", + "government", + "housing", + "labour", + "markets", + "money", + "prices", + "trade", + "business" + ] }, - "description": "Grouping of events (provider: tradingeconomics)" + "description": "Grouping of events. (provider: tradingeconomics)" + }, + { + "name": "calendar_id", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "tradingeconomics", + "description": "Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed. (provider: tradingeconomics)", + "tradingeconomics": { + "multiple_items_allowed": true + } + }, + "description": "Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed. (provider: tradingeconomics)" } ], "responses": { @@ -2329,7 +2438,7 @@ "economy" ], "summary": "Cpi", - "description": "Consumer Price Index (CPI). Returns either the rescaled index value, or a rate of change (inflation).", + "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).", "operationId": "economy_cpi", "security": [ { @@ -2409,9 +2518,9 @@ "united_kingdom", "united_states" ], - "multiple_items_allowed": [ - "fred" - ], + "fred": { + "multiple_items_allowed": true + }, "title": "Country" }, "description": "The country to get data. Multiple comma separated items allowed for provider(s): fred." @@ -2575,7 +2684,7 @@ "economy" ], "summary": "Risk Premium", - "description": "Market Risk Premium by country.", + "description": "Get Market Risk Premium by country.", "operationId": "economy_risk_premium", "security": [ { @@ -2672,14 +2781,13 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { "enum": [ - "ecb" + "ecb", + "fred" ], - "const": "ecb", "type": "string", - "default": "ecb", "title": "Provider" } }, @@ -2725,25 +2833,121 @@ "in": "query", "required": false, "schema": { - "enum": [ - "brazil", - "canada", - "china", - "eu_ex_euro_area", - "eu_institutions", - "india", - "japan", - "russia", - "switzerland", - "united_kingdom", - "united_states", - "total", - null + "anyOf": [ + { + "enum": [ + "brazil", + "canada", + "china", + "eu_ex_euro_area", + "eu_institutions", + "india", + "japan", + "russia", + "switzerland", + "united_kingdom", + "united_states", + "total", + null + ] + }, + { + "enum": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "czechia", + "denmark", + "estonia", + "finland", + "france", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "poland", + "portugal", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkey", + "united_kingdom", + "united_states", + "g7", + "g20" + ], + "type": "string" + } ], - "title": "ecb", - "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb)" + "title": "ecb,fred", + "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb);\n The country to get data. Enter as a 3-letter ISO country code, default is USA. (provider: fred)", + "choices": "argentina,australia,austria,belgium,brazil,canada,chile,china,colombia,costa_rica,czechia,denmark,estonia,finland,france,germany,greece,hungary,iceland,india,indonesia,ireland,israel,italy,japan,korea,latvia,lithuania,luxembourg,mexico,netherlands,new_zealand,norway,poland,portugal,russia,saudi_arabia,slovak_republic,slovenia,south_africa,spain,sweden,switzerland,turkey,united_kingdom,united_states,g7,g20" }, - "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb)" + "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb);\n The country to get data. Enter as a 3-letter ISO country code, default is USA. (provider: fred)" + }, + { + "name": "start_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "fred", + "description": "Start date of the data, in YYYY-MM-DD format. (provider: fred)" + }, + "description": "Start date of the data, in YYYY-MM-DD format. (provider: fred)" + }, + { + "name": "end_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "fred", + "description": "End date of the data, in YYYY-MM-DD format. (provider: fred)" + }, + "description": "End date of the data, in YYYY-MM-DD format. (provider: fred)" } ], "responses": { @@ -2793,6 +2997,21 @@ }, "model": "BalanceOfPayments", "examples": [ + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "provider": "fred", + "country": "brazil" + }, + "provider": "fred" + }, { "scope": "api", "parameters": { @@ -2826,7 +3045,7 @@ "economy" ], "summary": "Fred Search", - "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()`.", + "description": "Search for FRED series or economic releases by ID or string.\n\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.", "operationId": "economy_fred_search", "security": [ { @@ -2892,10 +3111,10 @@ "schema": { "anyOf": [ { - "type": "integer" + "type": "string" }, { - "type": "string" + "type": "integer" }, { "type": "null" @@ -2949,11 +3168,18 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "frequency", - "units", - "seasonal_adjustment" + "anyOf": [ + { + "enum": [ + "frequency", + "units", + "seasonal_adjustment" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "fred", "description": "Filter by an attribute. (provider: fred)" @@ -3124,9 +3350,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fred.", - "multiple_items_allowed": [ - "fred" - ], + "fred": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fred." @@ -3193,22 +3419,29 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "a", - "q", - "m", - "w", - "d", - "wef", - "weth", - "wew", - "wetu", - "wem", - "wesu", - "wesa", - "bwew", - "bwem" + "anyOf": [ + { + "enum": [ + "a", + "q", + "m", + "w", + "d", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "fred", "description": "\n Frequency aggregation to convert high frequency data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday\n (provider: fred)" @@ -3220,11 +3453,18 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "avg", - "sum", - "eop" + "anyOf": [ + { + "enum": [ + "avg", + "sum", + "eop" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "fred", "description": "\n A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set.\n avg = Average\n sum = Sum\n eop = End of Period\n (provider: fred)", @@ -3237,16 +3477,23 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "chg", - "ch1", - "pch", - "pc1", - "pca", - "cch", - "cca", - "log" + "anyOf": [ + { + "enum": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "fred", "description": "\n Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log\n (provider: fred)" @@ -3375,7 +3622,7 @@ "economy" ], "summary": "Money Measures", - "description": "Money Measures (M1/M2 and components). The Federal Reserve publishes as part of the H.6 Release.", + "description": "Get Money Measures (M1/M2 and components).\n\nThe Federal Reserve publishes as part of the H.6 Release.", "operationId": "economy_money_measures", "security": [ { @@ -3526,7 +3773,7 @@ "economy" ], "summary": "Unemployment", - "description": "Global unemployment data.", + "description": "Get global unemployment data.", "operationId": "economy_unemployment", "security": [ { @@ -3796,7 +4043,7 @@ "economy" ], "summary": "Composite Leading Indicator", - "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.", + "description": "Use the composite leading indicator (CLI).\n\nIt is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\n\nCLIs show short-term economic movements in qualitative rather than quantitative terms.", "operationId": "economy_composite_leading_indicator", "security": [ { @@ -3962,7 +4209,7 @@ "economy" ], "summary": "Short Term Interest Rate", - "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\".", + "description": "Get Short-term interest rates.\n\nThey 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.\n\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\".", "operationId": "economy_short_term_interest_rate", "security": [ { @@ -4172,7 +4419,7 @@ "economy" ], "summary": "Long Term Interest Rate", - "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.", + "description": "Get Long-term interest rates that refer to government bonds maturing in ten years.\n\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.", "operationId": "economy_long_term_interest_rate", "security": [ { @@ -4382,7 +4629,7 @@ "economy" ], "summary": "Fred Regional", - "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.", + "description": "Query the Geo Fred API for regional economic data by series group.\n\nThe series group ID is found by using `fred_search` and the `series_id` parameter.", "operationId": "economy_fred_regional", "security": [ { @@ -4701,6 +4948,472 @@ ] } }, + "/api/v1/economy/country_profile": { + "get": { + "tags": [ + "economy" + ], + "summary": "Country Profile", + "description": "Get a profile of country statistics and economic indicators.", + "operationId": "economy_country_profile", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "econdb" + ], + "const": "econdb", + "type": "string", + "default": "econdb", + "title": "Provider" + } + }, + { + "name": "country", + "in": "query", + "required": true, + "schema": { + "type": "string", + "description": "The country to get data. Multiple comma separated items allowed for provider(s): econdb.", + "econdb": { + "multiple_items_allowed": true + }, + "title": "Country" + }, + "description": "The country to get data. Multiple comma separated items allowed for provider(s): econdb." + }, + { + "name": "latest", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "econdb", + "description": "If True, return only the latest data. If False, return all available data for each indicator. (provider: econdb)", + "default": true + }, + "description": "If True, return only the latest data. If False, return all available data for each indicator. (provider: econdb)" + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "econdb", + "description": "If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data. (provider: econdb)", + "default": true + }, + "description": "If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data. (provider: econdb)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_CountryProfile" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "CountryProfile", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "econdb", + "country": "united_kingdom" + }, + "provider": "econdb" + }, + { + "scope": "api", + "description": "Enter the country as the full name, or iso code. If `latest` is False, the complete history for each series is returned.", + "parameters": { + "country": "united_states,jp", + "latest": 0.0, + "provider": "econdb" + }, + "provider": "econdb" + } + ] + } + }, + "/api/v1/economy/available_indicators": { + "get": { + "tags": [ + "economy" + ], + "summary": "Available Indicators", + "description": "Get the available economic indicators for a provider.", + "operationId": "economy_available_indicators", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "econdb" + ], + "const": "econdb", + "type": "string", + "default": "econdb", + "title": "Provider" + } + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "econdb", + "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week. (provider: econdb)", + "default": true + }, + "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week. (provider: econdb)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_AvailableIndicators" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "AvailableIndicators", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "econdb" + }, + "provider": "econdb" + } + ] + } + }, + "/api/v1/economy/indicators": { + "get": { + "tags": [ + "economy" + ], + "summary": "Indicators", + "description": "Get economic indicators by country and indicator.", + "operationId": "economy_indicators", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "econdb" + ], + "const": "econdb", + "type": "string", + "default": "econdb", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": true, + "schema": { + "type": "string", + "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed for provider(s): econdb.", + "econdb": { + "multiple_items_allowed": true + }, + "title": "Symbol" + }, + "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed for provider(s): econdb." + }, + { + "name": "country", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed for provider(s): econdb.", + "econdb": { + "multiple_items_allowed": true + }, + "title": "Country" + }, + "description": "The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed for provider(s): econdb." + }, + { + "name": "start_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "description": "Start date of the data, in YYYY-MM-DD format.", + "title": "Start Date" + }, + "description": "Start date of the data, in YYYY-MM-DD format." + }, + { + "name": "end_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "description": "End date of the data, in YYYY-MM-DD format.", + "title": "End Date" + }, + "description": "End date of the data, in YYYY-MM-DD format." + }, + { + "name": "transform", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "toya", + "tpop", + "tusd", + "tpgp" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "econdb", + "description": "The transformation to apply to the data, default is None.\n\n tpop: Change from previous period\n toya: Change from one year ago\n tusd: Values as US dollars\n tpgp: Values as a percent of GDP\n\n Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results.\n This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities.\n `tusd` should only be used where values are currencies. (provider: econdb)" + }, + "description": "The transformation to apply to the data, default is None.\n\n tpop: Change from previous period\n toya: Change from one year ago\n tusd: Values as US dollars\n tpgp: Values as a percent of GDP\n\n Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results.\n This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities.\n `tusd` should only be used where values are currencies. (provider: econdb)" + }, + { + "name": "frequency", + "in": "query", + "required": false, + "schema": { + "enum": [ + "annual", + "quarter", + "month" + ], + "type": "string", + "title": "econdb", + "description": "The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'. (provider: econdb)", + "default": "quarter" + }, + "description": "The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'. (provider: econdb)" + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "econdb", + "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data. (provider: econdb)", + "default": true + }, + "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data. (provider: econdb)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_EconomicIndicators" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "EconomicIndicators", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "econdb", + "symbol": "PCOCO" + }, + "provider": "econdb" + }, + { + "scope": "api", + "description": "Enter the country as the full name, or iso code. Use `available_indicators()` to get a list of supported indicators from EconDB.", + "parameters": { + "symbol": "CPI", + "country": "united_states,jp", + "provider": "econdb" + }, + "provider": "econdb" + }, + { + "scope": "api", + "description": "Use the `main` symbol to get the group of main indicators for a country.", + "parameters": { + "provider": "econdb", + "symbol": "main", + "country": "eu" + }, + "provider": "econdb" + } + ] + } + }, "/api/v1/equity/calendar/ipo": { "get": { "tags": [ @@ -5419,6 +6132,211 @@ ] } }, + "/api/v1/equity/compare/company_facts": { + "get": { + "tags": [ + "equity" + ], + "summary": "Company Facts", + "description": "Copmare reported company facts and fundamental data points.", + "operationId": "equity_compare_company_facts", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "sec" + ], + "const": "sec", + "type": "string", + "default": "sec", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): sec.", + "sec": { + "multiple_items_allowed": true + }, + "title": "Symbol" + }, + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): sec." + }, + { + "name": "fact", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.", + "default": "", + "title": "Fact" + }, + "description": "The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider." + }, + { + "name": "year", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "sec", + "description": "The year to retrieve the data for. If not provided, the current year is used. When symbol(s) are provided, excluding the year will return all reported values for the concept. (provider: sec)" + }, + "description": "The year to retrieve the data for. If not provided, the current year is used. When symbol(s) are provided, excluding the year will return all reported values for the concept. (provider: sec)" + }, + { + "name": "fiscal_period", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "fy", + "q1", + "q2", + "q3", + "q4" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "sec", + "description": "The fiscal period to retrieve the data for. If not provided, the most recent quarter is used. This parameter is ignored when a symbol is supplied. (provider: sec)" + }, + "description": "The fiscal period to retrieve the data for. If not provided, the most recent quarter is used. This parameter is ignored when a symbol is supplied. (provider: sec)" + }, + { + "name": "instantaneous", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "sec", + "description": "Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data.\nThe function will automatically attempt the inverse of this parameter if the initial fiscal quarter request fails. This parameter is ignored when a symbol is supplied. (provider: sec)", + "default": false + }, + "description": "Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data.\nThe function will automatically attempt the inverse of this parameter if the initial fiscal quarter request fails. This parameter is ignored when a symbol is supplied. (provider: sec)" + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "sec", + "description": "Whether to use cache for the request. Defaults to True. (provider: sec)", + "default": true + }, + "description": "Whether to use cache for the request. Defaults to True. (provider: sec)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_CompareCompanyFacts" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "CompareCompanyFacts", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "sec" + }, + "provider": "sec" + }, + { + "scope": "api", + "parameters": { + "provider": "sec", + "fact": "PaymentsForRepurchaseOfCommonStock", + "year": 2023 + }, + "provider": "sec" + }, + { + "scope": "api", + "parameters": { + "provider": "sec", + "symbol": "NVDA,AAPL,AMZN,MSFT,GOOG,SMCI", + "fact": "RevenueFromContractWithCustomerExcludingAssessedTax", + "year": 2024 + }, + "provider": "sec" + } + ] + } + }, "/api/v1/equity/estimates/price_target": { "get": { "tags": [ @@ -5460,10 +6378,12 @@ } ], "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp.", - "multiple_items_allowed": [ - "benzinga", - "fmp" + "benzinga": [ + "multiple_items_allowed" ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp." @@ -5648,8 +6568,8 @@ ], "title": "benzinga", "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed. (provider: benzinga)", - "multiple_items_allowed": [ - "benzinga" + "benzinga": [ + "multiple_items_allowed" ] }, "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed. (provider: benzinga)" @@ -5675,8 +6595,8 @@ ], "title": "benzinga", "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed. (provider: benzinga)", - "multiple_items_allowed": [ - "benzinga" + "benzinga": [ + "multiple_items_allowed" ] }, "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed. (provider: benzinga)" @@ -5702,8 +6622,8 @@ ], "title": "benzinga", "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 comma separated items allowed. (provider: benzinga)", - "multiple_items_allowed": [ - "benzinga" + "benzinga": [ + "multiple_items_allowed" ] }, "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 comma separated items allowed. (provider: benzinga)" @@ -5826,9 +6746,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." @@ -5943,30 +6863,57 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { "enum": [ - "fmp" + "fmp", + "intrinio" ], - "const": "fmp", "type": "string", - "default": "fmp", "title": "Provider" } }, { "name": "symbol", "in": "query", - "required": true, + "required": false, "schema": { - "type": "string", - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } ], + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." + }, + { + "name": "industry_group_number", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The Zacks industry group number. (provider: intrinio)" + }, + "description": "The Zacks industry group number. (provider: intrinio)" } ], "responses": { @@ -6069,9 +7016,9 @@ } ], "description": "Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga.", - "multiple_items_allowed": [ - "benzinga" - ], + "benzinga": { + "multiple_items_allowed": true + }, "title": "Analyst Name" }, "description": "Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga." @@ -6090,9 +7037,9 @@ } ], "description": "Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga.", - "multiple_items_allowed": [ - "benzinga" - ], + "benzinga": { + "multiple_items_allowed": true + }, "title": "Firm Name" }, "description": "Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga." @@ -6112,9 +7059,9 @@ ], "title": "benzinga", "description": "List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga)", - "multiple_items_allowed": [ - "benzinga" - ] + "benzinga": { + "multiple_items_allowed": true + } }, "description": "List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga)" }, @@ -6133,9 +7080,9 @@ ], "title": "benzinga", "description": "Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga)", - "multiple_items_allowed": [ - "benzinga" - ] + "benzinga": { + "multiple_items_allowed": true + } }, "description": "Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga)" }, @@ -6192,9 +7139,9 @@ ], "title": "benzinga", "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: benzinga)", - "multiple_items_allowed": [ - "benzinga" - ] + "benzinga": { + "multiple_items_allowed": true + } }, "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: benzinga)" } @@ -6264,13 +7211,777 @@ ] } }, + "/api/v1/equity/estimates/forward_sales": { + "get": { + "tags": [ + "equity" + ], + "summary": "Forward Sales", + "description": "Get forward sales estimates.", + "operationId": "equity_estimates_forward_sales", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "intrinio" + ], + "const": "intrinio", + "type": "string", + "default": "intrinio", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio.", + "intrinio": { + "multiple_items_allowed": true + }, + "title": "Symbol" + }, + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." + }, + { + "name": "fiscal_year", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" + }, + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" + }, + { + "name": "fiscal_period", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "fy", + "q1", + "q2", + "q3", + "q4" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The future fiscal period to retrieve estimates for. (provider: intrinio)" + }, + "description": "The future fiscal period to retrieve estimates for. (provider: intrinio)" + }, + { + "name": "calendar_year", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" + }, + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" + }, + { + "name": "calendar_period", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "q1", + "q2", + "q3", + "q4" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" + }, + "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_ForwardSalesEstimates" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "ForwardSalesEstimates", + "examples": [ + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "parameters": { + "fiscal_year": 2025, + "fiscal_period": "fy", + "provider": "intrinio" + }, + "provider": "intrinio" + } + ] + } + }, + "/api/v1/equity/estimates/forward_ebitda": { + "get": { + "tags": [ + "equity" + ], + "summary": "Forward Ebitda", + "description": "Get forward EBITDA estimates.", + "operationId": "equity_estimates_forward_ebitda", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": true, + "schema": { + "enum": [ + "fmp", + "intrinio" + ], + "type": "string", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, + "title": "Symbol" + }, + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." + }, + { + "name": "fiscal_period", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "annual", + "quarter" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "fmp,intrinio", + "description": "The future fiscal period to retrieve estimates for. (provider: fmp);\n Filter for only full-year or quarterly estimates. (provider: intrinio)", + "default": "annual" + }, + "description": "The future fiscal period to retrieve estimates for. (provider: fmp);\n Filter for only full-year or quarterly estimates. (provider: intrinio)" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "fmp", + "description": "The number of data entries to return. (provider: fmp)" + }, + "description": "The number of data entries to return. (provider: fmp)" + }, + { + "name": "include_historical", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "fmp", + "description": "If True, the data will include all past data and the limit will be ignored. (provider: fmp)", + "default": false + }, + "description": "If True, the data will include all past data and the limit will be ignored. (provider: fmp)" + }, + { + "name": "estimate_type", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "ebitda", + "ebit", + "enterprise_value", + "cash_flow_per_share", + "pretax_income" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Limit the EBITDA estimates to this type. (provider: intrinio)" + }, + "description": "Limit the EBITDA estimates to this type. (provider: intrinio)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_ForwardEbitdaEstimates" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "ForwardEbitdaEstimates", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "fiscal_period": "annual", + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL,MSFT", + "fiscal_period": "quarter", + "provider": "fmp" + }, + "provider": "fmp" + } + ] + } + }, + "/api/v1/equity/estimates/forward_eps": { + "get": { + "tags": [ + "equity" + ], + "summary": "Forward Eps", + "description": "Get forward EPS estimates.", + "operationId": "equity_estimates_forward_eps", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": true, + "schema": { + "enum": [ + "fmp", + "intrinio" + ], + "type": "string", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, + "title": "Symbol" + }, + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." + }, + { + "name": "fiscal_period", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "annual", + "quarter" + ], + "type": "string" + }, + { + "enum": [ + "fy", + "q1", + "q2", + "q3", + "q4" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "fmp,intrinio", + "description": "The future fiscal period to retrieve estimates for. (provider: fmp, intrinio)", + "default": "annual" + }, + "description": "The future fiscal period to retrieve estimates for. (provider: fmp, intrinio)" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "fmp", + "description": "The number of data entries to return. (provider: fmp)" + }, + "description": "The number of data entries to return. (provider: fmp)" + }, + { + "name": "include_historical", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "fmp", + "description": "If True, the data will include all past data and the limit will be ignored. (provider: fmp)", + "default": false + }, + "description": "If True, the data will include all past data and the limit will be ignored. (provider: fmp)" + }, + { + "name": "fiscal_year", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" + }, + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" + }, + { + "name": "calendar_year", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" + }, + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" + }, + { + "name": "calendar_period", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "q1", + "q2", + "q3", + "q4" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" + }, + "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_ForwardEpsEstimates" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "ForwardEpsEstimates", + "examples": [ + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "parameters": { + "fiscal_year": 2025, + "fiscal_period": "fy", + "provider": "intrinio" + }, + "provider": "intrinio" + } + ] + } + }, + "/api/v1/equity/estimates/forward_pe": { + "get": { + "tags": [ + "equity" + ], + "summary": "Forward Pe", + "description": "Get forward PE estimates.", + "operationId": "equity_estimates_forward_pe", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "intrinio" + ], + "const": "intrinio", + "type": "string", + "default": "intrinio", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio.", + "intrinio": { + "multiple_items_allowed": true + }, + "title": "Symbol" + }, + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_ForwardPeEstimates" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "ForwardPeEstimates", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL,MSFT,GOOG", + "provider": "intrinio" + }, + "provider": "intrinio" + } + ] + } + }, "/api/v1/equity/discovery/filings": { "get": { "tags": [ "equity" ], "summary": "Filings", - "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.", + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more.\n\nSEC filings 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.", "operationId": "equity_discovery_filings", "security": [ { @@ -6482,9 +8193,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." @@ -7367,10 +9078,17 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "asc", - "desc" + "anyOf": [ + { + "enum": [ + "asc", + "desc" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "polygon", "description": "Order of the financial statement. (provider: polygon)" @@ -7382,10 +9100,17 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "filing_date", - "period_of_report_date" + "anyOf": [ + { + "enum": [ + "filing_date", + "period_of_report_date" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "polygon", "description": "Sort of the financial statement. (provider: polygon)" @@ -8291,9 +10016,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio.", - "multiple_items_allowed": [ - "intrinio" - ], + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." @@ -8305,9 +10030,9 @@ "schema": { "type": "string", "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio.", - "multiple_items_allowed": [ - "intrinio" - ], + "intrinio": { + "multiple_items_allowed": true + }, "title": "Tag" }, "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." @@ -8407,9 +10132,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio.", - "multiple_items_allowed": [ - "intrinio" - ], + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." @@ -8421,9 +10146,9 @@ "schema": { "type": "string", "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio.", - "multiple_items_allowed": [ - "intrinio" - ], + "intrinio": { + "multiple_items_allowed": true + }, "title": "Tag" }, "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." @@ -9192,10 +10917,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "multiple_items_allowed": [ - "fmp", - "intrinio" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." @@ -9463,9 +11190,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." @@ -9680,9 +11407,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." @@ -10150,380 +11877,16 @@ "schema": { "anyOf": [ { - "enum": [ - "1", - "1-A", - "1-A POS", - "1-A-W", - "1-E", - "1-E AD", - "1-K", - "1-SA", - "1-U", - "1-Z", - "1-Z-W", - "10-12B", - "10-12G", - "10-D", - "10-K", - "10-KT", - "10-Q", - "10-QT", - "11-K", - "11-KT", - "13F-HR", - "13F-NT", - "13FCONP", - "144", - "15-12B", - "15-12G", - "15-15D", - "15F-12B", - "15F-12G", - "15F-15D", - "18-12B", - "18-K", - "19B-4E", - "2-A", - "2-AF", - "2-E", - "20-F", - "20FR12B", - "20FR12G", - "24F-2NT", - "25", - "25-NSE", - "253G1", - "253G2", - "253G3", - "253G4", - "3", - "305B2", - "34-12H", - "4", - "40-17F1", - "40-17F2", - "40-17G", - "40-17GCS", - "40-202A", - "40-203A", - "40-206A", - "40-24B2", - "40-33", - "40-6B", - "40-8B25", - "40-8F-2", - "40-APP", - "40-F", - "40-OIP", - "40FR12B", - "40FR12G", - "424A", - "424B1", - "424B2", - "424B3", - "424B4", - "424B5", - "424B7", - "424B8", - "424H", - "425", - "485APOS", - "485BPOS", - "485BXT", - "486APOS", - "486BPOS", - "486BXT", - "487", - "497", - "497AD", - "497H2", - "497J", - "497K", - "497VPI", - "497VPU", - "5", - "6-K", - "6B NTC", - "6B ORDR", - "8-A12B", - "8-A12G", - "8-K", - "8-K12B", - "8-K12G3", - "8-K15D5", - "8-M", - "8F-2 NTC", - "8F-2 ORDR", - "9-M", - "ABS-15G", - "ABS-EE", - "ADN-MTL", - "ADV-E", - "ADV-H-C", - "ADV-H-T", - "ADV-NR", - "ANNLRPT", - "APP NTC", - "APP ORDR", - "APP WD", - "APP WDG", - "ARS", - "ATS-N", - "ATS-N-C", - "ATS-N/UA", - "AW", - "AW WD", - "C", - "C-AR", - "C-AR-W", - "C-TR", - "C-TR-W", - "C-U", - "C-U-W", - "C-W", - "CB", - "CERT", - "CERTARCA", - "CERTBATS", - "CERTCBO", - "CERTNAS", - "CERTNYS", - "CERTPAC", - "CFPORTAL", - "CFPORTAL-W", - "CORRESP", - "CT ORDER", - "D", - "DEF 14A", - "DEF 14C", - "DEFA14A", - "DEFA14C", - "DEFC14A", - "DEFC14C", - "DEFM14A", - "DEFM14C", - "DEFN14A", - "DEFR14A", - "DEFR14C", - "DEL AM", - "DFAN14A", - "DFRN14A", - "DOS", - "DOSLTR", - "DRS", - "DRSLTR", - "DSTRBRPT", - "EFFECT", - "F-1", - "F-10", - "F-10EF", - "F-10POS", - "F-1MEF", - "F-3", - "F-3ASR", - "F-3D", - "F-3DPOS", - "F-3MEF", - "F-4", - "F-4 POS", - "F-4MEF", - "F-6", - "F-6 POS", - "F-6EF", - "F-7", - "F-7 POS", - "F-8", - "F-8 POS", - "F-80", - "F-80POS", - "F-9", - "F-9 POS", - "F-N", - "F-X", - "FOCUSN", - "FWP", - "G-405", - "G-405N", - "G-FIN", - "G-FINW", - "IRANNOTICE", - "MA", - "MA-A", - "MA-I", - "MA-W", - "MSD", - "MSDCO", - "MSDW", - "N-1", - "N-14", - "N-14 8C", - "N-14MEF", - "N-18F1", - "N-1A", - "N-2", - "N-2 POSASR", - "N-23C-2", - "N-23C3A", - "N-23C3B", - "N-23C3C", - "N-2ASR", - "N-2MEF", - "N-30B-2", - "N-30D", - "N-4", - "N-5", - "N-54A", - "N-54C", - "N-6", - "N-6F", - "N-8A", - "N-8B-2", - "N-8F", - "N-8F NTC", - "N-8F ORDR", - "N-CEN", - "N-CR", - "N-CSR", - "N-CSRS", - "N-MFP", - "N-MFP1", - "N-MFP2", - "N-PX", - "N-Q", - "N-VP", - "N-VPFS", - "NO ACT", - "NPORT-EX", - "NPORT-NP", - "NPORT-P", - "NRSRO-CE", - "NRSRO-UPD", - "NSAR-A", - "NSAR-AT", - "NSAR-B", - "NSAR-BT", - "NSAR-U", - "NT 10-D", - "NT 10-K", - "NT 10-Q", - "NT 11-K", - "NT 20-F", - "NT N-CEN", - "NT N-MFP", - "NT N-MFP1", - "NT N-MFP2", - "NT NPORT-EX", - "NT NPORT-P", - "NT-NCEN", - "NT-NCSR", - "NT-NSAR", - "NTFNCEN", - "NTFNCSR", - "NTFNSAR", - "NTN 10D", - "NTN 10K", - "NTN 10Q", - "NTN 20F", - "OIP NTC", - "OIP ORDR", - "POS 8C", - "POS AM", - "POS AMI", - "POS EX", - "POS462B", - "POS462C", - "POSASR", - "PRE 14A", - "PRE 14C", - "PREC14A", - "PREC14C", - "PREM14A", - "PREM14C", - "PREN14A", - "PRER14A", - "PRER14C", - "PRRN14A", - "PX14A6G", - "PX14A6N", - "QRTLYRPT", - "QUALIF", - "REG-NR", - "REVOKED", - "RW", - "RW WD", - "S-1", - "S-11", - "S-11MEF", - "S-1MEF", - "S-20", - "S-3", - "S-3ASR", - "S-3D", - "S-3DPOS", - "S-3MEF", - "S-4", - "S-4 POS", - "S-4EF", - "S-4MEF", - "S-6", - "S-8", - "S-8 POS", - "S-B", - "S-BMEF", - "SBSE", - "SBSE-A", - "SBSE-BD", - "SBSE-C", - "SBSE-W", - "SC 13D", - "SC 13E1", - "SC 13E3", - "SC 13G", - "SC 14D9", - "SC 14F1", - "SC 14N", - "SC TO-C", - "SC TO-I", - "SC TO-T", - "SC13E4F", - "SC14D1F", - "SC14D9C", - "SC14D9F", - "SD", - "SDR", - "SE", - "SEC ACTION", - "SEC STAFF ACTION", - "SEC STAFF LETTER", - "SF-1", - "SF-3", - "SL", - "SP 15D2", - "STOP ORDER", - "SUPPL", - "T-3", - "TA-1", - "TA-2", - "TA-W", - "TACO", - "TH", - "TTW", - "UNDER", - "UPLOAD", - "WDL-REQ", - "X-17A-5" - ], "type": "string" }, { "type": "null" } ], - "title": "sec", - "description": "Type of the SEC filing form. (provider: sec)" + "description": "Filter by form type. Check the data provider for available types.", + "title": "Form Type" }, - "description": "Type of the SEC filing form. (provider: sec)" + "description": "Filter by form type. Check the data provider for available types." }, { "name": "limit", @@ -11236,26 +12599,33 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "award", - "conversion", - "return", - "expire_short", - "in_kind", - "gift", - "expire_long", - "discretionary", - "other", - "small", - "exempt", - "otm", - "purchase", - "sale", - "tender", - "will", - "itm", - "trust" + "anyOf": [ + { + "enum": [ + "award", + "conversion", + "return", + "expire_short", + "in_kind", + "gift", + "expire_long", + "discretionary", + "other", + "small", + "exempt", + "otm", + "purchase", + "sale", + "tender", + "will", + "itm", + "trust" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "fmp", "description": "Type of the transaction. (provider: fmp)" @@ -11516,7 +12886,7 @@ "equity" ], "summary": "Form 13F", - "description": "The Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", + "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", "operationId": "equity_ownership_form_13f", "security": [ { @@ -11699,10 +13069,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "multiple_items_allowed": [ - "fmp", - "intrinio" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." @@ -12041,10 +13413,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon.", - "multiple_items_allowed": [ - "fmp", - "polygon" - ], + "fmp": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon." @@ -12339,9 +13713,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." @@ -12481,6 +13855,25 @@ "default": 0 }, "description": "\n Skip N number of reports from current. A value of 1 will skip the most recent report.\n (provider: sec)" + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "sec", + "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache. (provider: sec)", + "default": true + }, + "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache. (provider: sec)" } ], "responses": { @@ -12725,7 +14118,7 @@ "equity" ], "summary": "Screener", - "description": "Screen for companies meeting various criteria. These criteria include\nmarket cap, price, beta, volume, and dividend yield.", + "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", "operationId": "equity_screener", "security": [ { @@ -12973,21 +14366,21 @@ "anyOf": [ { "enum": [ - "Consumer Cyclical", - "Energy", - "Technology", - "Industrials", - "Financial Services", - "Basic Materials", - "Communication Services", - "Consumer Defensive", - "Healthcare", - "Real Estate", - "Utilities", - "Industrial Goods", - "Financial", - "Services", - "Conglomerates" + "consumer_cyclical", + "energy", + "technology", + "industrials", + "financial_services", + "basic_materials", + "communication_services", + "consumer_defensive", + "healthcare", + "real_estate", + "utilities", + "industrial_goods", + "financial", + "services", + "conglomerates" ], "type": "string" }, @@ -13223,10 +14616,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "multiple_items_allowed": [ - "fmp", - "intrinio" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." @@ -13694,10 +15089,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon.", - "multiple_items_allowed": [ - "fmp", - "polygon" - ], + "fmp": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon." @@ -13982,10 +15379,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "multiple_items_allowed": [ - "fmp", - "intrinio" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio." @@ -14191,9 +15590,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp." @@ -14291,10 +15690,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "multiple_items_allowed": [ - "fmp", - "intrinio" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." @@ -14454,10 +15855,10 @@ "type": "null" } ], - "title": "fmp,sec", - "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);\n A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)" + "title": "fmp,intrinio,sec", + "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);\n A specific date to get data for. (provider: intrinio);\n A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)" }, - "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);\n A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)" + "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);\n A specific date to get data for. (provider: intrinio);\n A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)" }, { "name": "cik", @@ -14684,107 +16085,6 @@ ] } }, - "/api/v1/etf/holdings_performance": { - "get": { - "tags": [ - "etf" - ], - "summary": "Holdings Performance", - "description": "Get the recent price performance of each ticker held in the ETF.", - "operationId": "etf_holdings_performance", - "security": [ - { - "OAuth2PasswordBearer": [] - } - ], - "parameters": [ - { - "name": "provider", - "in": "query", - "required": false, - "schema": { - "enum": [ - "fmp" - ], - "const": "fmp", - "type": "string", - "default": "fmp", - "title": "Provider" - } - }, - { - "name": "symbol", - "in": "query", - "required": true, - "schema": { - "type": "string", - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], - "title": "Symbol" - }, - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OBBject_EtfHoldingsPerformance" - } - } - } - }, - "404": { - "description": "Not found" - }, - "400": { - "description": "No Results Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OpenBBErrorResponse" - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OpenBBErrorResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - }, - "model": "EtfHoldingsPerformance", - "examples": [ - { - "scope": "api", - "parameters": { - "symbol": "XLK", - "provider": "fmp" - }, - "provider": "fmp" - } - ] - } - }, "/api/v1/etf/equity_exposure": { "get": { "tags": [ @@ -14820,9 +16120,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp." @@ -16509,14 +17809,279 @@ ] } }, + "/api/v1/fixedincome/government/yield_curve": { + "get": { + "tags": [ + "fixedincome" + ], + "summary": "Yield Curve", + "description": "Get yield curve data by country and date.", + "operationId": "fixedincome_government_yield_curve", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": true, + "schema": { + "enum": [ + "ecb", + "econdb", + "federal_reserve", + "fmp", + "fred" + ], + "type": "string", + "title": "Provider" + } + }, + { + "name": "date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "A specific date to get data for. By default is the current data. Multiple comma separated items allowed for provider(s): ecb, econdb, federal_reserve, fmp, fred.", + "ecb": { + "multiple_items_allowed": true + }, + "econdb": [ + "multiple_items_allowed" + ], + "federal_reserve": { + "multiple_items_allowed": true + }, + "fmp": { + "multiple_items_allowed": true + }, + "fred": { + "multiple_items_allowed": true + }, + "title": "Date" + }, + "description": "A specific date to get data for. By default is the current data. Multiple comma separated items allowed for provider(s): ecb, econdb, federal_reserve, fmp, fred." + }, + { + "name": "rating", + "in": "query", + "required": false, + "schema": { + "enum": [ + "aaa", + "all_ratings" + ], + "type": "string", + "title": "ecb", + "description": "The rating type, either 'aaa' or 'all_ratings'. (provider: ecb)", + "default": "aaa" + }, + "description": "The rating type, either 'aaa' or 'all_ratings'. (provider: ecb)" + }, + { + "name": "yield_curve_type", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "spot_rate", + "instantaneous_forward", + "par_yield" + ], + "type": "string" + }, + { + "enum": [ + "nominal", + "real", + "breakeven", + "corporate_spot", + "corporate_par" + ], + "type": "string" + } + ], + "title": "ecb,fred", + "description": "The yield curve type. (provider: ecb);\n Yield curve type. Nominal and Real Rates are available daily, others are monthly. The closest date to the requested date will be returned. (provider: fred)", + "default": "spot_rate" + }, + "description": "The yield curve type. (provider: ecb);\n Yield curve type. Nominal and Real Rates are available daily, others are monthly. The closest date to the requested date will be returned. (provider: fred)" + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "ecb,econdb", + "description": "If true, cache the request for four hours. (provider: ecb, econdb)", + "default": true + }, + "description": "If true, cache the request for four hours. (provider: ecb, econdb)" + }, + { + "name": "country", + "in": "query", + "required": false, + "schema": { + "enum": [ + "australia", + "canada", + "china", + "hong_kong", + "india", + "japan", + "mexico", + "new_zealand", + "russia", + "saudi_arabia", + "singapore", + "south_africa", + "south_korea", + "taiwan", + "thailand", + "united_kingdom", + "united_states" + ], + "type": "string", + "title": "econdb", + "description": "The country to get data. New Zealand, Mexico, Singapore, and Thailand have only monthly data. The nearest date to the requested one will be used. (provider: econdb)", + "choices": [ + "australia", + "canada", + "china", + "hong_kong", + "india", + "japan", + "mexico", + "new_zealand", + "russia", + "saudi_arabia", + "singapore", + "south_africa", + "south_korea", + "taiwan", + "thailand", + "united_kingdom", + "united_states" + ], + "default": "united_states" + }, + "description": "The country to get data. New Zealand, Mexico, Singapore, and Thailand have only monthly data. The nearest date to the requested one will be used. (provider: econdb)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_YieldCurve" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "YieldCurve", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "federal_reserve" + }, + "provider": "federal_reserve" + }, + { + "scope": "api", + "parameters": { + "date": "2023-05-01,2024-05-01", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "date": "2023-05-01", + "country": "united_kingdom", + "provider": "econdb" + }, + "provider": "econdb" + }, + { + "scope": "api", + "parameters": { + "provider": "ecb", + "yield_curve_type": "par_yield" + }, + "provider": "ecb" + }, + { + "scope": "api", + "parameters": { + "provider": "fred", + "yield_curve_type": "real", + "date": "2023-05-01,2024-05-01" + }, + "provider": "fred" + } + ] + } + }, "/api/v1/fixedincome/government/us_yield_curve": { "get": { "tags": [ "fixedincome" ], - "summary": "Us Yield Curve", + "summary": "This endpoint will be removed in a future version. Use, `/fixedincome/government/yield_curve`, instead. Deprecated in OpenBB Platform V4.2 to be removed in V4.4.", "description": "US Yield Curve. Get United States yield curve.", "operationId": "fixedincome_government_us_yield_curve", + "deprecated": true, "security": [ { "OAuth2PasswordBearer": [] @@ -16646,9 +18211,10 @@ "tags": [ "fixedincome" ], - "summary": "Eu Yield Curve", + "summary": "This endpoint will be removed in a future version. Use, `/fixedincome/government/yield_curve`, instead. Deprecated in OpenBB Platform V4.2 to be removed in V4.4.", "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.", "operationId": "fixedincome_government_eu_yield_curve", + "deprecated": true, "security": [ { "OAuth2PasswordBearer": [] @@ -17517,9 +19083,9 @@ } ], "description": "Maturities in years. Multiple comma separated items allowed for provider(s): fred.", - "multiple_items_allowed": [ - "fred" - ], + "fred": { + "multiple_items_allowed": true + }, "default": 10.0, "title": "Maturity" }, @@ -17536,9 +19102,9 @@ "par_yield", "spot_rate" ], - "multiple_items_allowed": [ - "fred" - ], + "fred": { + "multiple_items_allowed": true + }, "default": "spot_rate", "title": "Category" }, @@ -17981,11 +19547,15 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon.", - "multiple_items_allowed": [ - "fmp", - "intrinio", - "polygon" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon." @@ -18156,7 +19726,7 @@ "index" ], "summary": "This endpoint is deprecated; use `/index/price/historical` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3.", - "description": "Historical Market Indices.", + "description": "Get Historical Market Indices.", "operationId": "index_market", "deprecated": true, "security": [ @@ -18186,11 +19756,15 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon.", - "multiple_items_allowed": [ - "fmp", - "intrinio", - "polygon" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon." @@ -18352,7 +19926,7 @@ "index" ], "summary": "Constituents", - "description": "Index Constituents.", + "description": "Get Index Constituents.", "operationId": "index_constituents", "security": [ { @@ -18820,6 +20394,179 @@ "description": "Content types of the news to retrieve. (provider: benzinga)" }, "description": "Content types of the news to retrieve. (provider: benzinga)" + }, + { + "name": "source", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "yahoo", + "moody", + "moody_us_news", + "moody_us_press_releases" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The source of the news article. (provider: intrinio)" + }, + "description": "The source of the news article. (provider: intrinio)" + }, + { + "name": "sentiment", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "positive", + "neutral", + "negative" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Return news only from this source. (provider: intrinio)" + }, + "description": "Return news only from this source. (provider: intrinio)" + }, + { + "name": "language", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter by language. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter by language. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "topic", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter by topic. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter by topic. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "word_count_greater_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "word_count_less_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "is_spam", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "business_relevance_greater_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + { + "name": "business_relevance_less_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" } ], "responses": { @@ -18958,12 +20705,18 @@ } ], "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon.", - "multiple_items_allowed": [ - "benzinga", - "fmp", - "intrinio", - "polygon" - ], + "benzinga": { + "multiple_items_allowed": true + }, + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon." @@ -19264,6 +21017,179 @@ "default": 0 }, "description": "Page number of the results. Use in combination with limit. (provider: fmp)" + }, + { + "name": "source", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "yahoo", + "moody", + "moody_us_news", + "moody_us_press_releases" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The source of the news article. (provider: intrinio)" + }, + "description": "The source of the news article. (provider: intrinio)" + }, + { + "name": "sentiment", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "positive", + "neutral", + "negative" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Return news only from this source. (provider: intrinio)" + }, + "description": "Return news only from this source. (provider: intrinio)" + }, + { + "name": "language", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter by language. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter by language. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "topic", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter by topic. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter by topic. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "word_count_greater_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "word_count_less_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "is_spam", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "business_relevance_greater_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + { + "name": "business_relevance_less_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" } ], "responses": { @@ -19371,6 +21297,558 @@ ] } }, + "/api/v1/pro/watchlist": { + "get": { + "tags": [ + "pro" + ], + "summary": "Watchlist", + "description": "Watchlist endpoint for pro users.", + "operationId": "pro_watchlist", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "pro" + ], + "const": "pro", + "type": "string", + "default": "pro", + "title": "Provider" + } + }, + { + "name": "data_provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "fmp" + ], + "const": "fmp", + "type": "string", + "title": "pro", + "description": "Provider name. (provider: pro)", + "default": "fmp" + }, + "description": "Provider name. (provider: pro)" + }, + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "pro", + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)", + "pro": [ + "multiple_items_allowed" + ] + }, + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_Watchlist" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "Watchlist", + "examples": [] + } + }, + "/api/v1/pro/key_metrics": { + "get": { + "tags": [ + "pro" + ], + "summary": "Key Metrics", + "description": "Key metrics endpoint for pro users.", + "operationId": "pro_key_metrics", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "pro" + ], + "const": "pro", + "type": "string", + "default": "pro", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "pro", + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)", + "pro": [ + "multiple_items_allowed" + ] + }, + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)" + }, + { + "name": "category", + "in": "query", + "required": false, + "schema": { + "enum": [ + "equity", + "etf" + ], + "type": "string", + "title": "pro", + "description": "Category of the asset. (provider: pro)", + "default": "equity" + }, + "description": "Category of the asset. (provider: pro)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_ProKeyMetrics" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "ProKeyMetrics", + "examples": [] + } + }, + "/api/v1/pro/grouped_comparisons": { + "get": { + "tags": [ + "pro" + ], + "summary": "Grouped Comparisons", + "description": "Grouped comparison endpoint for pro users.", + "operationId": "pro_grouped_comparisons", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "pro" + ], + "const": "pro", + "type": "string", + "default": "pro", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "pro", + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)", + "pro": { + "multiple_items_allowed": true + } + }, + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_GroupedComparisons" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "GroupedComparisons", + "examples": [] + } + }, + "/api/v1/pro/grouped_financials": { + "get": { + "tags": [ + "pro" + ], + "summary": "Grouped Financials", + "description": "Grouped financials endpoint for pro users.", + "operationId": "pro_grouped_financials", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "pro" + ], + "const": "pro", + "type": "string", + "default": "pro", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "pro", + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)", + "pro": [ + "multiple_items_allowed" + ] + }, + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)" + }, + { + "name": "data_provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "fmp", + "intrinio" + ], + "type": "string", + "title": "pro", + "description": "Provider name. (provider: pro)", + "default": "fmp" + }, + "description": "Provider name. (provider: pro)" + }, + { + "name": "period", + "in": "query", + "required": false, + "schema": { + "enum": [ + "annual", + "quarter" + ], + "type": "string", + "title": "pro", + "description": "None", + "default": "annual" + }, + "description": "None" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "title": "pro", + "description": "None", + "default": 5 + }, + "description": "None" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_GroupedFinancials" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "GroupedFinancials", + "examples": [] + } + }, + "/api/v1/pro/nixtla_timegen": { + "post": { + "tags": [ + "pro" + ], + "summary": "Nixtla Timegen", + "description": "Nixtla Timegen endpoint.", + "operationId": "pro_nixtla_timegen", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NixtlaTimegenQueryParams" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_list_NixtlaTimegenData__" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "model": "", + "examples": [] + } + }, "/api/v1/regulators/sec/cik_map": { "get": { "tags": [ @@ -19409,6 +21887,25 @@ "title": "Symbol" }, "description": "Symbol to get data for." + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "sec", + "description": "Whether or not to use cache for the request, default is True. (provider: sec)", + "default": true + }, + "description": "Whether or not to use cache for the request, default is True. (provider: sec)" } ], "responses": { @@ -19522,11 +22019,11 @@ "type": "null" } ], - "description": "Whether or not to use cache. If True, cache will store for seven days.", + "description": "Whether or not to use cache.", "default": true, "title": "Use Cache" }, - "description": "Whether or not to use cache. If True, cache will store for seven days." + "description": "Whether or not to use cache." } ], "responses": { @@ -19600,7 +22097,7 @@ "regulators" ], "summary": "Schema Files", - "description": "A tool for navigating the directory of SEC XML schema files by year.", + "description": "Use tool for navigating the directory of SEC XML schema files by year.", "operationId": "regulators_sec_schema_files", "security": [ { @@ -19647,11 +22144,11 @@ "type": "null" } ], - "description": "Whether or not to use cache. If True, cache will store for seven days.", + "description": "Whether or not to use cache.", "default": true, "title": "Use Cache" }, - "description": "Whether or not to use cache. If True, cache will store for seven days." + "description": "Whether or not to use cache." }, { "name": "url", @@ -19875,7 +22372,7 @@ "regulators" ], "summary": "Rss Litigation", - "description": "The RSS feed provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", + "description": "Get the RSS feed that provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", "operationId": "regulators_sec_rss_litigation", "security": [ { @@ -20008,11 +22505,11 @@ "type": "null" } ], - "description": "Whether or not to use cache. If True, cache will store for seven days.", + "description": "Whether or not to use cache.", "default": true, "title": "Use Cache" }, - "description": "Whether or not to use cache. If True, cache will store for seven days." + "description": "Whether or not to use cache." } ], "responses": { @@ -20143,6 +22640,18 @@ "title": "Ignore Type" }, "description": "Comma separated list of types to ignore. (stock, etf, index, indices)" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "description": "Limit the number of results returned.", + "default": 25, + "title": "Limit" + }, + "description": "Limit the number of results returned." } ], "responses": { @@ -20167,27 +22676,41 @@ } } } - } - }, - "/search/currencies": { - "get": { + }, + "post": { "tags": [ "search" ], - "summary": "Currencies", + "summary": "Post Symbols", "description": "Get supported tickers from the OpenBB SDK API.", - "operationId": "unique_currencies", + "operationId": "post_symbols", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PostSearchParams" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Response Unique Currencies" + "$ref": "#/components/schemas/FMPTickerResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" } } } @@ -20411,7 +22934,45 @@ }, "components": { "schemas": { - "BenzingaAnalystSearch": { + "AvailableComparisonData": { + "properties": { + "financial_ratios": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/PossibleYears" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Financial Ratios", + "description": "Available financial ratios." + }, + "valuation_multiples": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/PossibleYears" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Valuation Multiples", + "description": "Available valuation multiples." + } + }, + "additionalProperties": true, + "type": "object", + "title": "AvailableComparisonData", + "description": "Available Comparison Data." + }, + "BenzingaAnalystSearchData": { "properties": { "last_updated": { "anyOf": [ @@ -20595,7 +23156,7 @@ "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "overall_std_dev": { + "overall_stdev": { "anyOf": [ { "type": "number" @@ -20604,12 +23165,12 @@ "type": "null" } ], - "title": "Overall Std Dev", + "title": "Overall Stdev", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "gain_count_1m": { + "1m_gain_count": { "anyOf": [ { "type": "integer" @@ -20618,10 +23179,10 @@ "type": "null" } ], - "title": "Gain Count 1M", + "title": "1M Gain Count", "description": "The number of ratings that have gained value over the last month" }, - "loss_count_1m": { + "1m_loss_count": { "anyOf": [ { "type": "integer" @@ -20630,10 +23191,10 @@ "type": "null" } ], - "title": "Loss Count 1M", + "title": "1M Loss Count", "description": "The number of ratings that have lost value over the last month" }, - "average_return_1m": { + "1m_average_return": { "anyOf": [ { "type": "number" @@ -20642,12 +23203,12 @@ "type": "null" } ], - "title": "Average Return 1M", + "title": "1M Average Return", "description": "The average percent (normalized) price difference per rating over the last month", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "std_dev_1m": { + "1m_stdev": { "anyOf": [ { "type": "number" @@ -20656,36 +23217,12 @@ "type": "null" } ], - "title": "Std Dev 1M", + "title": "1M Stdev", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "gain_count_3m": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Gain Count 3M", - "description": "The number of ratings that have gained value over the last 3 months" - }, - "loss_count_3m": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Loss Count 3M", - "description": "The number of ratings that have lost value over the last 3 months" - }, - "average_return_3m": { + "1m_smart_score": { "anyOf": [ { "type": "number" @@ -20694,12 +23231,62 @@ "type": "null" } ], - "title": "Average Return 3M", + "title": "1M Smart Score", + "description": "A weighted average smart score over the last month." + }, + "1m_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "1M Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "3m_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "3M Gain Count", + "description": "The number of ratings that have gained value over the last 3 months" + }, + "3m_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "3M Loss Count", + "description": "The number of ratings that have lost value over the last 3 months" + }, + "3m_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3M Average Return", "description": "The average percent (normalized) price difference per rating over the last 3 months", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "std_dev_3m": { + "3m_stdev": { "anyOf": [ { "type": "number" @@ -20708,36 +23295,12 @@ "type": "null" } ], - "title": "Std Dev 3M", + "title": "3M Stdev", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "gain_count_6m": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Gain Count 6M", - "description": "The number of ratings that have gained value over the last 6 months" - }, - "loss_count_6m": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Loss Count 6M", - "description": "The number of ratings that have lost value over the last 6 months" - }, - "average_return_6m": { + "3m_smart_score": { "anyOf": [ { "type": "number" @@ -20746,12 +23309,62 @@ "type": "null" } ], - "title": "Average Return 6M", + "title": "3M Smart Score", + "description": "A weighted average smart score over the last 3 months." + }, + "3m_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3M Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "6m_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "6M Gain Count", + "description": "The number of ratings that have gained value over the last 6 months" + }, + "6m_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "6M Loss Count", + "description": "The number of ratings that have lost value over the last 6 months" + }, + "6m_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "6M Average Return", "description": "The average percent (normalized) price difference per rating over the last 6 months", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "std_dev_6m": { + "6m_stdev": { "anyOf": [ { "type": "number" @@ -20760,12 +23373,12 @@ "type": "null" } ], - "title": "Std Dev 6M", + "title": "6M Stdev", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "gain_count_9m": { + "9m_gain_count": { "anyOf": [ { "type": "integer" @@ -20774,10 +23387,10 @@ "type": "null" } ], - "title": "Gain Count 9M", + "title": "9M Gain Count", "description": "The number of ratings that have gained value over the last 9 months" }, - "loss_count_9m": { + "9m_loss_count": { "anyOf": [ { "type": "integer" @@ -20786,10 +23399,10 @@ "type": "null" } ], - "title": "Loss Count 9M", + "title": "9M Loss Count", "description": "The number of ratings that have lost value over the last 9 months" }, - "average_return_9m": { + "9m_average_return": { "anyOf": [ { "type": "number" @@ -20798,12 +23411,12 @@ "type": "null" } ], - "title": "Average Return 9M", + "title": "9M Average Return", "description": "The average percent (normalized) price difference per rating over the last 9 months", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "std_dev_9m": { + "9m_stdev": { "anyOf": [ { "type": "number" @@ -20812,36 +23425,12 @@ "type": "null" } ], - "title": "Std Dev 9M", + "title": "9M Stdev", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "gain_count_1y": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Gain Count 1Y", - "description": "The number of ratings that have gained value over the last 1 year" - }, - "loss_count_1y": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Loss Count 1Y", - "description": "The number of ratings that have lost value over the last 1 year" - }, - "average_return_1y": { + "9m_smart_score": { "anyOf": [ { "type": "number" @@ -20850,12 +23439,62 @@ "type": "null" } ], - "title": "Average Return 1Y", + "title": "9M Smart Score", + "description": "A weighted average smart score over the last 9 months." + }, + "9m_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "9M Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "1y_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "1Y Gain Count", + "description": "The number of ratings that have gained value over the last 1 year" + }, + "1y_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "1Y Loss Count", + "description": "The number of ratings that have lost value over the last 1 year" + }, + "1y_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "1Y Average Return", "description": "The average percent (normalized) price difference per rating over the last 1 year", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "std_dev_1y": { + "1y_stdev": { "anyOf": [ { "type": "number" @@ -20864,36 +23503,12 @@ "type": "null" } ], - "title": "Std Dev 1Y", + "title": "1Y Stdev", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "gain_count_2y": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Gain Count 2Y", - "description": "The number of ratings that have gained value over the last 2 years" - }, - "loss_count_2y": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Loss Count 2Y", - "description": "The number of ratings that have lost value over the last 2 years" - }, - "average_return_2y": { + "1y_smart_score": { "anyOf": [ { "type": "number" @@ -20902,12 +23517,62 @@ "type": "null" } ], - "title": "Average Return 2Y", + "title": "1Y Smart Score", + "description": "A weighted average smart score over the last 1 year." + }, + "1y_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "1Y Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "2y_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "2Y Gain Count", + "description": "The number of ratings that have gained value over the last 2 years" + }, + "2y_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "2Y Loss Count", + "description": "The number of ratings that have lost value over the last 2 years" + }, + "2y_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "2Y Average Return", "description": "The average percent (normalized) price difference per rating over the last 2 years", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "std_dev_2y": { + "2y_stdev": { "anyOf": [ { "type": "number" @@ -20916,36 +23581,12 @@ "type": "null" } ], - "title": "Std Dev 2Y", + "title": "2Y Stdev", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "gain_count_3y": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Gain Count 3Y", - "description": "The number of ratings that have gained value over the last 3 years" - }, - "loss_count_3y": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Loss Count 3Y", - "description": "The number of ratings that have lost value over the last 3 years" - }, - "average_return_3y": { + "2y_smart_score": { "anyOf": [ { "type": "number" @@ -20954,12 +23595,62 @@ "type": "null" } ], - "title": "Average Return 3Y", + "title": "2Y Smart Score", + "description": "A weighted average smart score over the last 3 years." + }, + "2y_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "2Y Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "3y_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "3Y Gain Count", + "description": "The number of ratings that have gained value over the last 3 years" + }, + "3y_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "3Y Loss Count", + "description": "The number of ratings that have lost value over the last 3 years" + }, + "3y_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3Y Average Return", "description": "The average percent (normalized) price difference per rating over the last 3 years", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "std_dev_3y": { + "3y_stdev": { "anyOf": [ { "type": "number" @@ -20968,10 +23659,36 @@ "type": "null" } ], - "title": "Std Dev 3Y", + "title": "3Y Stdev", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years", "x-frontend_multiply": 100, "x-unit_measurement": "percent" + }, + "3y_smart_score": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3Y Smart Score", + "description": "A weighted average smart score over the last 3 years." + }, + "3y_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3Y Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" } }, "additionalProperties": true, @@ -20979,10 +23696,10 @@ "required": [ "name_full" ], - "title": "BenzingaAnalystSearch", + "title": "BenzingaAnalystSearchData", "description": "Benzinga Analyst Search Data." }, - "BenzingaCompanyNews": { + "BenzingaCompanyNewsData": { "properties": { "date": { "type": "string", @@ -21129,10 +23846,10 @@ "url", "id" ], - "title": "BenzingaCompanyNews", + "title": "BenzingaCompanyNewsData", "description": "Benzinga Company News Data." }, - "BenzingaPriceTarget": { + "BenzingaPriceTargetData": { "properties": { "published_date": { "anyOf": [ @@ -21310,7 +24027,7 @@ "title": "Rating Previous", "description": "Previous analyst rating for the company." }, - "action": { + "action_company": { "anyOf": [ { "type": "string", @@ -21332,10 +24049,10 @@ "type": "null" } ], - "title": "Action", + "title": "Action Company", "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined." }, - "action_change": { + "action_pt": { "anyOf": [ { "type": "string", @@ -21352,7 +24069,7 @@ "type": "null" } ], - "title": "Action Change", + "title": "Action Pt", "description": "Description of the change in price target from firm's last price target." }, "importance": { @@ -21435,7 +24152,7 @@ "title": "Id", "description": "Unique ID of this entry." }, - "last_updated": { + "updated": { "anyOf": [ { "type": "string", @@ -21445,7 +24162,7 @@ "type": "null" } ], - "title": "Last Updated", + "title": "Updated", "description": "Last updated timestamp, UTC." } }, @@ -21455,10 +24172,10 @@ "published_date", "symbol" ], - "title": "BenzingaPriceTarget", + "title": "BenzingaPriceTargetData", "description": "Benzinga Price Target Data." }, - "BenzingaWorldNews": { + "BenzingaWorldNewsData": { "properties": { "date": { "type": "string", @@ -21599,7 +24316,7 @@ "title", "id" ], - "title": "BenzingaWorldNews", + "title": "BenzingaWorldNewsData", "description": "Benzinga World News Data." }, "Chart": { @@ -21641,7 +24358,8 @@ } }, "type": "object", - "title": "Chart" + "title": "Chart", + "description": "Model for Chart." }, "ChartFormat": { "type": "string", @@ -21649,9 +24367,10 @@ "plotly" ], "const": "plotly", - "title": "ChartFormat" + "title": "ChartFormat", + "description": "Chart format." }, - "ECBBalanceOfPayments": { + "ECBBalanceOfPaymentsData": { "properties": { "period": { "type": "string", @@ -22946,10 +25665,10 @@ }, "additionalProperties": true, "type": "object", - "title": "ECBBalanceOfPayments", + "title": "ECBBalanceOfPaymentsData", "description": "ECB Balance of Payments Data." }, - "ECBCurrencyReferenceRates": { + "ECBCurrencyReferenceRatesData": { "properties": { "date": { "type": "string", @@ -23335,10 +26054,10 @@ "required": [ "date" ], - "title": "ECBCurrencyReferenceRates", + "title": "ECBCurrencyReferenceRatesData", "description": "ECB Currency Reference Rates Data." }, - "ECBEUYieldCurve": { + "ECBEUYieldCurveData": { "properties": { "maturity": { "anyOf": [ @@ -23369,10 +26088,522 @@ }, "additionalProperties": true, "type": "object", - "title": "ECBEUYieldCurve", + "title": "ECBEUYieldCurveData", "description": "ECB Yield Curve Data." }, - "FMPAnalystEstimates": { + "ECBYieldCurveData": { + "properties": { + "date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Date", + "description": "The date of the data." + }, + "maturity": { + "type": "string", + "title": "Maturity", + "description": "Maturity length of the security." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "The yield as a normalized percent (0.05 is 5%)", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "ECBYieldCurveData", + "description": "ECB Yield Curve Data." + }, + "EconDbAvailableIndicatorsData": { + "properties": { + "symbol_root": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol Root", + "description": "The root symbol representing the indicator." + }, + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Symbol representing the entity requested in the data. The root symbol with additional codes." + }, + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Country", + "description": "The name of the country, region, or entity represented by the symbol." + }, + "iso": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Iso", + "description": "The ISO code of the country, region, or entity represented by the symbol." + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description", + "description": "The description of the indicator." + }, + "frequency": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Frequency", + "description": "The frequency of the indicator data." + }, + "currency": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Currency", + "description": "The currency, or unit, the data is based in." + }, + "scale": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Scale", + "description": "The scale of the data." + }, + "multiplier": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Multiplier", + "description": "The multiplier of the data to arrive at whole units." + }, + "transformation": { + "type": "string", + "title": "Transformation", + "description": "Transformation type." + }, + "source": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Source", + "description": "The original source of the data." + }, + "first_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "First Date", + "description": "The first date of the data." + }, + "last_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Last Date", + "description": "The last date of the data." + }, + "last_insert_timestamp": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Insert Timestamp", + "description": "The time of the last update. Data is typically reported with a lag." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "multiplier", + "transformation" + ], + "title": "EconDbAvailableIndicatorsData", + "description": "EconDB Available Indicators Data." + }, + "EconDbCountryProfileData": { + "properties": { + "country": { + "type": "string", + "title": "Country", + "description": "" + }, + "population": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Population", + "description": "Population." + }, + "gdp_usd": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Gdp Usd", + "description": "Gross Domestic Product, in billions of USD." + }, + "gdp_qoq": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Gdp Qoq", + "description": "GDP growth quarter-over-quarter change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "gdp_yoy": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Gdp Yoy", + "description": "GDP growth year-over-year change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "cpi_yoy": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cpi Yoy", + "description": "Consumer Price Index year-over-year change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "core_yoy": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Core Yoy", + "description": "Core Consumer Price Index year-over-year change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "retail_sales_yoy": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Retail Sales Yoy", + "description": "Retail Sales year-over-year change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "industrial_production_yoy": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Industrial Production Yoy", + "description": "Industrial Production year-over-year change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "policy_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Policy Rate", + "description": "Short term policy rate, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "yield_10y": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Yield 10Y", + "description": "10-year government bond yield, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "govt_debt_gdp": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Govt Debt Gdp", + "description": "Government debt as a percent (normalized) of GDP.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "current_account_gdp": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Current Account Gdp", + "description": "Current account balance as a percent (normalized) of GDP.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "jobless_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Jobless Rate", + "description": "Unemployment rate, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "country" + ], + "title": "EconDbCountryProfileData", + "description": "EconDB Country Profile Data." + }, + "EconDbEconomicIndicatorsData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "symbol_root": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol Root", + "description": "The root symbol for the indicator (e.g. GDP)." + }, + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Country", + "description": "The country represented by the data." + }, + "value": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Value", + "description": "" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date" + ], + "title": "EconDbEconomicIndicatorsData", + "description": "EconDB Economic Indicators Data." + }, + "EconDbYieldCurveData": { + "properties": { + "date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Date", + "description": "The date of the data." + }, + "maturity": { + "type": "string", + "title": "Maturity", + "description": "Maturity length of the security." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "The yield as a normalized percent (0.05 is 5%)", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "EconDbYieldCurveData", + "description": "EconDB Yield Curve Data." + }, + "FMPAnalystEstimatesData": { "properties": { "symbol": { "type": "string", @@ -23632,10 +26863,10 @@ "symbol", "date" ], - "title": "FMPAnalystEstimates", + "title": "FMPAnalystEstimatesData", "description": "FMP Analyst Estimates Data." }, - "FMPAvailableIndices": { + "FMPAvailableIndicesData": { "properties": { "name": { "anyOf": [ @@ -23661,27 +26892,27 @@ "title": "Currency", "description": "Currency the index is traded in." }, - "stock_exchange": { + "stockExchange": { "type": "string", - "title": "Stock Exchange", + "title": "Stockexchange", "description": "Stock exchange where the index is listed." }, - "exchange_short_name": { + "exchangeShortName": { "type": "string", - "title": "Exchange Short Name", + "title": "Exchangeshortname", "description": "Short name of the stock exchange where the index is listed." } }, "additionalProperties": true, "type": "object", "required": [ - "stock_exchange", - "exchange_short_name" + "stockExchange", + "exchangeShortName" ], - "title": "FMPAvailableIndices", + "title": "FMPAvailableIndicesData", "description": "FMP Available Indices Data." }, - "FMPBalanceSheet": { + "FMPBalanceSheetData": { "properties": { "period_ending": { "type": "string", @@ -24321,10 +27552,10 @@ "required": [ "period_ending" ], - "title": "FMPBalanceSheet", + "title": "FMPBalanceSheetData", "description": "FMP Balance Sheet Data." }, - "FMPBalanceSheetGrowth": { + "FMPBalanceSheetGrowthData": { "properties": { "symbol": { "anyOf": [ @@ -24590,10 +27821,10 @@ "growth_total_debt", "growth_net_debt" ], - "title": "FMPBalanceSheetGrowth", + "title": "FMPBalanceSheetGrowthData", "description": "FMP Balance Sheet Growth Data." }, - "FMPCalendarDividend": { + "FMPCalendarDividendData": { "properties": { "ex_dividend_date": { "type": "string", @@ -24669,7 +27900,7 @@ "title": "Declaration Date", "description": "Declaration date of the dividend." }, - "adjusted_amount": { + "adjDividend": { "anyOf": [ { "type": "number" @@ -24678,7 +27909,7 @@ "type": "null" } ], - "title": "Adjusted Amount", + "title": "Adjdividend", "description": "The adjusted-dividend amount." }, "label": { @@ -24700,10 +27931,10 @@ "ex_dividend_date", "symbol" ], - "title": "FMPCalendarDividend", + "title": "FMPCalendarDividendData", "description": "FMP Dividend Calendar Data." }, - "FMPCalendarEarnings": { + "FMPCalendarEarningsData": { "properties": { "report_date": { "type": "string", @@ -24752,7 +27983,7 @@ "title": "Eps Consensus", "description": "The analyst conesus earnings-per-share estimate." }, - "eps_actual": { + "eps": { "anyOf": [ { "type": "number" @@ -24761,10 +27992,10 @@ "type": "null" } ], - "title": "Eps Actual", + "title": "Eps", "description": "The actual earnings per share announced." }, - "revenue_actual": { + "revenue": { "anyOf": [ { "type": "number" @@ -24773,10 +28004,10 @@ "type": "null" } ], - "title": "Revenue Actual", + "title": "Revenue", "description": "The actual reported revenue." }, - "revenue_consensus": { + "revenueEstimated": { "anyOf": [ { "type": "number" @@ -24785,10 +28016,10 @@ "type": "null" } ], - "title": "Revenue Consensus", + "title": "Revenueestimated", "description": "The revenue forecast consensus." }, - "period_ending": { + "fiscalDateEnding": { "anyOf": [ { "type": "string", @@ -24798,10 +28029,10 @@ "type": "null" } ], - "title": "Period Ending", + "title": "Fiscaldateending", "description": "The fiscal period end date." }, - "reporting_time": { + "time": { "anyOf": [ { "type": "string" @@ -24810,10 +28041,10 @@ "type": "null" } ], - "title": "Reporting Time", + "title": "Time", "description": "The reporting time - e.g. after market close." }, - "updated_date": { + "updatedFromDate": { "anyOf": [ { "type": "string", @@ -24823,7 +28054,7 @@ "type": "null" } ], - "title": "Updated Date", + "title": "Updatedfromdate", "description": "The date the data was updated last." } }, @@ -24833,10 +28064,10 @@ "report_date", "symbol" ], - "title": "FMPCalendarEarnings", + "title": "FMPCalendarEarningsData", "description": "FMP Earnings Calendar Data." }, - "FMPCalendarSplits": { + "FMPCalendarSplitsData": { "properties": { "date": { "type": "string", @@ -24874,10 +28105,10 @@ "numerator", "denominator" ], - "title": "FMPCalendarSplits", + "title": "FMPCalendarSplitsData", "description": "FMP Calendar Splits Data." }, - "FMPCashFlowStatement": { + "FMPCashFlowStatementData": { "properties": { "period_ending": { "type": "string", @@ -25336,10 +28567,10 @@ "required": [ "period_ending" ], - "title": "FMPCashFlowStatement", + "title": "FMPCashFlowStatementData", "description": "FMP Cash Flow Statement Data." }, - "FMPCashFlowStatementGrowth": { + "FMPCashFlowStatementGrowthData": { "properties": { "symbol": { "anyOf": [ @@ -25551,10 +28782,10 @@ "growth_capital_expenditure", "growth_free_cash_flow" ], - "title": "FMPCashFlowStatementGrowth", + "title": "FMPCashFlowStatementGrowthData", "description": "FMP Cash Flow Statement Growth Data." }, - "FMPCompanyFilings": { + "FMPCompanyFilingsData": { "properties": { "filing_date": { "type": "string", @@ -25635,10 +28866,10 @@ "filing_date", "report_url" ], - "title": "FMPCompanyFilings", + "title": "FMPCompanyFilingsData", "description": "FMP Company Filings Data." }, - "FMPCompanyNews": { + "FMPCompanyNewsData": { "properties": { "date": { "type": "string", @@ -25712,10 +28943,10 @@ "url", "source" ], - "title": "FMPCompanyNews", + "title": "FMPCompanyNewsData", "description": "FMP Company News Data." }, - "FMPCompanyOverview": { + "FMPCompanyOverviewData": { "properties": { "symbol": { "type": "string", @@ -26119,10 +29350,10 @@ "is_adr", "is_fund" ], - "title": "FMPCompanyOverview", + "title": "FMPCompanyOverviewData", "description": "FMP Company Overview Data." }, - "FMPCryptoHistorical": { + "FMPCryptoHistoricalData": { "properties": { "date": { "anyOf": [ @@ -26204,7 +29435,7 @@ "title": "Change", "description": "Change in the price from the previous close." }, - "change_percent": { + "changeOverTime": { "anyOf": [ { "type": "number" @@ -26213,7 +29444,7 @@ "type": "null" } ], - "title": "Change Percent", + "title": "Changeovertime", "description": "Change in the price from the previous close, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" @@ -26229,10 +29460,10 @@ "close", "volume" ], - "title": "FMPCryptoHistorical", + "title": "FMPCryptoHistoricalData", "description": "FMP Crypto Historical Price Data." }, - "FMPCryptoSearch": { + "FMPCryptoSearchData": { "properties": { "symbol": { "type": "string", @@ -26263,7 +29494,7 @@ "title": "Currency", "description": "The currency the crypto trades for." }, - "exchange": { + "stockExchange": { "anyOf": [ { "type": "string" @@ -26272,10 +29503,10 @@ "type": "null" } ], - "title": "Exchange", + "title": "Stockexchange", "description": "The exchange code the crypto trades on." }, - "exchange_name": { + "exchangeShortName": { "anyOf": [ { "type": "string" @@ -26284,7 +29515,7 @@ "type": "null" } ], - "title": "Exchange Name", + "title": "Exchangeshortname", "description": "The short name of the exchange the crypto trades on." } }, @@ -26293,10 +29524,10 @@ "required": [ "symbol" ], - "title": "FMPCryptoSearch", + "title": "FMPCryptoSearchData", "description": "FMP Crypto Search Data." }, - "FMPCurrencyHistorical": { + "FMPCurrencyHistoricalData": { "properties": { "date": { "anyOf": [ @@ -26385,7 +29616,7 @@ "title": "Change", "description": "Change in the price from the previous close." }, - "change_percent": { + "changeOverTime": { "anyOf": [ { "type": "number" @@ -26394,7 +29625,7 @@ "type": "null" } ], - "title": "Change Percent", + "title": "Changeovertime", "description": "Change in the price from the previous close, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" @@ -26409,21 +29640,28 @@ "low", "close" ], - "title": "FMPCurrencyHistorical", + "title": "FMPCurrencyHistoricalData", "description": "FMP Currency Historical Price Data." }, - "FMPCurrencyPairs": { + "FMPCurrencyPairsData": { "properties": { - "name": { - "type": "string", - "title": "Name", - "description": "Name of the currency pair." - }, "symbol": { "type": "string", "title": "Symbol", "description": "Symbol of the currency pair." }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the currency pair." + }, "currency": { "type": "string", "title": "Currency", @@ -26457,14 +29695,13 @@ "additionalProperties": true, "type": "object", "required": [ - "name", "symbol", "currency" ], - "title": "FMPCurrencyPairs", + "title": "FMPCurrencyPairsData", "description": "FMP Currency Available Pairs Data." }, - "FMPCurrencySnapshots": { + "FMPCurrencySnapshotsData": { "properties": { "base_currency": { "type": "string", @@ -26648,10 +29885,10 @@ "counter_currency", "last_rate" ], - "title": "FMPCurrencySnapshots", + "title": "FMPCurrencySnapshotsData", "description": "FMP Currency Snapshots Data." }, - "FMPDiscoveryFilings": { + "FMPDiscoveryFilingsData": { "properties": { "symbol": { "type": "string", @@ -26695,10 +29932,10 @@ "form_type", "link" ], - "title": "FMPDiscoveryFilings", + "title": "FMPDiscoveryFilingsData", "description": "FMP Discovery Filings Data." }, - "FMPEarningsCallTranscript": { + "FMPEarningsCallTranscriptData": { "properties": { "symbol": { "type": "string", @@ -26736,10 +29973,10 @@ "date", "content" ], - "title": "FMPEarningsCallTranscript", + "title": "FMPEarningsCallTranscriptData", "description": "FMP Earnings Call Transcript Data." }, - "FMPEconomicCalendar": { + "FMPEconomicCalendarData": { "properties": { "date": { "anyOf": [ @@ -26766,6 +30003,18 @@ "title": "Country", "description": "Country of event." }, + "category": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Category", + "description": "Category of event." + }, "event": { "anyOf": [ { @@ -26778,7 +30027,7 @@ "title": "Event", "description": "Event name." }, - "reference": { + "importance": { "anyOf": [ { "type": "string" @@ -26787,8 +30036,8 @@ "type": "null" } ], - "title": "Reference", - "description": "Abbreviated period for which released data refers to." + "title": "Importance", + "description": "The importance level for the event." }, "source": { "anyOf": [ @@ -26802,111 +30051,6 @@ "title": "Source", "description": "Source of the data." }, - "sourceurl": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Sourceurl", - "description": "Source URL." - }, - "actual": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Actual", - "description": "Latest released value." - }, - "previous": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Previous", - "description": "Value for the previous period after the revision (if revision is applicable)." - }, - "consensus": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Consensus", - "description": "Average forecast among a representative group of economists." - }, - "forecast": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Forecast", - "description": "Trading Economics projections" - }, - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url", - "description": "Trading Economics URL" - }, - "importance": { - "anyOf": [ - { - "type": "integer", - "enum": [ - 0, - 1, - 2, - 3 - ] - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Importance", - "description": "Importance of the event. 1-Low, 2-Medium, 3-High" - }, "currency": { "anyOf": [ { @@ -26931,6 +30075,66 @@ "title": "Unit", "description": "Unit of the data." }, + "consensus": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Consensus", + "description": "Average forecast among a representative group of economists." + }, + "previous": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Previous", + "description": "Value for the previous period after the revision (if revision is applicable)." + }, + "revised": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Revised", + "description": "Revised previous value, if applicable." + }, + "actual": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Actual", + "description": "Latest released value." + }, "change": { "anyOf": [ { @@ -26955,7 +30159,7 @@ "title": "Change Percent", "description": "Percentage change since previous." }, - "updated_at": { + "last_updated": { "anyOf": [ { "type": "string", @@ -26965,7 +30169,7 @@ "type": "null" } ], - "title": "Updated At", + "title": "Last Updated", "description": "Last updated timestamp." }, "created_at": { @@ -26984,10 +30188,10 @@ }, "additionalProperties": true, "type": "object", - "title": "FMPEconomicCalendar", + "title": "FMPEconomicCalendarData", "description": "FMP Economics Calendar Data.\n\nSource: https://site.financialmodelingprep.com/developer/docs/economic-calendar-api" }, - "FMPEquityHistorical": { + "FMPEquityHistoricalData": { "properties": { "date": { "anyOf": [ @@ -27098,7 +30302,7 @@ "title": "Change", "description": "Change in the price from the previous close." }, - "change_percent": { + "changeOverTime": { "anyOf": [ { "type": "number" @@ -27107,7 +30311,7 @@ "type": "null" } ], - "title": "Change Percent", + "title": "Changeovertime", "description": "Change in the price from the previous close, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" @@ -27122,10 +30326,10 @@ "low", "close" ], - "title": "FMPEquityHistorical", + "title": "FMPEquityHistoricalData", "description": "FMP Equity Historical Price Data." }, - "FMPEquityOwnership": { + "FMPEquityOwnershipData": { "properties": { "date": { "type": "string", @@ -27369,10 +30573,10 @@ "change_in_performance", "is_counted_for_performance" ], - "title": "FMPEquityOwnership", + "title": "FMPEquityOwnershipData", "description": "FMP Equity Ownership Data." }, - "FMPEquityPeers": { + "FMPEquityPeersData": { "properties": { "peers_list": { "items": { @@ -27385,10 +30589,10 @@ }, "additionalProperties": true, "type": "object", - "title": "FMPEquityPeers", + "title": "FMPEquityPeersData", "description": "FMP Equity Peers Data." }, - "FMPEquityProfile": { + "FMPEquityProfileData": { "properties": { "symbol": { "type": "string", @@ -27888,7 +31092,7 @@ "title": "Currency", "description": "Currency in which the stock is traded." }, - "market_cap": { + "mktCap": { "anyOf": [ { "type": "integer" @@ -27897,10 +31101,10 @@ "type": "null" } ], - "title": "Market Cap", + "title": "Mktcap", "description": "Market capitalization of the company." }, - "last_price": { + "price": { "anyOf": [ { "type": "number" @@ -27909,7 +31113,7 @@ "type": "null" } ], - "title": "Last Price", + "title": "Price", "description": "The last traded price." }, "year_high": { @@ -27936,7 +31140,7 @@ "title": "Year Low", "description": "The one-year low of the price." }, - "volume_avg": { + "volAvg": { "anyOf": [ { "type": "integer" @@ -27945,10 +31149,10 @@ "type": "null" } ], - "title": "Volume Avg", + "title": "Volavg", "description": "Average daily trading volume." }, - "annualized_dividend_amount": { + "lastDiv": { "anyOf": [ { "type": "number" @@ -27957,7 +31161,7 @@ "type": "null" } ], - "title": "Annualized Dividend Amount", + "title": "Lastdiv", "description": "The annualized dividend payment based on the most recent regular dividend payment." }, "beta": { @@ -27982,10 +31186,10 @@ "is_adr", "is_fund" ], - "title": "FMPEquityProfile", + "title": "FMPEquityProfileData", "description": "FMP Equity Profile Data." }, - "FMPEquityQuote": { + "FMPEquityQuoteData": { "properties": { "symbol": { "type": "string", @@ -28406,7 +31610,7 @@ ], "title": "Change Percent", "description": "Change in price as a normalized percentage.", - "x-frontend_multiply": 100 + "x-frontendmultiply": 100 }, "year_high": { "anyOf": [ @@ -28535,10 +31739,10 @@ "required": [ "symbol" ], - "title": "FMPEquityQuote", + "title": "FMPEquityQuoteData", "description": "FMP Equity Quote Data." }, - "FMPEquityScreener": { + "FMPEquityScreenerData": { "properties": { "symbol": { "type": "string", @@ -28550,7 +31754,7 @@ "title": "Name", "description": "Name of the company." }, - "market_cap": { + "marketCap": { "anyOf": [ { "type": "integer" @@ -28559,7 +31763,7 @@ "type": "null" } ], - "title": "Market Cap", + "title": "Marketcap", "description": "The market cap of ticker." }, "sector": { @@ -28610,7 +31814,7 @@ "title": "Price", "description": "The current price." }, - "last_annual_dividend": { + "lastAnnualDividend": { "anyOf": [ { "type": "number" @@ -28619,7 +31823,7 @@ "type": "null" } ], - "title": "Last Annual Dividend", + "title": "Lastannualdividend", "description": "The last annual amount dividend paid." }, "volume": { @@ -28634,6 +31838,18 @@ "title": "Volume", "description": "The current trading volume." }, + "exchangeShortName": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Exchangeshortname", + "description": "The exchange code the asset trades on." + }, "exchange": { "anyOf": [ { @@ -28644,18 +31860,6 @@ } ], "title": "Exchange", - "description": "The exchange code the asset trades on." - }, - "exchange_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Exchange Name", "description": "The full name of the primary exchange." }, "country": { @@ -28670,7 +31874,7 @@ "title": "Country", "description": "The two-letter country abbreviation where the head office is located." }, - "is_etf": { + "isEtf": { "anyOf": [ { "type": "boolean", @@ -28683,10 +31887,10 @@ "type": "null" } ], - "title": "Is Etf", + "title": "Isetf", "description": "Whether the ticker is an ETF." }, - "actively_trading": { + "isActivelyTrading": { "anyOf": [ { "type": "boolean", @@ -28699,7 +31903,7 @@ "type": "null" } ], - "title": "Actively Trading", + "title": "Isactivelytrading", "description": "Whether the ETF is actively trading." } }, @@ -28709,10 +31913,10 @@ "symbol", "name" ], - "title": "FMPEquityScreener", + "title": "FMPEquityScreenerData", "description": "FMP Equity Screener Data." }, - "FMPEquityValuationMultiples": { + "FMPEquityValuationMultiplesData": { "properties": { "symbol": { "type": "string", @@ -29445,10 +32649,10 @@ "required": [ "symbol" ], - "title": "FMPEquityValuationMultiples", + "title": "FMPEquityValuationMultiplesData", "description": "FMP Equity Valuation Multiples Data." }, - "FMPEtfCountries": { + "FMPEtfCountriesData": { "properties": { "country": { "type": "string", @@ -29461,10 +32665,10 @@ "required": [ "country" ], - "title": "FMPEtfCountries", + "title": "FMPEtfCountriesData", "description": "FMP ETF Countries Data." }, - "FMPEtfEquityExposure": { + "FMPEtfEquityExposureData": { "properties": { "equity_symbol": { "type": "string", @@ -29524,10 +32728,10 @@ "equity_symbol", "etf_symbol" ], - "title": "FMPEtfEquityExposure", + "title": "FMPEtfEquityExposureData", "description": "FMP ETF Equity Exposure Data." }, - "FMPEtfHoldings": { + "FMPEtfHoldingsData": { "properties": { "symbol": { "anyOf": [ @@ -29628,7 +32832,7 @@ "title": "Units", "description": "The type of units." }, - "currency": { + "cur_cd": { "anyOf": [ { "type": "string" @@ -29637,10 +32841,10 @@ "type": "null" } ], - "title": "Currency", + "title": "Cur Cd", "description": "The currency of the holding." }, - "value": { + "valUsd": { "anyOf": [ { "type": "number" @@ -29649,10 +32853,10 @@ "type": "null" } ], - "title": "Value", + "title": "Valusd", "description": "The value of the holding, in dollars." }, - "weight": { + "pctVal": { "anyOf": [ { "type": "number" @@ -29661,12 +32865,12 @@ "type": "null" } ], - "title": "Weight", + "title": "Pctval", "description": "The weight of the holding, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "payoff_profile": { + "payoffProfile": { "anyOf": [ { "type": "string" @@ -29675,10 +32879,10 @@ "type": "null" } ], - "title": "Payoff Profile", + "title": "Payoffprofile", "description": "The payoff profile of the holding." }, - "asset_category": { + "assetCat": { "anyOf": [ { "type": "string" @@ -29687,10 +32891,10 @@ "type": "null" } ], - "title": "Asset Category", + "title": "Assetcat", "description": "The asset category of the holding." }, - "issuer_category": { + "issuerCat": { "anyOf": [ { "type": "string" @@ -29699,10 +32903,10 @@ "type": "null" } ], - "title": "Issuer Category", + "title": "Issuercat", "description": "The issuer category of the holding." }, - "country": { + "invCountry": { "anyOf": [ { "type": "string" @@ -29711,10 +32915,10 @@ "type": "null" } ], - "title": "Country", + "title": "Invcountry", "description": "The country of the holding." }, - "is_restricted": { + "isRestrictedSec": { "anyOf": [ { "type": "string" @@ -29723,10 +32927,10 @@ "type": "null" } ], - "title": "Is Restricted", + "title": "Isrestrictedsec", "description": "Whether the holding is restricted." }, - "fair_value_level": { + "fairValLevel": { "anyOf": [ { "type": "integer" @@ -29735,10 +32939,10 @@ "type": "null" } ], - "title": "Fair Value Level", + "title": "Fairvallevel", "description": "The fair value level of the holding." }, - "is_cash_collateral": { + "isCashCollateral": { "anyOf": [ { "type": "string" @@ -29747,10 +32951,10 @@ "type": "null" } ], - "title": "Is Cash Collateral", + "title": "Iscashcollateral", "description": "Whether the holding is cash collateral." }, - "is_non_cash_collateral": { + "isNonCashCollateral": { "anyOf": [ { "type": "string" @@ -29759,10 +32963,10 @@ "type": "null" } ], - "title": "Is Non Cash Collateral", + "title": "Isnoncashcollateral", "description": "Whether the holding is non-cash collateral." }, - "is_loan_by_fund": { + "isLoanByFund": { "anyOf": [ { "type": "string" @@ -29771,7 +32975,7 @@ "type": "null" } ], - "title": "Is Loan By Fund", + "title": "Isloanbyfund", "description": "Whether the holding is loan by fund." }, "cik": { @@ -29786,7 +32990,7 @@ "title": "Cik", "description": "The CIK of the filing." }, - "acceptance_datetime": { + "acceptanceTime": { "anyOf": [ { "type": "string" @@ -29795,7 +32999,7 @@ "type": "null" } ], - "title": "Acceptance Datetime", + "title": "Acceptancetime", "description": "The acceptance datetime of the filing." }, "updated": { @@ -29818,10 +33022,10 @@ }, "additionalProperties": true, "type": "object", - "title": "FMPEtfHoldings", + "title": "FMPEtfHoldingsData", "description": "FMP ETF Holdings Data." }, - "FMPEtfHoldingsDate": { + "FMPEtfHoldingsDateData": { "properties": { "date": { "type": "string", @@ -29835,250 +33039,10 @@ "required": [ "date" ], - "title": "FMPEtfHoldingsDate", + "title": "FMPEtfHoldingsDateData", "description": "FMP ETF Holdings Data." }, - "FMPEtfHoldingsPerformance": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "The ticker symbol." - }, - "one_day": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "One Day", - "description": "One-day return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "wtd": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Wtd", - "description": "Week to date return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "one_week": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "One Week", - "description": "One-week return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "mtd": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Mtd", - "description": "Month to date return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "one_month": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "One Month", - "description": "One-month return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "qtd": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Qtd", - "description": "Quarter to date return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "three_month": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Three Month", - "description": "Three-month return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "six_month": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Six Month", - "description": "Six-month return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "ytd": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Ytd", - "description": "Year to date return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "one_year": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "One Year", - "description": "One-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "two_year": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Two Year", - "description": "Two-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "three_year": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Three Year", - "description": "Three-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "four_year": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Four Year", - "description": "Four-year", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "five_year": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Five Year", - "description": "Five-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "ten_year": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Ten Year", - "description": "Ten-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "max": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Max", - "description": "Return from the beginning of the time series.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "FMPEtfHoldingsPerformance", - "description": "FMP ETF Holdings Performance Data." - }, - "FMPEtfInfo": { + "FMPEtfInfoData": { "properties": { "symbol": { "type": "string", @@ -30121,7 +33085,7 @@ "title": "Inception Date", "description": "Inception date of the ETF." }, - "issuer": { + "etfCompany": { "anyOf": [ { "type": "string" @@ -30130,7 +33094,7 @@ "type": "null" } ], - "title": "Issuer", + "title": "Etfcompany", "description": "Company of the ETF." }, "cusip": { @@ -30275,10 +33239,10 @@ "name", "inception_date" ], - "title": "FMPEtfInfo", + "title": "FMPEtfInfoData", "description": "FMP ETF Info Data." }, - "FMPEtfSearch": { + "FMPEtfSearchData": { "properties": { "symbol": { "type": "string", @@ -30297,7 +33261,7 @@ "title": "Name", "description": "Name of the ETF." }, - "market_cap": { + "marketCap": { "anyOf": [ { "type": "number" @@ -30306,7 +33270,7 @@ "type": "null" } ], - "title": "Market Cap", + "title": "Marketcap", "description": "The market cap of the ETF." }, "sector": { @@ -30357,7 +33321,7 @@ "title": "Price", "description": "The current price of the ETF." }, - "last_annual_dividend": { + "lastAnnualDividend": { "anyOf": [ { "type": "number" @@ -30366,7 +33330,7 @@ "type": "null" } ], - "title": "Last Annual Dividend", + "title": "Lastannualdividend", "description": "The last annual dividend paid." }, "volume": { @@ -30381,6 +33345,18 @@ "title": "Volume", "description": "The current trading volume of the ETF." }, + "exchangeShortName": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Exchangeshortname", + "description": "The exchange code the ETF trades on." + }, "exchange": { "anyOf": [ { @@ -30391,18 +33367,6 @@ } ], "title": "Exchange", - "description": "The exchange code the ETF trades on." - }, - "exchange_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Exchange Name", "description": "The full name of the exchange the ETF trades on." }, "country": { @@ -30417,7 +33381,7 @@ "title": "Country", "description": "The country the ETF is registered in." }, - "actively_trading": { + "isActivelyTrading": { "anyOf": [ { "type": "boolean", @@ -30430,7 +33394,7 @@ "type": "null" } ], - "title": "Actively Trading", + "title": "Isactivelytrading", "description": "Whether the ETF is actively trading." } }, @@ -30439,10 +33403,10 @@ "required": [ "symbol" ], - "title": "FMPEtfSearch", + "title": "FMPEtfSearchData", "description": "FMP ETF Search Data." }, - "FMPEtfSectors": { + "FMPEtfSectorsData": { "properties": { "sector": { "type": "string", @@ -30468,10 +33432,10 @@ "sector", "weight" ], - "title": "FMPEtfSectors", + "title": "FMPEtfSectorsData", "description": "FMP ETF Sectors Data." }, - "FMPExecutiveCompensation": { + "FMPExecutiveCompensationData": { "properties": { "symbol": { "type": "string", @@ -30660,10 +33624,10 @@ "required": [ "symbol" ], - "title": "FMPExecutiveCompensation", + "title": "FMPExecutiveCompensationData", "description": "FMP Executive Compensation Data." }, - "FMPFinancialRatios": { + "FMPFinancialRatiosData": { "properties": { "period_ending": { "type": "string", @@ -30805,7 +33769,9 @@ } ], "title": "Gross Profit Margin", - "description": "Gross profit margin." + "description": "Gross profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "operating_profit_margin": { "anyOf": [ @@ -30817,7 +33783,9 @@ } ], "title": "Operating Profit Margin", - "description": "Operating profit margin." + "description": "Operating profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "pretax_profit_margin": { "anyOf": [ @@ -30829,7 +33797,9 @@ } ], "title": "Pretax Profit Margin", - "description": "Pretax profit margin." + "description": "Pretax profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "net_profit_margin": { "anyOf": [ @@ -30841,7 +33811,9 @@ } ], "title": "Net Profit Margin", - "description": "Net profit margin." + "description": "Net profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "effective_tax_rate": { "anyOf": [ @@ -30853,7 +33825,9 @@ } ], "title": "Effective Tax Rate", - "description": "Effective tax rate." + "description": "Effective tax rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "return_on_assets": { "anyOf": [ @@ -30865,7 +33839,9 @@ } ], "title": "Return On Assets", - "description": "Return on assets." + "description": "Return on assets.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "return_on_equity": { "anyOf": [ @@ -30877,7 +33853,9 @@ } ], "title": "Return On Equity", - "description": "Return on equity." + "description": "Return on equity.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "return_on_capital_employed": { "anyOf": [ @@ -30889,7 +33867,9 @@ } ], "title": "Return On Capital Employed", - "description": "Return on capital employed." + "description": "Return on capital employed.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "net_income_per_ebt": { "anyOf": [ @@ -30975,7 +33955,7 @@ "title": "Total Debt To Capitalization", "description": "Total debt to capitalization." }, - "interest_coverage": { + "interest_coverage_ratio": { "anyOf": [ { "type": "number" @@ -30984,10 +33964,10 @@ "type": "null" } ], - "title": "Interest Coverage", + "title": "Interest Coverage Ratio", "description": "Interest coverage." }, - "cash_flow_to_debt_ratio": { + "cash_flow_to_debt": { "anyOf": [ { "type": "number" @@ -30996,7 +33976,7 @@ "type": "null" } ], - "title": "Cash Flow To Debt Ratio", + "title": "Cash Flow To Debt", "description": "Cash flow to debt ratio." }, "company_equity_multiplier": { @@ -31143,7 +34123,7 @@ "title": "Free Cash Flow Operating Cash Flow Ratio", "description": "Free cash flow operating cash flow ratio." }, - "cash_flow_coverage_ratios": { + "cash_flow_coverage_ratio": { "anyOf": [ { "type": "number" @@ -31152,10 +34132,10 @@ "type": "null" } ], - "title": "Cash Flow Coverage Ratios", - "description": "Cash flow coverage ratios." + "title": "Cash Flow Coverage Ratio", + "description": "Cash flow coverage ratio." }, - "short_term_coverage_ratios": { + "short_term_coverage_ratio": { "anyOf": [ { "type": "number" @@ -31164,8 +34144,8 @@ "type": "null" } ], - "title": "Short Term Coverage Ratios", - "description": "Short term coverage ratios." + "title": "Short Term Coverage Ratio", + "description": "Short term coverage ratio." }, "capital_expenditure_coverage_ratio": { "anyOf": [ @@ -31179,30 +34159,6 @@ "title": "Capital Expenditure Coverage Ratio", "description": "Capital expenditure coverage ratio." }, - "dividend_paid_and_capex_coverage_ratio": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Dividend Paid And Capex Coverage Ratio", - "description": "Dividend paid and capex coverage ratio." - }, - "dividend_payout_ratio": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Dividend Payout Ratio", - "description": "Dividend payout ratio." - }, "price_book_value_ratio": { "anyOf": [ { @@ -31311,6 +34267,30 @@ "title": "Price Sales Ratio", "description": "Price sales ratio." }, + "dividend_paid_and_capex_coverage_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dividend Paid And Capex Coverage Ratio", + "description": "Dividend paid and capex coverage ratio." + }, + "dividend_payout_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dividend Payout Ratio", + "description": "Dividend payout ratio." + }, "dividend_yield": { "anyOf": [ { @@ -31321,19 +34301,9 @@ } ], "title": "Dividend Yield", - "description": "Dividend yield." - }, - "dividend_yield_percentage": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Dividend Yield Percentage", - "description": "Dividend yield percentage." + "description": "Dividend yield.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "dividend_per_share": { "anyOf": [ @@ -31378,10 +34348,342 @@ "period_ending", "fiscal_period" ], - "title": "FMPFinancialRatios", + "title": "FMPFinancialRatiosData", "description": "FMP Financial Ratios Data." }, - "FMPHistoricalDividends": { + "FMPForwardEbitdaEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the entity." + }, + "last_updated": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Last Updated", + "description": "The date of the last update." + }, + "period_ending": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Period Ending", + "description": "The end date of the reporting period." + }, + "fiscal_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fiscal Year", + "description": "Fiscal year for the estimate." + }, + "fiscal_period": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Fiscal Period", + "description": "Fiscal quarter for the estimate." + }, + "calendar_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Calendar Year", + "description": "Calendar year for the estimate." + }, + "calendar_period": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Calendar Period", + "description": "Calendar quarter for the estimate." + }, + "low_estimate": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Low Estimate", + "description": "The EBITDA estimate low for the period." + }, + "high_estimate": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "High Estimate", + "description": "The EBITDA estimate high for the period." + }, + "mean": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Mean", + "description": "The EBITDA estimate mean for the period." + }, + "median": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Median", + "description": "The EBITDA estimate median for the period." + }, + "standard_deviation": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Standard Deviation", + "description": "The EBITDA estimate standard deviation for the period." + }, + "number_of_analysts": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Of Analysts", + "description": "Number of analysts providing estimates for the period." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "FMPForwardEbitdaEstimatesData", + "description": "FMP Forward EBITDA Data." + }, + "FMPForwardEpsEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the entity." + }, + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "fiscal_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fiscal Year", + "description": "Fiscal year for the estimate." + }, + "fiscal_period": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Fiscal Period", + "description": "Fiscal quarter for the estimate." + }, + "calendar_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Calendar Year", + "description": "Calendar year for the estimate." + }, + "calendar_period": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Calendar Period", + "description": "Calendar quarter for the estimate." + }, + "low_estimate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Low Estimate", + "description": "Estimated EPS low for the period." + }, + "high_estimate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "High Estimate", + "description": "Estimated EPS high for the period." + }, + "mean": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Mean", + "description": "Estimated EPS mean for the period." + }, + "median": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Median", + "description": "Estimated EPS median for the period." + }, + "standard_deviation": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Standard Deviation", + "description": "Estimated EPS standard deviation for the period." + }, + "number_of_analysts": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Of Analysts", + "description": "Number of analysts providing estimates for the period." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "date" + ], + "title": "FMPForwardEpsEstimatesData", + "description": "FMP Forward EPS Data." + }, + "FMPHistoricalDividendsData": { "properties": { "ex_dividend_date": { "type": "string", @@ -31452,10 +34754,10 @@ "label", "adj_dividend" ], - "title": "FMPHistoricalDividends", + "title": "FMPHistoricalDividendsData", "description": "FMP Historical Dividends Data." }, - "FMPHistoricalEmployees": { + "FMPHistoricalEmployeesData": { "properties": { "symbol": { "type": "string", @@ -31519,10 +34821,10 @@ "employee_count", "source" ], - "title": "FMPHistoricalEmployees", + "title": "FMPHistoricalEmployeesData", "description": "FMP Historical Employees Data." }, - "FMPHistoricalEps": { + "FMPHistoricalEpsData": { "properties": { "date": { "type": "string", @@ -31571,7 +34873,7 @@ "title": "Eps Estimated", "description": "Estimated EPS for the earnings date." }, - "revenue_estimated": { + "revenueEstimated": { "anyOf": [ { "type": "number" @@ -31580,10 +34882,10 @@ "type": "null" } ], - "title": "Revenue Estimated", + "title": "Revenueestimated", "description": "Estimated consensus revenue for the reporting period." }, - "revenue_actual": { + "revenue": { "anyOf": [ { "type": "number" @@ -31592,10 +34894,10 @@ "type": "null" } ], - "title": "Revenue Actual", + "title": "Revenue", "description": "The actual reported revenue." }, - "reporting_time": { + "time": { "anyOf": [ { "type": "string" @@ -31604,10 +34906,10 @@ "type": "null" } ], - "title": "Reporting Time", + "title": "Time", "description": "The reporting time - e.g. after market close." }, - "updated_at": { + "updatedFromDate": { "anyOf": [ { "type": "string", @@ -31617,10 +34919,10 @@ "type": "null" } ], - "title": "Updated At", + "title": "Updatedfromdate", "description": "The date when the data was last updated." }, - "period_ending": { + "fiscalDateEnding": { "anyOf": [ { "type": "string", @@ -31630,7 +34932,7 @@ "type": "null" } ], - "title": "Period Ending", + "title": "Fiscaldateending", "description": "The fiscal period end date." } }, @@ -31639,10 +34941,10 @@ "required": [ "symbol" ], - "title": "FMPHistoricalEps", + "title": "FMPHistoricalEpsData", "description": "FMP Historical EPS Data." }, - "FMPHistoricalSplits": { + "FMPHistoricalSplitsData": { "properties": { "date": { "type": "string", @@ -31692,10 +34994,10 @@ "required": [ "date" ], - "title": "FMPHistoricalSplits", + "title": "FMPHistoricalSplitsData", "description": "FMP Historical Splits Data." }, - "FMPIncomeStatement": { + "FMPIncomeStatementData": { "properties": { "period_ending": { "type": "string", @@ -32131,10 +35433,10 @@ "required": [ "period_ending" ], - "title": "FMPIncomeStatement", + "title": "FMPIncomeStatementData", "description": "FMP Income Statement Data." }, - "FMPIncomeStatementGrowth": { + "FMPIncomeStatementGrowthData": { "properties": { "symbol": { "anyOf": [ @@ -32322,10 +35624,10 @@ "growth_weighted_average_shs_out", "growth_weighted_average_shs_out_dil" ], - "title": "FMPIncomeStatementGrowth", + "title": "FMPIncomeStatementGrowthData", "description": "FMP Income Statement Growth Data." }, - "FMPIndexConstituents": { + "FMPIndexConstituentsData": { "properties": { "symbol": { "type": "string", @@ -32424,10 +35726,10 @@ "symbol", "sector" ], - "title": "FMPIndexConstituents", + "title": "FMPIndexConstituentsData", "description": "FMP Index Constituents Data." }, - "FMPIndexHistorical": { + "FMPIndexHistoricalData": { "properties": { "date": { "anyOf": [ @@ -32527,7 +35829,7 @@ "title": "Change", "description": "Change in the price from the previous close." }, - "change_percent": { + "changeOverTime": { "anyOf": [ { "type": "number" @@ -32536,7 +35838,7 @@ "type": "null" } ], - "title": "Change Percent", + "title": "Changeovertime", "description": "Change in the price from the previous close, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" @@ -32547,10 +35849,10 @@ "required": [ "date" ], - "title": "FMPIndexHistorical", + "title": "FMPIndexHistoricalData", "description": "FMP Index Historical Data." }, - "FMPInsiderTrading": { + "FMPInsiderTradingData": { "properties": { "symbol": { "anyOf": [ @@ -32743,10 +36045,10 @@ "required": [ "form_type" ], - "title": "FMPInsiderTrading", + "title": "FMPInsiderTradingData", "description": "FMP Insider Trading Data." }, - "FMPInstitutionalOwnership": { + "FMPInstitutionalOwnershipData": { "properties": { "symbol": { "type": "string", @@ -32786,19 +36088,19 @@ "title": "Investors Holding Change", "description": "Change in the number of investors holding the stock." }, - "number_of_13f_shares": { + "numberOf13Fshares": { "type": "integer", - "title": "Number Of 13F Shares", + "title": "Numberof13Fshares", "description": "Number of 13F shares." }, - "last_number_of_13f_shares": { + "lastNumberOf13Fshares": { "type": "integer", - "title": "Last Number Of 13F Shares", + "title": "Lastnumberof13Fshares", "description": "Number of 13F shares in the last quarter." }, - "number_of_13f_shares_change": { + "numberOf13FsharesChange": { "type": "integer", - "title": "Number Of 13F Shares Change", + "title": "Numberof13Fshareschange", "description": "Change in the number of 13F shares." }, "total_invested": { @@ -32973,10 +36275,10 @@ "last_put_call_ratio", "put_call_ratio_change" ], - "title": "FMPInstitutionalOwnership", + "title": "FMPInstitutionalOwnershipData", "description": "FMP Institutional Ownership Data." }, - "FMPKeyExecutives": { + "FMPKeyExecutivesData": { "properties": { "title": { "type": "string", @@ -33055,10 +36357,10 @@ "title", "name" ], - "title": "FMPKeyExecutives", + "title": "FMPKeyExecutivesData", "description": "FMP Key Executives Data." }, - "FMPKeyMetrics": { + "FMPKeyMetricsData": { "properties": { "symbol": { "anyOf": [ @@ -33096,18 +36398,18 @@ "title": "Pe Ratio", "description": "Price-to-earnings ratio (P/E ratio)" }, - "date": { + "period_ending": { "type": "string", "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Period Ending", + "description": "Period ending date." }, - "period": { + "fiscal_period": { "type": "string", - "title": "Period", + "title": "Fiscal Period", "description": "Period of the data." }, - "calendar_year": { + "fiscal_year": { "anyOf": [ { "type": "integer" @@ -33116,8 +36418,8 @@ "type": "null" } ], - "title": "Calendar Year", - "description": "Calendar year." + "title": "Fiscal Year", + "description": "Calendar year for the fiscal period." }, "revenue_per_share": { "anyOf": [ @@ -33131,6 +36433,18 @@ "title": "Revenue Per Share", "description": "Revenue per share" }, + "capex_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capex Per Share", + "description": "Capital expenditures per share" + }, "net_income_per_share": { "anyOf": [ { @@ -33227,7 +36541,7 @@ "title": "Interest Debt Per Share", "description": "Interest debt per share" }, - "enterprise_value": { + "price_to_sales": { "anyOf": [ { "type": "number" @@ -33236,22 +36550,10 @@ "type": "null" } ], - "title": "Enterprise Value", - "description": "Enterprise value" - }, - "price_to_sales_ratio": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Price To Sales Ratio", + "title": "Price To Sales", "description": "Price-to-sales ratio" }, - "pocf_ratio": { + "price_to_operating_cash_flow": { "anyOf": [ { "type": "number" @@ -33260,10 +36562,10 @@ "type": "null" } ], - "title": "Pocf Ratio", + "title": "Price To Operating Cash Flow", "description": "Price-to-operating cash flow ratio" }, - "pfcf_ratio": { + "price_to_free_cash_flow": { "anyOf": [ { "type": "number" @@ -33272,10 +36574,10 @@ "type": "null" } ], - "title": "Pfcf Ratio", + "title": "Price To Free Cash Flow", "description": "Price-to-free cash flow ratio" }, - "pb_ratio": { + "price_to_book": { "anyOf": [ { "type": "number" @@ -33284,10 +36586,10 @@ "type": "null" } ], - "title": "Pb Ratio", + "title": "Price To Book", "description": "Price-to-book ratio" }, - "ptb_ratio": { + "price_to_tangible_book": { "anyOf": [ { "type": "number" @@ -33296,7 +36598,7 @@ "type": "null" } ], - "title": "Ptb Ratio", + "title": "Price To Tangible Book", "description": "Price-to-tangible book ratio" }, "ev_to_sales": { @@ -33311,7 +36613,7 @@ "title": "Ev To Sales", "description": "Enterprise value-to-sales ratio" }, - "enterprise_value_over_ebitda": { + "ev_to_ebitda": { "anyOf": [ { "type": "number" @@ -33320,7 +36622,7 @@ "type": "null" } ], - "title": "Enterprise Value Over Ebitda", + "title": "Ev To Ebitda", "description": "Enterprise value-to-EBITDA ratio" }, "ev_to_operating_cash_flow": { @@ -33357,7 +36659,9 @@ } ], "title": "Earnings Yield", - "description": "Earnings yield" + "description": "Earnings yield", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "free_cash_flow_yield": { "anyOf": [ @@ -33369,7 +36673,21 @@ } ], "title": "Free Cash Flow Yield", - "description": "Free cash flow yield" + "description": "Free cash flow yield", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "debt_to_market_cap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debt To Market Cap", + "description": "Debt-to-market capitalization ratio" }, "debt_to_equity": { "anyOf": [ @@ -33443,20 +36761,6 @@ "title": "Income Quality", "description": "Income quality" }, - "dividend_yield": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Dividend Yield", - "description": "Dividend yield, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, "payout_ratio": { "anyOf": [ { @@ -33553,54 +36857,6 @@ "title": "Stock Based Compensation To Revenue", "description": "Stock-based compensation-to-revenue ratio" }, - "graham_number": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Graham Number", - "description": "Graham number" - }, - "roic": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Roic", - "description": "Return on invested capital" - }, - "return_on_tangible_assets": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Return On Tangible Assets", - "description": "Return on tangible assets" - }, - "graham_net_net": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Graham Net Net", - "description": "Graham net-net working capital" - }, "working_capital": { "anyOf": [ { @@ -33637,6 +36893,18 @@ "title": "Net Current Asset Value", "description": "Net current asset value" }, + "enterprise_value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Enterprise Value", + "description": "Enterprise value" + }, "invested_capital": { "anyOf": [ { @@ -33757,7 +37025,7 @@ "title": "Inventory Turnover", "description": "Inventory turnover" }, - "roe": { + "return_on_equity": { "anyOf": [ { "type": "number" @@ -33766,10 +37034,12 @@ "type": "null" } ], - "title": "Roe", - "description": "Return on equity" + "title": "Return On Equity", + "description": "Return on equity", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "capex_per_share": { + "return_on_invested_capital": { "anyOf": [ { "type": "number" @@ -33778,20 +37048,74 @@ "type": "null" } ], - "title": "Capex Per Share", - "description": "Capital expenditures per share" + "title": "Return On Invested Capital", + "description": "Return on invested capital", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "return_on_tangible_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Return On Tangible Assets", + "description": "Return on tangible assets", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "dividend_yield": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dividend Yield", + "description": "Dividend yield, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "graham_number": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Graham Number", + "description": "Graham number" + }, + "graham_net_net": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Graham Net Net", + "description": "Graham net-net working capital" } }, "additionalProperties": true, "type": "object", "required": [ - "date", - "period" + "period_ending", + "fiscal_period" ], - "title": "FMPKeyMetrics", + "title": "FMPKeyMetricsData", "description": "FMP Key Metrics Data." }, - "FMPMarketSnapshots": { + "FMPMarketSnapshotsData": { "properties": { "symbol": { "type": "string", @@ -33925,7 +37249,7 @@ "title": "Last Price Timestamp", "description": "The timestamp of the last price." }, - "ma50": { + "priceAvg50": { "anyOf": [ { "type": "number" @@ -33934,10 +37258,10 @@ "type": "null" } ], - "title": "Ma50", + "title": "Priceavg50", "description": "The 50-day moving average." }, - "ma200": { + "priceAvg200": { "anyOf": [ { "type": "number" @@ -33946,10 +37270,10 @@ "type": "null" } ], - "title": "Ma200", + "title": "Priceavg200", "description": "The 200-day moving average." }, - "year_high": { + "yearHigh": { "anyOf": [ { "type": "number" @@ -33958,10 +37282,10 @@ "type": "null" } ], - "title": "Year High", + "title": "Yearhigh", "description": "The 52-week high." }, - "year_low": { + "yearLow": { "anyOf": [ { "type": "number" @@ -33970,7 +37294,7 @@ "type": "null" } ], - "title": "Year Low", + "title": "Yearlow", "description": "The 52-week low." }, "volume_avg": { @@ -33985,7 +37309,7 @@ "title": "Volume Avg", "description": "Average daily trading volume." }, - "market_cap": { + "marketCap": { "anyOf": [ { "type": "integer" @@ -33994,7 +37318,7 @@ "type": "null" } ], - "title": "Market Cap", + "title": "Marketcap", "description": "Market cap of the stock." }, "eps": { @@ -34057,7 +37381,7 @@ "title": "Exchange", "description": "The exchange of the stock." }, - "earnings_date": { + "earningsAnnouncement": { "anyOf": [ { "type": "string", @@ -34071,7 +37395,7 @@ "type": "null" } ], - "title": "Earnings Date", + "title": "Earningsannouncement", "description": "The upcoming earnings announcement date." } }, @@ -34080,10 +37404,10 @@ "required": [ "symbol" ], - "title": "FMPMarketSnapshots", + "title": "FMPMarketSnapshotsData", "description": "FMP Market Snapshots Data." }, - "FMPPricePerformance": { + "FMPPricePerformanceData": { "properties": { "symbol": { "type": "string", @@ -34320,10 +37644,86 @@ "required": [ "symbol" ], - "title": "FMPPricePerformance", + "title": "FMPPricePerformanceData", "description": "FMP Price Performance Data." }, - "FMPPriceTarget": { + "FMPPriceTargetConsensusData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "The company name" + }, + "target_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Target High", + "description": "High target of the price target consensus." + }, + "target_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Target Low", + "description": "Low target of the price target consensus." + }, + "target_consensus": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Target Consensus", + "description": "Consensus target of the price target consensus." + }, + "target_median": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Target Median", + "description": "Median target of the price target consensus." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "FMPPriceTargetConsensusData", + "description": "FMP Price Target Consensus Data." + }, + "FMPPriceTargetData": { "properties": { "published_date": { "anyOf": [ @@ -34568,74 +37968,10 @@ "published_date", "symbol" ], - "title": "FMPPriceTarget", + "title": "FMPPriceTargetData", "description": "FMP Price Target Data." }, - "FMPPriceTargetConsensus": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "target_high": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Target High", - "description": "High target of the price target consensus." - }, - "target_low": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Target Low", - "description": "Low target of the price target consensus." - }, - "target_consensus": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Target Consensus", - "description": "Consensus target of the price target consensus." - }, - "target_median": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Target Median", - "description": "Median target of the price target consensus." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "FMPPriceTargetConsensus", - "description": "FMP Price Target Consensus Data." - }, - "FMPRevenueBusinessLine": { + "FMPRevenueBusinessLineData": { "properties": { "period_ending": { "type": "string", @@ -34695,10 +38031,10 @@ "period_ending", "business_line" ], - "title": "FMPRevenueBusinessLine", + "title": "FMPRevenueBusinessLineData", "description": "FMP Revenue by Business Line Data." }, - "FMPRevenueGeographic": { + "FMPRevenueGeographicData": { "properties": { "period_ending": { "type": "string", @@ -34758,10 +38094,10 @@ "period_ending", "geographic_segment" ], - "title": "FMPRevenueGeographic", + "title": "FMPRevenueGeographicData", "description": "FMP Revenue Geographic Data." }, - "FMPRiskPremium": { + "FMPRiskPremiumData": { "properties": { "country": { "type": "string", @@ -34812,10 +38148,10 @@ "required": [ "country" ], - "title": "FMPRiskPremium", + "title": "FMPRiskPremiumData", "description": "FMP Risk Premium Data." }, - "FMPShareStatistics": { + "FMPShareStatisticsData": { "properties": { "symbol": { "type": "string", @@ -34889,7 +38225,7 @@ "required": [ "symbol" ], - "title": "FMPShareStatistics", + "title": "FMPShareStatisticsData", "description": "FMP Share Statistics Data." }, "FMPTicker": { @@ -34905,6 +38241,17 @@ ], "title": "Symbol" }, + "ticker": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Ticker" + }, "name": { "anyOf": [ { @@ -34927,6 +38274,17 @@ ], "title": "Exchange" }, + "exchange_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Exchange Name" + }, "currency": { "anyOf": [ { @@ -34938,6 +38296,17 @@ ], "title": "Currency" }, + "market_cap_range": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Market Cap Range" + }, "industry": { "anyOf": [ { @@ -35049,7 +38418,7 @@ "title": "FMPTickerResponse", "description": "FMP Ticker Response." }, - "FMPTreasuryRates": { + "FMPTreasuryRatesData": { "properties": { "date": { "type": "string", @@ -35245,10 +38614,10 @@ "required": [ "date" ], - "title": "FMPTreasuryRates", + "title": "FMPTreasuryRatesData", "description": "FMP Treasury Rates Data." }, - "FMPWorldNews": { + "FMPWorldNewsData": { "properties": { "date": { "type": "string", @@ -35316,10 +38685,47 @@ "title", "site" ], - "title": "FMPWorldNews", + "title": "FMPWorldNewsData", "description": "FMP World News Data." }, - "FREDAMERIBOR": { + "FMPYieldCurveData": { + "properties": { + "date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Date", + "description": "The date of the data." + }, + "maturity": { + "type": "string", + "title": "Maturity", + "description": "Maturity length of the security." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "The yield as a normalized percent (0.05 is 5%)", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "FMPYieldCurveData", + "description": "FMP Yield Curve Data." + }, + "FREDAMERIBORData": { "properties": { "date": { "type": "string", @@ -35346,10 +38752,10 @@ "date", "rate" ], - "title": "FREDAMERIBOR", + "title": "FREDAMERIBORData", "description": "FRED AMERIBOR Data." }, - "FREDCommercialPaper": { + "FREDCommercialPaperData": { "properties": { "date": { "type": "string", @@ -35376,10 +38782,10 @@ "date", "rate" ], - "title": "FREDCommercialPaper", + "title": "FREDCommercialPaperData", "description": "FRED Commercial Paper Data." }, - "FREDConsumerPriceIndex": { + "FREDConsumerPriceIndexData": { "properties": { "date": { "type": "string", @@ -35393,10 +38799,10 @@ "required": [ "date" ], - "title": "FREDConsumerPriceIndex", + "title": "FREDConsumerPriceIndexData", "description": "FRED Consumer Price Index Data." }, - "FREDDiscountWindowPrimaryCreditRate": { + "FREDDiscountWindowPrimaryCreditRateData": { "properties": { "date": { "type": "string", @@ -35423,10 +38829,10 @@ "date", "rate" ], - "title": "FREDDiscountWindowPrimaryCreditRate", + "title": "FREDDiscountWindowPrimaryCreditRateData", "description": "FRED Discount Window Primary Credit Rate Data." }, - "FREDESTR": { + "FREDESTRData": { "properties": { "date": { "type": "string", @@ -35453,10 +38859,10 @@ "date", "rate" ], - "title": "FREDESTR", + "title": "FREDESTRData", "description": "FRED ESTR Data." }, - "FREDEuropeanCentralBankInterestRates": { + "FREDEuropeanCentralBankInterestRatesData": { "properties": { "date": { "type": "string", @@ -35483,10 +38889,10 @@ "date", "rate" ], - "title": "FREDEuropeanCentralBankInterestRates", + "title": "FREDEuropeanCentralBankInterestRatesData", "description": "FRED European Central Bank Interest Rates Data." }, - "FREDFED": { + "FREDFEDData": { "properties": { "date": { "type": "string", @@ -35513,10 +38919,10 @@ "date", "rate" ], - "title": "FREDFED", + "title": "FREDFEDData", "description": "FRED FED Data." }, - "FREDHighQualityMarketCorporateBond": { + "FREDHighQualityMarketCorporateBondData": { "properties": { "date": { "type": "string", @@ -35565,10 +38971,10 @@ "yield_curve", "series_id" ], - "title": "FREDHighQualityMarketCorporateBond", + "title": "FREDHighQualityMarketCorporateBondData", "description": "FRED High Quality Market Corporate Bond Data." }, - "FREDICEBofA": { + "FREDICEBofAData": { "properties": { "date": { "type": "string", @@ -35595,10 +39001,10 @@ "date", "rate" ], - "title": "FREDICEBofA", + "title": "FREDICEBofAData", "description": "FRED ICE BofA US Corporate Bond Indices Data." }, - "FREDIORB": { + "FREDIORBData": { "properties": { "date": { "type": "string", @@ -35625,10 +39031,10 @@ "date", "rate" ], - "title": "FREDIORB", + "title": "FREDIORBData", "description": "FRED IORB Data." }, - "FREDMoodyCorporateBondIndex": { + "FREDMoodyCorporateBondIndexData": { "properties": { "date": { "type": "string", @@ -35655,10 +39061,10 @@ "date", "rate" ], - "title": "FREDMoodyCorporateBondIndex", + "title": "FREDMoodyCorporateBondIndexData", "description": "FRED Moody Corporate Bond Index Data." }, - "FREDPROJECTION": { + "FREDPROJECTIONData": { "properties": { "date": { "type": "string", @@ -35763,10 +39169,10 @@ "range_low", "central_tendency_low" ], - "title": "FREDPROJECTION", + "title": "FREDPROJECTIONData", "description": "FRED PROJECTION Data." }, - "FREDSOFR": { + "FREDSOFRData": { "properties": { "date": { "type": "string", @@ -35793,10 +39199,10 @@ "date", "rate" ], - "title": "FREDSOFR", + "title": "FREDSOFRData", "description": "FRED SOFR Data." }, - "FREDSONIA": { + "FREDSONIAData": { "properties": { "date": { "type": "string", @@ -35823,10 +39229,10 @@ "date", "rate" ], - "title": "FREDSONIA", + "title": "FREDSONIAData", "description": "FRED SONIA Data." }, - "FREDSelectedTreasuryBill": { + "FREDSelectedTreasuryBillData": { "properties": { "date": { "type": "string", @@ -35853,10 +39259,10 @@ "date", "rate" ], - "title": "FREDSelectedTreasuryBill", + "title": "FREDSelectedTreasuryBillData", "description": "FRED Selected Treasury Bill Data." }, - "FREDSelectedTreasuryConstantMaturity": { + "FREDSelectedTreasuryConstantMaturityData": { "properties": { "date": { "type": "string", @@ -35883,10 +39289,10 @@ "date", "rate" ], - "title": "FREDSelectedTreasuryConstantMaturity", + "title": "FREDSelectedTreasuryConstantMaturityData", "description": "FRED Selected Treasury Constant Maturity Data." }, - "FREDSpotRate": { + "FREDSpotRateData": { "properties": { "date": { "type": "string", @@ -35913,10 +39319,10 @@ "date", "rate" ], - "title": "FREDSpotRate", + "title": "FREDSpotRateData", "description": "FRED Spot Rate Data." }, - "FREDTreasuryConstantMaturity": { + "FREDTreasuryConstantMaturityData": { "properties": { "date": { "type": "string", @@ -35943,32 +39349,10 @@ "date", "rate" ], - "title": "FREDTreasuryConstantMaturity", + "title": "FREDTreasuryConstantMaturityData", "description": "FRED Treasury Constant Maturity Data." }, - "FREDYieldCurve": { - "properties": { - "maturity": { - "type": "number", - "title": "Maturity", - "description": "Maturity of the treasury rate in years." - }, - "rate": { - "type": "number", - "title": "Rate", - "description": "Associated rate given in decimal form (0.05 is 5%)" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "maturity", - "rate" - ], - "title": "FREDYieldCurve", - "description": "FRED US Yield Curve Data." - }, - "FederalReserveFED": { + "FederalReserveFEDData": { "properties": { "date": { "type": "string", @@ -35995,10 +39379,10 @@ "date", "rate" ], - "title": "FederalReserveFED", + "title": "FederalReserveFEDData", "description": "FederalReserve FED Data." }, - "FederalReserveMoneyMeasures": { + "FederalReserveMoneyMeasuresData": { "properties": { "month": { "type": "string", @@ -36084,10 +39468,10 @@ "m1", "m2" ], - "title": "FederalReserveMoneyMeasures", + "title": "FederalReserveMoneyMeasuresData", "description": "FederalReserve Money Measures Data." }, - "FederalReserveTreasuryRates": { + "FederalReserveTreasuryRatesData": { "properties": { "date": { "type": "string", @@ -36283,9 +39667,323 @@ "required": [ "date" ], - "title": "FederalReserveTreasuryRates", + "title": "FederalReserveTreasuryRatesData", "description": "FederalReserve Treasury Rates Data." }, + "FederalReserveYieldCurveData": { + "properties": { + "date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Date", + "description": "The date of the data." + }, + "maturity": { + "type": "string", + "title": "Maturity", + "description": "Maturity length of the security." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "The yield as a normalized percent (0.05 is 5%)", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "FederalReserveYieldCurveData", + "description": "FederalReserve Yield Curve Data." + }, + "FilterTypes": { + "type": "string", + "enum": [ + "stock", + "etf", + "index", + "indices", + "economic", + "all" + ], + "title": "FilterTypes", + "description": "Filter Types." + }, + "FredBalanceOfPaymentsData": { + "properties": { + "period": { + "type": "string", + "format": "date", + "title": "Period", + "description": "The date representing the beginning of the reporting period." + }, + "balance_percent_of_gdp": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Balance Percent Of Gdp", + "description": "Current Account Balance as Percent of GDP", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "balance_total": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Balance Total", + "description": "Current Account Total Balance (USD)" + }, + "balance_total_services": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Balance Total Services", + "description": "Current Account Total Services Balance (USD)" + }, + "balance_total_secondary_income": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Balance Total Secondary Income", + "description": "Current Account Total Secondary Income Balance (USD)" + }, + "balance_total_goods": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Balance Total Goods", + "description": "Current Account Total Goods Balance (USD)" + }, + "balance_total_primary_income": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Balance Total Primary Income", + "description": "Current Account Total Primary Income Balance (USD)" + }, + "credits_services_percent_of_goods_and_services": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Credits Services Percent Of Goods And Services", + "description": "Current Account Credits Services as Percent of Goods and Services", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "credits_services_percent_of_current_account": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Credits Services Percent Of Current Account", + "description": "Current Account Credits Services as Percent of Current Account", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "credits_total_services": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Credits Total Services", + "description": "Current Account Credits Total Services (USD)" + }, + "credits_total_goods": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Credits Total Goods", + "description": "Current Account Credits Total Goods (USD)" + }, + "credits_total_primary_income": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Credits Total Primary Income", + "description": "Current Account Credits Total Primary Income (USD)" + }, + "credits_total_secondary_income": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Credits Total Secondary Income", + "description": "Current Account Credits Total Secondary Income (USD)" + }, + "credits_total": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Credits Total", + "description": "Current Account Credits Total (USD)" + }, + "debits_services_percent_of_goods_and_services": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debits Services Percent Of Goods And Services", + "description": "Current Account Debits Services as Percent of Goods and Services", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "debits_services_percent_of_current_account": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debits Services Percent Of Current Account", + "description": "Current Account Debits Services as Percent of Current Account", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "debits_total_services": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debits Total Services", + "description": "Current Account Debits Total Services (USD)" + }, + "debits_total_goods": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debits Total Goods", + "description": "Current Account Debits Total Goods (USD)" + }, + "debits_total_primary_income": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debits Total Primary Income", + "description": "Current Account Debits Total Primary Income (USD)" + }, + "debits_total": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debits Total", + "description": "Current Account Debits Total (USD)" + }, + "debits_total_secondary_income": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debits Total Secondary Income", + "description": "Current Account Debits Total Secondary Income (USD)" + } + }, + "additionalProperties": true, + "type": "object", + "title": "FredBalanceOfPaymentsData", + "description": "FRED Balance Of Payments Data." + }, "FredIndex": { "properties": { "symbol": { @@ -36403,7 +40101,7 @@ "title": "FredIndex", "description": "Fred Index Model." }, - "FredRegional": { + "FredRegionalData": { "properties": { "date": { "type": "string", @@ -36431,10 +40129,10 @@ "value": { "anyOf": [ { - "type": "number" + "type": "integer" }, { - "type": "integer" + "type": "number" }, { "type": "null" @@ -36457,18 +40155,18 @@ "code", "series_id" ], - "title": "FredRegional", + "title": "FredRegionalData", "description": "FRED Regional Data." }, - "FredSearch": { + "FredSearchData": { "properties": { "release_id": { "anyOf": [ { - "type": "integer" + "type": "string" }, { - "type": "string" + "type": "integer" }, { "type": "null" @@ -36699,10 +40397,10 @@ "series_group": { "anyOf": [ { - "type": "integer" + "type": "string" }, { - "type": "string" + "type": "integer" }, { "type": "null" @@ -36714,10 +40412,10 @@ }, "additionalProperties": true, "type": "object", - "title": "FredSearch", + "title": "FredSearchData", "description": "FRED Search Data." }, - "FredSeries": { + "FredSeriesData": { "properties": { "date": { "type": "string", @@ -36731,9 +40429,1650 @@ "required": [ "date" ], - "title": "FredSeries", + "title": "FredSeriesData", "description": "FRED Series Data." }, + "GroupedComparisons": { + "properties": { + "financial_ratios": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/GroupedRatios" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Financial Ratios", + "description": "Ratios data." + }, + "valuation_multiples": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/GroupedMetrics" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Valuation Multiples", + "description": "Metrics data." + }, + "available": { + "anyOf": [ + { + "$ref": "#/components/schemas/AvailableComparisonData" + }, + { + "type": "null" + } + ], + "description": "Available financial data." + }, + "tickers": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/FMPTicker" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Tickers", + "description": "Ticker objects with information about the stocks in the comparison." + } + }, + "additionalProperties": true, + "type": "object", + "title": "GroupedComparisons", + "description": "Grouped Comparisons Data." + }, + "GroupedFinancials": { + "properties": { + "balance_sheet": { + "anyOf": [ + { + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/FMPBalanceSheetData" + }, + { + "$ref": "#/components/schemas/IntrinioBalanceSheetData" + } + ] + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Balance Sheet", + "description": "Balance sheet data." + }, + "cash_flow_statement": { + "anyOf": [ + { + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/FMPCashFlowStatementData" + }, + { + "$ref": "#/components/schemas/IntrinioCashFlowStatementData" + } + ] + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Cash Flow Statement", + "description": "Cash flow statement data." + }, + "income_statement": { + "anyOf": [ + { + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/FMPIncomeStatementData" + }, + { + "$ref": "#/components/schemas/IntrinioIncomeStatementData" + } + ] + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Income Statement", + "description": "Income statement data." + } + }, + "additionalProperties": true, + "type": "object", + "title": "GroupedFinancials", + "description": "Grouped Financials Data." + }, + "GroupedMetrics": { + "properties": { + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Stock symbol." + }, + "market_cap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Market Cap", + "description": "Market capitalization" + }, + "pe_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Pe Ratio", + "description": "Price-to-earnings ratio (P/E ratio)" + }, + "period_ending": { + "type": "string", + "format": "date", + "title": "Period Ending", + "description": "Period ending date." + }, + "fiscal_period": { + "type": "string", + "title": "Fiscal Period", + "description": "Period of the data." + }, + "fiscal_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fiscal Year", + "description": "Calendar year for the fiscal period." + }, + "revenue_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Revenue Per Share", + "description": "Revenue per share" + }, + "capex_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capex Per Share", + "description": "Capital expenditures per share" + }, + "net_income_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Income Per Share", + "description": "Net income per share" + }, + "operating_cash_flow_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Operating Cash Flow Per Share", + "description": "Operating cash flow per share" + }, + "free_cash_flow_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Free Cash Flow Per Share", + "description": "Free cash flow per share" + }, + "cash_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cash Per Share", + "description": "Cash per share" + }, + "book_value_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Book Value Per Share", + "description": "Book value per share" + }, + "tangible_book_value_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Tangible Book Value Per Share", + "description": "Tangible book value per share" + }, + "shareholders_equity_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Shareholders Equity Per Share", + "description": "Shareholders equity per share" + }, + "interest_debt_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Interest Debt Per Share", + "description": "Interest debt per share" + }, + "price_to_sales": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Sales", + "description": "Price-to-sales ratio" + }, + "price_to_operating_cash_flow": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Operating Cash Flow", + "description": "Price-to-operating cash flow ratio" + }, + "price_to_free_cash_flow": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Free Cash Flow", + "description": "Price-to-free cash flow ratio" + }, + "price_to_book": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Book", + "description": "Price-to-book ratio" + }, + "price_to_tangible_book": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Tangible Book", + "description": "Price-to-tangible book ratio" + }, + "ev_to_sales": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ev To Sales", + "description": "Enterprise value-to-sales ratio" + }, + "ev_to_ebitda": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ev To Ebitda", + "description": "Enterprise value-to-EBITDA ratio" + }, + "ev_to_operating_cash_flow": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ev To Operating Cash Flow", + "description": "Enterprise value-to-operating cash flow ratio" + }, + "ev_to_free_cash_flow": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ev To Free Cash Flow", + "description": "Enterprise value-to-free cash flow ratio" + }, + "earnings_yield": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Earnings Yield", + "description": "Earnings yield", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "free_cash_flow_yield": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Free Cash Flow Yield", + "description": "Free cash flow yield", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "debt_to_market_cap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debt To Market Cap", + "description": "Debt-to-market capitalization ratio" + }, + "debt_to_equity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debt To Equity", + "description": "Debt-to-equity ratio" + }, + "debt_to_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debt To Assets", + "description": "Debt-to-assets ratio" + }, + "net_debt_to_ebitda": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Debt To Ebitda", + "description": "Net debt-to-EBITDA ratio" + }, + "current_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Current Ratio", + "description": "Current ratio" + }, + "interest_coverage": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Interest Coverage", + "description": "Interest coverage" + }, + "income_quality": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Income Quality", + "description": "Income quality" + }, + "payout_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Payout Ratio", + "description": "Payout ratio" + }, + "sales_general_and_administrative_to_revenue": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Sales General And Administrative To Revenue", + "description": "Sales general and administrative expenses-to-revenue ratio" + }, + "research_and_development_to_revenue": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Research And Development To Revenue", + "description": "Research and development expenses-to-revenue ratio" + }, + "intangibles_to_total_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Intangibles To Total Assets", + "description": "Intangibles-to-total assets ratio" + }, + "capex_to_operating_cash_flow": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capex To Operating Cash Flow", + "description": "Capital expenditures-to-operating cash flow ratio" + }, + "capex_to_revenue": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capex To Revenue", + "description": "Capital expenditures-to-revenue ratio" + }, + "capex_to_depreciation": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capex To Depreciation", + "description": "Capital expenditures-to-depreciation ratio" + }, + "stock_based_compensation_to_revenue": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Stock Based Compensation To Revenue", + "description": "Stock-based compensation-to-revenue ratio" + }, + "working_capital": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Working Capital", + "description": "Working capital" + }, + "tangible_asset_value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Tangible Asset Value", + "description": "Tangible asset value" + }, + "net_current_asset_value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Current Asset Value", + "description": "Net current asset value" + }, + "enterprise_value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Enterprise Value", + "description": "Enterprise value" + }, + "invested_capital": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Invested Capital", + "description": "Invested capital" + }, + "average_receivables": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Average Receivables", + "description": "Average receivables" + }, + "average_payables": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Average Payables", + "description": "Average payables" + }, + "average_inventory": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Average Inventory", + "description": "Average inventory" + }, + "days_sales_outstanding": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Days Sales Outstanding", + "description": "Days sales outstanding" + }, + "days_payables_outstanding": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Days Payables Outstanding", + "description": "Days payables outstanding" + }, + "days_of_inventory_on_hand": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Days Of Inventory On Hand", + "description": "Days of inventory on hand" + }, + "receivables_turnover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Receivables Turnover", + "description": "Receivables turnover" + }, + "payables_turnover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Payables Turnover", + "description": "Payables turnover" + }, + "inventory_turnover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Inventory Turnover", + "description": "Inventory turnover" + }, + "return_on_equity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Return On Equity", + "description": "Return on equity", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "return_on_invested_capital": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Return On Invested Capital", + "description": "Return on invested capital", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "return_on_tangible_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Return On Tangible Assets", + "description": "Return on tangible assets", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "dividend_yield": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dividend Yield", + "description": "Dividend yield, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "graham_number": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Graham Number", + "description": "Graham number" + }, + "graham_net_net": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Graham Net Net", + "description": "Graham net-net working capital" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Stock name." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending", + "fiscal_period" + ], + "title": "GroupedMetrics", + "description": "Grouped Metrics Data." + }, + "GroupedRatios": { + "properties": { + "period_ending": { + "type": "string", + "title": "Period Ending", + "description": "The date of the data." + }, + "fiscal_period": { + "type": "string", + "title": "Fiscal Period", + "description": "Period of the financial ratios." + }, + "fiscal_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fiscal Year", + "description": "Fiscal year." + }, + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Stock symbol." + }, + "current_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Current Ratio", + "description": "Current ratio." + }, + "quick_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Quick Ratio", + "description": "Quick ratio." + }, + "cash_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cash Ratio", + "description": "Cash ratio." + }, + "days_of_sales_outstanding": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Days Of Sales Outstanding", + "description": "Days of sales outstanding." + }, + "days_of_inventory_outstanding": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Days Of Inventory Outstanding", + "description": "Days of inventory outstanding." + }, + "operating_cycle": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Operating Cycle", + "description": "Operating cycle." + }, + "days_of_payables_outstanding": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Days Of Payables Outstanding", + "description": "Days of payables outstanding." + }, + "cash_conversion_cycle": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cash Conversion Cycle", + "description": "Cash conversion cycle." + }, + "gross_profit_margin": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Gross Profit Margin", + "description": "Gross profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "operating_profit_margin": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Operating Profit Margin", + "description": "Operating profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "pretax_profit_margin": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Pretax Profit Margin", + "description": "Pretax profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "net_profit_margin": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Profit Margin", + "description": "Net profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "effective_tax_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Effective Tax Rate", + "description": "Effective tax rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "return_on_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Return On Assets", + "description": "Return on assets.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "return_on_equity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Return On Equity", + "description": "Return on equity.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "return_on_capital_employed": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Return On Capital Employed", + "description": "Return on capital employed.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "net_income_per_ebt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Income Per Ebt", + "description": "Net income per EBT." + }, + "ebt_per_ebit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ebt Per Ebit", + "description": "EBT per EBIT." + }, + "ebit_per_revenue": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ebit Per Revenue", + "description": "EBIT per revenue." + }, + "debt_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debt Ratio", + "description": "Debt ratio." + }, + "debt_equity_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debt Equity Ratio", + "description": "Debt equity ratio." + }, + "long_term_debt_to_capitalization": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Long Term Debt To Capitalization", + "description": "Long term debt to capitalization." + }, + "total_debt_to_capitalization": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Debt To Capitalization", + "description": "Total debt to capitalization." + }, + "interest_coverage_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Interest Coverage Ratio", + "description": "Interest coverage." + }, + "cash_flow_to_debt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cash Flow To Debt", + "description": "Cash flow to debt ratio." + }, + "company_equity_multiplier": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Company Equity Multiplier", + "description": "Company equity multiplier." + }, + "receivables_turnover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Receivables Turnover", + "description": "Receivables turnover." + }, + "payables_turnover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Payables Turnover", + "description": "Payables turnover." + }, + "inventory_turnover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Inventory Turnover", + "description": "Inventory turnover." + }, + "fixed_asset_turnover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Fixed Asset Turnover", + "description": "Fixed asset turnover." + }, + "asset_turnover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Asset Turnover", + "description": "Asset turnover." + }, + "operating_cash_flow_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Operating Cash Flow Per Share", + "description": "Operating cash flow per share." + }, + "free_cash_flow_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Free Cash Flow Per Share", + "description": "Free cash flow per share." + }, + "cash_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cash Per Share", + "description": "Cash per share." + }, + "payout_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Payout Ratio", + "description": "Payout ratio." + }, + "operating_cash_flow_sales_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Operating Cash Flow Sales Ratio", + "description": "Operating cash flow sales ratio." + }, + "free_cash_flow_operating_cash_flow_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Free Cash Flow Operating Cash Flow Ratio", + "description": "Free cash flow operating cash flow ratio." + }, + "cash_flow_coverage_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cash Flow Coverage Ratio", + "description": "Cash flow coverage ratio." + }, + "short_term_coverage_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Short Term Coverage Ratio", + "description": "Short term coverage ratio." + }, + "capital_expenditure_coverage_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capital Expenditure Coverage Ratio", + "description": "Capital expenditure coverage ratio." + }, + "price_book_value_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price Book Value Ratio", + "description": "Price book value ratio." + }, + "price_to_book_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Book Ratio", + "description": "Price to book ratio." + }, + "price_to_sales_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Sales Ratio", + "description": "Price to sales ratio." + }, + "price_earnings_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price Earnings Ratio", + "description": "Price earnings ratio." + }, + "price_to_free_cash_flows_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Free Cash Flows Ratio", + "description": "Price to free cash flows ratio." + }, + "price_to_operating_cash_flows_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Operating Cash Flows Ratio", + "description": "Price to operating cash flows ratio." + }, + "price_cash_flow_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price Cash Flow Ratio", + "description": "Price cash flow ratio." + }, + "price_earnings_to_growth_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price Earnings To Growth Ratio", + "description": "Price earnings to growth ratio." + }, + "price_sales_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price Sales Ratio", + "description": "Price sales ratio." + }, + "dividend_paid_and_capex_coverage_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dividend Paid And Capex Coverage Ratio", + "description": "Dividend paid and capex coverage ratio." + }, + "dividend_payout_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dividend Payout Ratio", + "description": "Dividend payout ratio." + }, + "dividend_yield": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dividend Yield", + "description": "Dividend yield.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "dividend_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dividend Per Share", + "description": "Dividend per share." + }, + "enterprise_value_multiple": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Enterprise Value Multiple", + "description": "Enterprise value multiple." + }, + "price_fair_value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price Fair Value", + "description": "Price fair value." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Stock name." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending", + "fiscal_period" + ], + "title": "GroupedRatios", + "description": "Grouped Ratios Data." + }, "HTTPValidationError": { "properties": { "detail": { @@ -36747,7 +42086,19 @@ "type": "object", "title": "HTTPValidationError" }, - "IntrinioBalanceSheet": { + "IgnoreTypes": { + "type": "string", + "enum": [ + "stock", + "etf", + "index", + "indices", + "economic" + ], + "title": "IgnoreTypes", + "description": "Ignore Types." + }, + "IntrinioBalanceSheetData": { "properties": { "period_ending": { "type": "string", @@ -37865,10 +43216,10 @@ "required": [ "period_ending" ], - "title": "IntrinioBalanceSheet", + "title": "IntrinioBalanceSheetData", "description": "Intrinio Balance Sheet Data." }, - "IntrinioCalendarIpo": { + "IntrinioCalendarIpoData": { "properties": { "symbol": { "anyOf": [ @@ -38141,10 +43492,10 @@ }, "additionalProperties": true, "type": "object", - "title": "IntrinioCalendarIpo", + "title": "IntrinioCalendarIpoData", "description": "Intrinio IPO Calendar Data." }, - "IntrinioCashFlowStatement": { + "IntrinioCashFlowStatementData": { "properties": { "period_ending": { "type": "string", @@ -38722,7 +44073,7 @@ "required": [ "period_ending" ], - "title": "IntrinioCashFlowStatement", + "title": "IntrinioCashFlowStatementData", "description": "Intrinio Cash Flow Statement Data." }, "IntrinioCompany": { @@ -38790,7 +44141,7 @@ "title": "IntrinioCompany", "description": "Intrinio Company Data." }, - "IntrinioCompanyFilings": { + "IntrinioCompanyFilingsData": { "properties": { "filing_date": { "type": "string", @@ -38920,10 +44271,10 @@ "industry_group", "industry_category" ], - "title": "IntrinioCompanyFilings", + "title": "IntrinioCompanyFilingsData", "description": "Intrinio Company Filings Data." }, - "IntrinioCompanyNews": { + "IntrinioCompanyNewsData": { "properties": { "date": { "type": "string", @@ -38983,10 +44334,141 @@ "title": "Symbols", "description": "Symbols associated with the article." }, + "source": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Source", + "description": "The source of the news article." + }, + "summary": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Summary", + "description": "The summary of the news article." + }, + "topics": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Topics", + "description": "The topics related to the news article." + }, + "word_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Word Count", + "description": "The word count of the news article." + }, + "business_relevance": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Business Relevance", + "description": " \tHow strongly correlated the news article is to the business" + }, + "sentiment": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Sentiment", + "description": "The sentiment of the news article - i.e, negative, positive." + }, + "sentiment_confidence": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Sentiment Confidence", + "description": "The confidence score of the sentiment rating." + }, + "language": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Language", + "description": "The language of the news article." + }, + "spam": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Spam", + "description": "Whether the news article is spam." + }, + "copyright": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Copyright", + "description": "The copyright notice of the news article." + }, "id": { "type": "string", "title": "Id", "description": "Article ID." + }, + "security": { + "anyOf": [ + { + "$ref": "#/components/schemas/IntrinioSecurity" + }, + { + "type": "null" + } + ], + "description": "The Intrinio Security object. Contains the security details related to the news article." } }, "additionalProperties": true, @@ -38997,21 +44479,28 @@ "url", "id" ], - "title": "IntrinioCompanyNews", + "title": "IntrinioCompanyNewsData", "description": "Intrinio Company News Data." }, - "IntrinioCurrencyPairs": { + "IntrinioCurrencyPairsData": { "properties": { - "name": { + "symbol": { "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Name", "description": "Name of the currency pair." }, - "code": { - "type": "string", - "title": "Code", - "description": "Code of the currency pair." - }, "base_currency": { "type": "string", "title": "Base Currency", @@ -39026,15 +44515,14 @@ "additionalProperties": true, "type": "object", "required": [ - "name", - "code", + "symbol", "base_currency", "quote_currency" ], - "title": "IntrinioCurrencyPairs", + "title": "IntrinioCurrencyPairsData", "description": "Intrinio Currency Available Pairs Data." }, - "IntrinioEquityHistorical": { + "IntrinioEquityHistoricalData": { "properties": { "date": { "anyOf": [ @@ -39121,7 +44609,7 @@ "title": "Change", "description": "Change in the price of the symbol from the previous day." }, - "change_percent": { + "percent_change": { "anyOf": [ { "type": "number" @@ -39130,7 +44618,7 @@ "type": "null" } ], - "title": "Change Percent", + "title": "Percent Change", "description": "Percent change in the price of the symbol from the previous day.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" @@ -39268,7 +44756,7 @@ "title": "Close Time", "description": "The timestamp that represents the end of the interval span." }, - "interval": { + "frequency": { "anyOf": [ { "type": "string" @@ -39277,10 +44765,10 @@ "type": "null" } ], - "title": "Interval", + "title": "Frequency", "description": "The data time frequency." }, - "intra_period": { + "intraperiod": { "anyOf": [ { "type": "boolean" @@ -39289,7 +44777,7 @@ "type": "null" } ], - "title": "Intra Period", + "title": "Intraperiod", "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period" } }, @@ -39302,10 +44790,10 @@ "low", "close" ], - "title": "IntrinioEquityHistorical", + "title": "IntrinioEquityHistoricalData", "description": "Intrinio Equity Historical Price Data." }, - "IntrinioEquityInfo": { + "IntrinioEquityInfoData": { "properties": { "symbol": { "type": "string", @@ -39784,10 +45272,10 @@ "required": [ "symbol" ], - "title": "IntrinioEquityInfo", + "title": "IntrinioEquityInfoData", "description": "Intrinio Equity Info Data." }, - "IntrinioEquityQuote": { + "IntrinioEquityQuoteData": { "properties": { "symbol": { "type": "string", @@ -40208,7 +45696,7 @@ ], "title": "Change Percent", "description": "Change in price as a normalized percentage.", - "x-frontend_multiply": 100 + "x-frontendmultiply": 100 }, "year_high": { "anyOf": [ @@ -40282,10 +45770,10 @@ "symbol", "updated_on" ], - "title": "IntrinioEquityQuote", + "title": "IntrinioEquityQuoteData", "description": "Intrinio Equity Quote Data." }, - "IntrinioEquitySearch": { + "IntrinioEquitySearchData": { "properties": { "symbol": { "anyOf": [ @@ -40300,7 +45788,14 @@ "description": "Symbol representing the entity requested in the data." }, "name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Name", "description": "Name of the company." }, @@ -40337,15 +45832,14 @@ "additionalProperties": true, "type": "object", "required": [ - "name", "cik", "lei", "intrinio_id" ], - "title": "IntrinioEquitySearch", + "title": "IntrinioEquitySearchData", "description": "Intrinio Equity Search Data." }, - "IntrinioEtfHoldings": { + "IntrinioEtfHoldingsData": { "properties": { "symbol": { "anyOf": [ @@ -40484,10 +45978,10 @@ "balance": { "anyOf": [ { - "type": "number" + "type": "integer" }, { - "type": "integer" + "type": "number" }, { "type": "null" @@ -40584,10 +46078,10 @@ }, "additionalProperties": true, "type": "object", - "title": "IntrinioEtfHoldings", + "title": "IntrinioEtfHoldingsData", "description": "Intrinio ETF Holdings Data." }, - "IntrinioEtfInfo": { + "IntrinioEtfInfoData": { "properties": { "symbol": { "type": "string", @@ -41894,7 +47388,7 @@ "title": "Domicile", "description": "2 letter ISO country code for the country where the ETP is domiciled." }, - "listing_country": { + "listing_country_code": { "anyOf": [ { "type": "string" @@ -41903,7 +47397,7 @@ "type": "null" } ], - "title": "Listing Country", + "title": "Listing Country Code", "description": "2 letter ISO country code for the country of the primary listing." }, "listing_region": { @@ -42014,10 +47508,10 @@ "name", "inception_date" ], - "title": "IntrinioEtfInfo", + "title": "IntrinioEtfInfoData", "description": "Intrinio ETF Info Data." }, - "IntrinioEtfPricePerformance": { + "IntrinioEtfPricePerformanceData": { "properties": { "symbol": { "anyOf": [ @@ -42447,10 +47941,10 @@ }, "additionalProperties": true, "type": "object", - "title": "IntrinioEtfPricePerformance", + "title": "IntrinioEtfPricePerformanceData", "description": "Intrinio ETF Performance Data." }, - "IntrinioEtfSearch": { + "IntrinioEtfSearchData": { "properties": { "symbol": { "type": "string", @@ -42547,10 +48041,10 @@ "required": [ "symbol" ], - "title": "IntrinioEtfSearch", + "title": "IntrinioEtfSearchData", "description": "Intrinio ETF Search Data." }, - "IntrinioFinancialRatios": { + "IntrinioFinancialRatiosData": { "properties": { "period_ending": { "type": "string", @@ -42581,10 +48075,817 @@ "period_ending", "fiscal_period" ], - "title": "IntrinioFinancialRatios", + "title": "IntrinioFinancialRatiosData", "description": "Intrinio Financial Ratios Data." }, - "IntrinioFredSeries": { + "IntrinioForwardEbitdaEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the entity." + }, + "last_updated": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Last Updated", + "description": "The date of the last update." + }, + "period_ending": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Period Ending", + "description": "The end date of the reporting period." + }, + "fiscal_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fiscal Year", + "description": "Fiscal year for the estimate." + }, + "fiscal_period": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Fiscal Period", + "description": "Fiscal quarter for the estimate." + }, + "calendar_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Calendar Year", + "description": "Calendar year for the estimate." + }, + "calendar_period": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Calendar Period", + "description": "Calendar quarter for the estimate." + }, + "low_estimate": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Low Estimate", + "description": "The EBITDA estimate low for the period." + }, + "high_estimate": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "High Estimate", + "description": "The EBITDA estimate high for the period." + }, + "mean": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Mean", + "description": "The EBITDA estimate mean for the period." + }, + "median": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Median", + "description": "The EBITDA estimate median for the period." + }, + "standard_deviation": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Standard Deviation", + "description": "The EBITDA estimate standard deviation for the period." + }, + "number_of_analysts": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Of Analysts", + "description": "Number of analysts providing estimates for the period." + }, + "conensus_type": { + "anyOf": [ + { + "type": "string", + "enum": [ + "ebitda", + "ebit", + "enterprise_value", + "cash_flow_per_share", + "pretax_income" + ] + }, + { + "type": "null" + } + ], + "title": "Conensus Type", + "description": "The type of estimate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "IntrinioForwardEbitdaEstimatesData", + "description": "Intrinio Forward EBITDA Estimates Data." + }, + "IntrinioForwardEpsEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the entity." + }, + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "fiscal_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fiscal Year", + "description": "Fiscal year for the estimate." + }, + "fiscal_period": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Fiscal Period", + "description": "Fiscal quarter for the estimate." + }, + "calendar_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Calendar Year", + "description": "Calendar year for the estimate." + }, + "calendar_period": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Calendar Period", + "description": "Calendar quarter for the estimate." + }, + "low_estimate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Low Estimate", + "description": "Estimated EPS low for the period." + }, + "high_estimate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "High Estimate", + "description": "Estimated EPS high for the period." + }, + "mean": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Mean", + "description": "Estimated EPS mean for the period." + }, + "median": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Median", + "description": "Estimated EPS median for the period." + }, + "standard_deviation": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Standard Deviation", + "description": "Estimated EPS standard deviation for the period." + }, + "number_of_analysts": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Of Analysts", + "description": "Number of analysts providing estimates for the period." + }, + "revisions_change_percent": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Revisions Change Percent", + "description": "The earnings per share (EPS) percent change in estimate for the period.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "mean_1w": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Mean 1W", + "description": "The mean estimate for the period one week ago." + }, + "mean_1m": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Mean 1M", + "description": "The mean estimate for the period one month ago." + }, + "mean_2m": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Mean 2M", + "description": "The mean estimate for the period two months ago." + }, + "mean_3m": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Mean 3M", + "description": "The mean estimate for the period three months ago." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "date" + ], + "title": "IntrinioForwardEpsEstimatesData", + "description": "Intrinio Forward EPS Estimates Data." + }, + "IntrinioForwardPeEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the entity." + }, + "year_1": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year 1", + "description": "Estimated PE ratio for the next fiscal year." + }, + "year_2": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year 2", + "description": "Estimated PE ratio two fiscal years from now." + }, + "year_3": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year 3", + "description": "Estimated PE ratio three fiscal years from now." + }, + "year_4": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year 4", + "description": "Estimated PE ratio four fiscal years from now." + }, + "year_5": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year 5", + "description": "Estimated PE ratio five fiscal years from now." + }, + "peg_ratio_year_1": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Peg Ratio Year 1", + "description": "Estimated Forward PEG ratio for the next fiscal year." + }, + "eps_ttm": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Eps Ttm", + "description": "The latest trailing twelve months earnings per share." + }, + "last_updated": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Last Updated", + "description": "The date the data was last updated." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "IntrinioForwardPeEstimatesData", + "description": "Intrinio Forward PE Estimates Data." + }, + "IntrinioForwardSalesEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the entity." + }, + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "fiscal_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fiscal Year", + "description": "Fiscal year for the estimate." + }, + "fiscal_period": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Fiscal Period", + "description": "Fiscal quarter for the estimate." + }, + "calendar_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Calendar Year", + "description": "Calendar year for the estimate." + }, + "calendar_period": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Calendar Period", + "description": "Calendar quarter for the estimate." + }, + "low_estimate": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Low Estimate", + "description": "The sales estimate low for the period." + }, + "high_estimate": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "High Estimate", + "description": "The sales estimate high for the period." + }, + "mean": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Mean", + "description": "The sales estimate mean for the period." + }, + "median": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Median", + "description": "The sales estimate median for the period." + }, + "standard_deviation": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Standard Deviation", + "description": "The sales estimate standard deviation for the period." + }, + "number_of_analysts": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Of Analysts", + "description": "Number of analysts providing estimates for the period." + }, + "revisions_1w_up": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Revisions 1W Up", + "description": "Number of revisions up in the last week." + }, + "revisions_1w_down": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Revisions 1W Down", + "description": "Number of revisions down in the last week." + }, + "revisions_1w_change_percent": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Revisions 1W Change Percent", + "description": "The analyst revisions percent change in estimate for the period of 1 week.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "revisions_1m_up": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Revisions 1M Up", + "description": "Number of revisions up in the last month." + }, + "revisions_1m_down": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Revisions 1M Down", + "description": "Number of revisions down in the last month." + }, + "revisions_1m_change_percent": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Revisions 1M Change Percent", + "description": "The analyst revisions percent change in estimate for the period of 1 month.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "revisions_3m_up": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Revisions 3M Up", + "description": "Number of revisions up in the last 3 months." + }, + "revisions_3m_down": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Revisions 3M Down", + "description": "Number of revisions down in the last 3 months." + }, + "revisions_3m_change_percent": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Revisions 3M Change Percent", + "description": "The analyst revisions percent change in estimate for the period of 3 months.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "date" + ], + "title": "IntrinioForwardSalesEstimatesData", + "description": "Intrinio Forward Sales Estimates Data." + }, + "IntrinioFredSeriesData": { "properties": { "date": { "type": "string", @@ -42610,10 +48911,10 @@ "required": [ "date" ], - "title": "IntrinioFredSeries", + "title": "IntrinioFredSeriesData", "description": "Intrinio FRED Series Data." }, - "IntrinioHistoricalAttributes": { + "IntrinioHistoricalAttributesData": { "properties": { "date": { "type": "string", @@ -42657,10 +48958,10 @@ "date", "symbol" ], - "title": "IntrinioHistoricalAttributes", + "title": "IntrinioHistoricalAttributesData", "description": "Intrinio Historical Attributes Data." }, - "IntrinioHistoricalDividends": { + "IntrinioHistoricalDividendsData": { "properties": { "ex_dividend_date": { "type": "string", @@ -42716,10 +49017,10 @@ "ex_dividend_date", "amount" ], - "title": "IntrinioHistoricalDividends", + "title": "IntrinioHistoricalDividendsData", "description": "Intrinio Historical Dividends Data." }, - "IntrinioIncomeStatement": { + "IntrinioIncomeStatementData": { "properties": { "period_ending": { "type": "string", @@ -43705,10 +50006,10 @@ "required": [ "period_ending" ], - "title": "IntrinioIncomeStatement", + "title": "IntrinioIncomeStatementData", "description": "Intrinio Income Statement Data." }, - "IntrinioIndexHistorical": { + "IntrinioIndexHistoricalData": { "properties": { "date": { "anyOf": [ @@ -43790,10 +50091,10 @@ "required": [ "date" ], - "title": "IntrinioIndexHistorical", + "title": "IntrinioIndexHistoricalData", "description": "Intrinio Index Historical Data." }, - "IntrinioInsiderTrading": { + "IntrinioInsiderTradingData": { "properties": { "symbol": { "anyOf": [ @@ -44046,10 +50347,10 @@ "underlying_shares": { "anyOf": [ { - "type": "number" + "type": "integer" }, { - "type": "integer" + "type": "number" }, { "type": "null" @@ -44148,10 +50449,10 @@ "required": [ "company_name" ], - "title": "IntrinioInsiderTrading", + "title": "IntrinioInsiderTradingData", "description": "Intrinio Insider Trading Data." }, - "IntrinioKeyMetrics": { + "IntrinioKeyMetricsData": { "properties": { "symbol": { "anyOf": [ @@ -44647,10 +50948,10 @@ }, "additionalProperties": true, "type": "object", - "title": "IntrinioKeyMetrics", + "title": "IntrinioKeyMetricsData", "description": "Intrinio Key Metrics Data." }, - "IntrinioLatestAttributes": { + "IntrinioLatestAttributesData": { "properties": { "symbol": { "type": "string", @@ -44690,10 +50991,10 @@ "required": [ "symbol" ], - "title": "IntrinioLatestAttributes", + "title": "IntrinioLatestAttributesData", "description": "Intrinio Latest Attributes Data." }, - "IntrinioMarketSnapshots": { + "IntrinioMarketSnapshotsData": { "properties": { "symbol": { "type": "string", @@ -44927,10 +51228,10 @@ "required": [ "symbol" ], - "title": "IntrinioMarketSnapshots", + "title": "IntrinioMarketSnapshotsData", "description": "Intrinio Market Snapshots Data." }, - "IntrinioOptionsChains": { + "IntrinioOptionsChainsData": { "properties": { "symbol": { "anyOf": [ @@ -45446,10 +51747,10 @@ "strike", "option_type" ], - "title": "IntrinioOptionsChains", + "title": "IntrinioOptionsChainsData", "description": "Intrinio Options Chains Data." }, - "IntrinioOptionsUnusual": { + "IntrinioOptionsUnusualData": { "properties": { "underlying_symbol": { "anyOf": [ @@ -45552,10 +51853,159 @@ "total_size", "total_value" ], - "title": "IntrinioOptionsUnusual", + "title": "IntrinioOptionsUnusualData", "description": "Intrinio Unusual Options Data." }, - "IntrinioReportedFinancials": { + "IntrinioPriceTargetConsensusData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "The company name" + }, + "target_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Target High", + "description": "High target of the price target consensus." + }, + "target_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Target Low", + "description": "Low target of the price target consensus." + }, + "target_consensus": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Target Consensus", + "description": "Consensus target of the price target consensus." + }, + "target_median": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Target Median", + "description": "Median target of the price target consensus." + }, + "standard_deviation": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Standard Deviation", + "description": "The standard deviation of target price estimates." + }, + "total_analysts": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Total Analysts", + "description": "The total number of target price estimates in consensus." + }, + "raised": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Raised", + "description": "The number of analysts that have raised their target price estimates." + }, + "lowered": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Lowered", + "description": "The number of analysts that have lowered their target price estimates." + }, + "most_recent_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Most Recent Date", + "description": "The date of the most recent estimate." + }, + "industry_group_number": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Industry Group Number", + "description": "The Zacks industry group number." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "IntrinioPriceTargetConsensusData", + "description": "Intrinio Price Target Consensus Data." + }, + "IntrinioReportedFinancialsData": { "properties": { "period_ending": { "type": "string", @@ -45587,10 +52037,10 @@ "period_ending", "fiscal_period" ], - "title": "IntrinioReportedFinancials", + "title": "IntrinioReportedFinancialsData", "description": "Intrinio Reported Financials Data.\n\nThe fields for this model are generated dynamically from the XBRL tags in the Intrinio response." }, - "IntrinioSearchAttributes": { + "IntrinioSearchAttributesData": { "properties": { "id": { "type": "string", @@ -45705,7 +52155,7 @@ "tag", "statement_code" ], - "title": "IntrinioSearchAttributes", + "title": "IntrinioSearchAttributesData", "description": "Intrinio Search Attributes Data." }, "IntrinioSecurity": { @@ -45844,7 +52294,7 @@ "title": "IntrinioSecurity", "description": "Intrinio Security Data." }, - "IntrinioShareStatistics": { + "IntrinioShareStatisticsData": { "properties": { "symbol": { "type": "string", @@ -45912,7 +52362,7 @@ "title": "Source", "description": "Source of the received data." }, - "adjusted_outstanding_shares": { + "adjweightedavebasicdilutedsharesos": { "anyOf": [ { "type": "number" @@ -45921,7 +52371,7 @@ "type": "null" } ], - "title": "Adjusted Outstanding Shares", + "title": "Adjweightedavebasicdilutedsharesos", "description": "Total number of shares of a publicly-traded company, adjusted for splits." }, "public_float": { @@ -45942,10 +52392,10 @@ "required": [ "symbol" ], - "title": "IntrinioShareStatistics", + "title": "IntrinioShareStatisticsData", "description": "Intrinio Share Statistics Data." }, - "IntrinioWorldNews": { + "IntrinioWorldNewsData": { "properties": { "date": { "type": "string", @@ -46000,15 +52450,152 @@ "title": "Url", "description": "URL to the article." }, + "source": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Source", + "description": "The source of the news article." + }, + "summary": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Summary", + "description": "The summary of the news article." + }, + "topics": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Topics", + "description": "The topics related to the news article." + }, + "word_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Word Count", + "description": "The word count of the news article." + }, + "business_relevance": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Business Relevance", + "description": " \tHow strongly correlated the news article is to the business" + }, + "sentiment": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Sentiment", + "description": "The sentiment of the news article - i.e, negative, positive." + }, + "sentiment_confidence": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Sentiment Confidence", + "description": "The confidence score of the sentiment rating." + }, + "language": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Language", + "description": "The language of the news article." + }, + "spam": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Spam", + "description": "Whether the news article is spam." + }, + "copyright": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Copyright", + "description": "The copyright notice of the news article." + }, "id": { "type": "string", "title": "Id", "description": "Article ID." }, "company": { - "type": "object", - "title": "Company", - "description": "Company details related to the news article." + "anyOf": [ + { + "$ref": "#/components/schemas/IntrinioCompany" + }, + { + "type": "null" + } + ], + "description": "The Intrinio Company object. Contains details company reference data." + }, + "security": { + "anyOf": [ + { + "$ref": "#/components/schemas/IntrinioSecurity" + }, + { + "type": "null" + } + ], + "description": "The Intrinio Security object. Contains the security details related to the news article." } }, "additionalProperties": true, @@ -46016,12 +52603,225 @@ "required": [ "date", "title", - "id", - "company" + "id" ], - "title": "IntrinioWorldNews", + "title": "IntrinioWorldNewsData", "description": "Intrinio World News Data." }, + "NixtlaTimegenData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "Date." + }, + "forecast": { + "type": "number", + "title": "Forecast", + "description": "Forecast value." + }, + "levels": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/NixtlaTimegenLevelData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Levels", + "description": "Prediction intervals." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "forecast" + ], + "title": "NixtlaTimegenData", + "description": "Nixtla Timegen Data." + }, + "NixtlaTimegenLevelData": { + "properties": { + "level": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "number" + } + ], + "title": "Level", + "description": "Level." + }, + "high": { + "type": "number", + "title": "High", + "description": "High value." + }, + "low": { + "type": "number", + "title": "Low", + "description": "Low value." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "level", + "high", + "low" + ], + "title": "NixtlaTimegenLevelData", + "description": "Nixtla Timegen Level Data." + }, + "NixtlaTimegenQueryParams": { + "properties": { + "freq": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Freq", + "description": "Frequency of the data. H: hourly, D: daily, W: weekly, M: monthly, Q: quarterly, Y: yearly.", + "default": "D" + }, + "fh": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fh", + "description": "Forecast horizon.", + "default": 7 + }, + "y": { + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Y", + "description": "Time series data." + }, + "level": { + "anyOf": [ + { + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "number" + } + ] + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Level", + "description": "A list of values representing the prediction intervals. Each value is a percentage that indicates the level of certainty for the corresponding prediction interval. For example, [80, 90] defines 80% and 90% prediction intervals." + }, + "clean_ex_first": { + "type": "boolean", + "title": "Clean Ex First", + "description": "Clean the first example.", + "default": true + }, + "finetune_steps": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Finetune Steps", + "description": "Number of finetune steps.", + "default": 0 + }, + "finetune_loss": { + "anyOf": [ + { + "type": "string", + "enum": [ + "default", + "mae", + "mse", + "rmse", + "mape", + "smape" + ] + }, + { + "type": "null" + } + ], + "title": "Finetune Loss", + "description": "Finetune loss.", + "default": "default" + }, + "model": { + "anyOf": [ + { + "type": "string", + "enum": [ + "timegpt-1", + "timegpt-1-long-horizon", + "short-horizon", + "long-horizon", + "azureai" + ] + }, + { + "type": "null" + } + ], + "title": "Model", + "description": "Model to use.", + "default": "timegpt-1" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "y" + ], + "title": "NixtlaTimegenQueryParams", + "description": "Nixtla Timegen Query." + }, "OBBject_AMERIBOR": { "properties": { "_id": { @@ -46032,17 +52832,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDAMERIBOR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDAMERIBOR" - } - } + "$ref": "#/components/schemas/FREDAMERIBORData" }, "type": "array" }, @@ -46051,10 +52841,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "AMERIBOR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46114,17 +52901,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPAnalystEstimates" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPAnalystEstimates" - } - } + "$ref": "#/components/schemas/FMPAnalystEstimatesData" }, "type": "array" }, @@ -46133,10 +52910,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "AnalystEstimates" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46196,17 +52970,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/BenzingaAnalystSearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "benzinga": "#/components/schemas/BenzingaAnalystSearch" - } - } + "$ref": "#/components/schemas/BenzingaAnalystSearchData" }, "type": "array" }, @@ -46215,10 +52979,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "AnalystSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46268,6 +53029,75 @@ "title": "OBBject_AnalystSearch", "description": "OBBject with results of type AnalystSearch" }, + "OBBject_AvailableIndicators": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/EconDbAvailableIndicatorsData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_AvailableIndicators", + "description": "OBBject with results of type AvailableIndicators" + }, "OBBject_AvailableIndices": { "properties": { "_id": { @@ -46278,17 +53108,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPAvailableIndices" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPAvailableIndices" - } - } + "$ref": "#/components/schemas/FMPAvailableIndicesData" }, "type": "array" }, @@ -46297,10 +53117,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "AvailableIndices" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46362,15 +53179,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/ECBBalanceOfPayments" + "$ref": "#/components/schemas/ECBBalanceOfPaymentsData" + }, + { + "$ref": "#/components/schemas/FredBalanceOfPaymentsData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "ecb": "#/components/schemas/ECBBalanceOfPayments" - } - } + ] }, "type": "array" }, @@ -46379,10 +53193,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "BalanceOfPayments" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46444,23 +53255,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPBalanceSheet" + "$ref": "#/components/schemas/PolygonBalanceSheetData" }, { - "$ref": "#/components/schemas/IntrinioBalanceSheet" + "$ref": "#/components/schemas/IntrinioBalanceSheetData" }, { - "$ref": "#/components/schemas/PolygonBalanceSheet" + "$ref": "#/components/schemas/FMPBalanceSheetData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPBalanceSheet", - "intrinio": "#/components/schemas/IntrinioBalanceSheet", - "polygon": "#/components/schemas/PolygonBalanceSheet" - } - } + ] }, "type": "array" }, @@ -46469,10 +53272,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "BalanceSheet" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46532,17 +53332,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPBalanceSheetGrowth" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPBalanceSheetGrowth" - } - } + "$ref": "#/components/schemas/FMPBalanceSheetGrowthData" }, "type": "array" }, @@ -46551,10 +53341,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "BalanceSheetGrowth" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46614,17 +53401,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDCLI" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDCLI" - } - } + "$ref": "#/components/schemas/OECDCLIData" }, "type": "array" }, @@ -46633,10 +53410,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CLI" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46696,17 +53470,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCalendarDividend" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCalendarDividend" - } - } + "$ref": "#/components/schemas/FMPCalendarDividendData" }, "type": "array" }, @@ -46715,10 +53479,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CalendarDividend" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46778,17 +53539,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCalendarEarnings" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCalendarEarnings" - } - } + "$ref": "#/components/schemas/FMPCalendarEarningsData" }, "type": "array" }, @@ -46797,10 +53548,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CalendarEarnings" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46860,17 +53608,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioCalendarIpo" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioCalendarIpo" - } - } + "$ref": "#/components/schemas/IntrinioCalendarIpoData" }, "type": "array" }, @@ -46879,10 +53617,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CalendarIpo" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46942,17 +53677,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCalendarSplits" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCalendarSplits" - } - } + "$ref": "#/components/schemas/FMPCalendarSplitsData" }, "type": "array" }, @@ -46961,10 +53686,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CalendarSplits" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47026,23 +53748,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPCashFlowStatement" + "$ref": "#/components/schemas/FMPCashFlowStatementData" }, { - "$ref": "#/components/schemas/IntrinioCashFlowStatement" + "$ref": "#/components/schemas/PolygonCashFlowStatementData" }, { - "$ref": "#/components/schemas/PolygonCashFlowStatement" + "$ref": "#/components/schemas/IntrinioCashFlowStatementData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCashFlowStatement", - "intrinio": "#/components/schemas/IntrinioCashFlowStatement", - "polygon": "#/components/schemas/PolygonCashFlowStatement" - } - } + ] }, "type": "array" }, @@ -47051,10 +53765,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CashFlowStatement" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47114,17 +53825,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCashFlowStatementGrowth" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCashFlowStatementGrowth" - } - } + "$ref": "#/components/schemas/FMPCashFlowStatementGrowthData" }, "type": "array" }, @@ -47133,10 +53834,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CashFlowStatementGrowth" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47195,27 +53893,13 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/SecCikMap" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecCikMap" - } - } + "$ref": "#/components/schemas/SecCikMapData" }, { "type": "null" } ], - "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "CikMap" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47275,17 +53959,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDCommercialPaper" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDCommercialPaper" - } - } + "$ref": "#/components/schemas/FREDCommercialPaperData" }, "type": "array" }, @@ -47294,10 +53968,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CommercialPaper" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47359,23 +54030,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPCompanyFilings" + "$ref": "#/components/schemas/IntrinioCompanyFilingsData" }, { - "$ref": "#/components/schemas/IntrinioCompanyFilings" + "$ref": "#/components/schemas/FMPCompanyFilingsData" }, { - "$ref": "#/components/schemas/SecCompanyFilings" + "$ref": "#/components/schemas/SecCompanyFilingsData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCompanyFilings", - "intrinio": "#/components/schemas/IntrinioCompanyFilings", - "sec": "#/components/schemas/SecCompanyFilings" - } - } + ] }, "type": "array" }, @@ -47384,10 +54047,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CompanyFilings" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47449,27 +54109,18 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/BenzingaCompanyNews" + "$ref": "#/components/schemas/FMPCompanyNewsData" }, { - "$ref": "#/components/schemas/FMPCompanyNews" + "$ref": "#/components/schemas/PolygonCompanyNewsData" }, { - "$ref": "#/components/schemas/IntrinioCompanyNews" + "$ref": "#/components/schemas/BenzingaCompanyNewsData" }, { - "$ref": "#/components/schemas/PolygonCompanyNews" + "$ref": "#/components/schemas/IntrinioCompanyNewsData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "benzinga": "#/components/schemas/BenzingaCompanyNews", - "fmp": "#/components/schemas/FMPCompanyNews", - "intrinio": "#/components/schemas/IntrinioCompanyNews", - "polygon": "#/components/schemas/PolygonCompanyNews" - } - } + ] }, "type": "array" }, @@ -47478,10 +54129,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CompanyNews" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47540,27 +54188,13 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCompanyOverview" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCompanyOverview" - } - } + "$ref": "#/components/schemas/FMPCompanyOverviewData" }, { "type": "null" } ], - "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "CompanyOverview" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47610,6 +54244,75 @@ "title": "OBBject_CompanyOverview", "description": "OBBject with results of type CompanyOverview" }, + "OBBject_CompareCompanyFacts": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/SecCompareCompanyFactsData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_CompareCompanyFacts", + "description": "OBBject with results of type CompareCompanyFacts" + }, "OBBject_ConsumerPriceIndex": { "properties": { "_id": { @@ -47620,17 +54323,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDConsumerPriceIndex" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDConsumerPriceIndex" - } - } + "$ref": "#/components/schemas/FREDConsumerPriceIndexData" }, "type": "array" }, @@ -47639,10 +54332,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ConsumerPriceIndex" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47692,6 +54382,75 @@ "title": "OBBject_ConsumerPriceIndex", "description": "OBBject with results of type ConsumerPriceIndex" }, + "OBBject_CountryProfile": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/EconDbCountryProfileData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_CountryProfile", + "description": "OBBject with results of type CountryProfile" + }, "OBBject_CryptoHistorical": { "properties": { "_id": { @@ -47704,19 +54463,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPCryptoHistorical" + "$ref": "#/components/schemas/FMPCryptoHistoricalData" }, { - "$ref": "#/components/schemas/PolygonCryptoHistorical" + "$ref": "#/components/schemas/PolygonCryptoHistoricalData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCryptoHistorical", - "polygon": "#/components/schemas/PolygonCryptoHistorical" - } - } + ] }, "type": "array" }, @@ -47725,10 +54477,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CryptoHistorical" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47788,17 +54537,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCryptoSearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCryptoSearch" - } - } + "$ref": "#/components/schemas/FMPCryptoSearchData" }, "type": "array" }, @@ -47807,10 +54546,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CryptoSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47872,19 +54608,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPCurrencyHistorical" + "$ref": "#/components/schemas/FMPCurrencyHistoricalData" }, { - "$ref": "#/components/schemas/PolygonCurrencyHistorical" + "$ref": "#/components/schemas/PolygonCurrencyHistoricalData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCurrencyHistorical", - "polygon": "#/components/schemas/PolygonCurrencyHistorical" - } - } + ] }, "type": "array" }, @@ -47893,10 +54622,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CurrencyHistorical" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47958,23 +54684,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPCurrencyPairs" + "$ref": "#/components/schemas/PolygonCurrencyPairsData" }, { - "$ref": "#/components/schemas/IntrinioCurrencyPairs" + "$ref": "#/components/schemas/IntrinioCurrencyPairsData" }, { - "$ref": "#/components/schemas/PolygonCurrencyPairs" + "$ref": "#/components/schemas/FMPCurrencyPairsData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCurrencyPairs", - "intrinio": "#/components/schemas/IntrinioCurrencyPairs", - "polygon": "#/components/schemas/PolygonCurrencyPairs" - } - } + ] }, "type": "array" }, @@ -47983,10 +54701,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CurrencyPairs" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48045,27 +54760,13 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/ECBCurrencyReferenceRates" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "ecb": "#/components/schemas/ECBCurrencyReferenceRates" - } - } + "$ref": "#/components/schemas/ECBCurrencyReferenceRatesData" }, { "type": "null" } ], - "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "CurrencyReferenceRates" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48127,15 +54828,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPCurrencySnapshots" + "$ref": "#/components/schemas/PolygonCurrencySnapshotsData" + }, + { + "$ref": "#/components/schemas/FMPCurrencySnapshotsData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCurrencySnapshots" - } - } + ] }, "type": "array" }, @@ -48144,10 +54842,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CurrencySnapshots" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48207,17 +54902,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDDiscountWindowPrimaryCreditRate" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDDiscountWindowPrimaryCreditRate" - } - } + "$ref": "#/components/schemas/FREDDiscountWindowPrimaryCreditRateData" }, "type": "array" }, @@ -48226,10 +54911,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "DiscountWindowPrimaryCreditRate" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48289,17 +54971,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPDiscoveryFilings" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPDiscoveryFilings" - } - } + "$ref": "#/components/schemas/FMPDiscoveryFilingsData" }, "type": "array" }, @@ -48308,10 +54980,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "DiscoveryFilings" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48371,17 +55040,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDESTR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDESTR" - } - } + "$ref": "#/components/schemas/FREDESTRData" }, "type": "array" }, @@ -48390,10 +55049,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ESTR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48453,17 +55109,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/ECBEUYieldCurve" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "ecb": "#/components/schemas/ECBEUYieldCurve" - } - } + "$ref": "#/components/schemas/ECBEUYieldCurveData" }, "type": "array" }, @@ -48472,10 +55118,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EUYieldCurve" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48535,17 +55178,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEarningsCallTranscript" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEarningsCallTranscript" - } - } + "$ref": "#/components/schemas/FMPEarningsCallTranscriptData" }, "type": "array" }, @@ -48554,10 +55187,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EarningsCallTranscript" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48619,19 +55249,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEconomicCalendar" + "$ref": "#/components/schemas/FMPEconomicCalendarData" }, { - "$ref": "#/components/schemas/TEEconomicCalendar" + "$ref": "#/components/schemas/TEEconomicCalendarData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEconomicCalendar", - "tradingeconomics": "#/components/schemas/TEEconomicCalendar" - } - } + ] }, "type": "array" }, @@ -48640,10 +55263,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EconomicCalendar" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48693,6 +55313,75 @@ "title": "OBBject_EconomicCalendar", "description": "OBBject with results of type EconomicCalendar" }, + "OBBject_EconomicIndicators": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/EconDbEconomicIndicatorsData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_EconomicIndicators", + "description": "OBBject with results of type EconomicIndicators" + }, "OBBject_EquityFTD": { "properties": { "_id": { @@ -48703,17 +55392,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/SecEquityFtd" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecEquityFtd" - } - } + "$ref": "#/components/schemas/SecEquityFtdData" }, "type": "array" }, @@ -48722,10 +55401,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityFTD" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48787,23 +55463,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEquityHistorical" + "$ref": "#/components/schemas/IntrinioEquityHistoricalData" }, { - "$ref": "#/components/schemas/IntrinioEquityHistorical" + "$ref": "#/components/schemas/FMPEquityHistoricalData" }, { - "$ref": "#/components/schemas/PolygonEquityHistorical" + "$ref": "#/components/schemas/PolygonEquityHistoricalData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityHistorical", - "intrinio": "#/components/schemas/IntrinioEquityHistorical", - "polygon": "#/components/schemas/PolygonEquityHistorical" - } - } + ] }, "type": "array" }, @@ -48812,10 +55480,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityHistorical" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48877,19 +55542,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEquityProfile" + "$ref": "#/components/schemas/IntrinioEquityInfoData" }, { - "$ref": "#/components/schemas/IntrinioEquityInfo" + "$ref": "#/components/schemas/FMPEquityProfileData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityProfile", - "intrinio": "#/components/schemas/IntrinioEquityInfo" - } - } + ] }, "type": "array" }, @@ -48898,10 +55556,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityInfo" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48961,17 +55616,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/PolygonEquityNBBO" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "polygon": "#/components/schemas/PolygonEquityNBBO" - } - } + "$ref": "#/components/schemas/PolygonEquityNBBOData" }, "type": "array" }, @@ -48980,10 +55625,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityNBBO" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49043,17 +55685,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEquityOwnership" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityOwnership" - } - } + "$ref": "#/components/schemas/FMPEquityOwnershipData" }, "type": "array" }, @@ -49062,10 +55694,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityOwnership" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49124,27 +55753,13 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEquityPeers" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityPeers" - } - } + "$ref": "#/components/schemas/FMPEquityPeersData" }, { "type": "null" } ], - "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "EquityPeers" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49206,19 +55821,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEquityQuote" + "$ref": "#/components/schemas/FMPEquityQuoteData" }, { - "$ref": "#/components/schemas/IntrinioEquityQuote" + "$ref": "#/components/schemas/IntrinioEquityQuoteData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityQuote", - "intrinio": "#/components/schemas/IntrinioEquityQuote" - } - } + ] }, "type": "array" }, @@ -49227,10 +55835,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityQuote" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49290,17 +55895,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEquityScreener" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityScreener" - } - } + "$ref": "#/components/schemas/FMPEquityScreenerData" }, "type": "array" }, @@ -49309,10 +55904,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityScreener" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49374,19 +55966,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/IntrinioEquitySearch" + "$ref": "#/components/schemas/SecEquitySearchData" }, { - "$ref": "#/components/schemas/SecEquitySearch" + "$ref": "#/components/schemas/IntrinioEquitySearchData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioEquitySearch", - "sec": "#/components/schemas/SecEquitySearch" - } - } + ] }, "type": "array" }, @@ -49395,10 +55980,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquitySearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49458,17 +56040,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEquityValuationMultiples" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityValuationMultiples" - } - } + "$ref": "#/components/schemas/FMPEquityValuationMultiplesData" }, "type": "array" }, @@ -49477,10 +56049,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityValuationMultiples" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49540,17 +56109,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEtfCountries" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfCountries" - } - } + "$ref": "#/components/schemas/FMPEtfCountriesData" }, "type": "array" }, @@ -49559,10 +56118,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfCountries" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49622,17 +56178,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEtfEquityExposure" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfEquityExposure" - } - } + "$ref": "#/components/schemas/FMPEtfEquityExposureData" }, "type": "array" }, @@ -49641,10 +56187,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfEquityExposure" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49706,23 +56249,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEquityHistorical" + "$ref": "#/components/schemas/IntrinioEquityHistoricalData" }, { - "$ref": "#/components/schemas/IntrinioEquityHistorical" + "$ref": "#/components/schemas/FMPEquityHistoricalData" }, { - "$ref": "#/components/schemas/PolygonEquityHistorical" + "$ref": "#/components/schemas/PolygonEquityHistoricalData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityHistorical", - "intrinio": "#/components/schemas/IntrinioEquityHistorical", - "polygon": "#/components/schemas/PolygonEquityHistorical" - } - } + ] }, "type": "array" }, @@ -49731,10 +56266,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfHistorical" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49796,23 +56328,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEtfHoldings" + "$ref": "#/components/schemas/SecEtfHoldingsData" }, { - "$ref": "#/components/schemas/IntrinioEtfHoldings" + "$ref": "#/components/schemas/FMPEtfHoldingsData" }, { - "$ref": "#/components/schemas/SecEtfHoldings" + "$ref": "#/components/schemas/IntrinioEtfHoldingsData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfHoldings", - "intrinio": "#/components/schemas/IntrinioEtfHoldings", - "sec": "#/components/schemas/SecEtfHoldings" - } - } + ] }, "type": "array" }, @@ -49821,10 +56345,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfHoldings" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49884,17 +56405,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEtfHoldingsDate" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfHoldingsDate" - } - } + "$ref": "#/components/schemas/FMPEtfHoldingsDateData" }, "type": "array" }, @@ -49903,10 +56414,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfHoldingsDate" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49956,88 +56464,6 @@ "title": "OBBject_EtfHoldingsDate", "description": "OBBject with results of type EtfHoldingsDate" }, - "OBBject_EtfHoldingsPerformance": { - "properties": { - "_id": { - "type": "string", - "title": " Id" - }, - "results": { - "anyOf": [ - { - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEtfHoldingsPerformance" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfHoldingsPerformance" - } - } - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfHoldingsPerformance" - }, - "provider": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Provider", - "description": "Provider name." - }, - "warnings": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/Warning_" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Warnings", - "description": "List of warnings." - }, - "chart": { - "anyOf": [ - { - "$ref": "#/components/schemas/Chart" - }, - { - "type": "null" - } - ], - "description": "Chart object." - }, - "extra": { - "type": "object", - "title": "Extra", - "description": "Extra info." - } - }, - "type": "object", - "title": "OBBject_EtfHoldingsPerformance", - "description": "OBBject with results of type EtfHoldingsPerformance" - }, "OBBject_EtfInfo": { "properties": { "_id": { @@ -50050,19 +56476,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEtfInfo" + "$ref": "#/components/schemas/IntrinioEtfInfoData" }, { - "$ref": "#/components/schemas/IntrinioEtfInfo" + "$ref": "#/components/schemas/FMPEtfInfoData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfInfo", - "intrinio": "#/components/schemas/IntrinioEtfInfo" - } - } + ] }, "type": "array" }, @@ -50071,10 +56490,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfInfo" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50136,19 +56552,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPPricePerformance" + "$ref": "#/components/schemas/IntrinioEtfPricePerformanceData" }, { - "$ref": "#/components/schemas/IntrinioEtfPricePerformance" + "$ref": "#/components/schemas/FMPPricePerformanceData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPPricePerformance", - "intrinio": "#/components/schemas/IntrinioEtfPricePerformance" - } - } + ] }, "type": "array" }, @@ -50157,10 +56566,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfPricePerformance" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50222,19 +56628,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEtfSearch" + "$ref": "#/components/schemas/FMPEtfSearchData" }, { - "$ref": "#/components/schemas/IntrinioEtfSearch" + "$ref": "#/components/schemas/IntrinioEtfSearchData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfSearch", - "intrinio": "#/components/schemas/IntrinioEtfSearch" - } - } + ] }, "type": "array" }, @@ -50243,10 +56642,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50306,17 +56702,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEtfSectors" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfSectors" - } - } + "$ref": "#/components/schemas/FMPEtfSectorsData" }, "type": "array" }, @@ -50325,10 +56711,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfSectors" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50388,17 +56771,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDEuropeanCentralBankInterestRates" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDEuropeanCentralBankInterestRates" - } - } + "$ref": "#/components/schemas/FREDEuropeanCentralBankInterestRatesData" }, "type": "array" }, @@ -50407,10 +56780,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EuropeanCentralBankInterestRates" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50470,17 +56840,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPExecutiveCompensation" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPExecutiveCompensation" - } - } + "$ref": "#/components/schemas/FMPExecutiveCompensationData" }, "type": "array" }, @@ -50489,10 +56849,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ExecutiveCompensation" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50554,19 +56911,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FederalReserveFED" + "$ref": "#/components/schemas/FederalReserveFEDData" }, { - "$ref": "#/components/schemas/FREDFED" + "$ref": "#/components/schemas/FREDFEDData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "federal_reserve": "#/components/schemas/FederalReserveFED", - "fred": "#/components/schemas/FREDFED" - } - } + ] }, "type": "array" }, @@ -50575,10 +56925,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "FEDFUNDS" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50640,19 +56987,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPFinancialRatios" + "$ref": "#/components/schemas/IntrinioFinancialRatiosData" }, { - "$ref": "#/components/schemas/IntrinioFinancialRatios" + "$ref": "#/components/schemas/FMPFinancialRatiosData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPFinancialRatios", - "intrinio": "#/components/schemas/IntrinioFinancialRatios" - } - } + ] }, "type": "array" }, @@ -50661,10 +57001,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "FinancialRatios" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50724,17 +57061,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/SecForm13FHR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecForm13FHR" - } - } + "$ref": "#/components/schemas/SecForm13FHRData" }, "type": "array" }, @@ -50743,10 +57070,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "Form13FHR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50796,7 +57120,7 @@ "title": "OBBject_Form13FHR", "description": "OBBject with results of type Form13FHR" }, - "OBBject_FredRegional": { + "OBBject_ForwardEbitdaEstimates": { "properties": { "_id": { "type": "string", @@ -50808,15 +57132,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FredRegional" + "$ref": "#/components/schemas/FMPForwardEbitdaEstimatesData" + }, + { + "$ref": "#/components/schemas/IntrinioForwardEbitdaEstimatesData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FredRegional" - } - } + ] }, "type": "array" }, @@ -50825,10 +57146,290 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "FredRegional" + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_ForwardEbitdaEstimates", + "description": "OBBject with results of type ForwardEbitdaEstimates" + }, + "OBBject_ForwardEpsEstimates": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/IntrinioForwardEpsEstimatesData" + }, + { + "$ref": "#/components/schemas/FMPForwardEpsEstimatesData" + } + ] + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_ForwardEpsEstimates", + "description": "OBBject with results of type ForwardEpsEstimates" + }, + "OBBject_ForwardPeEstimates": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/IntrinioForwardPeEstimatesData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_ForwardPeEstimates", + "description": "OBBject with results of type ForwardPeEstimates" + }, + "OBBject_ForwardSalesEstimates": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/IntrinioForwardSalesEstimatesData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_ForwardSalesEstimates", + "description": "OBBject with results of type ForwardSalesEstimates" + }, + "OBBject_FredRegional": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/FredRegionalData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50888,17 +57489,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FredSearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FredSearch" - } - } + "$ref": "#/components/schemas/FredSearchData" }, "type": "array" }, @@ -50907,10 +57498,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "FredSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50972,19 +57560,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FredSeries" + "$ref": "#/components/schemas/FredSeriesData" }, { - "$ref": "#/components/schemas/IntrinioFredSeries" + "$ref": "#/components/schemas/IntrinioFredSeriesData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FredSeries", - "intrinio": "#/components/schemas/IntrinioFredSeries" - } - } + ] }, "type": "array" }, @@ -50993,10 +57574,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "FredSeries" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51056,17 +57634,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDGdpForecast" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDGdpForecast" - } - } + "$ref": "#/components/schemas/OECDGdpForecastData" }, "type": "array" }, @@ -51075,10 +57643,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "GdpForecast" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51138,17 +57703,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDGdpNominal" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDGdpNominal" - } - } + "$ref": "#/components/schemas/OECDGdpNominalData" }, "type": "array" }, @@ -51157,10 +57712,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "GdpNominal" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51220,17 +57772,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDGdpReal" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDGdpReal" - } - } + "$ref": "#/components/schemas/OECDGdpRealData" }, "type": "array" }, @@ -51239,10 +57781,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "GdpReal" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51292,6 +57831,136 @@ "title": "OBBject_GdpReal", "description": "OBBject with results of type GdpReal" }, + "OBBject_GroupedComparisons": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "$ref": "#/components/schemas/GroupedComparisons" + }, + { + "type": "null" + } + ], + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_GroupedComparisons", + "description": "OBBject with results of type GroupedComparisons" + }, + "OBBject_GroupedFinancials": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "$ref": "#/components/schemas/GroupedFinancials" + }, + { + "type": "null" + } + ], + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_GroupedFinancials", + "description": "OBBject with results of type GroupedFinancials" + }, "OBBject_HighQualityMarketCorporateBond": { "properties": { "_id": { @@ -51302,17 +57971,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDHighQualityMarketCorporateBond" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDHighQualityMarketCorporateBond" - } - } + "$ref": "#/components/schemas/FREDHighQualityMarketCorporateBondData" }, "type": "array" }, @@ -51321,10 +57980,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HighQualityMarketCorporateBond" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51384,17 +58040,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioHistoricalAttributes" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioHistoricalAttributes" - } - } + "$ref": "#/components/schemas/IntrinioHistoricalAttributesData" }, "type": "array" }, @@ -51403,10 +58049,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HistoricalAttributes" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51468,19 +58111,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPHistoricalDividends" + "$ref": "#/components/schemas/FMPHistoricalDividendsData" }, { - "$ref": "#/components/schemas/IntrinioHistoricalDividends" + "$ref": "#/components/schemas/IntrinioHistoricalDividendsData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPHistoricalDividends", - "intrinio": "#/components/schemas/IntrinioHistoricalDividends" - } - } + ] }, "type": "array" }, @@ -51489,10 +58125,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HistoricalDividends" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51552,17 +58185,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPHistoricalEmployees" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPHistoricalEmployees" - } - } + "$ref": "#/components/schemas/FMPHistoricalEmployeesData" }, "type": "array" }, @@ -51571,10 +58194,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HistoricalEmployees" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51634,17 +58254,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPHistoricalEps" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPHistoricalEps" - } - } + "$ref": "#/components/schemas/FMPHistoricalEpsData" }, "type": "array" }, @@ -51653,10 +58263,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HistoricalEps" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51716,17 +58323,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPHistoricalSplits" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPHistoricalSplits" - } - } + "$ref": "#/components/schemas/FMPHistoricalSplitsData" }, "type": "array" }, @@ -51735,10 +58332,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HistoricalSplits" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51798,17 +58392,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDICEBofA" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDICEBofA" - } - } + "$ref": "#/components/schemas/FREDICEBofAData" }, "type": "array" }, @@ -51817,10 +58401,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ICEBofA" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51880,17 +58461,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDIORB" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDIORB" - } - } + "$ref": "#/components/schemas/FREDIORBData" }, "type": "array" }, @@ -51899,10 +58470,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "IORB" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51964,23 +58532,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPIncomeStatement" + "$ref": "#/components/schemas/FMPIncomeStatementData" }, { - "$ref": "#/components/schemas/IntrinioIncomeStatement" + "$ref": "#/components/schemas/PolygonIncomeStatementData" }, { - "$ref": "#/components/schemas/PolygonIncomeStatement" + "$ref": "#/components/schemas/IntrinioIncomeStatementData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPIncomeStatement", - "intrinio": "#/components/schemas/IntrinioIncomeStatement", - "polygon": "#/components/schemas/PolygonIncomeStatement" - } - } + ] }, "type": "array" }, @@ -51989,10 +58549,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "IncomeStatement" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52052,17 +58609,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPIncomeStatementGrowth" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPIncomeStatementGrowth" - } - } + "$ref": "#/components/schemas/FMPIncomeStatementGrowthData" }, "type": "array" }, @@ -52071,10 +58618,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "IncomeStatementGrowth" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52134,17 +58678,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPIndexConstituents" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPIndexConstituents" - } - } + "$ref": "#/components/schemas/FMPIndexConstituentsData" }, "type": "array" }, @@ -52153,10 +58687,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "IndexConstituents" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52218,23 +58749,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPIndexHistorical" + "$ref": "#/components/schemas/FMPIndexHistoricalData" }, { - "$ref": "#/components/schemas/IntrinioIndexHistorical" + "$ref": "#/components/schemas/PolygonIndexHistoricalData" }, { - "$ref": "#/components/schemas/PolygonIndexHistorical" + "$ref": "#/components/schemas/IntrinioIndexHistoricalData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPIndexHistorical", - "intrinio": "#/components/schemas/IntrinioIndexHistorical", - "polygon": "#/components/schemas/PolygonIndexHistorical" - } - } + ] }, "type": "array" }, @@ -52243,10 +58766,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "IndexHistorical" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52308,19 +58828,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPInsiderTrading" + "$ref": "#/components/schemas/IntrinioInsiderTradingData" }, { - "$ref": "#/components/schemas/IntrinioInsiderTrading" + "$ref": "#/components/schemas/FMPInsiderTradingData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPInsiderTrading", - "intrinio": "#/components/schemas/IntrinioInsiderTrading" - } - } + ] }, "type": "array" }, @@ -52329,10 +58842,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "InsiderTrading" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52392,17 +58902,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPInstitutionalOwnership" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPInstitutionalOwnership" - } - } + "$ref": "#/components/schemas/FMPInstitutionalOwnershipData" }, "type": "array" }, @@ -52411,10 +58911,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "InstitutionalOwnership" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52474,17 +58971,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/SecInstitutionsSearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecInstitutionsSearch" - } - } + "$ref": "#/components/schemas/SecInstitutionsSearchData" }, "type": "array" }, @@ -52493,10 +58980,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "InstitutionsSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52556,17 +59040,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPKeyExecutives" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPKeyExecutives" - } - } + "$ref": "#/components/schemas/FMPKeyExecutivesData" }, "type": "array" }, @@ -52575,10 +59049,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "KeyExecutives" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52640,19 +59111,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPKeyMetrics" + "$ref": "#/components/schemas/IntrinioKeyMetricsData" }, { - "$ref": "#/components/schemas/IntrinioKeyMetrics" + "$ref": "#/components/schemas/FMPKeyMetricsData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPKeyMetrics", - "intrinio": "#/components/schemas/IntrinioKeyMetrics" - } - } + ] }, "type": "array" }, @@ -52661,10 +59125,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "KeyMetrics" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52724,17 +59185,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDLTIR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDLTIR" - } - } + "$ref": "#/components/schemas/OECDLTIRData" }, "type": "array" }, @@ -52743,10 +59194,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "LTIR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52806,17 +59254,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioLatestAttributes" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioLatestAttributes" - } - } + "$ref": "#/components/schemas/IntrinioLatestAttributesData" }, "type": "array" }, @@ -52825,10 +59263,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "LatestAttributes" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52890,23 +59325,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPIndexHistorical" + "$ref": "#/components/schemas/FMPIndexHistoricalData" }, { - "$ref": "#/components/schemas/IntrinioIndexHistorical" + "$ref": "#/components/schemas/PolygonIndexHistoricalData" }, { - "$ref": "#/components/schemas/PolygonIndexHistorical" + "$ref": "#/components/schemas/IntrinioIndexHistoricalData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPIndexHistorical", - "intrinio": "#/components/schemas/IntrinioIndexHistorical", - "polygon": "#/components/schemas/PolygonIndexHistorical" - } - } + ] }, "type": "array" }, @@ -52915,10 +59342,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "MarketIndices" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52980,23 +59404,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPMarketSnapshots" + "$ref": "#/components/schemas/FMPMarketSnapshotsData" }, { - "$ref": "#/components/schemas/IntrinioMarketSnapshots" + "$ref": "#/components/schemas/PolygonMarketSnapshotsData" }, { - "$ref": "#/components/schemas/PolygonMarketSnapshots" + "$ref": "#/components/schemas/IntrinioMarketSnapshotsData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPMarketSnapshots", - "intrinio": "#/components/schemas/IntrinioMarketSnapshots", - "polygon": "#/components/schemas/PolygonMarketSnapshots" - } - } + ] }, "type": "array" }, @@ -53005,10 +59421,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "MarketSnapshots" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53068,17 +59481,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FederalReserveMoneyMeasures" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "federal_reserve": "#/components/schemas/FederalReserveMoneyMeasures" - } - } + "$ref": "#/components/schemas/FederalReserveMoneyMeasuresData" }, "type": "array" }, @@ -53087,10 +59490,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "MoneyMeasures" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53150,17 +59550,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDMoodyCorporateBondIndex" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDMoodyCorporateBondIndex" - } - } + "$ref": "#/components/schemas/FREDMoodyCorporateBondIndexData" }, "type": "array" }, @@ -53169,10 +59559,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "MoodyCorporateBondIndex" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53232,17 +59619,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioOptionsChains" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioOptionsChains" - } - } + "$ref": "#/components/schemas/IntrinioOptionsChainsData" }, "type": "array" }, @@ -53251,10 +59628,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "OptionsChains" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53314,17 +59688,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioOptionsUnusual" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioOptionsUnusual" - } - } + "$ref": "#/components/schemas/IntrinioOptionsUnusualData" }, "type": "array" }, @@ -53333,10 +59697,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "OptionsUnusual" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53396,17 +59757,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDPROJECTION" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDPROJECTION" - } - } + "$ref": "#/components/schemas/FREDPROJECTIONData" }, "type": "array" }, @@ -53415,10 +59766,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "PROJECTIONS" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53478,17 +59826,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPPricePerformance" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPPricePerformance" - } - } + "$ref": "#/components/schemas/FMPPricePerformanceData" }, "type": "array" }, @@ -53497,10 +59835,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "PricePerformance" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53562,19 +59897,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/BenzingaPriceTarget" + "$ref": "#/components/schemas/BenzingaPriceTargetData" }, { - "$ref": "#/components/schemas/FMPPriceTarget" + "$ref": "#/components/schemas/FMPPriceTargetData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "benzinga": "#/components/schemas/BenzingaPriceTarget", - "fmp": "#/components/schemas/FMPPriceTarget" - } - } + ] }, "type": "array" }, @@ -53583,10 +59911,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "PriceTarget" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53648,15 +59973,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPPriceTargetConsensus" + "$ref": "#/components/schemas/FMPPriceTargetConsensusData" + }, + { + "$ref": "#/components/schemas/IntrinioPriceTargetConsensusData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPPriceTargetConsensus" - } - } + ] }, "type": "array" }, @@ -53665,10 +59987,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "PriceTargetConsensus" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53718,6 +60037,75 @@ "title": "OBBject_PriceTargetConsensus", "description": "OBBject with results of type PriceTargetConsensus" }, + "OBBject_ProKeyMetrics": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/ProKeyMetrics" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_ProKeyMetrics", + "description": "OBBject with results of type ProKeyMetrics" + }, "OBBject_ReportedFinancials": { "properties": { "_id": { @@ -53728,17 +60116,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioReportedFinancials" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioReportedFinancials" - } - } + "$ref": "#/components/schemas/IntrinioReportedFinancialsData" }, "type": "array" }, @@ -53747,10 +60125,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ReportedFinancials" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53810,17 +60185,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPRevenueBusinessLine" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPRevenueBusinessLine" - } - } + "$ref": "#/components/schemas/FMPRevenueBusinessLineData" }, "type": "array" }, @@ -53829,10 +60194,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "RevenueBusinessLine" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53892,17 +60254,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPRevenueGeographic" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPRevenueGeographic" - } - } + "$ref": "#/components/schemas/FMPRevenueGeographicData" }, "type": "array" }, @@ -53911,10 +60263,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "RevenueGeographic" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53974,17 +60323,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPRiskPremium" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPRiskPremium" - } - } + "$ref": "#/components/schemas/FMPRiskPremiumData" }, "type": "array" }, @@ -53993,10 +60332,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "RiskPremium" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54056,17 +60392,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/SecRssLitigation" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecRssLitigation" - } - } + "$ref": "#/components/schemas/SecRssLitigationData" }, "type": "array" }, @@ -54075,10 +60401,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "RssLitigation" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54138,17 +60461,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDSOFR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDSOFR" - } - } + "$ref": "#/components/schemas/FREDSOFRData" }, "type": "array" }, @@ -54157,10 +60470,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SOFR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54220,17 +60530,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDSONIA" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDSONIA" - } - } + "$ref": "#/components/schemas/FREDSONIAData" }, "type": "array" }, @@ -54239,10 +60539,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SONIA" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54302,17 +60599,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDSTIR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDSTIR" - } - } + "$ref": "#/components/schemas/OECDSTIRData" }, "type": "array" }, @@ -54321,10 +60608,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "STIR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54383,27 +60667,13 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/SecSchemaFiles" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecSchemaFiles" - } - } + "$ref": "#/components/schemas/SecSchemaFilesData" }, { "type": "null" } ], - "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "SchemaFiles" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54463,17 +60733,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioSearchAttributes" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioSearchAttributes" - } - } + "$ref": "#/components/schemas/IntrinioSearchAttributesData" }, "type": "array" }, @@ -54482,10 +60742,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SearchAttributes" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54545,17 +60802,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDSelectedTreasuryBill" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDSelectedTreasuryBill" - } - } + "$ref": "#/components/schemas/FREDSelectedTreasuryBillData" }, "type": "array" }, @@ -54564,10 +60811,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SelectedTreasuryBill" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54627,17 +60871,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDSelectedTreasuryConstantMaturity" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDSelectedTreasuryConstantMaturity" - } - } + "$ref": "#/components/schemas/FREDSelectedTreasuryConstantMaturityData" }, "type": "array" }, @@ -54646,10 +60880,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SelectedTreasuryConstantMaturity" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54711,19 +60942,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPShareStatistics" + "$ref": "#/components/schemas/IntrinioShareStatisticsData" }, { - "$ref": "#/components/schemas/IntrinioShareStatistics" + "$ref": "#/components/schemas/FMPShareStatisticsData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPShareStatistics", - "intrinio": "#/components/schemas/IntrinioShareStatistics" - } - } + ] }, "type": "array" }, @@ -54732,10 +60956,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ShareStatistics" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54795,17 +61016,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/SecSicSearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecSicSearch" - } - } + "$ref": "#/components/schemas/SecSicSearchData" }, "type": "array" }, @@ -54814,10 +61025,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SicSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54877,17 +61085,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDSpotRate" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDSpotRate" - } - } + "$ref": "#/components/schemas/FREDSpotRateData" }, "type": "array" }, @@ -54896,10 +61094,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SpotRate" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54958,27 +61153,13 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/SecSymbolMap" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecSymbolMap" - } - } + "$ref": "#/components/schemas/SecSymbolMapData" }, { "type": "null" } ], - "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "SymbolMap" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55038,17 +61219,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDTreasuryConstantMaturity" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDTreasuryConstantMaturity" - } - } + "$ref": "#/components/schemas/FREDTreasuryConstantMaturityData" }, "type": "array" }, @@ -55057,10 +61228,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "TreasuryConstantMaturity" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55122,19 +61290,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FederalReserveTreasuryRates" + "$ref": "#/components/schemas/FMPTreasuryRatesData" }, { - "$ref": "#/components/schemas/FMPTreasuryRates" + "$ref": "#/components/schemas/FederalReserveTreasuryRatesData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "federal_reserve": "#/components/schemas/FederalReserveTreasuryRates", - "fmp": "#/components/schemas/FMPTreasuryRates" - } - } + ] }, "type": "array" }, @@ -55143,10 +61304,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "TreasuryRates" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55206,17 +61364,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDYieldCurve" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDYieldCurve" - } - } + "$ref": "#/components/schemas/openbb_fred__models__us_yield_curve__FREDYieldCurveData" }, "type": "array" }, @@ -55225,10 +61373,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "USYieldCurve" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55288,17 +61433,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDUnemployment" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDUnemployment" - } - } + "$ref": "#/components/schemas/OECDUnemploymentData" }, "type": "array" }, @@ -55307,10 +61442,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "Unemployment" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55360,6 +61492,75 @@ "title": "OBBject_Unemployment", "description": "OBBject with results of type Unemployment" }, + "OBBject_Watchlist": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Watchlist" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_Watchlist", + "description": "OBBject with results of type Watchlist" + }, "OBBject_WorldNews": { "properties": { "_id": { @@ -55372,23 +61573,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/BenzingaWorldNews" + "$ref": "#/components/schemas/IntrinioWorldNewsData" }, { - "$ref": "#/components/schemas/FMPWorldNews" + "$ref": "#/components/schemas/BenzingaWorldNewsData" }, { - "$ref": "#/components/schemas/IntrinioWorldNews" + "$ref": "#/components/schemas/FMPWorldNewsData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "benzinga": "#/components/schemas/BenzingaWorldNews", - "fmp": "#/components/schemas/FMPWorldNews", - "intrinio": "#/components/schemas/IntrinioWorldNews" - } - } + ] }, "type": "array" }, @@ -55397,10 +61590,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "WorldNews" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55450,7 +61640,161 @@ "title": "OBBject_WorldNews", "description": "OBBject with results of type WorldNews" }, - "OECDCLI": { + "OBBject_YieldCurve": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/FMPYieldCurveData" + }, + { + "$ref": "#/components/schemas/openbb_fred__models__yield_curve__FREDYieldCurveData" + }, + { + "$ref": "#/components/schemas/EconDbYieldCurveData" + }, + { + "$ref": "#/components/schemas/FederalReserveYieldCurveData" + }, + { + "$ref": "#/components/schemas/ECBYieldCurveData" + } + ] + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_YieldCurve", + "description": "OBBject with results of type YieldCurve" + }, + "OBBject_list_NixtlaTimegenData__": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/NixtlaTimegenData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject[T]", + "description": "OBBject" + }, + "OECDCLIData": { "properties": { "date": { "anyOf": [ @@ -55492,10 +61836,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDCLI", + "title": "OECDCLIData", "description": "OECD CLI Data." }, - "OECDGdpForecast": { + "OECDGdpForecastData": { "properties": { "date": { "anyOf": [ @@ -55525,10 +61869,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDGdpForecast", + "title": "OECDGdpForecastData", "description": "OECD GDP Forecast Data." }, - "OECDGdpNominal": { + "OECDGdpNominalData": { "properties": { "date": { "anyOf": [ @@ -55558,10 +61902,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDGdpNominal", + "title": "OECDGdpNominalData", "description": "OECD Nominal GDP Data." }, - "OECDGdpReal": { + "OECDGdpRealData": { "properties": { "date": { "anyOf": [ @@ -55591,10 +61935,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDGdpReal", + "title": "OECDGdpRealData", "description": "OECD Real GDP Data." }, - "OECDLTIR": { + "OECDLTIRData": { "properties": { "date": { "anyOf": [ @@ -55636,10 +61980,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDLTIR", + "title": "OECDLTIRData", "description": "OECD Long Term Interest Rate Data." }, - "OECDSTIR": { + "OECDSTIRData": { "properties": { "date": { "anyOf": [ @@ -55681,10 +62025,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDSTIR", + "title": "OECDSTIRData", "description": "OECD Short Term Interest Rate Data." }, - "OECDUnemployment": { + "OECDUnemploymentData": { "properties": { "date": { "anyOf": [ @@ -55726,7 +62070,7 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDUnemployment", + "title": "OECDUnemploymentData", "description": "OECD Unemployment Data." }, "OpenBBErrorResponse": { @@ -55748,7 +62092,7 @@ "title": "OpenBBErrorResponse", "description": "OpenBB Error Response." }, - "PolygonBalanceSheet": { + "PolygonBalanceSheetData": { "properties": { "period_ending": { "type": "string", @@ -56134,10 +62478,10 @@ "required": [ "period_ending" ], - "title": "PolygonBalanceSheet", + "title": "PolygonBalanceSheetData", "description": "Polygon Balance Sheet Statement Data." }, - "PolygonCashFlowStatement": { + "PolygonCashFlowStatementData": { "properties": { "period_ending": { "type": "string", @@ -56331,10 +62675,10 @@ "required": [ "period_ending" ], - "title": "PolygonCashFlowStatement", + "title": "PolygonCashFlowStatementData", "description": "Polygon Cash Flow Statement Data." }, - "PolygonCompanyNews": { + "PolygonCompanyNewsData": { "properties": { "date": { "type": "string", @@ -56453,10 +62797,10 @@ "id", "publisher" ], - "title": "PolygonCompanyNews", + "title": "PolygonCompanyNewsData", "description": "Polygon Company News Data." }, - "PolygonCryptoHistorical": { + "PolygonCryptoHistoricalData": { "properties": { "date": { "anyOf": [ @@ -56514,7 +62858,7 @@ "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, - "transactions": { + "n": { "anyOf": [ { "type": "integer", @@ -56524,7 +62868,7 @@ "type": "null" } ], - "title": "Transactions", + "title": "N", "description": "Number of transactions for the symbol in the time period." } }, @@ -56538,10 +62882,10 @@ "close", "volume" ], - "title": "PolygonCryptoHistorical", + "title": "PolygonCryptoHistoricalData", "description": "Polygon Crypto Historical Price Data." }, - "PolygonCurrencyHistorical": { + "PolygonCurrencyHistoricalData": { "properties": { "date": { "anyOf": [ @@ -56629,26 +62973,28 @@ "low", "close" ], - "title": "PolygonCurrencyHistorical", + "title": "PolygonCurrencyHistoricalData", "description": "Polygon Currency Historical Price Data." }, - "PolygonCurrencyPairs": { + "PolygonCurrencyPairsData": { "properties": { - "name": { + "symbol": { "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Name", "description": "Name of the currency pair." }, - "market": { - "type": "string", - "title": "Market", - "description": "Name of the trading market. Always 'fx'." - }, - "locale": { - "type": "string", - "title": "Locale", - "description": "Locale of the currency pair." - }, "currency_symbol": { "anyOf": [ { @@ -56661,18 +63007,6 @@ "title": "Currency Symbol", "description": "The symbol of the quote currency." }, - "currency_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Currency Name", - "description": "Name of the quote currency." - }, "base_currency_symbol": { "anyOf": [ { @@ -56697,13 +63031,349 @@ "title": "Base Currency Name", "description": "Name of the base currency." }, - "last_updated_utc": { + "market": { "type": "string", - "format": "date-time", - "title": "Last Updated Utc", - "description": "The last updated timestamp in UTC." + "title": "Market", + "description": "Name of the trading market. Always 'fx'." }, - "delisted_utc": { + "locale": { + "type": "string", + "title": "Locale", + "description": "Locale of the currency pair." + }, + "last_updated": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Last Updated", + "description": "The date the reference data was last updated." + }, + "delisted": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Delisted", + "description": "The date the item was delisted." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "market", + "locale" + ], + "title": "PolygonCurrencyPairsData", + "description": "Polygon Currency Available Pairs Data." + }, + "PolygonCurrencySnapshotsData": { + "properties": { + "base_currency": { + "type": "string", + "title": "Base Currency", + "description": "The base, or domestic, currency." + }, + "counter_currency": { + "type": "string", + "title": "Counter Currency", + "description": "The counter, or foreign, currency." + }, + "last_rate": { + "type": "number", + "title": "Last Rate", + "description": "The exchange rate, relative to the base currency. Rates are expressed as the amount of foreign currency received from selling one unit of the base currency, or the quantity of foreign currency required to purchase one unit of the domestic currency. To inverse the perspective, set the 'quote_type' parameter as 'direct'." + }, + "open": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Open", + "description": "The open price." + }, + "high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "High", + "description": "The high price." + }, + "low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Low", + "description": "The low price." + }, + "close": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Close", + "description": "The close price." + }, + "volume": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Volume", + "description": "The trading volume." + }, + "prev_close": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev Close", + "description": "The previous close price." + }, + "vwap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Vwap", + "description": "The volume-weighted average price." + }, + "change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Change", + "description": "The change in price from the previous day." + }, + "change_percent": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Change Percent", + "description": "The percentage change in price from the previous day.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "prev_open": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev Open", + "description": "The previous day's opening price." + }, + "prev_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev High", + "description": "The previous day's high price." + }, + "prev_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev Low", + "description": "The previous day's low price." + }, + "prev_volume": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev Volume", + "description": "The previous day's volume." + }, + "prev_vwap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev Vwap", + "description": "The previous day's VWAP." + }, + "bid": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Bid", + "description": "The current bid price." + }, + "ask": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ask", + "description": "The current ask price." + }, + "minute_open": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Open", + "description": "The open price from the most recent minute bar." + }, + "minute_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute High", + "description": "The high price from the most recent minute bar." + }, + "minute_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Low", + "description": "The low price from the most recent minute bar." + }, + "minute_close": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Close", + "description": "The close price from the most recent minute bar." + }, + "minute_volume": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Volume", + "description": "The volume from the most recent minute bar." + }, + "minute_vwap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Vwap", + "description": "The VWAP from the most recent minute bar." + }, + "minute_transactions": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Transactions", + "description": "The number of transactions in the most recent minute bar." + }, + "quote_timestamp": { "anyOf": [ { "type": "string", @@ -56713,22 +63383,48 @@ "type": "null" } ], - "title": "Delisted Utc", - "description": "The delisted timestamp in UTC." + "title": "Quote Timestamp", + "description": "The timestamp of the last quote." + }, + "minute_timestamp": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Minute Timestamp", + "description": "The timestamp for the start of the most recent minute bar." + }, + "last_updated": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Updated", + "description": "The last time the data was updated." } }, "additionalProperties": true, "type": "object", "required": [ - "name", - "market", - "locale", - "last_updated_utc" + "base_currency", + "counter_currency", + "last_rate", + "last_updated" ], - "title": "PolygonCurrencyPairs", - "description": "Polygon Currency Available Pairs Data." + "title": "PolygonCurrencySnapshotsData", + "description": "Polygon Currency Snapshots Data." }, - "PolygonEquityHistorical": { + "PolygonEquityHistoricalData": { "properties": { "date": { "anyOf": [ @@ -56791,7 +63487,7 @@ "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, - "transactions": { + "n": { "anyOf": [ { "type": "integer", @@ -56801,7 +63497,7 @@ "type": "null" } ], - "title": "Transactions", + "title": "N", "description": "Number of transactions for the symbol in the time period." } }, @@ -56814,10 +63510,10 @@ "low", "close" ], - "title": "PolygonEquityHistorical", + "title": "PolygonEquityHistoricalData", "description": "Polygon Equity Historical Price Data." }, - "PolygonEquityNBBO": { + "PolygonEquityNBBOData": { "properties": { "ask_exchange": { "type": "string", @@ -56849,7 +63545,7 @@ "title": "Bid Exchange", "description": "The exchange ID for the bid." }, - "tape": { + "tape_integer": { "anyOf": [ { "type": "string" @@ -56858,7 +63554,7 @@ "type": "null" } ], - "title": "Tape", + "title": "Tape Integer", "description": "The exchange tape." }, "conditions": { @@ -56900,7 +63596,7 @@ "title": "Indicators", "description": "A list of indicator codes." }, - "sequence_num": { + "sequence_number": { "anyOf": [ { "type": "integer" @@ -56909,7 +63605,7 @@ "type": "null" } ], - "title": "Sequence Num", + "title": "Sequence Number", "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)" }, "participant_timestamp": { @@ -56962,10 +63658,10 @@ "bid", "bid_exchange" ], - "title": "PolygonEquityNBBO", + "title": "PolygonEquityNBBOData", "description": "Polygon Equity NBBO data." }, - "PolygonIncomeStatement": { + "PolygonIncomeStatementData": { "properties": { "period_ending": { "type": "string", @@ -57519,10 +64215,10 @@ "required": [ "period_ending" ], - "title": "PolygonIncomeStatement", + "title": "PolygonIncomeStatementData", "description": "Polygon Income Statement Data." }, - "PolygonIndexHistorical": { + "PolygonIndexHistoricalData": { "properties": { "date": { "anyOf": [ @@ -57598,7 +64294,7 @@ "title": "Volume", "description": "The trading volume." }, - "transactions": { + "n": { "anyOf": [ { "type": "integer", @@ -57608,7 +64304,7 @@ "type": "null" } ], - "title": "Transactions", + "title": "N", "description": "Number of transactions for the symbol in the time period." } }, @@ -57617,10 +64313,10 @@ "required": [ "date" ], - "title": "PolygonIndexHistorical", + "title": "PolygonIndexHistoricalData", "description": "Polygon Index Historical Data." }, - "PolygonMarketSnapshots": { + "PolygonMarketSnapshotsData": { "properties": { "symbol": { "type": "string", @@ -57942,7 +64638,7 @@ "symbol", "last_updated" ], - "title": "PolygonMarketSnapshots", + "title": "PolygonMarketSnapshotsData", "description": "Polygon Market Snapshots Data." }, "PolygonPublisher": { @@ -57978,13 +64674,45 @@ "title": "PolygonPublisher", "description": "PolygonPublisher Data Model." }, - "SecCikMap": { + "PossibleYears": { "properties": { - "cik": { + "calendar_year": { "anyOf": [ { "type": "integer" }, + { + "type": "null" + } + ], + "title": "Calendar Year", + "description": "Calendar year." + }, + "periods": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Periods", + "description": "Periods." + } + }, + "additionalProperties": true, + "type": "object", + "title": "PossibleYears", + "description": "Possible Financial Years." + }, + "PostSearchParams": { + "properties": { + "q": { + "anyOf": [ { "type": "string" }, @@ -57992,16 +64720,272 @@ "type": "null" } ], + "title": "Q", + "default": "" + }, + "type": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/FilterTypes" + }, + "type": "array" + }, + { + "$ref": "#/components/schemas/FilterTypes" + }, + { + "type": "null" + } + ], + "title": "Type" + }, + "ignore_type": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/IgnoreTypes" + }, + "type": "array" + }, + { + "$ref": "#/components/schemas/IgnoreTypes" + }, + { + "type": "null" + } + ], + "title": "Ignore Type" + }, + "limit": { + "type": "integer", + "minimum": 1.0, + "title": "Limit", + "default": 25 + } + }, + "type": "object", + "title": "PostSearchParams", + "description": "Query Symbols Params." + }, + "ProKeyMetrics": { + "properties": { + "market_cap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Market Cap", + "description": "Market cap." + }, + "beta": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Beta", + "description": "Beta of the stock relative to the market." + }, + "day_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Day High", + "description": "Day high." + }, + "day_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Day Low", + "description": "Day low." + }, + "avg_volume": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Avg Volume", + "description": "Average volume over the last 10 trading days." + }, + "year_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year High", + "description": "52-week high of the stock price." + }, + "year_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year Low", + "description": "52-week low of the stock price." + }, + "dividend_yield_ttm": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dividend Yield Ttm", + "description": "Dividend yield trailing twelve months." + }, + "pe_ratio_ttm": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Pe Ratio Ttm", + "description": "Price earnings ratio trailing twelve months." + }, + "portfolio_turnover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Portfolio Turnover", + "description": "Portfolio turnover.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "net_asset_value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Asset Value", + "description": "Net asset value." + }, + "number_of_holdings": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Of Holdings", + "description": "Number of holdings." + }, + "net_expense_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Expense Ratio", + "description": "Net expense ratio.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "volume_avg_30": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Volume Avg 30", + "description": "One month average daily volume." + }, + "one_month": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "One Month", + "description": "One month performance.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "title": "ProKeyMetrics", + "description": "Pro Key Metrics Data." + }, + "SecCikMapData": { + "properties": { + "cik": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Cik", "description": "Central Index Key (CIK) for the requested entity." } }, "additionalProperties": true, "type": "object", - "title": "SecCikMap", + "title": "SecCikMapData", "description": "SEC CIK Mapping Data." }, - "SecCompanyFilings": { + "SecCompanyFilingsData": { "properties": { "filing_date": { "type": "string", @@ -58075,7 +65059,7 @@ "title": "Report Url", "description": "URL to the actual report." }, - "report_date": { + "reportDate": { "anyOf": [ { "type": "string", @@ -58085,7 +65069,7 @@ "type": "null" } ], - "title": "Report Date", + "title": "Reportdate", "description": "The date of the filing." }, "act": { @@ -58118,7 +65102,7 @@ "title": "Items", "description": "The SEC Item numbers." }, - "primary_doc_description": { + "primaryDocDescription": { "anyOf": [ { "type": "string" @@ -58127,10 +65111,10 @@ "type": "null" } ], - "title": "Primary Doc Description", + "title": "Primarydocdescription", "description": "The description of the primary document." }, - "primary_doc": { + "primaryDocument": { "anyOf": [ { "type": "string" @@ -58139,10 +65123,10 @@ "type": "null" } ], - "title": "Primary Doc", + "title": "Primarydocument", "description": "The filename of the primary document." }, - "accession_number": { + "accessionNumber": { "anyOf": [ { "type": "string" @@ -58154,10 +65138,10 @@ "type": "null" } ], - "title": "Accession Number", + "title": "Accessionnumber", "description": "The accession number." }, - "file_number": { + "fileNumber": { "anyOf": [ { "type": "string" @@ -58169,10 +65153,10 @@ "type": "null" } ], - "title": "File Number", + "title": "Filenumber", "description": "The file number." }, - "film_number": { + "filmNumber": { "anyOf": [ { "type": "string" @@ -58184,10 +65168,10 @@ "type": "null" } ], - "title": "Film Number", + "title": "Filmnumber", "description": "The film number." }, - "is_inline_xbrl": { + "isInlineXBRL": { "anyOf": [ { "type": "string" @@ -58199,10 +65183,10 @@ "type": "null" } ], - "title": "Is Inline Xbrl", + "title": "Isinlinexbrl", "description": "Whether the filing is an inline XBRL filing." }, - "is_xbrl": { + "isXBRL": { "anyOf": [ { "type": "string" @@ -58214,7 +65198,7 @@ "type": "null" } ], - "title": "Is Xbrl", + "title": "Isxbrl", "description": "Whether the filing is an XBRL filing." }, "size": { @@ -58232,7 +65216,7 @@ "title": "Size", "description": "The size of the filing." }, - "complete_submission_url": { + "completeSubmissionUrl": { "anyOf": [ { "type": "string" @@ -58241,10 +65225,10 @@ "type": "null" } ], - "title": "Complete Submission Url", + "title": "Completesubmissionurl", "description": "The URL to the complete filing submission." }, - "filing_detail_url": { + "filingDetailUrl": { "anyOf": [ { "type": "string" @@ -58253,7 +65237,7 @@ "type": "null" } ], - "title": "Filing Detail Url", + "title": "Filingdetailurl", "description": "The URL to the filing details." } }, @@ -58263,10 +65247,179 @@ "filing_date", "report_url" ], - "title": "SecCompanyFilings", + "title": "SecCompanyFilingsData", "description": "SEC Company Filings Data." }, - "SecEquityFtd": { + "SecCompareCompanyFactsData": { + "properties": { + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the entity." + }, + "value": { + "type": "number", + "title": "Value", + "description": "The reported value of the fact or concept." + }, + "reported_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Reported Date", + "description": "The date when the report was filed." + }, + "period_beginning": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Period Beginning", + "description": "The start date of the reporting period." + }, + "period_ending": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Period Ending", + "description": "The end date of the reporting period." + }, + "fiscal_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fiscal Year", + "description": "The fiscal year." + }, + "fiscal_period": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Fiscal Period", + "description": "The fiscal period of the fiscal year." + }, + "cik": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." + }, + "location": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Location", + "description": "Geographic location of the reporting entity." + }, + "form": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Form", + "description": "The SEC form associated with the fact or concept." + }, + "frame": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Frame", + "description": "The frame ID associated with the fact or concept, if applicable." + }, + "accession": { + "type": "string", + "title": "Accession", + "description": "SEC filing accession number associated with the reported fact or concept." + }, + "fact": { + "type": "string", + "title": "Fact", + "description": "The display name of the fact or concept." + }, + "unit": { + "type": "string", + "title": "Unit", + "description": "The unit of measurement for the fact or concept." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "value", + "cik", + "accession", + "fact" + ], + "title": "SecCompareCompanyFactsData", + "description": "SEC Compare Company Facts Data." + }, + "SecEquityFtdData": { "properties": { "settlement_date": { "anyOf": [ @@ -58344,10 +65497,10 @@ }, "additionalProperties": true, "type": "object", - "title": "SecEquityFtd", + "title": "SecEquityFtdData", "description": "SEC Equity FTD Data." }, - "SecEquitySearch": { + "SecEquitySearchData": { "properties": { "symbol": { "anyOf": [ @@ -58370,7 +65523,8 @@ "type": "null" } ], - "title": "Name" + "title": "Name", + "description": "Name of the company." }, "cik": { "type": "string", @@ -58383,10 +65537,10 @@ "required": [ "cik" ], - "title": "SecEquitySearch", + "title": "SecEquitySearchData", "description": "SEC Equity Search Data." }, - "SecEtfHoldings": { + "SecEtfHoldingsData": { "properties": { "symbol": { "anyOf": [ @@ -58472,7 +65626,7 @@ "title": "Balance", "description": "The balance of the holding." }, - "weight": { + "pctVal": { "anyOf": [ { "type": "number" @@ -58481,10 +65635,12 @@ "type": "null" } ], - "title": "Weight", - "description": "The weight of the holding in ETF in %." + "title": "Pctval", + "description": "The weight of the holding in ETF in %.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "value": { + "valUSD": { "anyOf": [ { "type": "number" @@ -58493,10 +65649,10 @@ "type": "null" } ], - "title": "Value", + "title": "Valusd", "description": "The value of the holding in USD." }, - "payoff_profile": { + "payoffProfile": { "anyOf": [ { "type": "string" @@ -58505,7 +65661,7 @@ "type": "null" } ], - "title": "Payoff Profile", + "title": "Payoffprofile", "description": "The payoff profile of the holding." }, "units": { @@ -58523,7 +65679,7 @@ "title": "Units", "description": "The units of the holding." }, - "currency": { + "curCd": { "anyOf": [ { "type": "string" @@ -58532,10 +65688,10 @@ "type": "null" } ], - "title": "Currency", + "title": "Curcd", "description": "The currency of the holding." }, - "asset_category": { + "assetCat": { "anyOf": [ { "type": "string" @@ -58544,10 +65700,10 @@ "type": "null" } ], - "title": "Asset Category", + "title": "Assetcat", "description": "The asset category of the holding." }, - "issuer_category": { + "issuerCat": { "anyOf": [ { "type": "string" @@ -58556,10 +65712,10 @@ "type": "null" } ], - "title": "Issuer Category", + "title": "Issuercat", "description": "The issuer category of the holding." }, - "country": { + "invCountry": { "anyOf": [ { "type": "string" @@ -58568,10 +65724,10 @@ "type": "null" } ], - "title": "Country", + "title": "Invcountry", "description": "The country of the holding." }, - "is_restricted": { + "isRestrictedSec": { "anyOf": [ { "type": "string" @@ -58580,10 +65736,10 @@ "type": "null" } ], - "title": "Is Restricted", + "title": "Isrestrictedsec", "description": "Whether the holding is restricted." }, - "fair_value_level": { + "fairValLevel": { "anyOf": [ { "type": "integer" @@ -58592,10 +65748,10 @@ "type": "null" } ], - "title": "Fair Value Level", + "title": "Fairvallevel", "description": "The fair value level of the holding." }, - "is_cash_collateral": { + "isCashCollateral": { "anyOf": [ { "type": "string" @@ -58604,10 +65760,10 @@ "type": "null" } ], - "title": "Is Cash Collateral", + "title": "Iscashcollateral", "description": "Whether the holding is cash collateral." }, - "is_non_cash_collateral": { + "isNonCashCollateral": { "anyOf": [ { "type": "string" @@ -58616,10 +65772,10 @@ "type": "null" } ], - "title": "Is Non Cash Collateral", + "title": "Isnoncashcollateral", "description": "Whether the holding is non-cash collateral." }, - "is_loan_by_fund": { + "isLoanByFund": { "anyOf": [ { "type": "string" @@ -58628,10 +65784,10 @@ "type": "null" } ], - "title": "Is Loan By Fund", + "title": "Isloanbyfund", "description": "Whether the holding is loan by fund." }, - "loan_value": { + "loanVal": { "anyOf": [ { "type": "number" @@ -58640,7 +65796,7 @@ "type": "null" } ], - "title": "Loan Value", + "title": "Loanval", "description": "The loan value of the holding." }, "issuer_conditional": { @@ -58714,7 +65870,9 @@ } ], "title": "Annualized Return", - "description": "The annualized return on the debt security." + "description": "The annualized return on the debt security.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "is_default": { "anyOf": [ @@ -58886,7 +66044,7 @@ } ], "title": "Rate Type Rec", - "description": "The type of rate for reveivable portion of the swap." + "description": "The type of rate for receivable portion of the swap." }, "receive_currency": { "anyOf": [ @@ -58922,7 +66080,7 @@ } ], "title": "Floating Rate Index Rec", - "description": "The floating rate index for reveivable portion of the swap." + "description": "The floating rate index for receivable portion of the swap." }, "floating_rate_spread_rec": { "anyOf": [ @@ -58946,7 +66104,7 @@ } ], "title": "Rate Tenor Rec", - "description": "The rate tenor for reveivable portion of the swap." + "description": "The rate tenor for receivable portion of the swap." }, "rate_tenor_unit_rec": { "anyOf": [ @@ -58961,7 +66119,7 @@ } ], "title": "Rate Tenor Unit Rec", - "description": "The rate tenor unit for reveivable portion of the swap." + "description": "The rate tenor unit for receivable portion of the swap." }, "reset_date_rec": { "anyOf": [ @@ -58973,7 +66131,7 @@ } ], "title": "Reset Date Rec", - "description": "The reset date for reveivable portion of the swap." + "description": "The reset date for receivable portion of the swap." }, "reset_date_unit_rec": { "anyOf": [ @@ -58988,7 +66146,7 @@ } ], "title": "Reset Date Unit Rec", - "description": "The reset date unit for reveivable portion of the swap." + "description": "The reset date unit for receivable portion of the swap." }, "rate_type_pmnt": { "anyOf": [ @@ -59311,10 +66469,10 @@ }, "additionalProperties": true, "type": "object", - "title": "SecEtfHoldings", + "title": "SecEtfHoldingsData", "description": "SEC ETF Holdings Data." }, - "SecForm13FHR": { + "SecForm13FHRData": { "properties": { "period_ending": { "type": "string", @@ -59434,12 +66592,12 @@ "value", "weight" ], - "title": "SecForm13FHR", + "title": "SecForm13FHRData", "description": "SEC Form 13F-HR Data." }, - "SecInstitutionsSearch": { + "SecInstitutionsSearchData": { "properties": { - "name": { + "Institution": { "anyOf": [ { "type": "string" @@ -59448,10 +66606,10 @@ "type": "null" } ], - "title": "Name", + "title": "Institution", "description": "The name of the institution." }, - "cik": { + "CIK Number": { "anyOf": [ { "type": "string" @@ -59463,21 +66621,21 @@ "type": "null" } ], - "title": "Cik", + "title": "Cik Number", "description": "Central Index Key (CIK)" } }, "additionalProperties": true, "type": "object", - "title": "SecInstitutionsSearch", + "title": "SecInstitutionsSearchData", "description": "SEC Institutions Search Data." }, - "SecRssLitigation": { + "SecRssLitigationData": { "properties": { - "published": { + "date": { "type": "string", "format": "date-time", - "title": "Published", + "title": "Date", "description": "The date of publication." }, "title": { @@ -59504,16 +66662,16 @@ "additionalProperties": true, "type": "object", "required": [ - "published", + "date", "title", "summary", "id", "link" ], - "title": "SecRssLitigation", + "title": "SecRssLitigationData", "description": "SEC Litigation RSS Feed Data." }, - "SecSchemaFiles": { + "SecSchemaFilesData": { "properties": { "files": { "items": { @@ -59529,22 +66687,22 @@ "required": [ "files" ], - "title": "SecSchemaFiles", + "title": "SecSchemaFilesData", "description": "SEC Schema Files List Data." }, - "SecSicSearch": { + "SecSicSearchData": { "properties": { - "sic": { + "SIC Code": { "type": "integer", - "title": "Sic", + "title": "Sic Code", "description": "Sector Industrial Code (SIC)" }, - "industry": { + "Industry Title": { "type": "string", - "title": "Industry", + "title": "Industry Title", "description": "Industry title." }, - "office": { + "Office": { "type": "string", "title": "Office", "description": "Reporting office within the Corporate Finance Office" @@ -59553,14 +66711,14 @@ "additionalProperties": true, "type": "object", "required": [ - "sic", - "industry", - "office" + "SIC Code", + "Industry Title", + "Office" ], - "title": "SecSicSearch", + "title": "SecSicSearchData", "description": "SEC Standard Industrial Classification Code (SIC) Data." }, - "SecSymbolMap": { + "SecSymbolMapData": { "properties": { "symbol": { "type": "string", @@ -59573,10 +66731,10 @@ "required": [ "symbol" ], - "title": "SecSymbolMap", + "title": "SecSymbolMapData", "description": "SEC symbol map Data." }, - "TEEconomicCalendar": { + "TEEconomicCalendarData": { "properties": { "date": { "anyOf": [ @@ -59603,6 +66761,18 @@ "title": "Country", "description": "Country of event." }, + "category": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Category", + "description": "Category of event." + }, "event": { "anyOf": [ { @@ -59615,7 +66785,7 @@ "title": "Event", "description": "Event name." }, - "reference": { + "importance": { "anyOf": [ { "type": "string" @@ -59624,8 +66794,8 @@ "type": "null" } ], - "title": "Reference", - "description": "Abbreviated period for which released data refers to." + "title": "Importance", + "description": "The importance level for the event." }, "source": { "anyOf": [ @@ -59639,111 +66809,6 @@ "title": "Source", "description": "Source of the data." }, - "sourceurl": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Sourceurl", - "description": "Source URL." - }, - "actual": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Actual", - "description": "Latest released value." - }, - "previous": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Previous", - "description": "Value for the previous period after the revision (if revision is applicable)." - }, - "consensus": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Consensus", - "description": "Average forecast among a representative group of economists." - }, - "forecast": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Forecast", - "description": "Trading Economics projections" - }, - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url", - "description": "Trading Economics URL" - }, - "importance": { - "anyOf": [ - { - "type": "integer", - "enum": [ - 0, - 1, - 2, - 3 - ] - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Importance", - "description": "Importance of the event. 1-Low, 2-Medium, 3-High" - }, "currency": { "anyOf": [ { @@ -59767,11 +66832,196 @@ ], "title": "Unit", "description": "Unit of the data." + }, + "consensus": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Consensus", + "description": "Average forecast among a representative group of economists." + }, + "previous": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Previous", + "description": "Value for the previous period after the revision (if revision is applicable)." + }, + "revised": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Revised", + "description": "Revised previous value, if applicable." + }, + "actual": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Actual", + "description": "Latest released value." + }, + "forecast": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Forecast", + "description": "TradingEconomics projections." + }, + "reference": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Reference", + "description": "Abbreviated period for which released data refers to." + }, + "reference_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Reference Date", + "description": "Date for the reference period." + }, + "calendar_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Calendar Id", + "description": "TradingEconomics Calendar ID." + }, + "date_span": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Date Span", + "description": "Date span of the event." + }, + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "TradingEconomics Symbol." + }, + "ticker": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Ticker", + "description": "TradingEconomics Ticker symbol." + }, + "te_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Te Url", + "description": "TradingEconomics URL path." + }, + "source_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Source Url", + "description": "Source URL." + }, + "last_updated": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Updated", + "description": "Last update of the data." } }, "additionalProperties": true, "type": "object", - "title": "TEEconomicCalendar", + "title": "TEEconomicCalendarData", "description": "Trading Economics Economic Calendar Data." }, "UDFSearchResult": { @@ -59919,17 +67169,6 @@ ], "title": "Description" }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" - }, "full_name": { "anyOf": [ { @@ -60321,7 +67560,207 @@ "category", "message" ], - "title": "Warning_" + "title": "Warning_", + "description": "Model for Warning." + }, + "Watchlist": { + "properties": { + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Stock symbol." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Stock name." + }, + "last_quote": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Last Quote", + "description": "Last quote." + }, + "day_change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Day Change", + "description": "Day change." + }, + "day_change_percent": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Day Change Percent", + "description": "Day change percent." + }, + "day_volume": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Day Volume", + "description": "Day volume." + }, + "market_cap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Market Cap", + "description": "Market cap." + }, + "pe": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Pe", + "description": "PE." + }, + "week_change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Week Change", + "description": "Week change." + }, + "month_change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Month Change", + "description": "Month change." + }, + "year_change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year Change", + "description": "Year change." + } + }, + "additionalProperties": true, + "type": "object", + "title": "Watchlist", + "description": "Watchlist Data." + }, + "openbb_fred__models__us_yield_curve__FREDYieldCurveData": { + "properties": { + "maturity": { + "type": "number", + "title": "Maturity", + "description": "Maturity of the treasury rate in years." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "Associated rate given in decimal form (0.05 is 5%)" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "FREDYieldCurveData", + "description": "FRED US Yield Curve Data." + }, + "openbb_fred__models__yield_curve__FREDYieldCurveData": { + "properties": { + "date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Date", + "description": "The date of the data." + }, + "maturity": { + "type": "string", + "title": "Maturity", + "description": "Maturity length of the security." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "The yield as a normalized percent (0.05 is 5%)", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "FREDYieldCurveData", + "description": "FRED Yield Curve Data." } }, "securitySchemes": { diff --git a/website/content/excel/openbb-functions.json b/website/content/excel/openbb-functions.json new file mode 100644 index 00000000000..58754cd3a0f --- /dev/null +++ b/website/content/excel/openbb-functions.json @@ -0,0 +1,173 @@ +{ + "CURRENCY.PRICE.HISTORICAL": { + "providers": [ + "fmp" + ] + }, + "CURRENCY.SNAPSHOTS": { + "providers": [ + "fmp" + ] + }, + "ECONOMY.CALENDAR": { + "providers": [ + "tradingeconomics" + ] + }, + "EQUITY.COMPARE.PEERS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.ESTIMATES.CONSENSUS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.ESTIMATES.HISTORICAL": { + "providers": [ + "fmp" + ] + }, + "EQUITY.ESTIMATES.PRICE_TARGET": { + "providers": [ + "benzinga", + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.BALANCE": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.CASH": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.DIVIDENDS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.FILINGS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.HISTORICAL_EPS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.INCOME": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.MANAGEMENT": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.METRICS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.OVERVIEW": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.RATIOS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.TRANSCRIPT": { + "providers": [ + "fmp" + ] + }, + "EQUITY.OWNERSHIP.INSIDER_TRADING": { + "providers": [ + "fmp" + ] + }, + "EQUITY.OWNERSHIP.INSTITUTIONAL": { + "providers": [ + "fmp" + ] + }, + "EQUITY.OWNERSHIP.MAJOR_HOLDERS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.OWNERSHIP.SHARE_STATISTICS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.PRICE.HISTORICAL": { + "providers": [ + "fmp" + ] + }, + "EQUITY.PRICE.PERFORMANCE": { + "providers": [ + "fmp" + ] + }, + "EQUITY.PRICE.QUOTE": { + "providers": [ + "fmp" + ] + }, + "EQUITY.PROFILE": { + "providers": [ + "fmp" + ] + }, + "ETF.HOLDINGS": { + "providers": [ + "intrinio" + ] + }, + "ETF.INFO": { + "providers": [ + "intrinio" + ] + }, + "INDEX.MARKET": { + "providers": [ + "fmp" + ] + }, + "NEWS.COMPANY": { + "providers": [ + "benzinga" + ] + }, + "NEWS.WORLD": { + "providers": [ + "benzinga" + ] + } +} \ No newline at end of file diff --git a/website/content/platform/developer_guide/index.mdx b/website/content/platform/developer_guide/index.mdx index 70b8518ec01..6fd4bec0678 100644 --- a/website/content/platform/developer_guide/index.mdx +++ b/website/content/platform/developer_guide/index.mdx @@ -3,28 +3,28 @@ title: Developer Guide sidebar_position: 1 description: The OpenBB Platform supplies core architecture and services for connecting data providers and extensions, consumable through the Python client or the Fast API keywords: -- developer_guide -- OpenBB Platform -- Python client -- Fast API -- getting started -- authorization -- data providers -- OpenBB Hub -- local environment -- environment variables -- user settings -- command execution -- API response -- logging -- proxy networks -- data cleaning -- technical analysis -- quantitative analysis -- charting libraries + - developer_guide + - OpenBB Platform + - Python client + - Fast API + - getting started + - authorization + - data providers + - OpenBB Hub + - local environment + - environment variables + - user settings + - command execution + - API response + - logging + - proxy networks + - data cleaning + - technical analysis + - quantitative analysis + - charting libraries --- -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; +import HeadTitle from "@site/src/components/General/HeadTitle.tsx"; @@ -62,4 +62,4 @@ Optional extras are not included with the base installation, and these include: - Toolkit extensions - CLI Terminal -Refer to [Extensions](/platform/developer_guide/extensions) for the list of extensions hosted in the OpenBB GitHub repository that can be installed independently. +Refer to [Extensions](/platform/user_guides/extensions) for the list of extensions hosted in the OpenBB GitHub repository that can be installed independently. diff --git a/website/content/platform/installation.mdx b/website/content/platform/installation.mdx index 379ba93c54b..263811896f2 100644 --- a/website/content/platform/installation.mdx +++ b/website/content/platform/installation.mdx @@ -168,7 +168,6 @@ pip uninstall openbb[all] ### Docker
- You can install and run the Platform from [GitHub Container Registry](https://github.com/OpenBB-finance/OpenBBTerminal/pkgs/container/openbb-platform) with: ```bash diff --git a/website/content/platform/user_guides/add_toolkit_extension.mdx b/website/content/platform/user_guides/add_toolkit_extension.mdx index 9e8636a2963..4446f63bdcc 100644 --- a/website/content/platform/user_guides/add_toolkit_extension.mdx +++ b/website/content/platform/user_guides/add_toolkit_extension.mdx @@ -24,7 +24,7 @@ import HeadTitle from "@site/src/components/General/HeadTitle.tsx"; -Before adding a new toolkit extension and router path to the OpenBB Platform using a supplied template, it is important to understand the difference between a toolkit and a provider extension. You can find more information on this [here](/platform/developer_guide/extensions). +Before adding a new toolkit extension and router path to the OpenBB Platform using a supplied template, it is important to understand the difference between a toolkit and a provider extension. You can find more information on this [here](/platform/user_guides/extensions). ## How To Create A Router Extension diff --git a/website/content/platform/user_guides/basic_syntax.mdx b/website/content/platform/user_guides/basic_syntax.mdx index eb9db88c8a4..ee0e3cfd3e3 100644 --- a/website/content/platform/user_guides/basic_syntax.mdx +++ b/website/content/platform/user_guides/basic_syntax.mdx @@ -3,25 +3,25 @@ title: Basic Syntax sidebar_position: 1 description: This page provides comprehensive information about standardized command syntax for an open-source platform. Topics discussed include the structure of command syntax, use of standardized parameters, usage of provider and symbol parameters, handling of date and limit parameters, and more. Also explored, are the methods for selecting data sources, handling different list and ticker symbol formats, and dealing with command responses and warnings. keywords: -- tutorial -- command syntax -- standardized parameters -- date format -- provider parameter -- data source selection -- symbol parameter -- list formats -- ticker symbols -- date parameter -- time series -- limit parameter -- keyword arguments -- endpoint parameters -- command response -- data models + - tutorial + - command syntax + - standardized parameters + - date format + - provider parameter + - data source selection + - symbol parameter + - list formats + - ticker symbols + - date parameter + - time series + - limit parameter + - keyword arguments + - endpoint parameters + - command response + - data models --- -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; +import HeadTitle from "@site/src/components/General/HeadTitle.tsx"; @@ -80,7 +80,7 @@ Provider coverage can be ascertained with the command below: obb.coverage.providers ``` -Refer to, [Data Extensions](/platform/developer_guide/extensions), for instructions on installing data provider extensions. +Refer to, [Data Extensions](/platform/user_guides/extensions), for instructions on installing data provider extensions. ## Symbol @@ -101,9 +101,7 @@ With providers supporting market data from multiple jurisdictions, the most comm ### One Symbol
-```python -quote = obb.equity.price.quote(symbol="td", provider="fmp") -``` + ```python quote = obb.equity.price.quote(symbol="td", provider="fmp") ```
### Multiple Symbols @@ -190,7 +188,7 @@ Where, optional, `limit` parameters are supplied, they are likely to have sensib income = obb.equity.fa.income("AAPL", period="quarter", provider="fmp", limit=4) ``` -## **kwargs +## \*\*kwargs All endpoints accept additional keyword arguments, but non-existent parameters will be ignored. Invalid parameters are communicated via the `warnings` field in the command response. Parameters can be stored as a dictionary and fed to the command as `**kwargs`. If a provider, or function, has an undocumented parameter it can still be accessed by supplying the additional kwargs. @@ -210,6 +208,6 @@ data.warnings ## References -All functions, parameters, and responses are detailed under the [Reference pages](/platform/reference). The data models for each provider source are described within the [Data Models](/platform/data_models) pages. +All functions, parameters, and responses are detailed under the [Reference pages](/platform/reference). The data models for each provider source are described within the [Data Models](/platform/data_models) pages. These pages are a quick way to cross-reference differences between providers. The same information is provided in a function's signature and docstring. diff --git a/website/content/platform/user_guides/extensions.mdx b/website/content/platform/user_guides/extensions.mdx new file mode 100644 index 00000000000..28acc772175 --- /dev/null +++ b/website/content/platform/user_guides/extensions.mdx @@ -0,0 +1,311 @@ +--- +title: Extensions +sidebar_position: 3 +description: This page describes the toolkit extensions available for the OpenBB Platform. +keywords: +- OpenBB Platform +- Python client +- Fast API +- getting started +- extensions +- data providers +- data extensions +- toolkit extensions +- toolkits +- endpoints +- community +- technical analysis +- quantitative analysis +- charting libraries +- Plotly +- OpenBBFigure +- PyWry +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + +The extension framework allows individual pieces to be installed and removed seamlessly within the environment, using only the desired data and toolkit extensions. + +There are two primary types of extensions for the OpenBB Platform: + +- Data +- Toolkits + +The OpenBB Core installation does not include any toolkit extensions. Install the OpenBB Platform with all data and toolkit extensions from PyPI with: + +```python +pip install openbb[all] +``` + +When installing from source, navigate into the `openbb_platform` folder from the root of the project and enter: + +```console +python dev_install.py -e +``` + +This installs all extensions in editable mode, and the Python interface is compiled in, `/openbb_platform/openbb/package`, instead of the environment's `site-packages` folder. The tables in the next pages lists extensions as either, Core or Community. The Core extensions are installed by default. + +A couple of notable differences between data and toolkit extension are: + +- In the OpenBB GitHub repo, extensions are all located under: + + ```console + ~/OpenBBTerminal/openbb_platform/extensions + ``` + +- An additional folder housing integration tests, with the `tests` folder staying empty. +- There is a `router` file, and there can be sub-folders with additional routers. +- Utility functions don't need their own sub-folder. +- `__init__.py` files are all empty. + +## Data Extensions + +
+ + +Data extensions will expand the breadth and coverage of the data available in the OpenBB Platform. Each source (provider) is its own independent extension, even if there is only one endpoint accessible. This allows every data source to be inserted or removed, at any time, without disturbing the operation of the Core components. + +Functions will appear in the Python Interface and Fast API only if a supported provider, for that specific endpoint, is installed. Additional Python libraries will be installed, where required, by the extension. + +## Provider Coverage + +The total installed coverage can be determined through the Python interface, as a dictionary. + +```python +from openbb import obb +obb.coverage.providers +``` + +## Installation + +All data extensions are installed with similar syntax. Published data extensions will have names beginning with `openbb`. For example, yFinance. + +```console +pip install openbb-yfinance +``` + +Additions and removals update the router automatically to reflect the changes when the Python interpreter is refreshed. Below is a list of data provider extensions. + +Uninstall any extension with `pip uninstall`. + +```console +pip uninstall openbb-yfinance +``` + +## Available Data Extensions + +### Core `openbb` Providers + +These packages are what will be installed when `pip install openbb` is run + +| Extension Name | Description | Installation Command | Minimum Subscription Type Required | +|----------------|-------------|----------------------|------------------------------------| +| openbb-benzinga | [Benzinga](https://www.benzinga.com/apis/en-ca/) data connector | pip install openbb-benzinga | Paid | +| openbb-fmp | [FMP](https://site.financialmodelingprep.com/developer/) data connector | pip install openbb-fmp | Free | +| openbb-fred | [FRED](https://fred.stlouisfed.org/) data connector | pip install openbb-fred | Free | +| openbb-intrinio | [Intrinio](https://intrinio.com/pricing) data connector | pip install openbb-intrinio | Paid | +| openbb-oecd | [OECD](https://data.oecd.org/) data connector | pip install openbb-oecd | Free | +| openbb-polygon | [Polygon](https://polygon.io/) data connector | pip install openbb-polygon | Free | +| openbb-sec | [SEC](https://www.sec.gov/edgar/sec-api-documentation) data connector | pip install openbb-sec | None | +| openbb-tiingo | [Tiingo](https://www.tiingo.com/about/pricing) data connector | pip install openbb-tiingo | Free | +| openbb-tradingeconomics | [TradingEconomics](https://tradingeconomics.com/api) data connector | pip install openbb-tradingeconomics | Paid | +| openbb-yfinance | [Yahoo Finance](https://finance.yahoo.com/) data connector | pip install openbb-yfinance | None | + +### Community Providers + +These packages are not installed when `pip install openbb` is run. They are available for installation separately or by running `pip install openbb[all]` + +| Extension Name | Description | Installation Command | Minimum Subscription Type Required | +|----------------|-------------|----------------------|------------------------------------| +| openbb-alpha-vantage | [Alpha Vantage](https://www.alphavantage.co/) data connector | pip install openbb-alpha-vantage | Free | +| openbb-biztoc | [Biztoc](https://api.biztoc.com/#biztoc-default) News data connector | pip install openbb-biztoc | Free | +| openbb-cboe | [Cboe](https://www.cboe.com/delayed_quotes/) data connector | pip install openbb-cboe | None | +| openbb-ecb | [ECB](https://data.ecb.europa.eu/) data connector | pip install openbb-ecb | None | +| openbb-federal-reserve | [Federal Reserve](https://www.federalreserve.gov/) data connector | pip install openbb-federal-reserve | None | +| openbb-finra | [FINRA](https://www.finra.org/finra-data) data connector | pip install openbb-finra | None / Free | +| openbb-finviz | [Finviz](https://finviz.com) data connector | pip install openbb-finviz | None | +| openbb-government-us | [US Government](https://data.gov) data connector | pip install openbb-us-government | None | +| openbb-nasdaq | [Nasdaq Data Link](https://data.nasdaq.com/) connector | pip install openbb-nasdaq | None / Free | +| openbb-seeking-alpha | [Seeking Alpha](https://seekingalpha.com/) data connector | pip install openbb-seeking-alpha | None | +| openbb-stockgrid | [Stockgrid](https://stockgrid.io) data connector | pip install openbb-stockgrid | None | +| openbb-tmx | [TMX](https://money.tmx.com) data connector | pip install openbb-tmx | None | +| openbb-tradier | [Tradier](https://tradier.com) data connector | pip install openbb-tradier | None | +| openbb-wsj | [Wall Street Journal](https://www.wsj.com/) data connector | pip install openbb-wsj | None | + +Have you published a data provider extension and want it featured on this list? Tell us about it! Open a pull request on [GitHub](https://github.com/OpenBB-finance/OpenBBTerminal/) to submit an extension for inclusion. Code contributions, for new and existing, data providers are always welcome. + +Search [PyPI](https://pypi.org/search/?q=openbb-) to find more extensions. + + +
+ +## Toolkit Extensions +
+ +OpenBB Toolkit Extensions expand the Platform with functions for manipulating data and preparing it for display. The Core Platform installation does not install any toolkit extensions. The table below is the current list of toolkit extensions. + +| Extension Name | Description | Installation Command | Core/Community | Router Path | +|:-----------------|:-----------:|:-------------------:|:------------------:|-------------:| +| openbb-charting | Rest API charting service and Plotly library. | pip install openbb-charting | Community | N/A | +| openbb-devtools | Aggregates dependencies that facilitate a nice development experience for OpenBB. | pip install openbb-devtools | N/A | +| openbb-econometrics | Econometrics models for the Python interface only. | pip install openbb-econometrics | Community | obb.econometrics | +| openbb-quantitative | Functions for performing quantitative analysis. | pip install openbb-quantitative | Community | obb.quantitative | +| openbb-technical | Functions for performing technical analysis. | pip install openbb-technical | Community | obb.technical | + +The sections below outline any specific installation considerations for the extension. + +## Charting + +The OpenBB Charting Extension supplies charting infrastructure and services to the OpenBB Platform. Figure objects are served via REST API or Python Client. It utilizes [PyWry](https://github.com/OpenBB-finance/pywry) for handling the display of interactive charts and tables in a separate window, with a Plotly library. + +Functions with dedicated views return figures to the `chart` attribute of the `OBBject` response object. They are displayed with the class method, `show()`. + +:::tip +The `openbb-charting` is an [`OBBject` extension](platform/getting_started/add_obbject_extension), which means the general functionality is exposed in every command result. +::: + +The following packages are dependencies of the `openbb-charting` extension: + +- scipy +- plotly +- statsmodels +- reportlab +- pywry +- svglib +- nbformat +- pandas-ta + +### Installation + +Install from PyPI with: + +```console +pip install openbb-charting +``` + +For more information check the documentation of the openbb-charting extension. + +## Devtools + +Please refer to the following PyPI distributed [package](https://pypi.org/project/openbb-devtools/). + +This Python package, `openbb-devtools`, is designed for OpenBB Platform Developers and contains a range of dependencies essential for robust and efficient software development. + +These dependencies cater to various aspects like code formatting, security analysis, type checking, testing, and kernel management. + +The inclusion of these packages ensures that the development process is streamlined, the code quality is maintained, and the software is secure and reliable. + +Included dependencies: + +- `ruff`: A fast Python linter focused on performance and simplicity. +- `pylint`: A tool that checks for errors in Python code, enforces a coding standard, and looks for code smells. +- `mypy`: A static type checker for Python, helping catch type errors during development. +- `pydocstyle`: A linter for Python docstrings to ensure they meet certain style requirements. +- `black`: An uncompromising Python code formatter, ensuring consistent code style. +- `bandit`: A tool designed to find common security issues in Python code. +- `pre-commit`: Manages and maintains pre-commit hooks that run checks before each commit, ensuring code quality. +- `nox`: A generic virtualenv management and test command line tool for running tests in isolated environments. +- `pytest`: A mature full-featured Python testing tool that helps in writing better programs. +- `pytest-cov`: A plugin for pytest that measures code coverage during testing. +- `ipykernel`: A package that provides the IPython kernel for Jupyter. +- `types-python-dateutil`: Type stubs for python-dateutil, aiding in static type checking. +- `types-toml`: Type stubs for TOML, useful for static type checking in TOML parsing. +- `poetry`: A tool for dependency management and packaging in Python. + +Each dependency plays a critical role in ensuring the code is clean, efficient, and functional, ultimately leading to the development of high-quality software. + +While developing code for the OpenBB Platform, one should always install the DevTools packages so that the above development tooling is available out-of-the-box. + +### Installation + +Install from PyPI with: + +```console +pip install openbb-devtools +``` + +:::info +When setting up the environment using the `openbb_platform/dev_install.py` script, the DevTools will also be installed. +::: + +## Econometrics + +The `openbb-econometrics` extension installs a new router path (`obb.econometrics`) and additional Python libraries: + +- scipy +- statsmodels +- arch +- linearmodels + +:::note + +Statsmodels requires a C compiler be present on the system. Follow the instructions [here](https://cython.readthedocs.io/en/latest/src/quickstart/install.html) for system-specific methods. + +This extension is not accessible via REST API because `statsmodels` is not serializable. +::: + +### Installation + +Install from PyPI with: + +```console +pip install openbb-econometrics +``` + +To install from source in editable mode, navigate into the folder, `~/openbb_platform/extensions/econometrics`, and enter: + +```console +pip install -e . +``` + +After installation, the Python interface will automatically rebuild on initialization. + +## Quantitative + +The `openbb-quantitative` extension installs a new router path (`obb.quantitative`) and a few additional Python libraries: + +- pandas-ta +- scipy +- statsmodels + +### Installation + +Install from PyPI with: + +```console +pip install openbb-quantitative +``` + +To install from source in editable mode, navigate into the folder, `~/openbb_platform/extensions/quantitative`, and enter: + +```console +pip install -e . +``` + +After installation, the Python interface will automatically rebuild on initialization. + +## Technical + +The `openbb-technical` extension is for performing technical analysis on time series data. It installs a new router path (`obb.technical`) and some additional Python libraries: + +- pandas-ta +- scikit-learn +- scipy +- statsmodels + +### Installation + +Install from PyPI with: + +```console +pip install openbb-technical +``` + +To install from source in editable mode, navigate into the folder, `~/openbb_platform/extensions/technical`, and enter: + +```console +pip install -e . +``` + +After installation, the Python interface will automatically rebuild on initialization. +
diff --git a/website/generate_excel_markdown.py b/website/generate_excel_markdown.py index 0fefcb7f036..8527de985e5 100644 --- a/website/generate_excel_markdown.py +++ b/website/generate_excel_markdown.py @@ -12,11 +12,13 @@ import requests WEBSITE_PATH = Path(__file__).parent.absolute() CONTENT_PATH = WEBSITE_PATH / "content" XL_FUNCS_PATH = CONTENT_PATH / "excel" / "functions.json" +XL_OPENBB_FUNCS_PATH = CONTENT_PATH / "excel" / "openbb-functions.json" XL_PLATFORM_PATH = CONTENT_PATH / "excel" / "openapi.json" SEO_METADATA_PATH = WEBSITE_PATH / "metadata" / "platform_v4_seo_metadata.json" # URLs: the platform url should match the backend being used by excel.openbb.co XL_FUNCS_URL = "https://excel.openbb.co/assets/functions.json" +XL_OPENBB_FUNCS_URL = "https://excel.openbb.co/assets/openbb-functions.json" XL_PLATFORM_URL = "https://sdk.openbb.co/openapi.json" @@ -46,6 +48,7 @@ class CommandLib: def __init__(self): self.xl_funcs = self.read_xl_funcs() + self.xl_openbb_funcs = self.read_xl_openbb_funcs() self.openapi = self.read_openapi() self.seo_metadata = self.read_seo_metadata() @@ -56,6 +59,13 @@ class CommandLib: with open(XL_FUNCS_PATH, "w") as f: json.dump(r.json(), f, indent=2) + @staticmethod + def fetch_xl_openbb_funcs(): + """Fetch the openbb version of excel functions.""" + r = requests.get(XL_OPENBB_FUNCS_URL, timeout=10) + with open(XL_OPENBB_FUNCS_PATH, "w") as f: + json.dump(r.json(), f, indent=2) + @staticmethod def fetch_openapi(): """Fetch the openapi.json.""" @@ -89,6 +99,12 @@ class CommandLib: for func in funcs["functions"] } + def read_xl_openbb_funcs(self) -> Dict[str, Any]: + """Read the Excel openbb functions file.""" + with open(XL_OPENBB_FUNCS_PATH) as f: + funcs = json.load(f) + return funcs + def read_openapi(self) -> dict: """Get the openapi.json.""" with open(XL_PLATFORM_PATH) as f: @@ -148,17 +164,39 @@ class CommandLib: ) ): models = self._traverse(["properties", "results", "anyOf"], inner_schema)[0] - if models.get("type") == "array": - models = models["items"] + models = ( + models["items"].get("oneOf", [models["items"]]) + if models.get("type") == "array" + else [models] + ) - d = {} - for k, v in self._traverse(["discriminator", "mapping"], models).items(): - model_schema = self._traverse(v.split("/"), self.openapi, ["#"]) - d[k] = { - name: {"description": info.get("description", "").replace("\n", "")} - for name, info in model_schema["properties"].items() - } - return d + # Get the available providers from the provider parameter enum + parameters = self._traverse( + [ + "paths", + self.API_PREFIX + cmd, + "get", + "parameters", + ], + self.openapi, + ) + providers = [] + for p in parameters: + if p.get("name") == "provider": + providers = p.get("schema", {}).get("enum", []) + if providers: + d = {} + for i, model in enumerate(models): + ref = model.get("$ref", "") + model_schema = self._traverse(ref.split("/"), self.openapi, ["#"]) + provider = providers[i] + d[provider] = { + name: { + "description": info.get("description", "").replace("\n", "") + } + for name, info in model_schema["properties"].items() + } + return d return {} def _get_examples( @@ -210,6 +248,7 @@ class CommandLib: data = self._get_data(cmd) return_ = self.xl_funcs[cmd].get("result", {}).get("dimensionality", "") examples = self._get_examples(cmd, parameters) + providers = self.xl_openbb_funcs.get(function, {}).get("providers", []) return { "name": name, "description": description, @@ -219,6 +258,7 @@ class CommandLib: "data": data, "return": return_, "examples": examples, + "providers": providers, } @@ -311,20 +351,25 @@ class Editor: def get_data() -> str: if data_schema := cmd_info["data"]: - data = "import Tabs from '@theme/Tabs';\n" - data += "import TabItem from '@theme/TabItem';\n\n" - data += "## Data\n\n" - data += "\n" - for provider, fields in data_schema.items(): - data += f"\n\n" - data += "| Name | Description |\n" - data += "| ---- | ----------- |\n" - for name, info in fields.items(): - description = info["description"] - data += f"| {name} | {description} |\n" - data += "\n" - data += "\n" - return data + providers = cmd_info["providers"] + filtered_data_schema = { + k: v for k, v in data_schema.items() if k in providers + } + if filtered_data_schema: + data = "import Tabs from '@theme/Tabs';\n" + data += "import TabItem from '@theme/TabItem';\n\n" + data += "## Data\n\n" + data += "\n" + for provider, fields in filtered_data_schema.items(): + data += f"\n\n" + data += "| Name | Description |\n" + data += "| ---- | ----------- |\n" + for name, info in fields.items(): + description = info["description"] + data += f"| {name} | {description} |\n" + data += "\n" + data += "\n" + return data return "" def get_examples() -> str: @@ -512,6 +557,7 @@ if __name__ == "__main__": pass else: CommandLib.fetch_xl_funcs() + CommandLib.fetch_xl_openbb_funcs() CommandLib.fetch_openapi() Editor(