From 0f441287b0535cc190e7156a55266a9f0a1921e7 Mon Sep 17 00:00:00 2001 From: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:42:57 +0100 Subject: [Enhancement] - Cleanup docs (#6254) * Delete reference and data_models contents * Update gitignore --- .gitignore | 2 + website/content/platform/data_models/AMERIBOR.md | 65 --- .../platform/data_models/AnalystEstimates.md | 76 --- .../platform/data_models/AvailableIndices.md | 100 ---- .../content/platform/data_models/BalanceSheet.md | 197 ------- .../platform/data_models/BalanceSheetGrowth.md | 95 ---- website/content/platform/data_models/COT.md | 96 ---- website/content/platform/data_models/COTSearch.md | 58 -- .../platform/data_models/CalendarDividend.md | 89 ---- .../platform/data_models/CalendarEarnings.md | 62 --- .../content/platform/data_models/CalendarIpo.md | 162 ------ .../content/platform/data_models/CalendarSplits.md | 58 -- .../platform/data_models/CashFlowStatement.md | 173 ------ .../data_models/CashFlowStatementGrowth.md | 86 --- website/content/platform/data_models/CikMap.md | 59 -- .../platform/data_models/CommercialPaper.md | 58 -- .../content/platform/data_models/CompanyFilings.md | 116 ---- .../content/platform/data_models/CompanyNews.md | 195 ------- .../platform/data_models/CompanyOverview.md | 88 --- .../platform/data_models/ConsumerPriceIndex.md | 63 --- .../platform/data_models/CryptoHistorical.md | 133 ----- .../content/platform/data_models/CryptoSearch.md | 65 --- .../platform/data_models/CurrencyHistorical.md | 132 ----- .../content/platform/data_models/CurrencyPairs.md | 102 ---- .../data_models/DiscountWindowPrimaryCreditRate.md | 65 --- .../platform/data_models/DiscoveryFilings.md | 86 --- website/content/platform/data_models/ESTR.md | 65 --- website/content/platform/data_models/ETFActive.md | 81 --- website/content/platform/data_models/ETFGainers.md | 82 --- website/content/platform/data_models/ETFLosers.md | 82 --- .../content/platform/data_models/EUYieldCurve.md | 65 --- .../platform/data_models/EarningsCallTranscript.md | 58 -- .../platform/data_models/EconomicCalendar.md | 134 ----- .../content/platform/data_models/EquityActive.md | 73 --- .../data_models/EquityAggressiveSmallCaps.md | 73 --- website/content/platform/data_models/EquityFTD.md | 73 --- .../content/platform/data_models/EquityGainers.md | 73 --- .../platform/data_models/EquityHistorical.md | 234 -------- website/content/platform/data_models/EquityInfo.md | 99 ---- .../content/platform/data_models/EquityLosers.md | 73 --- website/content/platform/data_models/EquityNBBO.md | 126 ----- .../platform/data_models/EquityOwnership.md | 93 ---- .../content/platform/data_models/EquityPeers.md | 53 -- .../content/platform/data_models/EquityQuote.md | 123 ----- .../content/platform/data_models/EquitySearch.md | 131 ----- .../platform/data_models/EquityShortInterest.md | 62 --- .../data_models/EquityUndervaluedGrowth.md | 73 --- .../data_models/EquityUndervaluedLargeCaps.md | 73 --- .../data_models/EquityValuationMultiples.md | 114 ---- .../content/platform/data_models/EtfCountries.md | 53 -- .../content/platform/data_models/EtfHistorical.md | 73 --- .../content/platform/data_models/EtfHoldings.md | 92 ---- .../platform/data_models/EtfHoldingsDate.md | 62 --- .../platform/data_models/EtfHoldingsPerformance.md | 87 --- website/content/platform/data_models/EtfInfo.md | 77 --- website/content/platform/data_models/EtfSearch.md | 83 --- website/content/platform/data_models/EtfSectors.md | 54 -- .../EuropeanCentralBankInterestRates.md | 56 -- .../platform/data_models/ExecutiveCompensation.md | 65 --- website/content/platform/data_models/FEDFUNDS.md | 65 --- website/content/platform/data_models/Filings.md | 92 ---- .../platform/data_models/FinancialRatios.md | 122 ----- .../content/platform/data_models/FredIndices.md | 70 --- .../content/platform/data_models/FuturesCurve.md | 64 --- .../platform/data_models/FuturesHistorical.md | 77 --- .../content/platform/data_models/GdpForecast.md | 69 --- website/content/platform/data_models/GdpNominal.md | 67 --- website/content/platform/data_models/GdpReal.md | 67 --- website/content/platform/data_models/GlobalNews.md | 149 ------ .../platform/data_models/GrowthTechEquities.md | 73 --- .../data_models/HighQualityMarketCorporateBond.md | 57 -- .../platform/data_models/HistoricalDividends.md | 59 -- .../platform/data_models/HistoricalEmployees.md | 61 --- .../platform/data_models/HistoricalStockSplits.md | 56 -- website/content/platform/data_models/ICEBofA.md | 70 --- website/content/platform/data_models/IORB.md | 55 -- .../platform/data_models/IncomeStatement.md | 215 -------- .../platform/data_models/IncomeStatementGrowth.md | 83 --- .../platform/data_models/IndexConstituents.md | 60 --- .../content/platform/data_models/IndexSearch.md | 84 --- .../content/platform/data_models/IndexSnapshots.md | 82 --- .../platform/data_models/InstitutionalOwnership.md | 90 ---- .../platform/data_models/InstitutionsSearch.md | 69 --- .../content/platform/data_models/KeyExecutives.md | 59 -- website/content/platform/data_models/KeyMetrics.md | 192 ------- .../content/platform/data_models/MarketIndices.md | 158 ------ .../platform/data_models/MarketSnapshots.md | 129 ----- .../data_models/MoodyCorporateBondIndex.md | 67 --- .../content/platform/data_models/OTCAggregate.md | 66 --- .../content/platform/data_models/OptionsChains.md | 130 ----- .../content/platform/data_models/OptionsUnusual.md | 80 --- .../content/platform/data_models/PROJECTIONS.md | 67 --- .../platform/data_models/PricePerformance.md | 87 --- .../content/platform/data_models/PriceTarget.md | 92 ---- .../platform/data_models/PriceTargetConsensus.md | 57 -- .../platform/data_models/RevenueBusinessLine.md | 56 -- .../platform/data_models/RevenueGeographic.md | 61 --- .../content/platform/data_models/RiskPremium.md | 55 -- .../content/platform/data_models/RssLitigation.md | 63 --- website/content/platform/data_models/SOFR.md | 65 --- website/content/platform/data_models/SONIA.md | 65 --- .../content/platform/data_models/SP500Multiples.md | 67 --- .../content/platform/data_models/SchemaFiles.md | 68 --- .../platform/data_models/SelectedTreasuryBill.md | 56 -- .../SelectedTreasuryConstantMaturity.md | 56 -- .../platform/data_models/ShareStatistics.md | 58 -- .../content/platform/data_models/ShortVolume.md | 70 --- website/content/platform/data_models/SicSearch.md | 70 --- website/content/platform/data_models/SpotRate.md | 57 -- .../platform/data_models/StockInsiderTrading.md | 69 --- website/content/platform/data_models/SymbolMap.md | 59 -- website/content/platform/data_models/TopRetail.md | 56 -- .../data_models/TreasuryConstantMaturity.md | 56 -- .../content/platform/data_models/TreasuryRates.md | 66 --- .../content/platform/data_models/USYieldCurve.md | 55 -- .../platform/data_models/UpcomingReleaseDays.md | 76 --- .../content/platform/data_models/_category_.json | 4 - website/content/platform/data_models/index.mdx | 592 --------------------- website/content/platform/reference/_category_.json | 4 - .../platform/reference/calendar/dividend.md | 129 ----- .../platform/reference/calendar/earnings.md | 102 ---- .../content/platform/reference/calendar/index.mdx | 30 -- website/content/platform/reference/calendar/ipo.md | 226 -------- .../content/platform/reference/calendar/split.md | 92 ---- website/content/platform/reference/cftc/cot.md | 135 ----- .../content/platform/reference/cftc/cot_search.md | 89 ---- website/content/platform/reference/cftc/index.mdx | 18 - .../content/platform/reference/compare/index.mdx | 12 - .../content/platform/reference/compare/peers.md | 89 ---- .../reference/corporate/commercial_paper.md | 100 ---- .../content/platform/reference/corporate/hqm.md | 92 ---- .../platform/reference/corporate/ice_bofa.md | 123 ----- .../content/platform/reference/corporate/index.mdx | 36 -- .../content/platform/reference/corporate/moody.md | 115 ---- .../platform/reference/corporate/spot_rates.md | 99 ---- .../content/platform/reference/crypto/index.mdx | 12 - .../content/platform/reference/crypto/search.md | 99 ---- .../content/platform/reference/currency/index.mdx | 12 - .../content/platform/reference/currency/search.md | 156 ------ .../content/platform/reference/darkpool/index.mdx | 12 - website/content/platform/reference/darkpool/otc.md | 104 ---- .../content/platform/reference/discovery/active.md | 127 ----- .../reference/discovery/aggressive_small_caps.md | 108 ---- .../platform/reference/discovery/filings.md | 135 ----- .../platform/reference/discovery/gainers.md | 128 ----- .../platform/reference/discovery/growth_tech.md | 111 ---- .../content/platform/reference/discovery/index.mdx | 84 --- .../content/platform/reference/discovery/losers.md | 125 ----- .../platform/reference/discovery/top_retail.md | 82 --- .../reference/discovery/undervalued_growth.md | 111 ---- .../reference/discovery/undervalued_large_caps.md | 107 ---- .../reference/discovery/upcoming_release_days.md | 101 ---- .../reference/econometrics/autocorrelation.md | 57 -- .../platform/reference/econometrics/causality.md | 59 -- .../reference/econometrics/cointegration.md | 57 -- .../reference/econometrics/correlation_matrix.md | 46 -- .../platform/reference/econometrics/index.mdx | 90 ---- .../reference/econometrics/ols_regression.md | 55 -- .../econometrics/ols_regression_summary.md | 59 -- .../reference/econometrics/panel_between.md | 59 -- .../econometrics/panel_first_difference.md | 57 -- .../platform/reference/econometrics/panel_fixed.md | 55 -- .../platform/reference/econometrics/panel_fmac.md | 55 -- .../reference/econometrics/panel_pooled.md | 52 -- .../reference/econometrics/panel_random_effects.md | 53 -- .../econometrics/residual_autocorrelation.md | 55 -- .../platform/reference/econometrics/unit_root.md | 61 --- .../content/platform/reference/economy/calendar.md | 184 ------- website/content/platform/reference/economy/cpi.md | 98 ---- .../content/platform/reference/economy/index.mdx | 24 - .../platform/reference/economy/risk_premium.md | 90 ---- .../content/platform/reference/equity/index.mdx | 30 -- .../platform/reference/equity/market_snapshots.md | 165 ------ website/content/platform/reference/equity/news.md | 261 --------- .../content/platform/reference/equity/profile.md | 158 ------ .../content/platform/reference/equity/search.md | 192 ------- .../platform/reference/estimates/consensus.md | 89 ---- .../platform/reference/estimates/historical.md | 143 ----- .../content/platform/reference/estimates/index.mdx | 24 - .../platform/reference/estimates/price_target.md | 125 ----- .../content/platform/reference/etf/countries.md | 81 --- .../content/platform/reference/etf/historical.md | 108 ---- website/content/platform/reference/etf/holdings.md | 146 ----- .../platform/reference/etf/holdings_date.md | 96 ---- .../platform/reference/etf/holdings_performance.md | 118 ---- website/content/platform/reference/etf/index.mdx | 60 --- website/content/platform/reference/etf/info.md | 117 ---- .../platform/reference/etf/price_performance.md | 130 ----- website/content/platform/reference/etf/search.md | 119 ----- website/content/platform/reference/etf/sectors.md | 89 ---- .../platform/reference/fixedincome/index.mdx | 12 - .../content/platform/reference/fixedincome/sofr.md | 105 ---- .../platform/reference/fundamental/balance.md | 222 -------- .../reference/fundamental/balance_growth.md | 156 ------ .../content/platform/reference/fundamental/cash.md | 234 -------- .../platform/reference/fundamental/cash_growth.md | 144 ----- .../platform/reference/fundamental/dividends.md | 95 ---- .../platform/reference/fundamental/earnings.md | 96 ---- .../reference/fundamental/employee_count.md | 96 ---- .../platform/reference/fundamental/filings.md | 162 ------ .../reference/fundamental/historical_splits.md | 90 ---- .../platform/reference/fundamental/income.md | 270 ---------- .../reference/fundamental/income_growth.md | 138 ----- .../platform/reference/fundamental/index.mdx | 126 ----- .../platform/reference/fundamental/management.md | 88 --- .../fundamental/management_compensation.md | 104 ---- .../platform/reference/fundamental/metrics.md | 278 ---------- .../platform/reference/fundamental/multiples.md | 192 ------- .../platform/reference/fundamental/overview.md | 148 ------ .../platform/reference/fundamental/ratios.md | 157 ------ .../reference/fundamental/revenue_per_geography.md | 100 ---- .../reference/fundamental/revenue_per_segment.md | 87 --- .../platform/reference/fundamental/transcript.md | 86 --- .../content/platform/reference/futures/curve.md | 100 ---- .../content/platform/reference/futures/index.mdx | 18 - website/content/platform/reference/futures/load.md | 115 ---- website/content/platform/reference/gdp/forecast.md | 100 ---- website/content/platform/reference/gdp/index.mdx | 24 - website/content/platform/reference/gdp/nominal.md | 96 ---- website/content/platform/reference/gdp/real.md | 102 ---- .../reference/government/eu_yield_curve.md | 123 ----- .../platform/reference/government/index.mdx | 24 - .../platform/reference/government/treasury.md | 101 ---- .../reference/government/us_yield_curve.md | 87 --- website/content/platform/reference/index.mdx | 151 ------ .../content/platform/reference/index/available.md | 114 ---- .../platform/reference/index/constituents.md | 92 ---- .../content/platform/reference/index/european.md | 111 ---- .../reference/index/european_constituents.md | 118 ---- website/content/platform/reference/index/fred.md | 105 ---- website/content/platform/reference/index/index.mdx | 60 --- website/content/platform/reference/index/market.md | 212 -------- website/content/platform/reference/index/search.md | 111 ---- .../content/platform/reference/index/snapshots.md | 121 ----- .../platform/reference/index/sp500_multiples.md | 111 ---- website/content/platform/reference/news/company.md | 240 --------- website/content/platform/reference/news/index.mdx | 18 - website/content/platform/reference/news/world.md | 220 -------- .../content/platform/reference/options/chains.md | 178 ------- .../content/platform/reference/options/index.mdx | 18 - .../content/platform/reference/options/unusual.md | 119 ----- .../content/platform/reference/ownership/index.mdx | 30 -- .../reference/ownership/insider_trading.md | 113 ---- .../platform/reference/ownership/institutional.md | 160 ------ .../platform/reference/ownership/major_holders.md | 140 ----- .../reference/ownership/share_statistics.md | 86 --- .../content/platform/reference/price/historical.md | 271 ---------- website/content/platform/reference/price/index.mdx | 42 -- website/content/platform/reference/price/nbbo.md | 175 ------ .../platform/reference/price/performance.md | 130 ----- website/content/platform/reference/price/quote.md | 196 ------- .../platform/reference/quantitative/capm.md | 38 -- .../platform/reference/quantitative/index.mdx | 66 --- .../platform/reference/quantitative/kurtosis.md | 54 -- .../platform/reference/quantitative/normality.md | 62 --- .../platform/reference/quantitative/omega_ratio.md | 59 -- .../platform/reference/quantitative/quantile.md | 58 -- .../reference/quantitative/sharpe_ratio.md | 56 -- .../platform/reference/quantitative/skewness.md | 57 -- .../reference/quantitative/sortino_ratio.md | 66 --- .../platform/reference/quantitative/summary.md | 52 -- .../reference/quantitative/unitroot_test.md | 64 --- .../content/platform/reference/rate/ameribor.md | 108 ---- .../content/platform/reference/rate/dpcredit.md | 102 ---- website/content/platform/reference/rate/ecb.md | 93 ---- website/content/platform/reference/rate/effr.md | 112 ---- .../platform/reference/rate/effr_forecast.md | 101 ---- website/content/platform/reference/rate/estr.md | 119 ----- website/content/platform/reference/rate/index.mdx | 54 -- website/content/platform/reference/rate/iorb.md | 95 ---- website/content/platform/reference/rate/sonia.md | 110 ---- website/content/platform/reference/sec/cik_map.md | 89 ---- website/content/platform/reference/sec/filings.md | 140 ----- website/content/platform/reference/sec/index.mdx | 48 -- .../platform/reference/sec/institutions_search.md | 104 ---- .../platform/reference/sec/rss_litigation.md | 98 ---- .../content/platform/reference/sec/schema_files.md | 98 ---- .../content/platform/reference/sec/sic_search.md | 105 ---- .../content/platform/reference/sec/symbol_map.md | 90 ---- .../platform/reference/shorts/fails_to_deliver.md | 103 ---- .../content/platform/reference/shorts/index.mdx | 24 - .../platform/reference/shorts/short_interest.md | 102 ---- .../platform/reference/shorts/short_volume.md | 109 ---- .../content/platform/reference/spreads/index.mdx | 24 - website/content/platform/reference/spreads/tmc.md | 95 ---- .../content/platform/reference/spreads/tmc_effr.md | 99 ---- .../platform/reference/spreads/treasury_effr.md | 100 ---- website/content/platform/reference/technical/ad.md | 79 --- .../content/platform/reference/technical/adosc.md | 80 --- .../content/platform/reference/technical/adx.md | 76 --- .../content/platform/reference/technical/aroon.md | 77 --- .../content/platform/reference/technical/atr.md | 73 --- .../content/platform/reference/technical/bbands.md | 86 --- .../content/platform/reference/technical/cci.md | 71 --- website/content/platform/reference/technical/cg.md | 80 --- .../content/platform/reference/technical/clenow.md | 74 --- .../content/platform/reference/technical/cones.md | 96 ---- .../content/platform/reference/technical/demark.md | 80 --- .../platform/reference/technical/donchian.md | 78 --- .../content/platform/reference/technical/ema.md | 76 --- .../content/platform/reference/technical/fib.md | 60 --- .../content/platform/reference/technical/fisher.md | 84 --- .../content/platform/reference/technical/hma.md | 80 --- .../platform/reference/technical/ichimoku.md | 69 --- .../content/platform/reference/technical/index.mdx | 162 ------ website/content/platform/reference/technical/kc.md | 78 --- .../content/platform/reference/technical/macd.md | 89 ---- .../content/platform/reference/technical/obv.md | 77 --- .../content/platform/reference/technical/rsi.md | 81 --- .../content/platform/reference/technical/sma.md | 78 --- .../content/platform/reference/technical/stoch.md | 94 ---- .../content/platform/reference/technical/vwap.md | 67 --- .../content/platform/reference/technical/wma.md | 89 ---- .../content/platform/reference/technical/zlma.md | 79 --- 314 files changed, 2 insertions(+), 29641 deletions(-) delete mode 100644 website/content/platform/data_models/AMERIBOR.md delete mode 100644 website/content/platform/data_models/AnalystEstimates.md delete mode 100644 website/content/platform/data_models/AvailableIndices.md delete mode 100644 website/content/platform/data_models/BalanceSheet.md delete mode 100644 website/content/platform/data_models/BalanceSheetGrowth.md delete mode 100644 website/content/platform/data_models/COT.md delete mode 100644 website/content/platform/data_models/COTSearch.md delete mode 100644 website/content/platform/data_models/CalendarDividend.md delete mode 100644 website/content/platform/data_models/CalendarEarnings.md delete mode 100644 website/content/platform/data_models/CalendarIpo.md delete mode 100644 website/content/platform/data_models/CalendarSplits.md delete mode 100644 website/content/platform/data_models/CashFlowStatement.md delete mode 100644 website/content/platform/data_models/CashFlowStatementGrowth.md delete mode 100644 website/content/platform/data_models/CikMap.md delete mode 100644 website/content/platform/data_models/CommercialPaper.md delete mode 100644 website/content/platform/data_models/CompanyFilings.md delete mode 100644 website/content/platform/data_models/CompanyNews.md delete mode 100644 website/content/platform/data_models/CompanyOverview.md delete mode 100644 website/content/platform/data_models/ConsumerPriceIndex.md delete mode 100644 website/content/platform/data_models/CryptoHistorical.md delete mode 100644 website/content/platform/data_models/CryptoSearch.md delete mode 100644 website/content/platform/data_models/CurrencyHistorical.md delete mode 100644 website/content/platform/data_models/CurrencyPairs.md delete mode 100644 website/content/platform/data_models/DiscountWindowPrimaryCreditRate.md delete mode 100644 website/content/platform/data_models/DiscoveryFilings.md delete mode 100644 website/content/platform/data_models/ESTR.md delete mode 100644 website/content/platform/data_models/ETFActive.md delete mode 100644 website/content/platform/data_models/ETFGainers.md delete mode 100644 website/content/platform/data_models/ETFLosers.md delete mode 100644 website/content/platform/data_models/EUYieldCurve.md delete mode 100644 website/content/platform/data_models/EarningsCallTranscript.md delete mode 100644 website/content/platform/data_models/EconomicCalendar.md delete mode 100644 website/content/platform/data_models/EquityActive.md delete mode 100644 website/content/platform/data_models/EquityAggressiveSmallCaps.md delete mode 100644 website/content/platform/data_models/EquityFTD.md delete mode 100644 website/content/platform/data_models/EquityGainers.md delete mode 100644 website/content/platform/data_models/EquityHistorical.md delete mode 100644 website/content/platform/data_models/EquityInfo.md delete mode 100644 website/content/platform/data_models/EquityLosers.md delete mode 100644 website/content/platform/data_models/EquityNBBO.md delete mode 100644 website/content/platform/data_models/EquityOwnership.md delete mode 100644 website/content/platform/data_models/EquityPeers.md delete mode 100644 website/content/platform/data_models/EquityQuote.md delete mode 100644 website/content/platform/data_models/EquitySearch.md delete mode 100644 website/content/platform/data_models/EquityShortInterest.md delete mode 100644 website/content/platform/data_models/EquityUndervaluedGrowth.md delete mode 100644 website/content/platform/data_models/EquityUndervaluedLargeCaps.md delete mode 100644 website/content/platform/data_models/EquityValuationMultiples.md delete mode 100644 website/content/platform/data_models/EtfCountries.md delete mode 100644 website/content/platform/data_models/EtfHistorical.md delete mode 100644 website/content/platform/data_models/EtfHoldings.md delete mode 100644 website/content/platform/data_models/EtfHoldingsDate.md delete mode 100644 website/content/platform/data_models/EtfHoldingsPerformance.md delete mode 100644 website/content/platform/data_models/EtfInfo.md delete mode 100644 website/content/platform/data_models/EtfSearch.md delete mode 100644 website/content/platform/data_models/EtfSectors.md delete mode 100644 website/content/platform/data_models/EuropeanCentralBankInterestRates.md delete mode 100644 website/content/platform/data_models/ExecutiveCompensation.md delete mode 100644 website/content/platform/data_models/FEDFUNDS.md delete mode 100644 website/content/platform/data_models/Filings.md delete mode 100644 website/content/platform/data_models/FinancialRatios.md delete mode 100644 website/content/platform/data_models/FredIndices.md delete mode 100644 website/content/platform/data_models/FuturesCurve.md delete mode 100644 website/content/platform/data_models/FuturesHistorical.md delete mode 100644 website/content/platform/data_models/GdpForecast.md delete mode 100644 website/content/platform/data_models/GdpNominal.md delete mode 100644 website/content/platform/data_models/GdpReal.md delete mode 100644 website/content/platform/data_models/GlobalNews.md delete mode 100644 website/content/platform/data_models/GrowthTechEquities.md delete mode 100644 website/content/platform/data_models/HighQualityMarketCorporateBond.md delete mode 100644 website/content/platform/data_models/HistoricalDividends.md delete mode 100644 website/content/platform/data_models/HistoricalEmployees.md delete mode 100644 website/content/platform/data_models/HistoricalStockSplits.md delete mode 100644 website/content/platform/data_models/ICEBofA.md delete mode 100644 website/content/platform/data_models/IORB.md delete mode 100644 website/content/platform/data_models/IncomeStatement.md delete mode 100644 website/content/platform/data_models/IncomeStatementGrowth.md delete mode 100644 website/content/platform/data_models/IndexConstituents.md delete mode 100644 website/content/platform/data_models/IndexSearch.md delete mode 100644 website/content/platform/data_models/IndexSnapshots.md delete mode 100644 website/content/platform/data_models/InstitutionalOwnership.md delete mode 100644 website/content/platform/data_models/InstitutionsSearch.md delete mode 100644 website/content/platform/data_models/KeyExecutives.md delete mode 100644 website/content/platform/data_models/KeyMetrics.md delete mode 100644 website/content/platform/data_models/MarketIndices.md delete mode 100644 website/content/platform/data_models/MarketSnapshots.md delete mode 100644 website/content/platform/data_models/MoodyCorporateBondIndex.md delete mode 100644 website/content/platform/data_models/OTCAggregate.md delete mode 100644 website/content/platform/data_models/OptionsChains.md delete mode 100644 website/content/platform/data_models/OptionsUnusual.md delete mode 100644 website/content/platform/data_models/PROJECTIONS.md delete mode 100644 website/content/platform/data_models/PricePerformance.md delete mode 100644 website/content/platform/data_models/PriceTarget.md delete mode 100644 website/content/platform/data_models/PriceTargetConsensus.md delete mode 100644 website/content/platform/data_models/RevenueBusinessLine.md delete mode 100644 website/content/platform/data_models/RevenueGeographic.md delete mode 100644 website/content/platform/data_models/RiskPremium.md delete mode 100644 website/content/platform/data_models/RssLitigation.md delete mode 100644 website/content/platform/data_models/SOFR.md delete mode 100644 website/content/platform/data_models/SONIA.md delete mode 100644 website/content/platform/data_models/SP500Multiples.md delete mode 100644 website/content/platform/data_models/SchemaFiles.md delete mode 100644 website/content/platform/data_models/SelectedTreasuryBill.md delete mode 100644 website/content/platform/data_models/SelectedTreasuryConstantMaturity.md delete mode 100644 website/content/platform/data_models/ShareStatistics.md delete mode 100644 website/content/platform/data_models/ShortVolume.md delete mode 100644 website/content/platform/data_models/SicSearch.md delete mode 100644 website/content/platform/data_models/SpotRate.md delete mode 100644 website/content/platform/data_models/StockInsiderTrading.md delete mode 100644 website/content/platform/data_models/SymbolMap.md delete mode 100644 website/content/platform/data_models/TopRetail.md delete mode 100644 website/content/platform/data_models/TreasuryConstantMaturity.md delete mode 100644 website/content/platform/data_models/TreasuryRates.md delete mode 100644 website/content/platform/data_models/USYieldCurve.md delete mode 100644 website/content/platform/data_models/UpcomingReleaseDays.md delete mode 100644 website/content/platform/data_models/_category_.json delete mode 100644 website/content/platform/data_models/index.mdx delete mode 100644 website/content/platform/reference/_category_.json delete mode 100644 website/content/platform/reference/calendar/dividend.md delete mode 100644 website/content/platform/reference/calendar/earnings.md delete mode 100644 website/content/platform/reference/calendar/index.mdx delete mode 100644 website/content/platform/reference/calendar/ipo.md delete mode 100644 website/content/platform/reference/calendar/split.md delete mode 100644 website/content/platform/reference/cftc/cot.md delete mode 100644 website/content/platform/reference/cftc/cot_search.md delete mode 100644 website/content/platform/reference/cftc/index.mdx delete mode 100644 website/content/platform/reference/compare/index.mdx delete mode 100644 website/content/platform/reference/compare/peers.md delete mode 100644 website/content/platform/reference/corporate/commercial_paper.md delete mode 100644 website/content/platform/reference/corporate/hqm.md delete mode 100644 website/content/platform/reference/corporate/ice_bofa.md delete mode 100644 website/content/platform/reference/corporate/index.mdx delete mode 100644 website/content/platform/reference/corporate/moody.md delete mode 100644 website/content/platform/reference/corporate/spot_rates.md delete mode 100644 website/content/platform/reference/crypto/index.mdx delete mode 100644 website/content/platform/reference/crypto/search.md delete mode 100644 website/content/platform/reference/currency/index.mdx delete mode 100644 website/content/platform/reference/currency/search.md delete mode 100644 website/content/platform/reference/darkpool/index.mdx delete mode 100644 website/content/platform/reference/darkpool/otc.md delete mode 100644 website/content/platform/reference/discovery/active.md delete mode 100644 website/content/platform/reference/discovery/aggressive_small_caps.md delete mode 100644 website/content/platform/reference/discovery/filings.md delete mode 100644 website/content/platform/reference/discovery/gainers.md delete mode 100644 website/content/platform/reference/discovery/growth_tech.md delete mode 100644 website/content/platform/reference/discovery/index.mdx delete mode 100644 website/content/platform/reference/discovery/losers.md delete mode 100644 website/content/platform/reference/discovery/top_retail.md delete mode 100644 website/content/platform/reference/discovery/undervalued_growth.md delete mode 100644 website/content/platform/reference/discovery/undervalued_large_caps.md delete mode 100644 website/content/platform/reference/discovery/upcoming_release_days.md delete mode 100644 website/content/platform/reference/econometrics/autocorrelation.md delete mode 100644 website/content/platform/reference/econometrics/causality.md delete mode 100644 website/content/platform/reference/econometrics/cointegration.md delete mode 100644 website/content/platform/reference/econometrics/correlation_matrix.md delete mode 100644 website/content/platform/reference/econometrics/index.mdx delete mode 100644 website/content/platform/reference/econometrics/ols_regression.md delete mode 100644 website/content/platform/reference/econometrics/ols_regression_summary.md delete mode 100644 website/content/platform/reference/econometrics/panel_between.md delete mode 100644 website/content/platform/reference/econometrics/panel_first_difference.md delete mode 100644 website/content/platform/reference/econometrics/panel_fixed.md delete mode 100644 website/content/platform/reference/econometrics/panel_fmac.md delete mode 100644 website/content/platform/reference/econometrics/panel_pooled.md delete mode 100644 website/content/platform/reference/econometrics/panel_random_effects.md delete mode 100644 website/content/platform/reference/econometrics/residual_autocorrelation.md delete mode 100644 website/content/platform/reference/econometrics/unit_root.md delete mode 100644 website/content/platform/reference/economy/calendar.md delete mode 100644 website/content/platform/reference/economy/cpi.md delete mode 100644 website/content/platform/reference/economy/index.mdx delete mode 100644 website/content/platform/reference/economy/risk_premium.md delete mode 100644 website/content/platform/reference/equity/index.mdx delete mode 100644 website/content/platform/reference/equity/market_snapshots.md delete mode 100644 website/content/platform/reference/equity/news.md delete mode 100644 website/content/platform/reference/equity/profile.md delete mode 100644 website/content/platform/reference/equity/search.md delete mode 100644 website/content/platform/reference/estimates/consensus.md delete mode 100644 website/content/platform/reference/estimates/historical.md delete mode 100644 website/content/platform/reference/estimates/index.mdx delete mode 100644 website/content/platform/reference/estimates/price_target.md delete mode 100644 website/content/platform/reference/etf/countries.md delete mode 100644 website/content/platform/reference/etf/historical.md delete mode 100644 website/content/platform/reference/etf/holdings.md delete mode 100644 website/content/platform/reference/etf/holdings_date.md delete mode 100644 website/content/platform/reference/etf/holdings_performance.md delete mode 100644 website/content/platform/reference/etf/index.mdx delete mode 100644 website/content/platform/reference/etf/info.md delete mode 100644 website/content/platform/reference/etf/price_performance.md delete mode 100644 website/content/platform/reference/etf/search.md delete mode 100644 website/content/platform/reference/etf/sectors.md delete mode 100644 website/content/platform/reference/fixedincome/index.mdx delete mode 100644 website/content/platform/reference/fixedincome/sofr.md delete mode 100644 website/content/platform/reference/fundamental/balance.md delete mode 100644 website/content/platform/reference/fundamental/balance_growth.md delete mode 100644 website/content/platform/reference/fundamental/cash.md delete mode 100644 website/content/platform/reference/fundamental/cash_growth.md delete mode 100644 website/content/platform/reference/fundamental/dividends.md delete mode 100644 website/content/platform/reference/fundamental/earnings.md delete mode 100644 website/content/platform/reference/fundamental/employee_count.md delete mode 100644 website/content/platform/reference/fundamental/filings.md delete mode 100644 website/content/platform/reference/fundamental/historical_splits.md delete mode 100644 website/content/platform/reference/fundamental/income.md delete mode 100644 website/content/platform/reference/fundamental/income_growth.md delete mode 100644 website/content/platform/reference/fundamental/index.mdx delete mode 100644 website/content/platform/reference/fundamental/management.md delete mode 100644 website/content/platform/reference/fundamental/management_compensation.md delete mode 100644 website/content/platform/reference/fundamental/metrics.md delete mode 100644 website/content/platform/reference/fundamental/multiples.md delete mode 100644 website/content/platform/reference/fundamental/overview.md delete mode 100644 website/content/platform/reference/fundamental/ratios.md delete mode 100644 website/content/platform/reference/fundamental/revenue_per_geography.md delete mode 100644 website/content/platform/reference/fundamental/revenue_per_segment.md delete mode 100644 website/content/platform/reference/fundamental/transcript.md delete mode 100644 website/content/platform/reference/futures/curve.md delete mode 100644 website/content/platform/reference/futures/index.mdx delete mode 100644 website/content/platform/reference/futures/load.md delete mode 100644 website/content/platform/reference/gdp/forecast.md delete mode 100644 website/content/platform/reference/gdp/index.mdx delete mode 100644 website/content/platform/reference/gdp/nominal.md delete mode 100644 website/content/platform/reference/gdp/real.md delete mode 100644 website/content/platform/reference/government/eu_yield_curve.md delete mode 100644 website/content/platform/reference/government/index.mdx delete mode 100644 website/content/platform/reference/government/treasury.md delete mode 100644 website/content/platform/reference/government/us_yield_curve.md delete mode 100644 website/content/platform/reference/index.mdx delete mode 100644 website/content/platform/reference/index/available.md delete mode 100644 website/content/platform/reference/index/constituents.md delete mode 100644 website/content/platform/reference/index/european.md delete mode 100644 website/content/platform/reference/index/european_constituents.md delete mode 100644 website/content/platform/reference/index/fred.md delete mode 100644 website/content/platform/reference/index/index.mdx delete mode 100644 website/content/platform/reference/index/market.md delete mode 100644 website/content/platform/reference/index/search.md delete mode 100644 website/content/platform/reference/index/snapshots.md delete mode 100644 website/content/platform/reference/index/sp500_multiples.md delete mode 100644 website/content/platform/reference/news/company.md delete mode 100644 website/content/platform/reference/news/index.mdx delete mode 100644 website/content/platform/reference/news/world.md delete mode 100644 website/content/platform/reference/options/chains.md delete mode 100644 website/content/platform/reference/options/index.mdx delete mode 100644 website/content/platform/reference/options/unusual.md delete mode 100644 website/content/platform/reference/ownership/index.mdx delete mode 100644 website/content/platform/reference/ownership/insider_trading.md delete mode 100644 website/content/platform/reference/ownership/institutional.md delete mode 100644 website/content/platform/reference/ownership/major_holders.md delete mode 100644 website/content/platform/reference/ownership/share_statistics.md delete mode 100644 website/content/platform/reference/price/historical.md delete mode 100644 website/content/platform/reference/price/index.mdx delete mode 100644 website/content/platform/reference/price/nbbo.md delete mode 100644 website/content/platform/reference/price/performance.md delete mode 100644 website/content/platform/reference/price/quote.md delete mode 100644 website/content/platform/reference/quantitative/capm.md delete mode 100644 website/content/platform/reference/quantitative/index.mdx delete mode 100644 website/content/platform/reference/quantitative/kurtosis.md delete mode 100644 website/content/platform/reference/quantitative/normality.md delete mode 100644 website/content/platform/reference/quantitative/omega_ratio.md delete mode 100644 website/content/platform/reference/quantitative/quantile.md delete mode 100644 website/content/platform/reference/quantitative/sharpe_ratio.md delete mode 100644 website/content/platform/reference/quantitative/skewness.md delete mode 100644 website/content/platform/reference/quantitative/sortino_ratio.md delete mode 100644 website/content/platform/reference/quantitative/summary.md delete mode 100644 website/content/platform/reference/quantitative/unitroot_test.md delete mode 100644 website/content/platform/reference/rate/ameribor.md delete mode 100644 website/content/platform/reference/rate/dpcredit.md delete mode 100644 website/content/platform/reference/rate/ecb.md delete mode 100644 website/content/platform/reference/rate/effr.md delete mode 100644 website/content/platform/reference/rate/effr_forecast.md delete mode 100644 website/content/platform/reference/rate/estr.md delete mode 100644 website/content/platform/reference/rate/index.mdx delete mode 100644 website/content/platform/reference/rate/iorb.md delete mode 100644 website/content/platform/reference/rate/sonia.md delete mode 100644 website/content/platform/reference/sec/cik_map.md delete mode 100644 website/content/platform/reference/sec/filings.md delete mode 100644 website/content/platform/reference/sec/index.mdx delete mode 100644 website/content/platform/reference/sec/institutions_search.md delete mode 100644 website/content/platform/reference/sec/rss_litigation.md delete mode 100644 website/content/platform/reference/sec/schema_files.md delete mode 100644 website/content/platform/reference/sec/sic_search.md delete mode 100644 website/content/platform/reference/sec/symbol_map.md delete mode 100644 website/content/platform/reference/shorts/fails_to_deliver.md delete mode 100644 website/content/platform/reference/shorts/index.mdx delete mode 100644 website/content/platform/reference/shorts/short_interest.md delete mode 100644 website/content/platform/reference/shorts/short_volume.md delete mode 100644 website/content/platform/reference/spreads/index.mdx delete mode 100644 website/content/platform/reference/spreads/tmc.md delete mode 100644 website/content/platform/reference/spreads/tmc_effr.md delete mode 100644 website/content/platform/reference/spreads/treasury_effr.md delete mode 100644 website/content/platform/reference/technical/ad.md delete mode 100644 website/content/platform/reference/technical/adosc.md delete mode 100644 website/content/platform/reference/technical/adx.md delete mode 100644 website/content/platform/reference/technical/aroon.md delete mode 100644 website/content/platform/reference/technical/atr.md delete mode 100644 website/content/platform/reference/technical/bbands.md delete mode 100644 website/content/platform/reference/technical/cci.md delete mode 100644 website/content/platform/reference/technical/cg.md delete mode 100644 website/content/platform/reference/technical/clenow.md delete mode 100644 website/content/platform/reference/technical/cones.md delete mode 100644 website/content/platform/reference/technical/demark.md delete mode 100644 website/content/platform/reference/technical/donchian.md delete mode 100644 website/content/platform/reference/technical/ema.md delete mode 100644 website/content/platform/reference/technical/fib.md delete mode 100644 website/content/platform/reference/technical/fisher.md delete mode 100644 website/content/platform/reference/technical/hma.md delete mode 100644 website/content/platform/reference/technical/ichimoku.md delete mode 100644 website/content/platform/reference/technical/index.mdx delete mode 100644 website/content/platform/reference/technical/kc.md delete mode 100644 website/content/platform/reference/technical/macd.md delete mode 100644 website/content/platform/reference/technical/obv.md delete mode 100644 website/content/platform/reference/technical/rsi.md delete mode 100644 website/content/platform/reference/technical/sma.md delete mode 100644 website/content/platform/reference/technical/stoch.md delete mode 100644 website/content/platform/reference/technical/vwap.md delete mode 100644 website/content/platform/reference/technical/wma.md delete mode 100644 website/content/platform/reference/technical/zlma.md diff --git a/.gitignore b/.gitignore index 85d7f18c32c..bdd736b86dc 100644 --- a/.gitignore +++ b/.gitignore @@ -89,3 +89,5 @@ openbb_platform/openbb/package/* # Reference files website/content/excel/reference/* website/content/excel/reference/*/* +website/content/platform/data_models/* +website/content/platform/reference/* diff --git a/website/content/platform/data_models/AMERIBOR.md b/website/content/platform/data_models/AMERIBOR.md deleted file mode 100644 index 89ebd541757..00000000000 --- a/website/content/platform/data_models/AMERIBOR.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Ameribor -description: OpenBB Platform Data Model ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `AMERIBOR` | `AMERIBORQueryParams` | `AMERIBORData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.ameribor_rates import ( -AMERIBORData, -AMERIBORQueryParams, -) -``` - -## Parameters - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True | -| provider | Literal['fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. | fred | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True | -| provider | Literal['fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. | fred | True | -| parameter | Literal['overnight', 'term_30', 'term_90', '1_week_term_structure', '1_month_term_structure', '3_month_term_structure', '6_month_term_structure', '1_year_term_structure', '2_year_term_structure', '30_day_ma', '90_day_ma'] | Period of AMERIBOR rate. | overnight | True | - - - - -## Data - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | AMERIBOR rate. | - - - diff --git a/website/content/platform/data_models/AnalystEstimates.md b/website/content/platform/data_models/AnalystEstimates.md deleted file mode 100644 index f4520af2a46..00000000000 --- a/website/content/platform/data_models/AnalystEstimates.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Historical Analyst Estimates -description: OpenBB Platform Data Model ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `AnalystEstimates` | `AnalystEstimatesQueryParams` | `AnalystEstimatesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.analyst_estimates import ( -AnalystEstimatesData, -AnalystEstimatesQueryParams, -) -``` - -## Parameters - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. | | False | -| period | Literal['quarter', 'annual'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 30 | True | -| provider | Literal['fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True | - - - - -## Data - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| estimated_revenue_low | int | Estimated revenue low. | -| estimated_revenue_high | int | Estimated revenue high. | -| estimated_revenue_avg | int | Estimated revenue average. | -| estimated_ebitda_low | int | Estimated EBITDA low. | -| estimated_ebitda_high | int | Estimated EBITDA high. | -| estimated_ebitda_avg | int | Estimated EBITDA average. | -| estimated_ebit_low | int | Estimated EBIT low. | -| estimated_ebit_high | int | Estimated EBIT high. | -| estimated_ebit_avg | int | Estimated EBIT average. | -| estimated_net_income_low | int | Estimated net income low. | -| estimated_net_income_high | int | Estimated net income high. | -| estimated_net_income_avg | int | Estimated net income average. | -| estimated_sga_expense_low | int | Estimated SGA expense low. | -| estimated_sga_expense_high | int | Estimated SGA expense high. | -| estimated_sga_expense_avg | int | Estimated SGA expense average. | -| estimated_eps_avg | float | Estimated EPS average. | -| estimated_eps_high | float | Estimated EPS high. | -| estimated_eps_low | float | Estimated EPS low. | -| number_analyst_estimated_revenue | int | Number of analysts who estimated revenue. | -| number_analysts_estimated_eps | int | Number of analysts who estimated EPS. | - - - diff --git a/website/content/platform/data_models/AvailableIndices.md b/website/content/platform/data_models/AvailableIndices.md deleted file mode 100644 index b22b06cbe4c..00000000000 --- a/website/content/platform/data_models/AvailableIndices.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: Available Indices -description: OpenBB Platform Data Model ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `AvailableIndices` | `AvailableIndicesQueryParams` | `AvailableIndicesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.available_indices import ( -AvailableIndicesData, -AvailableIndicesQueryParams, -) -``` - -## Parameters - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['cboe', 'fmp', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['cboe', 'fmp', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | True | -| europe | bool | Filter for European indices. False for US indices. | False | True | - - - - -## Data - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the index. | -| currency | str | Currency the index is traded in. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the index. | -| currency | str | Currency the index is traded in. | -| isin | str | ISIN code for the index. Valid only for European indices. | -| region | str | Region for the index. Valid only for European indices | -| symbol | str | Symbol for the index. | -| description | str | Description for the index. Valid only for US indices. | -| data_delay | int | Data delay for the index. Valid only for US indices. | -| open_time | datetime.time | Opening time for the index. Valid only for US indices. | -| close_time | datetime.time | Closing time for the index. Valid only for US indices. | -| time_zone | str | Time zone for the index. Valid only for US indices. | -| tick_days | str | The trading days for the index. Valid only for US indices. | -| tick_frequency | str | The frequency of the index ticks. Valid only for US indices. | -| tick_period | str | The period of the index ticks. Valid only for US indices. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the index. | -| currency | str | Currency the index is traded in. | -| stock_exchange | str | Stock exchange where the index is listed. | -| exchange_short_name | str | Short name of the stock exchange where the index is listed. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the index. | -| currency | str | Currency the index is traded in. | -| code | str | ID code for keying the index in the OpenBB Terminal. | -| symbol | str | Symbol for the index. | - - - diff --git a/website/content/platform/data_models/BalanceSheet.md b/website/content/platform/data_models/BalanceSheet.md deleted file mode 100644 index b1349ab3e1a..00000000000 --- a/website/content/platform/data_models/BalanceSheet.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -title: Balance Sheet -description: OpenBB Platform Data Model ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `BalanceSheet` | `BalanceSheetQueryParams` | `BalanceSheetData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.balance_sheet import ( -BalanceSheetData, -BalanceSheetQueryParams, -) -``` - -## Parameters - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 5 | True | -| provider | Literal['fmp', 'intrinio', 'polygon', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 5 | True | -| provider | Literal['fmp', 'intrinio', 'polygon', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True | -| cik | str | Central Index Key (CIK) of the company. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 5 | True | -| provider | Literal['fmp', 'intrinio', 'polygon', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True | -| filing_date | date | Filing date of the financial statement. | None | True | -| filing_date_lt | date | Filing date less than the given date. | None | True | -| filing_date_lte | date | Filing date less than or equal to the given date. | None | True | -| filing_date_gt | date | Filing date greater than the given date. | None | True | -| filing_date_gte | date | Filing date greater than or equal to the given date. | None | True | -| period_of_report_date | date | Period of report date of the financial statement. | None | True | -| period_of_report_date_lt | date | Period of report date less than the given date. | None | True | -| period_of_report_date_lte | date | Period of report date less than or equal to the given date. | None | True | -| period_of_report_date_gt | date | Period of report date greater than the given date. | None | True | -| period_of_report_date_gte | date | Period of report date greater than or equal to the given date. | None | True | -| include_sources | bool | Whether to include the sources of the financial statement. | None | True | -| order | Literal['asc', 'desc'] | Order of the financial statement. | None | True | -| sort | Literal['filing_date', 'period_of_report_date'] | Sort of the financial statement. | None | True | - - - - -## Data - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| cik | str | Central Index Key (CIK) of the company. | -| currency | str | Reporting currency. | -| filling_date | date | Filling date. | -| accepted_date | datetime | Accepted date. | -| period | str | Reporting period of the statement. | -| cash_and_cash_equivalents | float | Cash and cash equivalents | -| short_term_investments | float | Short-term investments | -| long_term_investments | float | Long-term investments | -| inventory | float | Inventory | -| net_receivables | float | Receivables, net | -| marketable_securities | float | Marketable securities | -| property_plant_equipment_net | float | Property, plant and equipment, net | -| goodwill | float | Goodwill | -| assets | float | Total assets | -| current_assets | float | Total current assets | -| other_current_assets | float | Other current assets | -| intangible_assets | float | Intangible assets | -| tax_assets | float | Accrued income taxes | -| non_current_assets | float | Total non-current assets | -| other_non_current_assets | float | Other non-current assets | -| account_payables | float | Accounts payable | -| tax_payables | float | Accrued income taxes | -| deferred_revenue | float | Accrued income taxes, other deferred revenue | -| other_assets | float | Other assets | -| total_assets | float | Total assets | -| long_term_debt | float | Long-term debt, Operating lease obligations, Long-term finance lease obligations | -| short_term_debt | float | Short-term borrowings, Long-term debt due within one year, Operating lease obligations due within one year, Finance lease obligations due within one year | -| liabilities | float | Total liabilities | -| other_current_liabilities | float | Other current liabilities | -| current_liabilities | float | Total current liabilities | -| total_liabilities_and_total_equity | float | Total liabilities and total equity | -| other_non_current_liabilities | float | Other non-current liabilities | -| non_current_liabilities | float | Total non-current liabilities | -| total_liabilities_and_stockholders_equity | float | Total liabilities and stockholders' equity | -| other_stockholder_equity | float | Other stockholders equity | -| total_stockholders_equity | float | Total stockholders' equity | -| other_liabilities | float | Other liabilities | -| total_liabilities | float | Total liabilities | -| common_stock | float | Common stock | -| preferred_stock | float | Preferred stock | -| accumulated_other_comprehensive_income_loss | float | Accumulated other comprehensive income (loss) | -| retained_earnings | float | Retained earnings | -| minority_interest | float | Minority interest | -| total_equity | float | Total equity | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| cik | str | Central Index Key (CIK) of the company. | -| currency | str | Reporting currency. | -| filling_date | date | Filling date. | -| accepted_date | datetime | Accepted date. | -| period | str | Reporting period of the statement. | -| cash_and_cash_equivalents | float | Cash and cash equivalents | -| short_term_investments | float | Short-term investments | -| long_term_investments | float | Long-term investments | -| inventory | float | Inventory | -| net_receivables | float | Receivables, net | -| marketable_securities | float | Marketable securities | -| property_plant_equipment_net | float | Property, plant and equipment, net | -| goodwill | float | Goodwill | -| assets | float | Total assets | -| current_assets | float | Total current assets | -| other_current_assets | float | Other current assets | -| intangible_assets | float | Intangible assets | -| tax_assets | float | Accrued income taxes | -| non_current_assets | float | Total non-current assets | -| other_non_current_assets | float | Other non-current assets | -| account_payables | float | Accounts payable | -| tax_payables | float | Accrued income taxes | -| deferred_revenue | float | Accrued income taxes, other deferred revenue | -| other_assets | float | Other assets | -| total_assets | float | Total assets | -| long_term_debt | float | Long-term debt, Operating lease obligations, Long-term finance lease obligations | -| short_term_debt | float | Short-term borrowings, Long-term debt due within one year, Operating lease obligations due within one year, Finance lease obligations due within one year | -| liabilities | float | Total liabilities | -| other_current_liabilities | float | Other current liabilities | -| current_liabilities | float | Total current liabilities | -| total_liabilities_and_total_equity | float | Total liabilities and total equity | -| other_non_current_liabilities | float | Other non-current liabilities | -| non_current_liabilities | float | Total non-current liabilities | -| total_liabilities_and_stockholders_equity | float | Total liabilities and stockholders' equity | -| other_stockholder_equity | float | Other stockholders equity | -| total_stockholders_equity | float | Total stockholders' equity | -| other_liabilities | float | Other liabilities | -| total_liabilities | float | Total liabilities | -| common_stock | float | Common stock | -| preferred_stock | float | Preferred stock | -| accumulated_other_comprehensive_income_loss | float | Accumulated other comprehensive income (loss) | -| retained_earnings | float | Retained earnings | -| minority_interest | float | Minority interest | -| total_equity | float | Total equity | -| calendar_year | int | Calendar Year | -| cash_and_short_term_investments | int | Cash and Short Term Investments | -| goodwill_and_intangible_assets | int | Goodwill and Intangible Assets | -| deferred_revenue_non_current | int | Deferred Revenue Non Current | -| total_investments | int | Total investments | -| capital_lease_obligations | int | Capital lease obligations | -| deferred_tax_liabilities_non_current | int | Deferred Tax Liabilities Non Current | -| total_debt | int | Total Debt | -| net_debt | int | Net Debt | -| link | str | Link to the statement. | -| final_link | str | Link to the final statement. | - - - diff --git a/website/content/platform/data_models/BalanceSheetGrowth.md b/website/content/platform/data_models/BalanceSheetGrowth.md deleted file mode 100644 index 8a24665263f..00000000000 --- a/website/content/platform/data_models/BalanceSheetGrowth.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: Balance Sheet Statement Growth -description: OpenBB Platform Data Model ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `BalanceSheetGrowth` | `BalanceSheetGrowthQueryParams` | `BalanceSheetGrowthData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.balance_sheet_growth import ( -BalanceSheetGrowthData, -BalanceSheetGrowthQueryParams, -) -``` - -## Parameters - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['fmp'] | The p