From cf22cf5d146e4e712160d32454c797a9ad4feb77 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Mon, 1 Apr 2024 17:11:52 +0100 Subject: [PATCH 1/2] Remove reference + data models --- .../content/platform/data_models/AMERIBOR.md | 80 -- .../platform/data_models/AnalystEstimates.md | 121 --- .../platform/data_models/AnalystSearch.md | 129 ---- .../platform/data_models/AvailableIndices.md | 136 ---- .../platform/data_models/BalanceOfPayments.md | 290 ------- .../platform/data_models/BalanceSheet.md | 323 -------- .../data_models/BalanceSheetGrowth.md | 159 ---- .../platform/data_models/BondPrices.md | 116 --- website/content/platform/data_models/CLI.md | 83 -- website/content/platform/data_models/COT.md | 87 --- .../content/platform/data_models/COTSearch.md | 87 --- .../platform/data_models/CalendarDividend.md | 114 --- .../platform/data_models/CalendarEarnings.md | 142 ---- .../platform/data_models/CalendarIpo.md | 134 ---- .../platform/data_models/CalendarSplits.md | 85 --- .../platform/data_models/CashFlowStatement.md | 247 ------ .../data_models/CashFlowStatementGrowth.md | 141 ---- .../content/platform/data_models/CikMap.md | 75 -- .../platform/data_models/CommercialPaper.md | 85 --- .../platform/data_models/CompanyFilings.md | 189 ----- .../platform/data_models/CompanyNews.md | 266 ------- .../platform/data_models/CompanyOverview.md | 145 ---- .../platform/data_models/CompareGroups.md | 98 --- .../data_models/ConsumerPriceIndex.md | 85 --- .../platform/data_models/CryptoHistorical.md | 173 ----- .../platform/data_models/CryptoSearch.md | 80 -- .../data_models/CurrencyHistorical.md | 170 ----- .../platform/data_models/CurrencyPairs.md | 123 --- .../data_models/CurrencyReferenceRates.md | 135 ---- .../platform/data_models/CurrencySnapshots.md | 102 --- .../DiscountWindowPrimaryCreditRate.md | 80 -- .../platform/data_models/DiscoveryFilings.md | 92 --- website/content/platform/data_models/ESTR.md | 80 -- .../content/platform/data_models/ETFActive.md | 97 --- .../platform/data_models/ETFGainers.md | 98 --- .../content/platform/data_models/ETFLosers.md | 98 --- .../platform/data_models/EUYieldCurve.md | 79 -- .../data_models/EarningsCallTranscript.md | 85 --- .../platform/data_models/EconomicCalendar.md | 170 ----- .../platform/data_models/EquityActive.md | 88 --- .../data_models/EquityAggressiveSmallCaps.md | 88 --- .../content/platform/data_models/EquityFTD.md | 87 --- .../platform/data_models/EquityGainers.md | 110 --- .../platform/data_models/EquityHistorical.md | 345 --------- .../platform/data_models/EquityInfo.md | 399 ---------- .../platform/data_models/EquityLosers.md | 88 --- .../platform/data_models/EquityNBBO.md | 98 --- .../platform/data_models/EquityOwnership.md | 155 ---- .../platform/data_models/EquityPeers.md | 75 -- .../platform/data_models/EquityQuote.md | 464 ----------- .../platform/data_models/EquityScreener.md | 104 --- .../platform/data_models/EquitySearch.md | 193 ----- .../data_models/EquityShortInterest.md | 93 --- .../data_models/EquityUndervaluedGrowth.md | 88 --- .../data_models/EquityUndervaluedLargeCaps.md | 88 --- .../data_models/EquityValuationMultiples.md | 195 ----- .../platform/data_models/EtfCountries.md | 91 --- .../platform/data_models/EtfEquityExposure.md | 83 -- .../platform/data_models/EtfHistorical.md | 345 --------- .../platform/data_models/EtfHoldings.md | 218 ------ .../platform/data_models/EtfHoldingsDate.md | 76 -- .../data_models/EtfHoldingsPerformance.md | 102 --- .../content/platform/data_models/EtfInfo.md | 319 -------- .../content/platform/data_models/EtfSearch.md | 164 ---- .../platform/data_models/EtfSectors.md | 94 --- .../EuropeanCentralBankInterestRates.md | 81 -- .../data_models/ExecutiveCompensation.md | 103 --- .../content/platform/data_models/FEDFUNDS.md | 97 --- .../platform/data_models/FinancialRatios.md | 159 ---- .../content/platform/data_models/Form13FHR.md | 102 --- .../platform/data_models/FredRegional.md | 92 --- .../platform/data_models/FredSearch.md | 118 --- .../platform/data_models/FredSeries.md | 105 --- .../platform/data_models/FuturesCurve.md | 97 --- .../platform/data_models/FuturesHistorical.md | 92 --- .../platform/data_models/GdpForecast.md | 84 -- .../platform/data_models/GdpNominal.md | 82 -- .../content/platform/data_models/GdpReal.md | 82 -- .../data_models/GrowthTechEquities.md | 88 --- .../HighQualityMarketCorporateBond.md | 84 -- .../data_models/HistoricalAttributes.md | 95 --- .../data_models/HistoricalDividends.md | 171 ----- .../data_models/HistoricalEmployees.md | 91 --- .../platform/data_models/HistoricalEps.md | 113 --- .../platform/data_models/HistoricalSplits.md | 81 -- .../content/platform/data_models/ICEBofA.md | 85 --- website/content/platform/data_models/IORB.md | 79 -- .../platform/data_models/IncomeStatement.md | 309 -------- .../data_models/IncomeStatementGrowth.md | 135 ---- .../platform/data_models/IndexConstituents.md | 130 ---- .../platform/data_models/IndexHistorical.md | 194 ----- .../platform/data_models/IndexSearch.md | 89 --- .../platform/data_models/IndexSectors.md | 78 -- .../platform/data_models/IndexSnapshots.md | 142 ---- .../platform/data_models/InsiderTrading.md | 189 ----- .../data_models/InstitutionalOwnership.md | 114 --- .../data_models/InstitutionsSearch.md | 78 -- .../platform/data_models/KeyExecutives.md | 110 --- .../platform/data_models/KeyMetrics.md | 290 ------- website/content/platform/data_models/LTIR.md | 83 -- .../platform/data_models/LatestAttributes.md | 81 -- .../platform/data_models/LbmaFixing.md | 101 --- .../platform/data_models/MarketIndices.md | 194 ----- .../platform/data_models/MarketSnapshots.md | 143 ---- .../platform/data_models/MoneyMeasures.md | 93 --- .../data_models/MoodyCorporateBondIndex.md | 82 -- .../platform/data_models/OTCAggregate.md | 81 -- .../platform/data_models/OptionsChains.md | 357 --------- .../platform/data_models/OptionsUnusual.md | 94 --- .../platform/data_models/PROJECTIONS.md | 88 --- .../platform/data_models/PricePerformance.md | 138 ---- .../platform/data_models/PriceTarget.md | 194 ----- .../data_models/PriceTargetConsensus.md | 132 ---- .../data_models/ReportedFinancials.md | 86 --- .../data_models/RevenueBusinessLine.md | 87 --- .../platform/data_models/RevenueGeographic.md | 87 --- .../platform/data_models/RiskPremium.md | 79 -- .../platform/data_models/RssLitigation.md | 77 -- website/content/platform/data_models/SOFR.md | 80 -- website/content/platform/data_models/SONIA.md | 80 -- .../platform/data_models/SP500Multiples.md | 83 -- website/content/platform/data_models/STIR.md | 84 -- .../platform/data_models/SchemaFiles.md | 78 -- .../platform/data_models/SearchAttributes.md | 97 --- .../data_models/SelectedTreasuryBill.md | 81 -- .../SelectedTreasuryConstantMaturity.md | 81 -- .../platform/data_models/ShareStatistics.md | 137 ---- .../platform/data_models/ShortVolume.md | 85 --- .../content/platform/data_models/SicSearch.md | 79 -- .../content/platform/data_models/SpotRate.md | 83 -- .../content/platform/data_models/SymbolMap.md | 77 -- .../content/platform/data_models/TopRetail.md | 81 -- .../data_models/TrailingDividendYield.md | 79 -- .../platform/data_models/TreasuryAuctions.md | 323 -------- .../data_models/TreasuryConstantMaturity.md | 81 -- .../platform/data_models/TreasuryPrices.md | 147 ---- .../platform/data_models/TreasuryRates.md | 132 ---- .../platform/data_models/USYieldCurve.md | 79 -- .../platform/data_models/Unemployment.md | 86 --- .../data_models/UpcomingReleaseDays.md | 83 -- .../content/platform/data_models/WorldNews.md | 208 ----- .../platform/data_models/_category_.json | 4 - .../content/platform/data_models/index.mdx | 721 ------------------ .../platform/reference/_category_.json | 4 - .../reference/commodity/_category_.json | 4 - .../platform/reference/commodity/index.mdx | 9 - .../reference/commodity/lbma_fixing.md | 121 --- .../platform/reference/crypto/_category_.json | 4 - .../platform/reference/crypto/index.mdx | 14 - .../reference/crypto/price/_category_.json | 4 - .../reference/crypto/price/historical.md | 211 ----- .../platform/reference/crypto/price/index.mdx | 9 - .../platform/reference/crypto/search.md | 113 --- .../reference/currency/_category_.json | 4 - .../platform/reference/currency/index.mdx | 16 - .../reference/currency/price/_category_.json | 4 - .../reference/currency/price/historical.md | 214 ------ .../reference/currency/price/index.mdx | 9 - .../reference/currency/reference_rates.md | 161 ---- .../platform/reference/currency/search.md | 184 ----- .../platform/reference/currency/snapshots.md | 122 --- .../reference/derivatives/_category_.json | 4 - .../derivatives/futures/_category_.json | 4 - .../reference/derivatives/futures/curve.md | 132 ---- .../derivatives/futures/historical.md | 115 --- .../reference/derivatives/futures/index.mdx | 10 - .../platform/reference/derivatives/index.mdx | 10 - .../derivatives/options/_category_.json | 4 - .../reference/derivatives/options/chains.md | 405 ---------- .../reference/derivatives/options/index.mdx | 10 - .../reference/derivatives/options/unusual.md | 131 ---- .../reference/econometrics/_category_.json | 4 - .../reference/econometrics/autocorrelation.md | 72 -- .../reference/econometrics/causality.md | 75 -- .../reference/econometrics/cointegration.md | 72 -- .../econometrics/correlation_matrix.md | 62 -- .../platform/reference/econometrics/index.mdx | 22 - .../reference/econometrics/ols_regression.md | 69 -- .../econometrics/ols_regression_summary.md | 69 -- .../reference/econometrics/panel_between.md | 69 -- .../econometrics/panel_first_difference.md | 67 -- .../reference/econometrics/panel_fixed.md | 64 -- .../reference/econometrics/panel_fmac.md | 64 -- .../reference/econometrics/panel_pooled.md | 64 -- .../econometrics/panel_random_effects.md | 62 -- .../econometrics/residual_autocorrelation.md | 70 -- .../reference/econometrics/unit_root.md | 76 -- .../reference/economy/_category_.json | 4 - .../reference/economy/balance_of_payments.md | 311 -------- .../platform/reference/economy/calendar.md | 218 ------ .../economy/composite_leading_indicator.md | 104 --- .../content/platform/reference/economy/cpi.md | 118 --- .../reference/economy/fred_regional.md | 113 --- .../platform/reference/economy/fred_search.md | 138 ---- .../platform/reference/economy/fred_series.md | 127 --- .../reference/economy/gdp/_category_.json | 4 - .../reference/economy/gdp/forecast.md | 104 --- .../platform/reference/economy/gdp/index.mdx | 11 - .../platform/reference/economy/gdp/nominal.md | 102 --- .../platform/reference/economy/gdp/real.md | 116 --- .../platform/reference/economy/index.mdx | 27 - .../economy/long_term_interest_rate.md | 110 --- .../reference/economy/money_measures.md | 112 --- .../reference/economy/risk_premium.md | 111 --- .../economy/short_term_interest_rate.md | 107 --- .../reference/economy/unemployment.md | 107 --- .../platform/reference/equity/_category_.json | 4 - .../reference/equity/calendar/_category_.json | 4 - .../reference/equity/calendar/dividend.md | 153 ---- .../reference/equity/calendar/earnings.md | 180 ----- .../reference/equity/calendar/index.mdx | 12 - .../platform/reference/equity/calendar/ipo.md | 202 ----- .../reference/equity/calendar/splits.md | 106 --- .../reference/equity/compare/_category_.json | 4 - .../reference/equity/compare/groups.md | 126 --- .../reference/equity/compare/index.mdx | 10 - .../reference/equity/compare/peers.md | 111 --- .../reference/equity/darkpool/_category_.json | 4 - .../reference/equity/darkpool/index.mdx | 9 - .../platform/reference/equity/darkpool/otc.md | 119 --- .../equity/discovery/_category_.json | 4 - .../reference/equity/discovery/active.md | 129 ---- .../equity/discovery/aggressive_small_caps.md | 123 --- .../reference/equity/discovery/filings.md | 117 --- .../reference/equity/discovery/gainers.md | 156 ---- .../reference/equity/discovery/growth_tech.md | 124 --- .../reference/equity/discovery/index.mdx | 18 - .../reference/equity/discovery/losers.md | 130 ---- .../reference/equity/discovery/top_retail.md | 105 --- .../equity/discovery/undervalued_growth.md | 125 --- .../discovery/undervalued_large_caps.md | 119 --- .../equity/discovery/upcoming_release_days.md | 106 --- .../equity/estimates/_category_.json | 4 - .../equity/estimates/analyst_search.md | 149 ---- .../reference/equity/estimates/consensus.md | 163 ---- .../reference/equity/estimates/historical.md | 182 ----- .../reference/equity/estimates/index.mdx | 12 - .../equity/estimates/price_target.md | 227 ------ .../equity/fundamental/_category_.json | 4 - .../reference/equity/fundamental/balance.md | 347 --------- .../equity/fundamental/balance_growth.md | 217 ------ .../reference/equity/fundamental/cash.md | 307 -------- .../equity/fundamental/cash_growth.md | 196 ----- .../reference/equity/fundamental/dividends.md | 204 ----- .../equity/fundamental/employee_count.md | 124 --- .../reference/equity/fundamental/filings.md | 237 ------ .../fundamental/historical_attributes.md | 114 --- .../equity/fundamental/historical_eps.md | 132 ---- .../equity/fundamental/historical_splits.md | 114 --- .../reference/equity/fundamental/income.md | 363 --------- .../equity/fundamental/income_growth.md | 189 ----- .../reference/equity/fundamental/index.mdx | 33 - .../equity/fundamental/latest_attributes.md | 100 --- .../equity/fundamental/management.md | 137 ---- .../fundamental/management_compensation.md | 139 ---- .../reference/equity/fundamental/metrics.md | 373 --------- .../reference/equity/fundamental/multiples.md | 270 ------- .../reference/equity/fundamental/overview.md | 207 ----- .../reference/equity/fundamental/ratios.md | 191 ----- .../equity/fundamental/reported_financials.md | 111 --- .../fundamental/revenue_per_geography.md | 123 --- .../equity/fundamental/revenue_per_segment.md | 118 --- .../equity/fundamental/search_attributes.md | 116 --- .../fundamental/trailing_dividend_yield.md | 99 --- .../equity/fundamental/transcript.md | 111 --- .../platform/reference/equity/index.mdx | 25 - .../reference/equity/market_snapshots.md | 175 ----- .../equity/ownership/_category_.json | 4 - .../reference/equity/ownership/form_13f.md | 132 ---- .../reference/equity/ownership/index.mdx | 15 - .../equity/ownership/insider_trading.md | 233 ------ .../equity/ownership/institutional.md | 178 ----- .../equity/ownership/major_holders.md | 199 ----- .../equity/ownership/share_statistics.md | 163 ---- .../reference/equity/price/_category_.json | 4 - .../reference/equity/price/historical.md | 380 --------- .../platform/reference/equity/price/index.mdx | 12 - .../platform/reference/equity/price/nbbo.md | 144 ---- .../reference/equity/price/performance.md | 177 ----- .../platform/reference/equity/price/quote.md | 535 ------------- .../platform/reference/equity/profile.md | 454 ----------- .../platform/reference/equity/screener.md | 123 --- .../platform/reference/equity/search.md | 250 ------ .../reference/equity/shorts/_category_.json | 4 - .../equity/shorts/fails_to_deliver.md | 114 --- .../reference/equity/shorts/index.mdx | 11 - .../reference/equity/shorts/short_interest.md | 129 ---- .../reference/equity/shorts/short_volume.md | 119 --- .../platform/reference/etf/_category_.json | 4 - .../platform/reference/etf/countries.md | 117 --- .../reference/etf/discovery/_category_.json | 4 - .../reference/etf/discovery/active.md | 138 ---- .../reference/etf/discovery/gainers.md | 144 ---- .../reference/etf/discovery/index.mdx | 11 - .../reference/etf/discovery/losers.md | 140 ---- .../platform/reference/etf/equity_exposure.md | 103 --- .../platform/reference/etf/historical.md | 380 --------- .../platform/reference/etf/holdings.md | 271 ------- .../platform/reference/etf/holdings_date.md | 106 --- .../reference/etf/holdings_performance.md | 128 ---- .../content/platform/reference/etf/index.mdx | 23 - .../content/platform/reference/etf/info.md | 357 --------- .../reference/etf/price_performance.md | 180 ----- .../content/platform/reference/etf/search.md | 199 ----- .../content/platform/reference/etf/sectors.md | 126 --- .../reference/fixedincome/_category_.json | 4 - .../fixedincome/corporate/_category_.json | 4 - .../fixedincome/corporate/bond_prices.md | 135 ---- .../fixedincome/corporate/commercial_paper.md | 125 --- .../reference/fixedincome/corporate/hqm.md | 118 --- .../fixedincome/corporate/ice_bofa.md | 136 ---- .../reference/fixedincome/corporate/index.mdx | 14 - .../reference/fixedincome/corporate/moody.md | 107 --- .../fixedincome/corporate/spot_rates.md | 122 --- .../fixedincome/government/_category_.json | 4 - .../fixedincome/government/eu_yield_curve.md | 135 ---- .../fixedincome/government/index.mdx | 13 - .../government/treasury_auctions.md | 343 --------- .../fixedincome/government/treasury_prices.md | 167 ---- .../fixedincome/government/treasury_rates.md | 151 ---- .../fixedincome/government/us_yield_curve.md | 108 --- .../platform/reference/fixedincome/index.mdx | 17 - .../fixedincome/rate/_category_.json | 4 - .../reference/fixedincome/rate/ameribor.md | 104 --- .../reference/fixedincome/rate/dpcredit.md | 105 --- .../reference/fixedincome/rate/ecb.md | 117 --- .../reference/fixedincome/rate/effr.md | 121 --- .../fixedincome/rate/effr_forecast.md | 113 --- .../reference/fixedincome/rate/estr.md | 105 --- .../reference/fixedincome/rate/index.mdx | 16 - .../reference/fixedincome/rate/iorb.md | 102 --- .../reference/fixedincome/rate/sonia.md | 104 --- .../platform/reference/fixedincome/sofr.md | 119 --- .../fixedincome/spreads/_category_.json | 4 - .../reference/fixedincome/spreads/index.mdx | 11 - .../reference/fixedincome/spreads/tcm.md | 106 --- .../reference/fixedincome/spreads/tcm_effr.md | 106 --- .../fixedincome/spreads/treasury_effr.md | 122 --- website/content/platform/reference/index.mdx | 76 -- .../platform/reference/index/_category_.json | 4 - .../platform/reference/index/available.md | 155 ---- .../platform/reference/index/constituents.md | 161 ---- .../platform/reference/index/index.mdx | 20 - .../platform/reference/index/market.md | 246 ------ .../reference/index/price/_category_.json | 4 - .../reference/index/price/historical.md | 215 ------ .../platform/reference/index/price/index.mdx | 9 - .../platform/reference/index/search.md | 114 --- .../platform/reference/index/sectors.md | 96 --- .../platform/reference/index/snapshots.md | 180 ----- .../reference/index/sp500_multiples.md | 123 --- .../platform/reference/news/_category_.json | 4 - .../platform/reference/news/company.md | 317 -------- .../content/platform/reference/news/index.mdx | 10 - .../content/platform/reference/news/world.md | 285 ------- .../reference/quantitative/_category_.json | 4 - .../platform/reference/quantitative/capm.md | 63 -- .../platform/reference/quantitative/index.mdx | 19 - .../reference/quantitative/normality.md | 70 -- .../quantitative/performance/_category_.json | 4 - .../quantitative/performance/index.mdx | 11 - .../quantitative/performance/omega_ratio.md | 65 -- .../quantitative/performance/sharpe_ratio.md | 69 -- .../quantitative/performance/sortino_ratio.md | 77 -- .../quantitative/rolling/_category_.json | 4 - .../reference/quantitative/rolling/index.mdx | 14 - .../quantitative/rolling/kurtosis.md | 67 -- .../reference/quantitative/rolling/mean.md | 65 -- .../quantitative/rolling/quantile.md | 67 -- .../reference/quantitative/rolling/skew.md | 67 -- .../reference/quantitative/rolling/stdev.md | 65 -- .../quantitative/rolling/variance.md | 64 -- .../quantitative/stats/_category_.json | 4 - .../reference/quantitative/stats/index.mdx | 14 - .../reference/quantitative/stats/kurtosis.md | 64 -- .../reference/quantitative/stats/mean.md | 63 -- .../reference/quantitative/stats/quantile.md | 63 -- .../reference/quantitative/stats/skew.md | 65 -- .../reference/quantitative/stats/stdev.md | 63 -- .../reference/quantitative/stats/variance.md | 62 -- .../reference/quantitative/summary.md | 68 -- .../reference/quantitative/unitroot_test.md | 75 -- .../reference/regulators/_category_.json | 4 - .../reference/regulators/cftc/_category_.json | 4 - .../platform/reference/regulators/cftc/cot.md | 129 ---- .../reference/regulators/cftc/cot_search.md | 117 --- .../reference/regulators/cftc/index.mdx | 10 - .../platform/reference/regulators/index.mdx | 10 - .../reference/regulators/sec/_category_.json | 4 - .../reference/regulators/sec/cik_map.md | 103 --- .../reference/regulators/sec/index.mdx | 14 - .../regulators/sec/institutions_search.md | 110 --- .../regulators/sec/rss_litigation.md | 109 --- .../reference/regulators/sec/schema_files.md | 124 --- .../reference/regulators/sec/sic_search.md | 113 --- .../reference/regulators/sec/symbol_map.md | 106 --- .../reference/technical/_category_.json | 4 - .../platform/reference/technical/ad.md | 83 -- .../platform/reference/technical/adosc.md | 81 -- .../platform/reference/technical/adx.md | 77 -- .../platform/reference/technical/aroon.md | 78 -- .../platform/reference/technical/atr.md | 80 -- .../platform/reference/technical/bbands.md | 82 -- .../platform/reference/technical/cci.md | 77 -- .../platform/reference/technical/cg.md | 83 -- .../platform/reference/technical/clenow.md | 80 -- .../platform/reference/technical/cones.md | 89 --- .../platform/reference/technical/demark.md | 86 --- .../platform/reference/technical/donchian.md | 80 -- .../platform/reference/technical/ema.md | 75 -- .../platform/reference/technical/fib.md | 69 -- .../platform/reference/technical/fisher.md | 85 --- .../platform/reference/technical/hma.md | 80 -- .../platform/reference/technical/ichimoku.md | 77 -- .../platform/reference/technical/index.mdx | 34 - .../platform/reference/technical/kc.md | 77 -- .../platform/reference/technical/macd.md | 89 --- .../platform/reference/technical/obv.md | 79 -- .../platform/reference/technical/rsi.md | 80 -- .../platform/reference/technical/sma.md | 78 -- .../platform/reference/technical/stoch.md | 94 --- .../platform/reference/technical/vwap.md | 69 -- .../platform/reference/technical/wma.md | 87 --- .../platform/reference/technical/zlma.md | 80 -- 424 files changed, 47082 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/AnalystSearch.md delete mode 100644 website/content/platform/data_models/AvailableIndices.md delete mode 100644 website/content/platform/data_models/BalanceOfPayments.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/BondPrices.md delete mode 100644 website/content/platform/data_models/CLI.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/CompareGroups.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/CurrencyReferenceRates.md delete mode 100644 website/content/platform/data_models/CurrencySnapshots.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/EquityScreener.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/EtfEquityExposure.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/FinancialRatios.md delete mode 100644 website/content/platform/data_models/Form13FHR.md delete mode 100644 website/content/platform/data_models/FredRegional.md delete mode 100644 website/content/platform/data_models/FredSearch.md delete mode 100644 website/content/platform/data_models/FredSeries.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/GrowthTechEquities.md delete mode 100644 website/content/platform/data_models/HighQualityMarketCorporateBond.md delete mode 100644 website/content/platform/data_models/HistoricalAttributes.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/HistoricalEps.md delete mode 100644 website/content/platform/data_models/HistoricalSplits.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/IndexHistorical.md delete mode 100644 website/content/platform/data_models/IndexSearch.md delete mode 100644 website/content/platform/data_models/IndexSectors.md delete mode 100644 website/content/platform/data_models/IndexSnapshots.md delete mode 100644 website/content/platform/data_models/InsiderTrading.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/LTIR.md delete mode 100644 website/content/platform/data_models/LatestAttributes.md delete mode 100644 website/content/platform/data_models/LbmaFixing.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/MoneyMeasures.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/ReportedFinancials.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/STIR.md delete mode 100644 website/content/platform/data_models/SchemaFiles.md delete mode 100644 website/content/platform/data_models/SearchAttributes.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/SymbolMap.md delete mode 100644 website/content/platform/data_models/TopRetail.md delete mode 100644 website/content/platform/data_models/TrailingDividendYield.md delete mode 100644 website/content/platform/data_models/TreasuryAuctions.md delete mode 100644 website/content/platform/data_models/TreasuryConstantMaturity.md delete mode 100644 website/content/platform/data_models/TreasuryPrices.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/Unemployment.md delete mode 100644 website/content/platform/data_models/UpcomingReleaseDays.md delete mode 100644 website/content/platform/data_models/WorldNews.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/commodity/_category_.json delete mode 100644 website/content/platform/reference/commodity/index.mdx delete mode 100644 website/content/platform/reference/commodity/lbma_fixing.md delete mode 100644 website/content/platform/reference/crypto/_category_.json delete mode 100644 website/content/platform/reference/crypto/index.mdx delete mode 100644 website/content/platform/reference/crypto/price/_category_.json delete mode 100644 website/content/platform/reference/crypto/price/historical.md delete mode 100644 website/content/platform/reference/crypto/price/index.mdx delete mode 100644 website/content/platform/reference/crypto/search.md delete mode 100644 website/content/platform/reference/currency/_category_.json delete mode 100644 website/content/platform/reference/currency/index.mdx delete mode 100644 website/content/platform/reference/currency/price/_category_.json delete mode 100644 website/content/platform/reference/currency/price/historical.md delete mode 100644 website/content/platform/reference/currency/price/index.mdx delete mode 100644 website/content/platform/reference/currency/reference_rates.md delete mode 100644 website/content/platform/reference/currency/search.md delete mode 100644 website/content/platform/reference/currency/snapshots.md delete mode 100644 website/content/platform/reference/derivatives/_category_.json delete mode 100644 website/content/platform/reference/derivatives/futures/_category_.json delete mode 100644 website/content/platform/reference/derivatives/futures/curve.md delete mode 100644 website/content/platform/reference/derivatives/futures/historical.md delete mode 100644 website/content/platform/reference/derivatives/futures/index.mdx delete mode 100644 website/content/platform/reference/derivatives/index.mdx delete mode 100644 website/content/platform/reference/derivatives/options/_category_.json delete mode 100644 website/content/platform/reference/derivatives/options/chains.md delete mode 100644 website/content/platform/reference/derivatives/options/index.mdx delete mode 100644 website/content/platform/reference/derivatives/options/unusual.md delete mode 100644 website/content/platform/reference/econometrics/_category_.json 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/_category_.json delete mode 100644 website/content/platform/reference/economy/balance_of_payments.md delete mode 100644 website/content/platform/reference/economy/calendar.md delete mode 100644 website/content/platform/reference/economy/composite_leading_indicator.md delete mode 100644 website/content/platform/reference/economy/cpi.md delete mode 100644 website/content/platform/reference/economy/fred_regional.md delete mode 100644 website/content/platform/reference/economy/fred_search.md delete mode 100644 website/content/platform/reference/economy/fred_series.md delete mode 100644 website/content/platform/reference/economy/gdp/_category_.json delete mode 100644 website/content/platform/reference/economy/gdp/forecast.md delete mode 100644 website/content/platform/reference/economy/gdp/index.mdx delete mode 100644 website/content/platform/reference/economy/gdp/nominal.md delete mode 100644 website/content/platform/reference/economy/gdp/real.md delete mode 100644 website/content/platform/reference/economy/index.mdx delete mode 100644 website/content/platform/reference/economy/long_term_interest_rate.md delete mode 100644 website/content/platform/reference/economy/money_measures.md delete mode 100644 website/content/platform/reference/economy/risk_premium.md delete mode 100644 website/content/platform/reference/economy/short_term_interest_rate.md delete mode 100644 website/content/platform/reference/economy/unemployment.md delete mode 100644 website/content/platform/reference/equity/_category_.json delete mode 100644 website/content/platform/reference/equity/calendar/_category_.json delete mode 100644 website/content/platform/reference/equity/calendar/dividend.md delete mode 100644 website/content/platform/reference/equity/calendar/earnings.md delete mode 100644 website/content/platform/reference/equity/calendar/index.mdx delete mode 100644 website/content/platform/reference/equity/calendar/ipo.md delete mode 100644 website/content/platform/reference/equity/calendar/splits.md delete mode 100644 website/content/platform/reference/equity/compare/_category_.json delete mode 100644 website/content/platform/reference/equity/compare/groups.md delete mode 100644 website/content/platform/reference/equity/compare/index.mdx delete mode 100644 website/content/platform/reference/equity/compare/peers.md delete mode 100644 website/content/platform/reference/equity/darkpool/_category_.json delete mode 100644 website/content/platform/reference/equity/darkpool/index.mdx delete mode 100644 website/content/platform/reference/equity/darkpool/otc.md delete mode 100644 website/content/platform/reference/equity/discovery/_category_.json delete mode 100644 website/content/platform/reference/equity/discovery/active.md delete mode 100644 website/content/platform/reference/equity/discovery/aggressive_small_caps.md delete mode 100644 website/content/platform/reference/equity/discovery/filings.md delete mode 100644 website/content/platform/reference/equity/discovery/gainers.md delete mode 100644 website/content/platform/reference/equity/discovery/growth_tech.md delete mode 100644 website/content/platform/reference/equity/discovery/index.mdx delete mode 100644 website/content/platform/reference/equity/discovery/losers.md delete mode 100644 website/content/platform/reference/equity/discovery/top_retail.md delete mode 100644 website/content/platform/reference/equity/discovery/undervalued_growth.md delete mode 100644 website/content/platform/reference/equity/discovery/undervalued_large_caps.md delete mode 100644 website/content/platform/reference/equity/discovery/upcoming_release_days.md delete mode 100644 website/content/platform/reference/equity/estimates/_category_.json delete mode 100644 website/content/platform/reference/equity/estimates/analyst_search.md delete mode 100644 website/content/platform/reference/equity/estimates/consensus.md delete mode 100644 website/content/platform/reference/equity/estimates/historical.md delete mode 100644 website/content/platform/reference/equity/estimates/index.mdx delete mode 100644 website/content/platform/reference/equity/estimates/price_target.md delete mode 100644 website/content/platform/reference/equity/fundamental/_category_.json delete mode 100644 website/content/platform/reference/equity/fundamental/balance.md delete mode 100644 website/content/platform/reference/equity/fundamental/balance_growth.md delete mode 100644 website/content/platform/reference/equity/fundamental/cash.md delete mode 100644 website/content/platform/reference/equity/fundamental/cash_growth.md delete mode 100644 website/content/platform/reference/equity/fundamental/dividends.md delete mode 100644 website/content/platform/reference/equity/fundamental/employee_count.md delete mode 100644 website/content/platform/reference/equity/fundamental/filings.md delete mode 100644 website/content/platform/reference/equity/fundamental/historical_attributes.md delete mode 100644 website/content/platform/reference/equity/fundamental/historical_eps.md delete mode 100644 website/content/platform/reference/equity/fundamental/historical_splits.md delete mode 100644 website/content/platform/reference/equity/fundamental/income.md delete mode 100644 website/content/platform/reference/equity/fundamental/income_growth.md delete mode 100644 website/content/platform/reference/equity/fundamental/index.mdx delete mode 100644 website/content/platform/reference/equity/fundamental/latest_attributes.md delete mode 100644 website/content/platform/reference/equity/fundamental/management.md delete mode 100644 website/content/platform/reference/equity/fundamental/management_compensation.md delete mode 100644 website/content/platform/reference/equity/fundamental/metrics.md delete mode 100644 website/content/platform/reference/equity/fundamental/multiples.md delete mode 100644 website/content/platform/reference/equity/fundamental/overview.md delete mode 100644 website/content/platform/reference/equity/fundamental/ratios.md delete mode 100644 website/content/platform/reference/equity/fundamental/reported_financials.md delete mode 100644 website/content/platform/reference/equity/fundamental/revenue_per_geography.md delete mode 100644 website/content/platform/reference/equity/fundamental/revenue_per_segment.md delete mode 100644 website/content/platform/reference/equity/fundamental/search_attributes.md delete mode 100644 website/content/platform/reference/equity/fundamental/trailing_dividend_yield.md delete mode 100644 website/content/platform/reference/equity/fundamental/transcript.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/ownership/_category_.json delete mode 100644 website/content/platform/reference/equity/ownership/form_13f.md delete mode 100644 website/content/platform/reference/equity/ownership/index.mdx delete mode 100644 website/content/platform/reference/equity/ownership/insider_trading.md delete mode 100644 website/content/platform/reference/equity/ownership/institutional.md delete mode 100644 website/content/platform/reference/equity/ownership/major_holders.md delete mode 100644 website/content/platform/reference/equity/ownership/share_statistics.md delete mode 100644 website/content/platform/reference/equity/price/_category_.json delete mode 100644 website/content/platform/reference/equity/price/historical.md delete mode 100644 website/content/platform/reference/equity/price/index.mdx delete mode 100644 website/content/platform/reference/equity/price/nbbo.md delete mode 100644 website/content/platform/reference/equity/price/performance.md delete mode 100644 website/content/platform/reference/equity/price/quote.md delete mode 100644 website/content/platform/reference/equity/profile.md delete mode 100644 website/content/platform/reference/equity/screener.md delete mode 100644 website/content/platform/reference/equity/search.md delete mode 100644 website/content/platform/reference/equity/shorts/_category_.json delete mode 100644 website/content/platform/reference/equity/shorts/fails_to_deliver.md delete mode 100644 website/content/platform/reference/equity/shorts/index.mdx delete mode 100644 website/content/platform/reference/equity/shorts/short_interest.md delete mode 100644 website/content/platform/reference/equity/shorts/short_volume.md delete mode 100644 website/content/platform/reference/etf/_category_.json delete mode 100644 website/content/platform/reference/etf/countries.md delete mode 100644 website/content/platform/reference/etf/discovery/_category_.json delete mode 100644 website/content/platform/reference/etf/discovery/active.md delete mode 100644 website/content/platform/reference/etf/discovery/gainers.md delete mode 100644 website/content/platform/reference/etf/discovery/index.mdx delete mode 100644 website/content/platform/reference/etf/discovery/losers.md delete mode 100644 website/content/platform/reference/etf/equity_exposure.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/_category_.json delete mode 100644 website/content/platform/reference/fixedincome/corporate/_category_.json delete mode 100644 website/content/platform/reference/fixedincome/corporate/bond_prices.md delete mode 100644 website/content/platform/reference/fixedincome/corporate/commercial_paper.md delete mode 100644 website/content/platform/reference/fixedincome/corporate/hqm.md delete mode 100644 website/content/platform/reference/fixedincome/corporate/ice_bofa.md delete mode 100644 website/content/platform/reference/fixedincome/corporate/index.mdx delete mode 100644 website/content/platform/reference/fixedincome/corporate/moody.md delete mode 100644 website/content/platform/reference/fixedincome/corporate/spot_rates.md delete mode 100644 website/content/platform/reference/fixedincome/government/_category_.json delete mode 100644 website/content/platform/reference/fixedincome/government/eu_yield_curve.md delete mode 100644 website/content/platform/reference/fixedincome/government/index.mdx delete mode 100644 website/content/platform/reference/fixedincome/government/treasury_auctions.md delete mode 100644 website/content/platform/reference/fixedincome/government/treasury_prices.md delete mode 100644 website/content/platform/reference/fixedincome/government/treasury_rates.md delete mode 100644 website/content/platform/reference/fixedincome/government/us_yield_curve.md delete mode 100644 website/content/platform/reference/fixedincome/index.mdx delete mode 100644 website/content/platform/reference/fixedincome/rate/_category_.json delete mode 100644 website/content/platform/reference/fixedincome/rate/ameribor.md delete mode 100644 website/content/platform/reference/fixedincome/rate/dpcredit.md delete mode 100644 website/content/platform/reference/fixedincome/rate/ecb.md delete mode 100644 website/content/platform/reference/fixedincome/rate/effr.md delete mode 100644 website/content/platform/reference/fixedincome/rate/effr_forecast.md delete mode 100644 website/content/platform/reference/fixedincome/rate/estr.md delete mode 100644 website/content/platform/reference/fixedincome/rate/index.mdx delete mode 100644 website/content/platform/reference/fixedincome/rate/iorb.md delete mode 100644 website/content/platform/reference/fixedincome/rate/sonia.md delete mode 100644 website/content/platform/reference/fixedincome/sofr.md delete mode 100644 website/content/platform/reference/fixedincome/spreads/_category_.json delete mode 100644 website/content/platform/reference/fixedincome/spreads/index.mdx delete mode 100644 website/content/platform/reference/fixedincome/spreads/tcm.md delete mode 100644 website/content/platform/reference/fixedincome/spreads/tcm_effr.md delete mode 100644 website/content/platform/reference/fixedincome/spreads/treasury_effr.md delete mode 100644 website/content/platform/reference/index.mdx delete mode 100644 website/content/platform/reference/index/_category_.json 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/index.mdx delete mode 100644 website/content/platform/reference/index/market.md delete mode 100644 website/content/platform/reference/index/price/_category_.json delete mode 100644 website/content/platform/reference/index/price/historical.md delete mode 100644 website/content/platform/reference/index/price/index.mdx delete mode 100644 website/content/platform/reference/index/search.md delete mode 100644 website/content/platform/reference/index/sectors.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/_category_.json 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/quantitative/_category_.json 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/normality.md delete mode 100644 website/content/platform/reference/quantitative/performance/_category_.json delete mode 100644 website/content/platform/reference/quantitative/performance/index.mdx delete mode 100644 website/content/platform/reference/quantitative/performance/omega_ratio.md delete mode 100644 website/content/platform/reference/quantitative/performance/sharpe_ratio.md delete mode 100644 website/content/platform/reference/quantitative/performance/sortino_ratio.md delete mode 100644 website/content/platform/reference/quantitative/rolling/_category_.json delete mode 100644 website/content/platform/reference/quantitative/rolling/index.mdx delete mode 100644 website/content/platform/reference/quantitative/rolling/kurtosis.md delete mode 100644 website/content/platform/reference/quantitative/rolling/mean.md delete mode 100644 website/content/platform/reference/quantitative/rolling/quantile.md delete mode 100644 website/content/platform/reference/quantitative/rolling/skew.md delete mode 100644 website/content/platform/reference/quantitative/rolling/stdev.md delete mode 100644 website/content/platform/reference/quantitative/rolling/variance.md delete mode 100644 website/content/platform/reference/quantitative/stats/_category_.json delete mode 100644 website/content/platform/reference/quantitative/stats/index.mdx delete mode 100644 website/content/platform/reference/quantitative/stats/kurtosis.md delete mode 100644 website/content/platform/reference/quantitative/stats/mean.md delete mode 100644 website/content/platform/reference/quantitative/stats/quantile.md delete mode 100644 website/content/platform/reference/quantitative/stats/skew.md delete mode 100644 website/content/platform/reference/quantitative/stats/stdev.md delete mode 100644 website/content/platform/reference/quantitative/stats/variance.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/regulators/_category_.json delete mode 100644 website/content/platform/reference/regulators/cftc/_category_.json delete mode 100644 website/content/platform/reference/regulators/cftc/cot.md delete mode 100644 website/content/platform/reference/regulators/cftc/cot_search.md delete mode 100644 website/content/platform/reference/regulators/cftc/index.mdx delete mode 100644 website/content/platform/reference/regulators/index.mdx delete mode 100644 website/content/platform/reference/regulators/sec/_category_.json delete mode 100644 website/content/platform/reference/regulators/sec/cik_map.md delete mode 100644 website/content/platform/reference/regulators/sec/index.mdx delete mode 100644 website/content/platform/reference/regulators/sec/institutions_search.md delete mode 100644 website/content/platform/reference/regulators/sec/rss_litigation.md delete mode 100644 website/content/platform/reference/regulators/sec/schema_files.md delete mode 100644 website/content/platform/reference/regulators/sec/sic_search.md delete mode 100644 website/content/platform/reference/regulators/sec/symbol_map.md delete mode 100644 website/content/platform/reference/technical/_category_.json 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/website/content/platform/data_models/AMERIBOR.md b/website/content/platform/data_models/AMERIBOR.md deleted file mode 100644 index bf158e640906..000000000000 --- a/website/content/platform/data_models/AMERIBOR.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "Ameribor" -description: "Ameribor" ---- - - - -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. | - - - - -| 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 8b724b820581..000000000000 --- a/website/content/platform/data_models/AnalystEstimates.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: "Analyst Estimates" -description: "Get historical analyst estimates for earnings and revenue" ---- - - - -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 | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | 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. | - - - - -| 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/AnalystSearch.md b/website/content/platform/data_models/AnalystSearch.md deleted file mode 100644 index ed2e457bf52b..000000000000 --- a/website/content/platform/data_models/AnalystSearch.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "Analyst Search" -description: "Search for specific analysts and get their forecast track record" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `AnalystSearch` | `AnalystSearchQueryParams` | `AnalystSearchData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.analyst_search import ( -AnalystSearchData, -AnalystSearchQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| analyst_name | str | A comma separated list of analyst names to bring back. Omitting will bring back all available analysts. | None | True | -| firm_name | str | A comma separated list of firm names to bring back. Omitting will bring back all available firms. | None | True | -| provider | Literal['benzinga'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| analyst_name | str | A comma separated list of analyst names to bring back. Omitting will bring back all available analysts. | None | True | -| firm_name | str | A comma separated list of firm names to bring back. Omitting will bring back all available firms. | None | True | -| provider | Literal['benzinga'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| analyst_ids | Union[str, List[str]] | A comma separated list of analyst IDs to bring back. | None | True | -| firm_ids | Union[str, List[str]] | A comma separated list of firm IDs to bring back. | None | True | -| limit | int | Number of results returned. Limit 1000. | 100 | True | -| page | int | 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. | 0 | True | -| fields | Union[str, List[str]] | 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. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| last_updated | datetime | Date of the last update. | -| firm_name | str | Firm name of the analyst. | -| name_first | str | Analyst first name. | -| name_last | str | Analyst last name. | -| name_full | str | Analyst full name. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| last_updated | datetime | Date of the last update. | -| firm_name | str | Firm name of the analyst. | -| name_first | str | Analyst first name. | -| name_last | str | Analyst last name. | -| name_full | str | Analyst full name. | -| analyst_id | str | ID of the analyst. | -| firm_id | str | ID of the analyst firm. | -| smart_score | float | A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate | -| overall_success_rate | float | The percentage (normalized) of gain/loss ratings that resulted in a gain overall. | -| overall_avg_return_percentile | float | The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating. | -| total_ratings_percentile | float | The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts | -| total_ratings | int | Number of recommendations made by this analyst. | -| overall_gain_count | int | The number of ratings that have gained value since the date of recommendation | -| overall_loss_count | int | The number of ratings that have lost value since the date of recommendation | -| overall_average_return | float | The average percent (normalized) price difference per rating since the date of recommendation | -| overall_std_dev | float | The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation | -| gain_count_1m | int | The number of ratings that have gained value over the last month | -| loss_count_1m | int | The number of ratings that have lost value over the last month | -| average_return_1m | float | The average percent (normalized) price difference per rating over the last month | -| std_dev_1m | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month | -| gain_count_3m | int | The number of ratings that have gained value over the last 3 months | -| loss_count_3m | int | The number of ratings that have lost value over the last 3 months | -| average_return_3m | float | The average percent (normalized) price difference per rating over the last 3 months | -| std_dev_3m | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months | -| gain_count_6m | int | The number of ratings that have gained value over the last 6 months | -| loss_count_6m | int | The number of ratings that have lost value over the last 6 months | -| average_return_6m | float | The average percent (normalized) price difference per rating over the last 6 months | -| std_dev_6m | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months | -| gain_count_9m | int | The number of ratings that have gained value over the last 9 months | -| loss_count_9m | int | The number of ratings that have lost value over the last 9 months | -| average_return_9m | float | The average percent (normalized) price difference per rating over the last 9 months | -| std_dev_9m | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months | -| gain_count_1y | int | The number of ratings that have gained value over the last 1 year | -| loss_count_1y | int | The number of ratings that have lost value over the last 1 year | -| average_return_1y | float | The average percent (normalized) price difference per rating over the last 1 year | -| std_dev_1y | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year | -| gain_count_2y | int | The number of ratings that have gained value over the last 2 years | -| loss_count_2y | int | The number of ratings that have lost value over the last 2 years | -| average_return_2y | float | The average percent (normalized) price difference per rating over the last 2 years | -| std_dev_2y | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years | -| gain_count_3y | int | The number of ratings that have gained value over the last 3 years | -| loss_count_3y | int | The number of ratings that have lost value over the last 3 years | -| average_return_3y | float | The average percent (normalized) price difference per rating over the last 3 years | -| std_dev_3y | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years | - - - - diff --git a/website/content/platform/data_models/AvailableIndices.md b/website/content/platform/data_models/AvailableIndices.md deleted file mode 100644 index c08820f04c26..000000000000 --- a/website/content/platform/data_models/AvailableIndices.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -title: "Available Indices" -description: "All indices available from a given provider" ---- - - - -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', 'tmx', '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', 'tmx', '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 | -| use_cache | bool | When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['cboe', 'fmp', 'tmx', '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', 'tmx', '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 | -| use_cache | bool | Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['cboe', 'fmp', 'tmx', '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 | - - - - ---- - -## 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. | -| 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. | -| symbol | str | The ticker symbol of the index. | - - - - -| 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/BalanceOfPayments.md b/website/content/platform/data_models/BalanceOfPayments.md deleted file mode 100644 index 992470e65d2f..000000000000 --- a/website/content/platform/data_models/BalanceOfPayments.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -title: "Balance Of Payments" -description: "Balance of Payments Reports" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `BalanceOfPayments` | `BalanceOfPaymentsQueryParams` | `BalanceOfPaymentsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -BalanceOfPaymentsData, -BalanceOfPaymentsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | -| report_type | Literal['main', 'summary', 'services', 'investment_income', 'direct_investment', 'portfolio_investment', 'other_investment'] | The report type, the level of detail in the data. | main | True | -| frequency | Literal['monthly', 'quarterly'] | The frequency of the data. Monthly is valid only for ['main', 'summary']. | monthly | True | -| country | Literal['brazil', 'canada', 'china', 'eu_ex_euro_area', 'eu_institutions', 'india', 'japan', 'russia', 'switzerland', 'united_kingdom', 'united_states', 'total'] | The country/region of the data. This parameter will override the 'report_type' parameter. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period | date | The date representing the beginning of the reporting period. | -| current_account | float | Current Account Balance (Billions of EUR) | -| goods | float | Goods Balance (Billions of EUR) | -| services | float | Services Balance (Billions of EUR) | -| primary_income | float | Primary Income Balance (Billions of EUR) | -| secondary_income | float | Secondary Income Balance (Billions of EUR) | -| capital_account | float | Capital Account Balance (Billions of EUR) | -| net_lending_to_rest_of_world | float | Balance of net lending to the rest of the world (Billions of EUR) | -| financial_account | float | Financial Account Balance (Billions of EUR) | -| direct_investment | float | Direct Investment Balance (Billions of EUR) | -| portfolio_investment | float | Portfolio Investment Balance (Billions of EUR) | -| financial_derivatives | float | Financial Derivatives Balance (Billions of EUR) | -| other_investment | float | Other Investment Balance (Billions of EUR) | -| reserve_assets | float | Reserve Assets Balance (Billions of EUR) | -| errors_and_ommissions | float | Errors and Omissions (Billions of EUR) | -| current_account_credit | float | Current Account Credits (Billions of EUR) | -| current_account_debit | float | Current Account Debits (Billions of EUR) | -| current_account_balance | float | Current Account Balance (Billions of EUR) | -| goods_credit | float | Goods Credits (Billions of EUR) | -| goods_debit | float | Goods Debits (Billions of EUR) | -| services_credit | float | Services Credits (Billions of EUR) | -| services_debit | float | Services Debits (Billions of EUR) | -| primary_income_credit | float | Primary Income Credits (Billions of EUR) | -| primary_income_employee_compensation_credit | float | Primary Income Employee Compensation Credit (Billions of EUR) | -| primary_income_debit | float | Primary Income Debits (Billions of EUR) | -| primary_income_employee_compensation_debit | float | Primary Income Employee Compensation Debit (Billions of EUR) | -| secondary_income_credit | float | Secondary Income Credits (Billions of EUR) | -| secondary_income_debit | float | Secondary Income Debits (Billions of EUR) | -| capital_account_credit | float | Capital Account Credits (Billions of EUR) | -| capital_account_debit | float | Capital Account Debits (Billions of EUR) | -| services_total_credit | float | Services Total Credit (Billions of EUR) | -| services_total_debit | float | Services Total Debit (Billions of EUR) | -| transport_credit | float | Transport Credit (Billions of EUR) | -| transport_debit | float | Transport Debit (Billions of EUR) | -| travel_credit | float | Travel Credit (Billions of EUR) | -| travel_debit | float | Travel Debit (Billions of EUR) | -| financial_services_credit | float | Financial Services Credit (Billions of EUR) | -| financial_services_debit | float | Financial Services Debit (Billions of EUR) | -| communications_credit | float | Communications Credit (Billions of EUR) | -| communications_debit | float | Communications Debit (Billions of EUR) | -| other_business_services_credit | float | Other Business Services Credit (Billions of EUR) | -| other_business_services_debit | float | Other Business Services Debit (Billions of EUR) | -| other_services_credit | float | Other Services Credit (Billions of EUR) | -| other_services_debit | float | Other Services Debit (Billions of EUR) | -| investment_total_credit | float | Investment Total Credit (Billions of EUR) | -| investment_total_debit | float | Investment Total Debit (Billions of EUR) | -| equity_credit | float | Equity Credit (Billions of EUR) | -| equity_reinvested_earnings_credit | float | Equity Reinvested Earnings Credit (Billions of EUR) | -| equity_debit | float | Equity Debit (Billions of EUR) | -| equity_reinvested_earnings_debit | float | Equity Reinvested Earnings Debit (Billions of EUR) | -| debt_instruments_credit | float | Debt Instruments Credit (Billions of EUR) | -| debt_instruments_debit | float | Debt Instruments Debit (Billions of EUR) | -| portfolio_investment_equity_credit | float | Portfolio Investment Equity Credit (Billions of EUR) | -| portfolio_investment_equity_debit | float | Portfolio Investment Equity Debit (Billions of EUR) | -| portfolio_investment_debt_instruments_credit | float | Portfolio Investment Debt Instruments Credit (Billions of EUR) | -| portofolio_investment_debt_instruments_debit | float | Portfolio Investment Debt Instruments Debit (Billions of EUR) | -| other_investment_credit | float | Other Investment Credit (Billions of EUR) | -| other_investment_debit | float | Other Investment Debit (Billions of EUR) | -| reserve_assets_credit | float | Reserve Assets Credit (Billions of EUR) | -| assets_total | float | Assets Total (Billions of EUR) | -| assets_equity | float | Assets Equity (Billions of EUR) | -| assets_debt_instruments | float | Assets Debt Instruments (Billions of EUR) | -| assets_mfi | float | Assets MFIs (Billions of EUR) | -| assets_non_mfi | float | Assets Non MFIs (Billions of EUR) | -| assets_direct_investment_abroad | float | Assets Direct Investment Abroad (Billions of EUR) | -| liabilities_total | float | Liabilities Total (Billions of EUR) | -| liabilities_equity | float | Liabilities Equity (Billions of EUR) | -| liabilities_debt_instruments | float | Liabilities Debt Instruments (Billions of EUR) | -| liabilities_mfi | float | Liabilities MFIs (Billions of EUR) | -| liabilities_non_mfi | float | Liabilities Non MFIs (Billions of EUR) | -| liabilities_direct_investment_euro_area | float | Liabilities Direct Investment in Euro Area (Billions of EUR) | -| assets_equity_and_fund_shares | float | Assets Equity and Investment Fund Shares (Billions of EUR) | -| assets_equity_shares | float | Assets Equity Shares (Billions of EUR) | -| assets_investment_fund_shares | float | Assets Investment Fund Shares (Billions of EUR) | -| assets_debt_short_term | float | Assets Debt Short Term (Billions of EUR) | -| assets_debt_long_term | float | Assets Debt Long Term (Billions of EUR) | -| assets_resident_sector_eurosystem | float | Assets Resident Sector Eurosystem (Billions of EUR) | -| assets_resident_sector_mfi_ex_eurosystem | float | Assets Resident Sector MFIs outside Eurosystem (Billions of EUR) | -| assets_resident_sector_government | float | Assets Resident Sector Government (Billions of EUR) | -| assets_resident_sector_other | float | Assets Resident Sector Other (Billions of EUR) | -| liabilities_equity_and_fund_shares | float | Liabilities Equity and Investment Fund Shares (Billions of EUR) | -| liabilities_investment_fund_shares | float | Liabilities Investment Fund Shares (Billions of EUR) | -| liabilities_debt_short_term | float | Liabilities Debt Short Term (Billions of EUR) | -| liabilities_debt_long_term | float | Liabilities Debt Long Term (Billions of EUR) | -| liabilities_resident_sector_government | float | Liabilities Resident Sector Government (Billions of EUR) | -| liabilities_resident_sector_other | float | Liabilities Resident Sector Other (Billions of EUR) | -| assets_currency_and_deposits | float | Assets Currency and Deposits (Billions of EUR) | -| assets_loans | float | Assets Loans (Billions of EUR) | -| assets_trade_credit_and_advances | float | Assets Trade Credits and Advances (Billions of EUR) | -| assets_eurosystem | float | Assets Eurosystem (Billions of EUR) | -| assets_other_mfi_ex_eurosystem | float | Assets Other MFIs outside Eurosystem (Billions of EUR) | -| assets_government | float | Assets Government (Billions of EUR) | -| assets_other_sectors | float | Assets Other Sectors (Billions of EUR) | -| liabilities_currency_and_deposits | float | Liabilities Currency and Deposits (Billions of EUR) | -| liabilities_loans | float | Liabilities Loans (Billions of EUR) | -| liabilities_trade_credit_and_advances | float | Liabilities Trade Credits and Advances (Billions of EUR) | -| liabilities_eurosystem | float | Liabilities Eurosystem (Billions of EUR) | -| liabilities_other_mfi_ex_eurosystem | float | Liabilities Other MFIs outside Eurosystem (Billions of EUR) | -| liabilities_government | float | Liabilities Government (Billions of EUR) | -| liabilities_other_sectors | float | Liabilities Other Sectors (Billions of EUR) | -| goods_balance | float | Goods Balance (Billions of EUR) | -| services_balance | float | Services Balance (Billions of EUR) | -| primary_income_balance | float | Primary Income Balance (Billions of EUR) | -| investment_income_balance | float | Investment Income Balance (Billions of EUR) | -| investment_income_credit | float | Investment Income Credits (Billions of EUR) | -| investment_income_debit | float | Investment Income Debits (Billions of EUR) | -| secondary_income_balance | float | Secondary Income Balance (Billions of EUR) | -| capital_account_balance | float | Capital Account Balance (Billions of EUR) | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period | date | The date representing the beginning of the reporting period. | -| current_account | float | Current Account Balance (Billions of EUR) | -| goods | float | Goods Balance (Billions of EUR) | -| services | float | Services Balance (Billions of EUR) | -| primary_income | float | Primary Income Balance (Billions of EUR) | -| secondary_income | float | Secondary Income Balance (Billions of EUR) | -| capital_account | float | Capital Account Balance (Billions of EUR) | -| net_lending_to_rest_of_world | float | Balance of net lending to the rest of the world (Billions of EUR) | -| financial_account | float | Financial Account Balance (Billions of EUR) | -| direct_investment | float | Direct Investment Balance (Billions of EUR) | -| portfolio_investment | float | Portfolio Investment Balance (Billions of EUR) | -| financial_derivatives | float | Financial Derivatives Balance (Billions of EUR) | -| other_investment | float | Other Investment Balance (Billions of EUR) | -| reserve_assets | float | Reserve Assets Balance (Billions of EUR) | -| errors_and_ommissions | float | Errors and Omissions (Billions of EUR) | -| current_account_credit | float | Current Account Credits (Billions of EUR) | -| current_account_debit | float | Current Account Debits (Billions of EUR) | -| current_account_balance | float | Current Account Balance (Billions of EUR) | -| goods_credit | float | Goods Credits (Billions of EUR) | -| goods_debit | float | Goods Debits (Billions of EUR) | -| services_credit | float | Services Credits (Billions of EUR) | -| services_debit | float | Services Debits (Billions of EUR) | -| primary_income_credit | float | Primary Income Credits (Billions of EUR) | -| primary_income_employee_compensation_credit | float | Primary Income Employee Compensation Credit (Billions of EUR) | -| primary_income_debit | float | Primary Income Debits (Billions of EUR) | -| primary_income_employee_compensation_debit | float | Primary Income Employee Compensation Debit (Billions of EUR) | -| secondary_income_credit | float | Secondary Income Credits (Billions of EUR) | -| secondary_income_debit | float | Secondary Income Debits (Billions of EUR) | -| capital_account_credit | float | Capital Account Credits (Billions of EUR) | -| capital_account_debit | float | Capital Account Debits (Billions of EUR) | -| services_total_credit | float | Services Total Credit (Billions of EUR) | -| services_total_debit | float | Services Total Debit (Billions of EUR) | -| transport_credit | float | Transport Credit (Billions of EUR) | -| transport_debit | float | Transport Debit (Billions of EUR) | -| travel_credit | float | Travel Credit (Billions of EUR) | -| travel_debit | float | Travel Debit (Billions of EUR) | -| financial_services_credit | float | Financial Services Credit (Billions of EUR) | -| financial_services_debit | float | Financial Services Debit (Billions of EUR) | -| communications_credit | float | Communications Credit (Billions of EUR) | -| communications_debit | float | Communications Debit (Billions of EUR) | -| other_business_services_credit | float | Other Business Services Credit (Billions of EUR) | -| other_business_services_debit | float | Other Business Services Debit (Billions of EUR) | -| other_services_credit | float | Other Services Credit (Billions of EUR) | -| other_services_debit | float | Other Services Debit (Billions of EUR) | -| investment_total_credit | float | Investment Total Credit (Billions of EUR) | -| investment_total_debit | float | Investment Total Debit (Billions of EUR) | -| equity_credit | float | Equity Credit (Billions of EUR) | -| equity_reinvested_earnings_credit | float | Equity Reinvested Earnings Credit (Billions of EUR) | -| equity_debit | float | Equity Debit (Billions of EUR) | -| equity_reinvested_earnings_debit | float | Equity Reinvested Earnings Debit (Billions of EUR) | -| debt_instruments_credit | float | Debt Instruments Credit (Billions of EUR) | -| debt_instruments_debit | float | Debt Instruments Debit (Billions of EUR) | -| portfolio_investment_equity_credit | float | Portfolio Investment Equity Credit (Billions of EUR) | -| portfolio_investment_equity_debit | float | Portfolio Investment Equity Debit (Billions of EUR) | -| portfolio_investment_debt_instruments_credit | float | Portfolio Investment Debt Instruments Credit (Billions of EUR) | -| portofolio_investment_debt_instruments_debit | float | Portfolio Investment Debt Instruments Debit (Billions of EUR) | -| other_investment_credit | float | Other Investment Credit (Billions of EUR) | -| other_investment_debit | float | Other Investment Debit (Billions of EUR) | -| reserve_assets_credit | float | Reserve Assets Credit (Billions of EUR) | -| assets_total | float | Assets Total (Billions of EUR) | -| assets_equity | float | Assets Equity (Billions of EUR) | -| assets_debt_instruments | float | Assets Debt Instruments (Billions of EUR) | -| assets_mfi | float | Assets MFIs (Billions of EUR) | -| assets_non_mfi | float | Assets Non MFIs (Billions of EUR) | -| assets_direct_investment_abroad | float | Assets Direct Investment Abroad (Billions of EUR) | -| liabilities_total | float | Liabilities Total (Billions of EUR) | -| liabilities_equity | float | Liabilities Equity (Billions of EUR) | -| liabilities_debt_instruments | float | Liabilities Debt Instruments (Billions of EUR) | -| liabilities_mfi | float | Liabilities MFIs (Billions of EUR) | -| liabilities_non_mfi | float | Liabilities Non MFIs (Billions of EUR) | -| liabilities_direct_investment_euro_area | float | Liabilities Direct Investment in Euro Area (Billions of EUR) | -| assets_equity_and_fund_shares | float | Assets Equity and Investment Fund Shares (Billions of EUR) | -| assets_equity_shares | float | Assets Equity Shares (Billions of EUR) | -| assets_investment_fund_shares | float | Assets Investment Fund Shares (Billions of EUR) | -| assets_debt_short_term | float | Assets Debt Short Term (Billions of EUR) | -| assets_debt_long_term | float | Assets Debt Long Term (Billions of EUR) | -| assets_resident_sector_eurosystem | float | Assets Resident Sector Eurosystem (Billions of EUR) | -| assets_resident_sector_mfi_ex_eurosystem | float | Assets Resident Sector MFIs outside Eurosystem (Billions of EUR) | -| assets_resident_sector_government | float | Assets Resident Sector Government (Billions of EUR) | -| assets_resident_sector_other | float | Assets Resident Sector Other (Billions of EUR) | -| liabilities_equity_and_fund_shares | float | Liabilities Equity and Investment Fund Shares (Billions of EUR) | -| liabilities_investment_fund_shares | float | Liabilities Investment Fund Shares (Billions of EUR) | -| liabilities_debt_short_term | float | Liabilities Debt Short Term (Billions of EUR) | -| liabilities_debt_long_term | float | Liabilities Debt Long Term (Billions of EUR) | -| liabilities_resident_sector_government | float | Liabilities Resident Sector Government (Billions of EUR) | -| liabilities_resident_sector_other | float | Liabilities Resident Sector Other (Billions of EUR) | -| assets_currency_and_deposits | float | Assets Currency and Deposits (Billions of EUR) | -| assets_loans | float | Assets Loans (Billions of EUR) | -| assets_trade_credit_and_advances | float | Assets Trade Credits and Advances (Billions of EUR) | -| assets_eurosystem | float | Assets Eurosystem (Billions of EUR) | -| assets_other_mfi_ex_eurosystem | float | Assets Other MFIs outside Eurosystem (Billions of EUR) | -| assets_government | float | Assets Government (Billions of EUR) | -| assets_other_sectors | float | Assets Other Sectors (Billions of EUR) | -| liabilities_currency_and_deposits | float | Liabilities Currency and Deposits (Billions of EUR) | -| liabilities_loans | float | Liabilities Loans (Billions of EUR) | -| liabilities_trade_credit_and_advances | float | Liabilities Trade Credits and Advances (Billions of EUR) | -| liabilities_eurosystem | float | Liabilities Eurosystem (Billions of EUR) | -| liabilities_other_mfi_ex_eurosystem | float | Liabilities Other MFIs outside Eurosystem (Billions of EUR) | -| liabilities_government | float | Liabilities Government (Billions of EUR) | -| liabilities_other_sectors | float | Liabilities Other Sectors (Billions of EUR) | -| goods_balance | float | Goods Balance (Billions of EUR) | -| services_balance | float | Services Balance (Billions of EUR) | -| primary_income_balance | float | Primary Income Balance (Billions of EUR) | -| investment_income_balance | float | Investment Income Balance (Billions of EUR) | -| investment_income_credit | float | Investment Income Credits (Billions of EUR) | -| investment_income_debit | float | Investment Income Debits (Billions of EUR) | -| secondary_income_balance | float | Secondary Income Balance (Billions of EUR) | -| capital_account_balance | float | Capital Account Balance (Billions of EUR) | - - - - diff --git a/website/content/platform/data_models/BalanceSheet.md b/website/content/platform/data_models/BalanceSheet.md deleted file mode 100644 index ea5bcf05d42d..000000000000 --- a/website/content/platform/data_models/BalanceSheet.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -title: "Balance Sheet" -description: "Get the balance sheet for a given company" ---- - - - -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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | -| fiscal_year | int | The specific fiscal year. Reports do not go beyond 2008. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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. | True | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| filing_date | date | The date when the filing was made. | -| accepted_date | datetime | The date and time when the filing was accepted. | -| reported_currency | str | The currency in which the balance sheet was reported. | -| cash_and_cash_equivalents | float | Cash and cash equivalents. | -| short_term_investments | float | Short term investments. | -| cash_and_short_term_investments | float | Cash and short term investments. | -| net_receivables | float | Net receivables. | -| inventory | float | Inventory. | -| other_current_assets | float | Other current assets. | -| total_current_assets | float | Total current assets. | -| plant_property_equipment_net | float | Plant property equipment net. | -| goodwill | float | Goodwill. | -| intangible_assets | float | Intangible assets. | -| goodwill_and_intangible_assets | float | Goodwill and intangible assets. | -| long_term_investments | float | Long term investments. | -| tax_assets | float | Tax assets. | -| other_non_current_assets | float | Other non current assets. | -| non_current_assets | float | Total non current assets. | -| other_assets | float | Other assets. | -| total_assets | float | Total assets. | -| accounts_payable | float | Accounts payable. | -| short_term_debt | float | Short term debt. | -| tax_payables | float | Tax payables. | -| current_deferred_revenue | float | Current deferred revenue. | -| other_current_liabilities | float | Other current liabilities. | -| total_current_liabilities | float | Total current liabilities. | -| long_term_debt | float | Long term debt. | -| deferred_revenue_non_current | float | Non current deferred revenue. | -| deferred_tax_liabilities_non_current | float | Deferred tax liabilities non current. | -| other_non_current_liabilities | float | Other non current liabilities. | -| total_non_current_liabilities | float | Total non current liabilities. | -| other_liabilities | float | Other liabilities. | -| capital_lease_obligations | float | Capital lease obligations. | -| total_liabilities | float | Total liabilities. | -| preferred_stock | float | Preferred stock. | -| common_stock | float | Common stock. | -| retained_earnings | float | Retained earnings. | -| accumulated_other_comprehensive_income | float | Accumulated other comprehensive income (loss). | -| other_shareholders_equity | float | Other shareholders equity. | -| other_total_shareholders_equity | float | Other total shareholders equity. | -| total_common_equity | float | Total common equity. | -| total_equity_non_controlling_interests | float | Total equity non controlling interests. | -| total_liabilities_and_shareholders_equity | float | Total liabilities and shareholders equity. | -| minority_interest | float | Minority interest. | -| total_liabilities_and_total_equity | float | Total liabilities and total equity. | -| total_investments | float | Total investments. | -| total_debt | float | Total debt. | -| net_debt | float | Net debt. | -| link | str | Link to the filing. | -| final_link | str | Link to the filing document. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| reported_currency | str | The currency in which the balance sheet is reported. | -| cash_and_cash_equivalents | float | Cash and cash equivalents. | -| cash_and_due_from_banks | float | Cash and due from banks. | -| restricted_cash | float | Restricted cash. | -| short_term_investments | float | Short term investments. | -| federal_funds_sold | float | Federal funds sold. | -| accounts_receivable | float | Accounts receivable. | -| note_and_lease_receivable | float | Note and lease receivable. (Vendor non-trade receivables) | -| inventories | float | Net Inventories. | -| customer_and_other_receivables | float | Customer and other receivables. | -| interest_bearing_deposits_at_other_banks | float | Interest bearing deposits at other banks. | -| time_deposits_placed_and_other_short_term_investments | float | Time deposits placed and other short term investments. | -| trading_account_securities | float | Trading account securities. | -| loans_and_leases | float | Loans and leases. | -| allowance_for_loan_and_lease_losses | float | Allowance for loan and lease losses. | -| current_deferred_refundable_income_taxes | float | Current deferred refundable income taxes. | -| other_current_assets | float | Other current assets. | -| loans_and_leases_net_of_allowance | float | Loans and leases net of allowance. | -| accrued_investment_income | float | Accrued investment income. | -| other_current_non_operating_assets | float | Other current non-operating assets. | -| loans_held_for_sale | float | Loans held for sale. | -| prepaid_expenses | float | Prepaid expenses. | -| total_current_assets | float | Total current assets. | -| plant_property_equipment_gross | float | Plant property equipment gross. | -| accumulated_depreciation | float | Accumulated depreciation. | -| premises_and_equipment_net | float | Net premises and equipment. | -| plant_property_equipment_net | float | Net plant property equipment. | -| long_term_investments | float | Long term investments. | -| mortgage_servicing_rights | float | Mortgage servicing rights. | -| unearned_premiums_asset | float | Unearned premiums asset. | -| non_current_note_lease_receivables | float | Non-current note lease receivables. | -| deferred_acquisition_cost | float | Deferred acquisition cost. | -| goodwill | float | Goodwill. | -| separate_account_business_assets | float | Separate account business assets. | -| non_current_deferred_refundable_income_taxes | float | Noncurrent deferred refundable income taxes. | -| intangible_assets | float | Intangible assets. | -| employee_benefit_assets | float | Employee benefit assets. | -| other_assets | float | Other assets. | -| other_non_current_operating_assets | float | Other noncurrent operating assets. | -| other_non_current_non_operating_assets | float | Other noncurrent non-operating assets. | -| interest_bearing_deposits | float | Interest bearing deposits. | -| total_non_current_assets | float | Total noncurrent assets. | -| total_assets | float | Total assets. | -| non_interest_bearing_deposits | float | Non interest bearing deposits. | -| federal_funds_purchased_and_securities_sold | float | Federal funds purchased and securities sold. | -| bankers_acceptance_outstanding | float | Bankers acceptance outstanding. | -| short_term_debt | float | Short term debt. | -| accounts_payable | float | Accounts payable. | -| current_deferred_revenue | float | Current deferred revenue. | -| current_deferred_payable_income_tax_liabilities | float | Current deferred payable income tax liabilities. | -| accrued_interest_payable | float | Accrued interest payable. | -| accrued_expenses | float | Accrued expenses. | -| other_short_term_payables | float | Other short term payables. | -| customer_deposits | float | Customer deposits. | -| dividends_payable | float | Dividends payable. | -| claims_and_claim_expense | float | Claims and claim expense. | -| future_policy_benefits | float | Future policy benefits. | -| current_employee_benefit_liabilities | float | Current employee benefit liabilities. | -| unearned_premiums_liability | float | Unearned premiums liability. | -| other_taxes_payable | float | Other taxes payable. | -| policy_holder_funds | float | Policy holder funds. | -| other_current_liabilities | float | Other current liabilities. | -| other_current_non_operating_liabilities | float | Other current non-operating liabilities. | -| separate_account_business_liabilities | float | Separate account business liabilities. | -| total_current_liabilities | float | Total current liabilities. | -| long_term_debt | float | Long term debt. | -| other_long_term_liabilities | float | Other long term liabilities. | -| non_current_deferred_revenue | float | Non-current deferred revenue. | -| non_current_deferred_payable_income_tax_liabilities | float | Non-current deferred payable income tax liabilities. | -| non_current_employee_benefit_liabilities | float | Non-current employee benefit liabilities. | -| other_non_current_operating_liabilities | float | Other non-current operating liabilities. | -| other_non_current_non_operating_liabilities | float | Other non-current, non-operating liabilities. | -| total_non_current_liabilities | float | Total non-current liabilities. | -| capital_lease_obligations | float | Capital lease obligations. | -| asset_retirement_reserve_litigation_obligation | float | Asset retirement reserve litigation obligation. | -| total_liabilities | float | Total liabilities. | -| commitments_contingencies | float | Commitments contingencies. | -| redeemable_non_controlling_interest | float | Redeemable non-controlling interest. | -| preferred_stock | float | Preferred stock. | -| common_stock | float | Common stock. | -| retained_earnings | float | Retained earnings. | -| treasury_stock | float | Treasury stock. | -| accumulated_other_comprehensive_income | float | Accumulated other comprehensive income. | -| participating_policy_holder_equity | float | Participating policy holder equity. | -| other_equity_adjustments | float | Other equity adjustments. | -| total_common_equity | float | Total common equity. | -| total_preferred_common_equity | float | Total preferred common equity. | -| non_controlling_interest | float | Non-controlling interest. | -| total_equity_non_controlling_interests | float | Total equity non-controlling interests. | -| total_liabilities_shareholders_equity | float | Total liabilities and shareholders equity. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| accounts_receivable | int | Accounts receivable | -| marketable_securities | int | Marketable securities | -| prepaid_expenses | int | Prepaid expenses | -| other_current_assets | int | Other current assets | -| total_current_assets | int | Total current assets | -| property_plant_equipment_net | int | Property plant and equipment net | -| inventory | int | Inventory | -| other_non_current_assets | int | Other non-current assets | -| total_non_current_assets | int | Total non-current assets | -| intangible_assets | int | Intangible assets | -| total_assets | int | Total assets | -| accounts_payable | int | Accounts payable | -| employee_wages | int | Employee wages | -| other_current_liabilities | int | Other current liabilities | -| total_current_liabilities | int | Total current liabilities | -| other_non_current_liabilities | int | Other non-current liabilities | -| total_non_current_liabilities | int | Total non-current liabilities | -| long_term_debt | int | Long term debt | -| total_liabilities | int | Total liabilities | -| minority_interest | int | Minority interest | -| temporary_equity_attributable_to_parent | int | Temporary equity attributable to parent | -| equity_attributable_to_parent | int | Equity attributable to parent | -| temporary_equity | int | Temporary equity | -| preferred_stock | int | Preferred stock | -| redeemable_non_controlling_interest | int | Redeemable non-controlling interest | -| redeemable_non_controlling_interest_other | int | Redeemable non-controlling interest other | -| total_stock_holders_equity | int | Total stock holders equity | -| total_liabilities_and_stock_holders_equity | int | Total liabilities and stockholders equity | -| total_equity | int | Total equity | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - diff --git a/website/content/platform/data_models/BalanceSheetGrowth.md b/website/content/platform/data_models/BalanceSheetGrowth.md deleted file mode 100644 index 89f955687e74..000000000000 --- a/website/content/platform/data_models/BalanceSheetGrowth.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: "Balance Sheet Growth" -description: "Get the growth of a company's balance sheet items over time" ---- - - - -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 | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | 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. | -| period | str | Reporting period. | -| growth_cash_and_cash_equivalents | float | Growth rate of cash and cash equivalents. | -| growth_short_term_investments | float | Growth rate of short-term investments. | -| growth_cash_and_short_term_investments | float | Growth rate of cash and short-term investments. | -| growth_net_receivables | float | Growth rate of net receivables. | -| growth_inventory | float | Growth rate of inventory. | -| growth_other_current_assets | float | Growth rate of other current assets. | -| growth_total_current_assets | float | Growth rate of total current assets. | -| growth_property_plant_equipment_net | float | Growth rate of net property, plant, and equipment. | -| growth_goodwill | float | Growth rate of goodwill. | -| growth_intangible_assets | float | Growth rate of intangible assets. | -| growth_goodwill_and_intangible_assets | float | Growth rate of goodwill and intangible assets. | -| growth_long_term_investments | float | Growth rate of long-term investments. | -| growth_tax_assets | float | Growth rate of tax assets. | -| growth_other_non_current_assets | float | Growth rate of other non-current assets. | -| growth_total_non_current_assets | float | Growth rate of total non-current assets. | -| growth_other_assets | float | Growth rate of other assets. | -| growth_total_assets | float | Growth rate of total assets. | -| growth_account_payables | float | Growth rate of accounts payable. | -| growth_short_term_debt | float | Growth rate of short-term debt. | -| growth_tax_payables | float | Growth rate of tax payables. | -| growth_deferred_revenue | float | Growth rate of deferred revenue. | -| growth_other_current_liabilities | float | Growth rate of other current liabilities. | -| growth_total_current_liabilities | float | Growth rate of total current liabilities. | -| growth_long_term_debt | float | Growth rate of long-term debt. | -| growth_deferred_revenue_non_current | float | Growth rate of non-current deferred revenue. | -| growth_deferrred_tax_liabilities_non_current | float | Growth rate of non-current deferred tax liabilities. | -| growth_other_non_current_liabilities | float | Growth rate of other non-current liabilities. | -| growth_total_non_current_liabilities | float | Growth rate of total non-current liabilities. | -| growth_other_liabilities | float | Growth rate of other liabilities. | -| growth_total_liabilities | float | Growth rate of total liabilities. | -| growth_common_stock | float | Growth rate of common stock. | -| growth_retained_earnings | float | Growth rate of retained earnings. | -| growth_accumulated_other_comprehensive_income_loss | float | Growth rate of accumulated other comprehensive income/loss. | -| growth_othertotal_stockholders_equity | float | Growth rate of other total stockholders' equity. | -| growth_total_stockholders_equity | float | Growth rate of total stockholders' equity. | -| growth_total_liabilities_and_stockholders_equity | float | Growth rate of total liabilities and stockholders' equity. | -| growth_total_investments | float | Growth rate of total investments. | -| growth_total_debt | float | Growth rate of total debt. | -| growth_net_debt | float | Growth rate of net debt. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| period | str | Reporting period. | -| growth_cash_and_cash_equivalents | float | Growth rate of cash and cash equivalents. | -| growth_short_term_investments | float | Growth rate of short-term investments. | -| growth_cash_and_short_term_investments | float | Growth rate of cash and short-term investments. | -| growth_net_receivables | float | Growth rate of net receivables. | -| growth_inventory | float | Growth rate of inventory. | -| growth_other_current_assets | float | Growth rate of other current assets. | -| growth_total_current_assets | float | Growth rate of total current assets. | -| growth_property_plant_equipment_net | float | Growth rate of net property, plant, and equipment. | -| growth_goodwill | float | Growth rate of goodwill. | -| growth_intangible_assets | float | Growth rate of intangible assets. | -| growth_goodwill_and_intangible_assets | float | Growth rate of goodwill and intangible assets. | -| growth_long_term_investments | float | Growth rate of long-term investments. | -| growth_tax_assets | float | Growth rate of tax assets. | -| growth_other_non_current_assets | float | Growth rate of other non-current assets. | -| growth_total_non_current_assets | float | Growth rate of total non-current assets. | -| growth_other_assets | float | Growth rate of other assets. | -| growth_total_assets | float | Growth rate of total assets. | -| growth_account_payables | float | Growth rate of accounts payable. | -| growth_short_term_debt | float | Growth rate of short-term debt. | -| growth_tax_payables | float | Growth rate of tax payables. | -| growth_deferred_revenue | float | Growth rate of deferred revenue. | -| growth_other_current_liabilities | float | Growth rate of other current liabilities. | -| growth_total_current_liabilities | float | Growth rate of total current liabilities. | -| growth_long_term_debt | float | Growth rate of long-term debt. | -| growth_deferred_revenue_non_current | float | Growth rate of non-current deferred revenue. | -| growth_deferrred_tax_liabilities_non_current | float | Growth rate of non-current deferred tax liabilities. | -| growth_other_non_current_liabilities | float | Growth rate of other non-current liabilities. | -| growth_total_non_current_liabilities | float | Growth rate of total non-current liabilities. | -| growth_other_liabilities | float | Growth rate of other liabilities. | -| growth_total_liabilities | float | Growth rate of total liabilities. | -| growth_common_stock | float | Growth rate of common stock. | -| growth_retained_earnings | float | Growth rate of retained earnings. | -| growth_accumulated_other_comprehensive_income_loss | float | Growth rate of accumulated other comprehensive income/loss. | -| growth_othertotal_stockholders_equity | float | Growth rate of other total stockholders' equity. | -| growth_total_stockholders_equity | float | Growth rate of total stockholders' equity. | -| growth_total_liabilities_and_stockholders_equity | float | Growth rate of total liabilities and stockholders' equity. | -| growth_total_investments | float | Growth rate of total investments. | -| growth_total_debt | float | Growth rate of total debt. | -| growth_net_debt | float | Growth rate of net debt. | - - - - diff --git a/website/content/platform/data_models/BondPrices.md b/website/content/platform/data_models/BondPrices.md deleted file mode 100644 index 666a391af75c..000000000000 --- a/website/content/platform/data_models/BondPrices.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "Bond Prices" -description: "Corporate Bond Prices" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `BondPrices` | `BondPricesQueryParams` | `BondPricesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.bond_prices import ( -BondPricesData, -BondPricesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| country | str | The country to get data. Matches partial name. | None | True | -| issuer_name | str | Name of the issuer. Returns partial matches and is case insensitive. | None | True | -| isin | Union[List, str] | International Securities Identification Number(s) of the bond(s). | None | True | -| lei | str | Legal Entity Identifier of the issuing entity. | None | True | -| currency | Union[List, str] | Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD). | None | True | -| coupon_min | float | Minimum coupon rate of the bond. | None | True | -| coupon_max | float | Maximum coupon rate of the bond. | None | True | -| issued_amount_min | int | Minimum issued amount of the bond. | None | True | -| issued_amount_max | str | Maximum issued amount of the bond. | None | True | -| maturity_date_min | date | Minimum maturity date of the bond. | None | True | -| maturity_date_max | date | Maximum maturity date of the bond. | None | True | -| provider | Literal['tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| country | str | The country to get data. Matches partial name. | None | True | -| issuer_name | str | Name of the issuer. Returns partial matches and is case insensitive. | None | True | -| isin | Union[List, str] | International Securities Identification Number(s) of the bond(s). | None | True | -| lei | str | Legal Entity Identifier of the issuing entity. | None | True | -| currency | Union[List, str] | Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD). | None | True | -| coupon_min | float | Minimum coupon rate of the bond. | None | True | -| coupon_max | float | Maximum coupon rate of the bond. | None | True | -| issued_amount_min | int | Minimum issued amount of the bond. | None | True | -| issued_amount_max | str | Maximum issued amount of the bond. | None | True | -| maturity_date_min | date | Minimum maturity date of the bond. | None | True | -| maturity_date_max | date | Maximum maturity date of the bond. | None | True | -| provider | Literal['tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | -| issue_date_min | date | Filter by the minimum original issue date. | None | True | -| issue_date_max | date | Filter by the maximum original issue date. | None | True | -| last_traded_min | date | Filter by the minimum last trade date. | None | True | -| use_cache | bool | All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. | True | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| isin | str | International Securities Identification Number of the bond. | -| lei | str | Legal Entity Identifier of the issuing entity. | -| figi | str | FIGI of the bond. | -| cusip | str | CUSIP of the bond. | -| coupon_rate | float | Coupon rate of the bond. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| isin | str | International Securities Identification Number of the bond. | -| lei | str | Legal Entity Identifier of the issuing entity. | -| figi | str | FIGI of the bond. | -| cusip | str | CUSIP of the bond. | -| coupon_rate | float | Coupon rate of the bond. | -| ytm | float | Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. Values are returned as a normalized percent. | -| price | float | The last price for the bond. | -| highest_price | float | The highest price for the bond on the last traded date. | -| lowest_price | float | The lowest price for the bond on the last traded date. | -| total_trades | int | Total number of trades on the last traded date. | -| last_traded_date | date | Last traded date of the bond. | -| maturity_date | date | Maturity date of the bond. | -| issue_date | date | Issue date of the bond. This is the date when the bond first accrues interest. | -| issuer_name | str | Name of the issuing entity. | - - - - diff --git a/website/content/platform/data_models/CLI.md b/website/content/platform/data_models/CLI.md deleted file mode 100644 index 1827d180da74..000000000000 --- a/website/content/platform/data_models/CLI.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "CLI" -description: "The composite leading indicator (CLI) is designed to provide early signals of turning points -in business cycles showing fluctuation of the economic activity around its long term potential level" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CLI` | `CLIQueryParams` | `CLIData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.composite_leading_indicator import ( -CLIData, -CLIQueryParams, -) -``` - ---- - -## 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['united_states', 'united_kingdom', 'japan', 'mexico', 'indonesia', 'australia', 'brazil', 'canada', 'italy', 'germany', 'turkey', 'france', 'south_africa', 'south_korea', 'spain', 'india', 'china', 'g7', 'g20', 'all'] | Country to get GDP for. | united_states | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | CLI value | -| country | str | Country for which CLI is given | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | CLI value | -| country | str | Country for which CLI is given | - - - - diff --git a/website/content/platform/data_models/COT.md b/website/content/platform/data_models/COT.md deleted file mode 100644 index 80f42ef9ebf7..000000000000 --- a/website/content/platform/data_models/COT.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "COT" -description: "Commitment of Traders Reports" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `COT` | `COTQueryParams` | `COTData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.cot import ( -COTData, -COTQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| id | str | The series ID string for the report. Default report is Two-Year Treasury Note Futures. | 042601 | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| id | str | The series ID string for the report. Default report is Two-Year Treasury Note Futures. | 042601 | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | -| data_type | Literal['F', 'FO', 'CITS'] | The type of data to reuturn. Default is 'FO'. F = Futures only FO = Futures and Options CITS = Commodity Index Trader Supplemental. Only valid for commodities. | FO | True | -| legacy_format | bool | Returns the legacy format of report. Default is False. | False | True | -| report_type | Literal['ALL', 'CHG', 'OLD', 'OTR'] | The type of report to return. Default is 'ALL'. ALL = All CHG = Change in Positions OLD = Old Crop Years OTR = Other Crop Years | ALL | True | -| measure | Literal['CR', 'NT', 'OI', 'CHG'] | The measure to return. Default is None. CR = Concentration Ratios NT = Number of Traders OI = Percent of Open Interest CHG = Change in Positions. Only valid when data_type is 'CITS'. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - diff --git a/website/content/platform/data_models/COTSearch.md b/website/content/platform/data_models/COTSearch.md deleted file mode 100644 index 6815e833bf31..000000000000 --- a/website/content/platform/data_models/COTSearch.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "COT Search" -description: "Curated Commitment of Traders Reports" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `COTSearch` | `COTSearchQueryParams` | `COTSearchData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -COTSearchData, -COTSearchQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| code | str | CFTC Code of the report. | -| name | str | Name of the underlying asset. | -| category | str | Category of the underlying asset. | -| subcategory | str | Subcategory of the underlying asset. | -| units | str | The units for one contract. | -| symbol | str | Symbol representing the entity requested in the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| code | str | CFTC Code of the report. | -| name | str | Name of the underlying asset. | -| category | str | Category of the underlying asset. | -| subcategory | str | Subcategory of the underlying asset. | -| units | str | The units for one contract. | -| symbol | str | Symbol representing the entity requested in the data. | - - - - diff --git a/website/content/platform/data_models/CalendarDividend.md b/website/content/platform/data_models/CalendarDividend.md deleted file mode 100644 index e81f8e23ec0e..000000000000 --- a/website/content/platform/data_models/CalendarDividend.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: "Calendar Dividend" -description: "Get historical and upcoming dividend payments" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CalendarDividend` | `CalendarDividendQueryParams` | `CalendarDividendData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.calendar_dividend import ( -CalendarDividendData, -CalendarDividendQueryParams, -) -``` - ---- - -## 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['fmp', 'nasdaq'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq'] | 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 | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| symbol | str | Symbol representing the entity requested in the data. | -| amount | float | The dividend amount per share. | -| name | str | Name of the entity. | -| record_date | date | The record date of ownership for eligibility. | -| payment_date | date | The payment date of the dividend. | -| declaration_date | date | Declaration date of the dividend. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| symbol | str | Symbol representing the entity requested in the data. | -| amount | float | The dividend amount per share. | -| name | str | Name of the entity. | -| record_date | date | The record date of ownership for eligibility. | -| payment_date | date | The payment date of the dividend. | -| declaration_date | date | Declaration date of the dividend. | -| adjusted_amount | float | The adjusted-dividend amount. | -| label | str | Ex-dividend date formatted for display. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| symbol | str | Symbol representing the entity requested in the data. | -| amount | float | The dividend amount per share. | -| name | str | Name of the entity. | -| record_date | date | The record date of ownership for eligibility. | -| payment_date | date | The payment date of the dividend. | -| declaration_date | date | Declaration date of the dividend. | -| annualized_amount | float | The indicated annualized dividend amount. | - - - - diff --git a/website/content/platform/data_models/CalendarEarnings.md b/website/content/platform/data_models/CalendarEarnings.md deleted file mode 100644 index 4a9560aa11fb..000000000000 --- a/website/content/platform/data_models/CalendarEarnings.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: "Calendar Earnings" -description: "Get historical and upcoming company earnings releases" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CalendarEarnings` | `CalendarEarningsQueryParams` | `CalendarEarningsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.calendar_earnings import ( -CalendarEarningsData, -CalendarEarningsQueryParams, -) -``` - ---- - -## 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['fmp', 'nasdaq', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq', 'tmx'] | 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 | -| ---- | ---- | ----------- | -| report_date | date | The date of the earnings report. | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| eps_previous | float | The earnings-per-share from the same previously reported period. | -| eps_consensus | float | The analyst conesus earnings-per-share estimate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| report_date | date | The date of the earnings report. | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| eps_previous | float | The earnings-per-share from the same previously reported period. | -| eps_consensus | float | The analyst conesus earnings-per-share estimate. | -| eps_actual | float | The actual earnings per share announced. | -| revenue_actual | float | The actual reported revenue. | -| revenue_consensus | float | The revenue forecast consensus. | -| period_ending | date | The fiscal period end date. | -| reporting_time | str | The reporting time - e.g. after market close. | -| updated_date | date | The date the data was updated last. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| report_date | date | The date of the earnings report. | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| eps_previous | float | The earnings-per-share from the same previously reported period. | -| eps_consensus | float | The analyst conesus earnings-per-share estimate. | -| eps_actual | float | The actual earnings per share (USD) announced. | -| surprise_percent | float | The earnings surprise as normalized percentage points. | -| num_estimates | int | The number of analysts providing estimates for the consensus. | -| period_ending | str | The fiscal period end date. | -| previous_report_date | date | The previous report date for the same period last year. | -| reporting_time | str | The reporting time - e.g. after market close. | -| market_cap | int | The market cap (USD) of the reporting entity. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| report_date | date | The date of the earnings report. | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| eps_previous | float | The earnings-per-share from the same previously reported period. | -| eps_consensus | float | The analyst conesus earnings-per-share estimate. | -| eps_actual | float | The actual EPS in dollars. | -| eps_surprise | float | The EPS surprise in dollars. | -| surprise_percent | float | The EPS surprise as a normalized percent. | -| reporting_time | str | The time of the report - i.e., before or after market. | - - - - diff --git a/website/content/platform/data_models/CalendarIpo.md b/website/content/platform/data_models/CalendarIpo.md deleted file mode 100644 index 98329b25a272..000000000000 --- a/website/content/platform/data_models/CalendarIpo.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: "Calendar Ipo" -description: "Get historical and upcoming initial public offerings (IPOs)" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CalendarIpo` | `CalendarIpoQueryParams` | `CalendarIpoData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.calendar_ipo import ( -CalendarIpoData, -CalendarIpoQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| 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 | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['intrinio', 'nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| 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 | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['intrinio', 'nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | -| status | Literal['upcoming', 'priced', 'withdrawn'] | Status of the IPO. [upcoming, priced, or withdrawn] | None | True | -| min_value | int | Return IPOs with an offer dollar amount greater than the given amount. | None | True | -| max_value | int | Return IPOs with an offer dollar amount less than the given amount. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| 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 | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['intrinio', 'nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | -| status | Literal['upcoming', 'priced', 'filed', 'withdrawn'] | The status of the IPO. | priced | True | -| is_spo | bool | If True, returns data for secondary public offerings (SPOs). | False | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| ipo_date | date | The date of the IPO, when the stock first trades on a major exchange. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| ipo_date | date | The date of the IPO, when the stock first trades on a major exchange. | -| status | Literal['upcoming', 'priced', 'withdrawn'] | The status of the IPO. Upcoming IPOs have not taken place yet but are expected to. Priced IPOs have taken place. Withdrawn IPOs were expected to take place, but were subsequently withdrawn and did not take place | -| exchange | str | The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ. | -| offer_amount | float | The total dollar amount of shares offered in the IPO. Typically this is share price * share count | -| share_price | float | The price per share at which the IPO was offered. | -| share_price_lowest | float | The expected lowest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs). | -| share_price_highest | float | The expected highest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs). | -| share_count | int | The number of shares offered in the IPO. | -| share_count_lowest | int | The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs). | -| share_count_highest | int | The expected highest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs). | -| announcement_url | str | The URL to the company's announcement of the IPO | -| sec_report_url | str | The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place. | -| open_price | float | The opening price at the beginning of the first trading day (only available for priced IPOs). | -| close_price | float | The closing price at the end of the first trading day (only available for priced IPOs). | -| volume | int | The volume at the end of the first trading day (only available for priced IPOs). | -| day_change | float | The percentage change between the open price and the close price on the first trading day (only available for priced IPOs). | -| week_change | float | The percentage change between the open price on the first trading day and the close price approximately a week after the first trading day (only available for priced IPOs). | -| month_change | float | The percentage change between the open price on the first trading day and the close price approximately a month after the first trading day (only available for priced IPOs). | -| id | str | The Intrinio ID of the IPO. | -| company | openbb_intrinio.utils.references.IntrinioCompany | The company that is going public via the IPO. | -| security | openbb_intrinio.utils.references.IntrinioSecurity | The primary Security for the Company that is going public via the IPO | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| ipo_date | date | The date of the IPO, when the stock first trades on a major exchange. | -| name | str | The name of the company. | -| offer_amount | float | The dollar value of the shares offered. | -| share_count | int | The number of shares offered. | -| expected_price_date | date | The date the pricing is expected. | -| filed_date | date | The date the IPO was filed. | -| withdraw_date | date | The date the IPO was withdrawn. | -| deal_status | str | The status of the deal. | - - - - diff --git a/website/content/platform/data_models/CalendarSplits.md b/website/content/platform/data_models/CalendarSplits.md deleted file mode 100644 index 625ce3eea7bb..000000000000 --- a/website/content/platform/data_models/CalendarSplits.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "Calendar Splits" -description: "Get historical and upcoming stock split operations" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CalendarSplits` | `CalendarSplitsQueryParams` | `CalendarSplitsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.calendar_splits import ( -CalendarSplitsData, -CalendarSplitsQueryParams, -) -``` - ---- - -## 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['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 | - - - - -| 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['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 | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| label | str | Label of the stock splits. | -| symbol | str | Symbol representing the entity requested in the data. | -| numerator | float | Numerator of the stock splits. | -| denominator | float | Denominator of the stock splits. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| label | str | Label of the stock splits. | -| symbol | str | Symbol representing the entity requested in the data. | -| numerator | float | Numerator of the stock splits. | -| denominator | float | Denominator of the stock splits. | - - - - diff --git a/website/content/platform/data_models/CashFlowStatement.md b/website/content/platform/data_models/CashFlowStatement.md deleted file mode 100644 index 69e524d5e48e..000000000000 --- a/website/content/platform/data_models/CashFlowStatement.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -title: "Cash Flow Statement" -description: "Get the cash flow statement for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CashFlowStatement` | `CashFlowStatementQueryParams` | `CashFlowStatementData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.cash_flow import ( -CashFlowStatementData, -CashFlowStatementQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | -| fiscal_year | int | The specific fiscal year. Reports do not go beyond 2008. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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. | False | True | -| order | Literal[None, 'asc', 'desc'] | Order of the financial statement. | None | True | -| sort | Literal[None, 'filing_date', 'period_of_report_date'] | Sort of the financial statement. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | The date the filing was accepted. | -| reported_currency | str | The currency in which the cash flow statement was reported. | -| net_income | float | Net income. | -| depreciation_and_amortization | float | Depreciation and amortization. | -| deferred_income_tax | float | Deferred income tax. | -| stock_based_compensation | float | Stock-based compensation. | -| change_in_working_capital | float | Change in working capital. | -| change_in_account_receivables | float | Change in account receivables. | -| change_in_inventory | float | Change in inventory. | -| change_in_account_payable | float | Change in account payable. | -| change_in_other_working_capital | float | Change in other working capital. | -| change_in_other_non_cash_items | float | Change in other non-cash items. | -| net_cash_from_operating_activities | float | Net cash from operating activities. | -| purchase_of_property_plant_and_equipment | float | Purchase of property, plant and equipment. | -| acquisitions | float | Acquisitions. | -| purchase_of_investment_securities | float | Purchase of investment securities. | -| sale_and_maturity_of_investments | float | Sale and maturity of investments. | -| other_investing_activities | float | Other investing activities. | -| net_cash_from_investing_activities | float | Net cash from investing activities. | -| repayment_of_debt | float | Repayment of debt. | -| issuance_of_common_equity | float | Issuance of common equity. | -| repurchase_of_common_equity | float | Repurchase of common equity. | -| payment_of_dividends | float | Payment of dividends. | -| other_financing_activities | float | Other financing activities. | -| net_cash_from_financing_activities | float | Net cash from financing activities. | -| effect_of_exchange_rate_changes_on_cash | float | Effect of exchange rate changes on cash. | -| net_change_in_cash_and_equivalents | float | Net change in cash and equivalents. | -| cash_at_beginning_of_period | float | Cash at beginning of period. | -| cash_at_end_of_period | float | Cash at end of period. | -| operating_cash_flow | float | Operating cash flow. | -| capital_expenditure | float | Capital expenditure. | -| free_cash_flow | float | None | -| link | str | Link to the filing. | -| final_link | str | Link to the filing document. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| reported_currency | str | The currency in which the balance sheet is reported. | -| net_income_continuing_operations | float | Net Income (Continuing Operations) | -| net_income_discontinued_operations | float | Net Income (Discontinued Operations) | -| net_income | float | Consolidated Net Income. | -| provision_for_loan_losses | float | Provision for Loan Losses | -| provision_for_credit_losses | float | Provision for credit losses | -| depreciation_expense | float | Depreciation Expense. | -| amortization_expense | float | Amortization Expense. | -| share_based_compensation | float | Share-based compensation. | -| non_cash_adjustments_to_reconcile_net_income | float | Non-Cash Adjustments to Reconcile Net Income. | -| changes_in_operating_assets_and_liabilities | float | Changes in Operating Assets and Liabilities (Net) | -| net_cash_from_continuing_operating_activities | float | Net Cash from Continuing Operating Activities | -| net_cash_from_discontinued_operating_activities | float | Net Cash from Discontinued Operating Activities | -| net_cash_from_operating_activities | float | Net Cash from Operating Activities | -| divestitures | float | Divestitures | -| sale_of_property_plant_and_equipment | float | Sale of Property, Plant, and Equipment | -| acquisitions | float | Acquisitions | -| purchase_of_investments | float | Purchase of Investments | -| purchase_of_investment_securities | float | Purchase of Investment Securities | -| sale_and_maturity_of_investments | float | Sale and Maturity of Investments | -| loans_held_for_sale | float | Loans Held for Sale (Net) | -| purchase_of_property_plant_and_equipment | float | Purchase of Property, Plant, and Equipment | -| other_investing_activities | float | Other Investing Activities (Net) | -| net_cash_from_continuing_investing_activities | float | Net Cash from Continuing Investing Activities | -| net_cash_from_discontinued_investing_activities | float | Net Cash from Discontinued Investing Activities | -| net_cash_from_investing_activities | float | Net Cash from Investing Activities | -| payment_of_dividends | float | Payment of Dividends | -| repurchase_of_common_equity | float | Repurchase of Common Equity | -| repurchase_of_preferred_equity | float | Repurchase of Preferred Equity | -| issuance_of_common_equity | float | Issuance of Common Equity | -| issuance_of_preferred_equity | float | Issuance of Preferred Equity | -| issuance_of_debt | float | Issuance of Debt | -| repayment_of_debt | float | Repayment of Debt | -| other_financing_activities | float | Other Financing Activities (Net) | -| cash_interest_received | float | Cash Interest Received | -| net_change_in_deposits | float | Net Change in Deposits | -| net_increase_in_fed_funds_sold | float | Net Increase in Fed Funds Sold | -| net_cash_from_continuing_financing_activities | float | Net Cash from Continuing Financing Activities | -| net_cash_from_discontinued_financing_activities | float | Net Cash from Discontinued Financing Activities | -| net_cash_from_financing_activities | float | Net Cash from Financing Activities | -| effect_of_exchange_rate_changes | float | Effect of Exchange Rate Changes | -| other_net_changes_in_cash | float | Other Net Changes in Cash | -| net_change_in_cash_and_equivalents | float | Net Change in Cash and Equivalents | -| cash_income_taxes_paid | float | Cash Income Taxes Paid | -| cash_interest_paid | float | Cash Interest Paid | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| net_cash_flow_from_operating_activities_continuing | int | Net cash flow from operating activities continuing. | -| net_cash_flow_from_operating_activities_discontinued | int | Net cash flow from operating activities discontinued. | -| net_cash_flow_from_operating_activities | int | Net cash flow from operating activities. | -| net_cash_flow_from_investing_activities_continuing | int | Net cash flow from investing activities continuing. | -| net_cash_flow_from_investing_activities_discontinued | int | Net cash flow from investing activities discontinued. | -| net_cash_flow_from_investing_activities | int | Net cash flow from investing activities. | -| net_cash_flow_from_financing_activities_continuing | int | Net cash flow from financing activities continuing. | -| net_cash_flow_from_financing_activities_discontinued | int | Net cash flow from financing activities discontinued. | -| net_cash_flow_from_financing_activities | int | Net cash flow from financing activities. | -| net_cash_flow_continuing | int | Net cash flow continuing. | -| net_cash_flow_discontinued | int | Net cash flow discontinued. | -| exchange_gains_losses | int | Exchange gains losses. | -| net_cash_flow | int | Net cash flow. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - diff --git a/website/content/platform/data_models/CashFlowStatementGrowth.md b/website/content/platform/data_models/CashFlowStatementGrowth.md deleted file mode 100644 index 0c3936fdd61a..000000000000 --- a/website/content/platform/data_models/CashFlowStatementGrowth.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: "Cash Flow Statement Growth" -description: "Get the growth of a company's cash flow statement items over time" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CashFlowStatementGrowth` | `CashFlowStatementGrowthQueryParams` | `CashFlowStatementGrowthData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.cash_flow_growth import ( -CashFlowStatementGrowthData, -CashFlowStatementGrowthQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | 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. | -| period | str | Period the statement is returned for. | -| growth_net_income | float | Growth rate of net income. | -| growth_depreciation_and_amortization | float | Growth rate of depreciation and amortization. | -| growth_deferred_income_tax | float | Growth rate of deferred income tax. | -| growth_stock_based_compensation | float | Growth rate of stock-based compensation. | -| growth_change_in_working_capital | float | Growth rate of change in working capital. | -| growth_accounts_receivables | float | Growth rate of accounts receivables. | -| growth_inventory | float | Growth rate of inventory. | -| growth_accounts_payables | float | Growth rate of accounts payables. | -| growth_other_working_capital | float | Growth rate of other working capital. | -| growth_other_non_cash_items | float | Growth rate of other non-cash items. | -| growth_net_cash_provided_by_operating_activities | float | Growth rate of net cash provided by operating activities. | -| growth_investments_in_property_plant_and_equipment | float | Growth rate of investments in property, plant, and equipment. | -| growth_acquisitions_net | float | Growth rate of net acquisitions. | -| growth_purchases_of_investments | float | Growth rate of purchases of investments. | -| growth_sales_maturities_of_investments | float | Growth rate of sales maturities of investments. | -| growth_other_investing_activities | float | Growth rate of other investing activities. | -| growth_net_cash_used_for_investing_activities | float | Growth rate of net cash used for investing activities. | -| growth_debt_repayment | float | Growth rate of debt repayment. | -| growth_common_stock_issued | float | Growth rate of common stock issued. | -| growth_common_stock_repurchased | float | Growth rate of common stock repurchased. | -| growth_dividends_paid | float | Growth rate of dividends paid. | -| growth_other_financing_activities | float | Growth rate of other financing activities. | -| growth_net_cash_used_provided_by_financing_activities | float | Growth rate of net cash used/provided by financing activities. | -| growth_effect_of_forex_changes_on_cash | float | Growth rate of the effect of foreign exchange changes on cash. | -| growth_net_change_in_cash | float | Growth rate of net change in cash. | -| growth_cash_at_end_of_period | float | Growth rate of cash at the end of the period. | -| growth_cash_at_beginning_of_period | float | Growth rate of cash at the beginning of the period. | -| growth_operating_cash_flow | float | Growth rate of operating cash flow. | -| growth_capital_expenditure | float | Growth rate of capital expenditure. | -| growth_free_cash_flow | float | Growth rate of free cash flow. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| period | str | Period the statement is returned for. | -| growth_net_income | float | Growth rate of net income. | -| growth_depreciation_and_amortization | float | Growth rate of depreciation and amortization. | -| growth_deferred_income_tax | float | Growth rate of deferred income tax. | -| growth_stock_based_compensation | float | Growth rate of stock-based compensation. | -| growth_change_in_working_capital | float | Growth rate of change in working capital. | -| growth_accounts_receivables | float | Growth rate of accounts receivables. | -| growth_inventory | float | Growth rate of inventory. | -| growth_accounts_payables | float | Growth rate of accounts payables. | -| growth_other_working_capital | float | Growth rate of other working capital. | -| growth_other_non_cash_items | float | Growth rate of other non-cash items. | -| growth_net_cash_provided_by_operating_activities | float | Growth rate of net cash provided by operating activities. | -| growth_investments_in_property_plant_and_equipment | float | Growth rate of investments in property, plant, and equipment. | -| growth_acquisitions_net | float | Growth rate of net acquisitions. | -| growth_purchases_of_investments | float | Growth rate of purchases of investments. | -| growth_sales_maturities_of_investments | float | Growth rate of sales maturities of investments. | -| growth_other_investing_activities | float | Growth rate of other investing activities. | -| growth_net_cash_used_for_investing_activities | float | Growth rate of net cash used for investing activities. | -| growth_debt_repayment | float | Growth rate of debt repayment. | -| growth_common_stock_issued | float | Growth rate of common stock issued. | -| growth_common_stock_repurchased | float | Growth rate of common stock repurchased. | -| growth_dividends_paid | float | Growth rate of dividends paid. | -| growth_other_financing_activities | float | Growth rate of other financing activities. | -| growth_net_cash_used_provided_by_financing_activities | float | Growth rate of net cash used/provided by financing activities. | -| growth_effect_of_forex_changes_on_cash | float | Growth rate of the effect of foreign exchange changes on cash. | -| growth_net_change_in_cash | float | Growth rate of net change in cash. | -| growth_cash_at_end_of_period | float | Growth rate of cash at the end of the period. | -| growth_cash_at_beginning_of_period | float | Growth rate of cash at the beginning of the period. | -| growth_operating_cash_flow | float | Growth rate of operating cash flow. | -| growth_capital_expenditure | float | Growth rate of capital expenditure. | -| growth_free_cash_flow | float | Growth rate of free cash flow. | - - - - diff --git a/website/content/platform/data_models/CikMap.md b/website/content/platform/data_models/CikMap.md deleted file mode 100644 index e3e7ac14ad1a..000000000000 --- a/website/content/platform/data_models/CikMap.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Cik Map" -description: "Map a ticker symbol to a CIK number" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CikMap` | `CikMapQueryParams` | `CikMapData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.cik_map import ( -CikMapData, -CikMapQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| cik | Union[int, str] | Central Index Key (CIK) for the requested entity. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| cik | Union[int, str] | Central Index Key (CIK) for the requested entity. | - - - - diff --git a/website/content/platform/data_models/CommercialPaper.md b/website/content/platform/data_models/CommercialPaper.md deleted file mode 100644 index 321b4eea8d98..000000000000 --- a/website/content/platform/data_models/CommercialPaper.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "Commercial Paper" -description: "Commercial Paper" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CommercialPaper` | `CommercialPaperQueryParams` | `CommercialPaperData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.cp import ( -CommercialPaperData, -CommercialPaperQueryParams, -) -``` - ---- - -## 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 | -| maturity | Literal['overnight', '7d', '15d', '30d', '60d', '90d'] | The maturity. | 30d | True | -| category | Literal['asset_backed', 'financial', 'nonfinancial'] | The category. | financial | True | -| grade | Literal['aa', 'a2_p2'] | The grade. | aa | 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 | -| maturity | Literal['overnight', '7d', '15d', '30d', '60d', '90d'] | The maturity. | 30d | True | -| category | Literal['asset_backed', 'financial', 'nonfinancial'] | The category. | financial | True | -| grade | Literal['aa', 'a2_p2'] | The grade. | aa | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Commercial Paper Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Commercial Paper Rate. | - - - - diff --git a/website/content/platform/data_models/CompanyFilings.md b/website/content/platform/data_models/CompanyFilings.md deleted file mode 100644 index 7e2947cde009..000000000000 --- a/website/content/platform/data_models/CompanyFilings.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -title: "Company Filings" -description: "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CompanyFilings` | `CompanyFilingsQueryParams` | `CompanyFilingsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.company_filings import ( -CompanyFilingsData, -CompanyFilingsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| form_type | str | Filter by form type. Check the data provider for available types. | None | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['fmp', 'intrinio', 'sec', 'tmx'] | 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 | str | Symbol to get data for. | None | True | -| form_type | str | Filter by form type. Check the data provider for available types. | None | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['fmp', 'intrinio', 'sec', 'tmx'] | 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 | str | Symbol to get data for. | None | True | -| form_type | str | Filter by form type. Check the data provider for available types. | None | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['fmp', 'intrinio', 'sec', 'tmx'] | 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 | -| 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 | -| thea_enabled | bool | Return filings that have been read by Intrinio's Thea NLP. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| form_type | str | Filter by form type. Check the data provider for available types. | None | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['fmp', 'intrinio', 'sec', 'tmx'] | 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 | Union[int, str] | Lookup filings by Central Index Key (CIK) instead of by symbol. | None | True | -| type | Literal['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 of the SEC filing form. | None | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for one day. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| form_type | str | Filter by form type. Check the data provider for available types. | None | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['fmp', 'intrinio', 'sec', 'tmx'] | 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 | -| start_date | Union[date, str] | The start date to fetch. | None | True | -| end_date | Union[date, str] | The end date to fetch. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | Accepted date of the filing. | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| report_type | str | Type of filing. | -| filing_url | str | URL to the filing page. | -| report_url | str | URL to the actual report. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | Accepted date of the filing. | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| report_type | str | Type of filing. | -| filing_url | str | URL to the filing page. | -| report_url | str | URL to the actual report. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | Accepted date of the filing. | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| report_type | str | Type of filing. | -| filing_url | str | URL to the filing page. | -| report_url | str | URL to the actual report. | -| id | str | Intrinio ID of the filing. | -| period_end_date | date | Ending date of the fiscal period for the filing. | -| sec_unique_id | str | SEC unique ID of the filing. | -| instance_url | str | URL for the XBRL filing for the report. | -| industry_group | str | Industry group of the company. | -| industry_category | str | Industry category of the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | Accepted date of the filing. | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| report_type | str | Type of filing. | -| filing_url | str | URL to the filing page. | -| report_url | str | URL to the actual report. | -| report_date | date | The date of the filing. | -| act | Union[int, str] | The SEC Act number. | -| items | Union[str, float] | The SEC Item numbers. | -| primary_doc_description | str | The description of the primary document. | -| primary_doc | str | The filename of the primary document. | -| accession_number | Union[int, str] | The accession number. | -| file_number | Union[int, str] | The file number. | -| film_number | Union[int, str] | The film number. | -| is_inline_xbrl | Union[int, str] | Whether the filing is an inline XBRL filing. | -| is_xbrl | Union[int, str] | Whether the filing is an XBRL filing. | -| size | Union[int, str] | The size of the filing. | -| complete_submission_url | str | The URL to the complete filing submission. | -| filing_detail_url | str | The URL to the filing details. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | Accepted date of the filing. | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| report_type | str | Type of filing. | -| filing_url | str | URL to the filing page. | -| report_url | str | URL to the actual report. | -| description | str | The description of the filing. | -| size | str | The file size of the PDF document. | - - - - diff --git a/website/content/platform/data_models/CompanyNews.md b/website/content/platform/data_models/CompanyNews.md deleted file mode 100644 index aa1539d335f9..000000000000 --- a/website/content/platform/data_models/CompanyNews.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: "Company News" -description: "Company News" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CompanyNews` | `CompanyNewsQueryParams` | `CompanyNewsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.company_news import ( -CompanyNewsData, -CompanyNewsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| date | Union[date, str] | A specific date to get data for. | None | True | -| display | Literal['headline', 'abstract', 'full'] | Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). | full | True | -| updated_since | int | Number of seconds since the news was updated. | None | True | -| published_since | int | Number of seconds since the news was published. | None | True | -| sort | Literal['id', 'created', 'updated'] | Key to sort the news by. | created | True | -| order | Literal['asc', 'desc'] | Order to sort the news by. | desc | True | -| isin | str | The company's ISIN. | None | True | -| cusip | str | The company's CUSIP. | None | True | -| channels | str | Channels of the news to retrieve. | None | True | -| topics | str | Topics of the news to retrieve. | None | True | -| authors | str | Authors of the news to retrieve. | None | True | -| content_types | str | Content types of the news to retrieve. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| page | int | Page number of the results. Use in combination with limit. | 0 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| order | Literal['asc', 'desc'] | Sort order of the articles. | desc | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| offset | int | Page offset, used in conjunction with limit. | 0 | True | -| source | str | A comma-separated list of the domains requested. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| page | int | The page number to start from. Use with limit. | 1 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| id | str | Article ID. | -| author | str | Author of the article. | -| teaser | str | Teaser of the news. | -| channels | str | Channels associated with the news. | -| stocks | str | Stocks associated with the news. | -| tags | str | Tags associated with the news. | -| updated | datetime | Updated date of the news. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| source | str | Name of the news source. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| id | str | Article ID. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| source | str | Source of the article. | -| tags | str | Keywords/tags in the article | -| id | str | Article ID. | -| amp_url | str | AMP URL. | -| publisher | openbb_polygon.models.company_news.PolygonPublisher | Publisher of the article. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| tags | str | Tags associated with the news article. | -| article_id | int | Unique ID of the news article. | -| source | str | News source. | -| crawl_date | datetime | Date the news article was crawled. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| source | str | Source of the news. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| source | str | Source of the news article | - - - - diff --git a/website/content/platform/data_models/CompanyOverview.md b/website/content/platform/data_models/CompanyOverview.md deleted file mode 100644 index 34949f4ad97d..000000000000 --- a/website/content/platform/data_models/CompanyOverview.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: "Company Overview" -description: "Get company general business and stock data for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CompanyOverview` | `CompanyOverviewQueryParams` | `CompanyOverviewData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.company_overview import ( -CompanyOverviewData, -CompanyOverviewQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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. | -| price | float | Price of the company. | -| beta | float | Beta of the company. | -| vol_avg | int | Volume average of the company. | -| mkt_cap | int | Market capitalization of the company. | -| last_div | float | Last dividend of the company. | -| range | str | Range of the company. | -| changes | float | Changes of the company. | -| company_name | str | Company name of the company. | -| currency | str | Currency of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| isin | str | ISIN of the company. | -| cusip | str | CUSIP of the company. | -| exchange | str | Exchange of the company. | -| exchange_short_name | str | Exchange short name of the company. | -| industry | str | Industry of the company. | -| website | str | Website of the company. | -| description | str | Description of the company. | -| ceo | str | CEO of the company. | -| sector | str | Sector of the company. | -| country | str | Country of the company. | -| full_time_employees | str | Full time employees of the company. | -| phone | str | Phone of the company. | -| address | str | Address of the company. | -| city | str | City of the company. | -| state | str | State of the company. | -| zip | str | Zip of the company. | -| dcf_diff | float | Discounted cash flow difference of the company. | -| dcf | float | Discounted cash flow of the company. | -| image | str | Image of the company. | -| ipo_date | date | IPO date of the company. | -| default_image | bool | If the image is the default image. | -| is_etf | bool | If the company is an ETF. | -| is_actively_trading | bool | If the company is actively trading. | -| is_adr | bool | If the company is an ADR. | -| is_fund | bool | If the company is a fund. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| price | float | Price of the company. | -| beta | float | Beta of the company. | -| vol_avg | int | Volume average of the company. | -| mkt_cap | int | Market capitalization of the company. | -| last_div | float | Last dividend of the company. | -| range | str | Range of the company. | -| changes | float | Changes of the company. | -| company_name | str | Company name of the company. | -| currency | str | Currency of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| isin | str | ISIN of the company. | -| cusip | str | CUSIP of the company. | -| exchange | str | Exchange of the company. | -| exchange_short_name | str | Exchange short name of the company. | -| industry | str | Industry of the company. | -| website | str | Website of the company. | -| description | str | Description of the company. | -| ceo | str | CEO of the company. | -| sector | str | Sector of the company. | -| country | str | Country of the company. | -| full_time_employees | str | Full time employees of the company. | -| phone | str | Phone of the company. | -| address | str | Address of the company. | -| city | str | City of the company. | -| state | str | State of the company. | -| zip | str | Zip of the company. | -| dcf_diff | float | Discounted cash flow difference of the company. | -| dcf | float | Discounted cash flow of the company. | -| image | str | Image of the company. | -| ipo_date | date | IPO date of the company. | -| default_image | bool | If the image is the default image. | -| is_etf | bool | If the company is an ETF. | -| is_actively_trading | bool | If the company is actively trading. | -| is_adr | bool | If the company is an ADR. | -| is_fund | bool | If the company is a fund. | - - - - diff --git a/website/content/platform/data_models/CompareGroups.md b/website/content/platform/data_models/CompareGroups.md deleted file mode 100644 index fb6868ae74a0..000000000000 --- a/website/content/platform/data_models/CompareGroups.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "Compare Groups" -description: "Get company data grouped by sector, industry or country and display either performance or valuation metrics" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CompareGroups` | `CompareGroupsQueryParams` | `CompareGroupsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.compare_groups import ( -CompareGroupsData, -CompareGroupsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| group | str | The group to compare - i.e., 'sector', 'industry', 'country'. Choices vary by provider. | None | True | -| metric | str | The type of metrics to compare - i.e, 'valuation', 'performance'. Choices vary by provider. | None | True | -| provider | Literal['finviz'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| group | str | The group to compare - i.e., 'sector', 'industry', 'country'. Choices vary by provider. | None | True | -| metric | str | The type of metrics to compare - i.e, 'valuation', 'performance'. Choices vary by provider. | None | True | -| provider | Literal['finviz'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name or label of the group. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name or label of the group. | -| stocks | int | The number of stocks in the group. | -| market_cap | int | The market cap of the group. | -| performance_1D | float | The performance in the last day, as a normalized percent. | -| performance_1W | float | The performance in the last week, as a normalized percent. | -| performance_1M | float | The performance in the last month, as a normalized percent. | -| performance_3M | float | The performance in the last quarter, as a normalized percent. | -| performance_6M | float | The performance in the last half year, as a normalized percent. | -| performance_1Y | float | The performance in the last year, as a normalized percent. | -| performance_YTD | float | The performance in the year to date, as a normalized percent. | -| dividend_yield | float | The dividend yield of the group, as a normalized percent. | -| pe | float | The P/E ratio of the group. | -| forward_pe | float | The forward P/E ratio of the group. | -| peg | float | The PEG ratio of the group. | -| eps_growth_past_5_years | float | The EPS growth of the group for the past 5 years, as a normalized percent. | -| eps_growth_next_5_years | float | The estimated EPS growth of the groupo for the next 5 years, as a normalized percent. | -| sales_growth_past_5_years | float | The sales growth of the group for the past 5 years, as a normalized percent. | -| float_short | float | The percent of the float shorted for the group, as a normalized value. | -| analyst_recommendation | float | The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. | -| volume | int | The trading volume. | -| volume_average | int | The 3-month average volume of the group. | -| volume_relative | float | The relative volume compared to the 3-month average volume. | - - - - diff --git a/website/content/platform/data_models/ConsumerPriceIndex.md b/website/content/platform/data_models/ConsumerPriceIndex.md deleted file mode 100644 index 3ec8e5bfe022..000000000000 --- a/website/content/platform/data_models/ConsumerPriceIndex.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "Consumer Price Index" -description: "Consumer Price Index (CPI)" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `ConsumerPriceIndex` | `ConsumerPriceIndexQueryParams` | `ConsumerPriceIndexData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.cpi import ( -ConsumerPriceIndexData, -ConsumerPriceIndexQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): fred. | | False | -| units | Literal['growth_previous', 'growth_same', 'index_2015'] | The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100. | growth_same | True | -| frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. Options: `monthly`, `quarter`, and `annual`. | monthly | True | -| harmonized | bool | Whether you wish to obtain harmonized data. | False | True | -| 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 | -| ---- | ---- | ----------- | ------- | -------- | -| country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): fred. | | False | -| units | Literal['growth_previous', 'growth_same', 'index_2015'] | The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100. | growth_same | True | -| frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. Options: `monthly`, `quarter`, and `annual`. | monthly | True | -| harmonized | bool | Whether you wish to obtain harmonized data. | False | True | -| 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - diff --git a/website/content/platform/data_models/CryptoHistorical.md b/website/content/platform/data_models/CryptoHistorical.md deleted file mode 100644 index 677b653cd55c..000000000000 --- a/website/content/platform/data_models/CryptoHistorical.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -title: "Crypto Historical" -description: "Get historical price data for cryptocurrency pair(s) within a provider" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CryptoHistorical` | `CryptoHistoricalQueryParams` | `CryptoHistoricalData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.crypto_historical import ( -CryptoHistoricalData, -CryptoHistoricalQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'] | Time interval of the data to return. | 1d | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | str | Time 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 | 1d | True | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'] | Time interval of the data to return. | 1d | True | -| exchanges | List[str] | To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q'] | Time interval of the data to return. | 1d | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | -| adj_close | float | The adjusted close price. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | -| transactions | int | Number of transactions for the symbol in the time period. | -| volume_notional | float | The last size done for the asset on the specific date in the quote currency. The volume of the asset on the specific date in the quote currency. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | - - - - diff --git a/website/content/platform/data_models/CryptoSearch.md b/website/content/platform/data_models/CryptoSearch.md deleted file mode 100644 index 49d685556e3e..000000000000 --- a/website/content/platform/data_models/CryptoSearch.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "Crypto Search" -description: "Search available cryptocurrency pairs within a provider" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CryptoSearch` | `CryptoSearchQueryParams` | `CryptoSearchData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.crypto_search import ( -CryptoSearchData, -CryptoSearchQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | None | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | None | 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. (Crypto) | -| name | str | Name of the crypto. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (Crypto) | -| name | str | Name of the crypto. | -| currency | str | The currency the crypto trades for. | -| exchange | str | The exchange code the crypto trades on. | -| exchange_name | str | The short name of the exchange the crypto trades on. | - - - - diff --git a/website/content/platform/data_models/CurrencyHistorical.md b/website/content/platform/data_models/CurrencyHistorical.md deleted file mode 100644 index 4e3a1daaa394..000000000000 --- a/website/content/platform/data_models/CurrencyHistorical.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -title: "Currency Historical" -description: "Currency Historical Price" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CurrencyHistorical` | `CurrencyHistoricalQueryParams` | `CurrencyHistoricalData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.currency_historical import ( -CurrencyHistoricalData, -CurrencyHistoricalQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'] | Time interval of the data to return. | 1d | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | str | Time 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 | 1d | True | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'] | Time interval of the data to return. | 1d | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q'] | Time interval of the data to return. | 1d | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | -| adj_close | float | The adjusted close price. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | - - - - diff --git a/website/content/platform/data_models/CurrencyPairs.md b/website/content/platform/data_models/CurrencyPairs.md deleted file mode 100644 index 525c6e89706e..000000000000 --- a/website/content/platform/data_models/CurrencyPairs.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: "Currency Pairs" -description: "Currency Search" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CurrencyPairs` | `CurrencyPairsQueryParams` | `CurrencyPairsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.currency_pairs import ( -CurrencyPairsData, -CurrencyPairsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'intrinio', 'polygon'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'intrinio', 'polygon'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'intrinio', 'polygon'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'intrinio', 'polygon'] | 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 | -| symbol | str | Symbol of the pair to search. | None | True | -| date | Union[date, str] | A specific date to get data for. | None | True | -| search | str | Search for terms within the ticker and/or company name. | | True | -| active | bool | Specify if the tickers returned should be actively traded on the queried date. | True | True | -| order | Literal['asc', 'desc'] | Order data by ascending or descending. | asc | True | -| sort | Literal['ticker', 'name', 'market', 'locale', 'currency_symbol', 'currency_name', 'base_currency_symbol', 'base_currency_name', 'last_updated_utc', 'delisted_utc'] | Sort field used for ordering. | | True | -| limit | int, Gt(gt=0) | The number of data entries to return. | 1000 | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the currency pair. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the currency pair. | -| symbol | str | Symbol of the currency pair. | -| currency | str | Base currency of the currency pair. | -| stock_exchange | str | Stock exchange of the currency pair. | -| exchange_short_name | str | Short name of the stock exchange of the currency pair. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the currency pair. | -| code | str | Code of the currency pair. | -| base_currency | str | ISO 4217 currency code of the base currency. | -| quote_currency | str | ISO 4217 currency code of the quote currency. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the currency pair. | -| market | str | Name of the trading market. Always 'fx'. | -| locale | str | Locale of the currency pair. | -| currency_symbol | str | The symbol of the quote currency. | -| currency_name | str | Name of the quote currency. | -| base_currency_symbol | str | The symbol of the base currency. | -| base_currency_name | str | Name of the base currency. | -| last_updated_utc | datetime | The last updated timestamp in UTC. | -| delisted_utc | datetime | The delisted timestamp in UTC. | - - - - diff --git a/website/content/platform/data_models/CurrencyReferenceRates.md b/website/content/platform/data_models/CurrencyReferenceRates.md deleted file mode 100644 index 97ba411f6e0d..000000000000 --- a/website/content/platform/data_models/CurrencyReferenceRates.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: "Currency Reference Rates" -description: "Current, official, currency reference rates" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CurrencyReferenceRates` | `CurrencyReferenceRatesQueryParams` | `CurrencyReferenceRatesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.currency_reference_rates import ( -CurrencyReferenceRatesData, -CurrencyReferenceRatesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| EUR | float | Euro. | -| USD | float | US Dollar. | -| JPY | float | Japanese Yen. | -| BGN | float | Bulgarian Lev. | -| CZK | float | Czech Koruna. | -| DKK | float | Danish Krone. | -| GBP | float | Pound Sterling. | -| HUF | float | Hungarian Forint. | -| PLN | float | Polish Zloty. | -| RON | float | Romanian Leu. | -| SEK | float | Swedish Krona. | -| CHF | float | Swiss Franc. | -| ISK | float | Icelandic Krona. | -| NOK | float | Norwegian Krone. | -| TRY | float | Turkish Lira. | -| AUD | float | Australian Dollar. | -| BRL | float | Brazilian Real. | -| CAD | float | Canadian Dollar. | -| CNY | float | Chinese Yuan. | -| HKD | float | Hong Kong Dollar. | -| IDR | float | Indonesian Rupiah. | -| ILS | float | Israeli Shekel. | -| INR | float | Indian Rupee. | -| KRW | float | South Korean Won. | -| MXN | float | Mexican Peso. | -| MYR | float | Malaysian Ringgit. | -| NZD | float | New Zealand Dollar. | -| PHP | float | Philippine Peso. | -| SGD | float | Singapore Dollar. | -| THB | float | Thai Baht. | -| ZAR | float | South African Rand. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| EUR | float | Euro. | -| USD | float | US Dollar. | -| JPY | float | Japanese Yen. | -| BGN | float | Bulgarian Lev. | -| CZK | float | Czech Koruna. | -| DKK | float | Danish Krone. | -| GBP | float | Pound Sterling. | -| HUF | float | Hungarian Forint. | -| PLN | float | Polish Zloty. | -| RON | float | Romanian Leu. | -| SEK | float | Swedish Krona. | -| CHF | float | Swiss Franc. | -| ISK | float | Icelandic Krona. | -| NOK | float | Norwegian Krone. | -| TRY | float | Turkish Lira. | -| AUD | float | Australian Dollar. | -| BRL | float | Brazilian Real. | -| CAD | float | Canadian Dollar. | -| CNY | float | Chinese Yuan. | -| HKD | float | Hong Kong Dollar. | -| IDR | float | Indonesian Rupiah. | -| ILS | float | Israeli Shekel. | -| INR | float | Indian Rupee. | -| KRW | float | South Korean Won. | -| MXN | float | Mexican Peso. | -| MYR | float | Malaysian Ringgit. | -| NZD | float | New Zealand Dollar. | -| PHP | float | Philippine Peso. | -| SGD | float | Singapore Dollar. | -| THB | float | Thai Baht. | -| ZAR | float | South African Rand. | - - - - diff --git a/website/content/platform/data_models/CurrencySnapshots.md b/website/content/platform/data_models/CurrencySnapshots.md deleted file mode 100644 index 814408af8c2a..000000000000 --- a/website/content/platform/data_models/CurrencySnapshots.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: "Currency Snapshots" -description: "Snapshots of currency exchange rates from an indirect or direct perspective of a base currency" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `CurrencySnapshots` | `CurrencySnapshotsQueryParams` | `CurrencySnapshotsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.currency_snapshots import ( -CurrencySnapshotsData, -CurrencySnapshotsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| base | Union[str, List[str]] | The base currency symbol. Multiple items allowed for provider(s): fmp. | usd | True | -| quote_type | Literal['direct', 'indirect'] | Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency. | indirect | True | -| counter_currencies | Union[str, List[str]] | An optional list of counter currency symbols to filter for. None returns all. | None | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| base | Union[str, List[str]] | The base currency symbol. Multiple items allowed for provider(s): fmp. | usd | True | -| quote_type | Literal['direct', 'indirect'] | Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency. | indirect | True | -| counter_currencies | Union[str, List[str]] | An optional list of counter currency symbols to filter for. None returns all. | None | 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 | -| ---- | ---- | ----------- | -| base_currency | str | The base, or domestic, currency. | -| counter_currency | str | The counter, or foreign, currency. | -| last_rate | float | 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 | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| base_currency | str | The base, or domestic, currency. | -| counter_currency | str | The counter, or foreign, currency. | -| last_rate | float | 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 | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | The change in the price from the previous close. | -| change_percent | float | The change in the price from the previous close, as a normalized percent. | -| ma50 | float | The 50-day moving average. | -| ma200 | float | The 200-day moving average. | -| year_high | float | The 52-week high. | -| year_low | float | The 52-week low. | -| last_rate_timestamp | datetime | The timestamp of the last rate. | - - - - diff --git a/website/content/platform/data_models/DiscountWindowPrimaryCreditRate.md b/website/content/platform/data_models/DiscountWindowPrimaryCreditRate.md deleted file mode 100644 index 6aeea844a7a1..000000000000 --- a/website/content/platform/data_models/DiscountWindowPrimaryCreditRate.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "Discount Window Primary Credit Rate" -description: "Discount Window Primary Credit Rate" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `DiscountWindowPrimaryCreditRate` | `DiscountWindowPrimaryCreditRateQueryParams` | `DiscountWindowPrimaryCreditRateData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.dwpcr_rates import ( -DiscountWindowPrimaryCreditRateData, -DiscountWindowPrimaryCreditRateQueryParams, -) -``` - ---- - -## 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['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual'] | FRED series ID of DWPCR data. | daily_excl_weekend | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Discount Window Primary Credit Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Discount Window Primary Credit Rate. | - - - - diff --git a/website/content/platform/data_models/DiscoveryFilings.md b/website/content/platform/data_models/DiscoveryFilings.md deleted file mode 100644 index 4c2ccacc08cf..000000000000 --- a/website/content/platform/data_models/DiscoveryFilings.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Discovery Filings" -description: "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `DiscoveryFilings` | `DiscoveryFilingsQueryParams` | `DiscoveryFilingsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.discovery_filings import ( -DiscoveryFilingsData, -DiscoveryFilingsQueryParams, -) -``` - ---- - -## 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 | -| form_type | str | Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. | None | True | -| limit | int | The number of data entries to return. | 100 | 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 | - - - - -| 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 | -| form_type | str | Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. | None | True | -| limit | int | The number of data entries to return. | 100 | 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 | -| is_done | bool | Flag for whether or not the filing is done. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| title | str | Title of the filing. | -| date | datetime | The date of the data. | -| form_type | str | The form type of the filing | -| link | str | URL to the filing page on the SEC site. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| title | str | Title of the filing. | -| date | datetime | The date of the data. | -| form_type | str | The form type of the filing | -| link | str | URL to the filing page on the SEC site. | - - - - diff --git a/website/content/platform/data_models/ESTR.md b/website/content/platform/data_models/ESTR.md deleted file mode 100644 index f351b80ca596..000000000000 --- a/website/content/platform/data_models/ESTR.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "ESTR" -description: "Euro Short-Term Rate" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `ESTR` | `ESTRQueryParams` | `ESTRData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.estr_rates import ( -ESTRData, -ESTRQueryParams, -) -``` - ---- - -## 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['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume'] | Period of ESTR rate. | volume_weighted_trimmed_mean_rate | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | ESTR rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | ESTR rate. | - - - - diff --git a/website/content/platform/data_models/ETFActive.md b/website/content/platform/data_models/ETFActive.md deleted file mode 100644 index 19016948943f..000000000000 --- a/website/content/platform/data_models/ETFActive.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "ETF Active" -description: "Get the most active ETFs" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `ETFActive` | `ETFActiveQueryParams` | `ETFActiveData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -ETFActiveData, -ETFActiveQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | -| country | str | Country of the entity. | -| mantissa | int | Mantissa. | -| type | str | Type of the entity. | -| formatted_price | str | Formatted price. | -| formatted_volume | str | Formatted volume. | -| formatted_price_change | str | Formatted price change. | -| formatted_percent_change | str | Formatted percent change. | -| url | str | The source url. | - - - - diff --git a/website/content/platform/data_models/ETFGainers.md b/website/content/platform/data_models/ETFGainers.md deleted file mode 100644 index 2c742db0d206..000000000000 --- a/website/content/platform/data_models/ETFGainers.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "ETF Gainers" -description: "Get the top ETF gainers" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `ETFGainers` | `ETFGainersQueryParams` | `ETFGainersData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -ETFGainersData, -ETFGainersQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | -| bluegrass_channel | str | Bluegrass channel. | -| country | str | Country of the entity. | -| mantissa | int | Mantissa. | -| type | str | Type of the entity. | -| formatted_price | str | Formatted price. | -| formatted_volume | str | Formatted volume. | -| formatted_price_change | str | Formatted price change. | -| formatted_percent_change | str | Formatted percent change. | -| url | str | The source url. | - - - - diff --git a/website/content/platform/data_models/ETFLosers.md b/website/content/platform/data_models/ETFLosers.md deleted file mode 100644 index c696750c211a..000000000000 --- a/website/content/platform/data_models/ETFLosers.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "ETF Losers" -description: "Get the top ETF losers" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `ETFLosers` | `ETFLosersQueryParams` | `ETFLosersData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -ETFLosersData, -ETFLosersQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | -| bluegrass_channel | str | Bluegrass channel. | -| country | str | Country of the entity. | -| mantissa | int | Mantissa. | -| type | str | Type of the entity. | -| formatted_price | str | Formatted price. | -| formatted_volume | str | Formatted volume. | -| formatted_price_change | str | Formatted price change. | -| formatted_percent_change | str | Formatted percent change. | -| url | str | The source url. | - - - - diff --git a/website/content/platform/data_models/EUYieldCurve.md b/website/content/platform/data_models/EUYieldCurve.md deleted file mode 100644 index 38ed66c68e57..000000000000 --- a/website/content/platform/data_models/EUYieldCurve.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "EU Yield Curve" -description: "Euro Area Yield Curve" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EUYieldCurve` | `EUYieldCurveQueryParams` | `EUYieldCurveData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.eu_yield_curve import ( -EUYieldCurveData, -EUYieldCurveQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. | None | True | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. | None | True | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | -| rating | Literal['aaa', 'all_ratings'] | The rating type, either 'aaa' or 'all_ratings'. | aaa | True | -| yield_curve_type | Literal['spot_rate', 'instantaneous_forward', 'par_yield'] | The yield curve type. | spot_rate | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| maturity | float | Maturity, in years. | -| rate | float | Yield curve rate, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| maturity | float | Maturity, in years. | -| rate | float | Yield curve rate, as a normalized percent. | - - - - diff --git a/website/content/platform/data_models/EarningsCallTranscript.md b/website/content/platform/data_models/EarningsCallTranscript.md deleted file mode 100644 index f96ed52a5b33..000000000000 --- a/website/content/platform/data_models/EarningsCallTranscript.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "Earnings Call Transcript" -description: "Get earnings call transcripts for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EarningsCallTranscript` | `EarningsCallTranscriptQueryParams` | `EarningsCallTranscriptData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.earnings_call_transcript import ( -EarningsCallTranscriptData, -EarningsCallTranscriptQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| year | int | Year of the earnings call transcript. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| year | int | Year of the earnings call transcript. | | False | -| 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. | -| quarter | int | Quarter of the earnings call transcript. | -| year | int | Year of the earnings call transcript. | -| date | datetime | The date of the data. | -| content | str | Content of the earnings call transcript. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| quarter | int | Quarter of the earnings call transcript. | -| year | int | Year of the earnings call transcript. | -| date | datetime | The date of the data. | -| content | str | Content of the earnings call transcript. | - - - - diff --git a/website/content/platform/data_models/EconomicCalendar.md b/website/content/platform/data_models/EconomicCalendar.md deleted file mode 100644 index d775cf9966a7..000000000000 --- a/website/content/platform/data_models/EconomicCalendar.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -title: "Economic Calendar" -description: "Get the upcoming, or historical, economic calendar of global events" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EconomicCalendar` | `EconomicCalendarQueryParams` | `EconomicCalendarData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.economic_calendar import ( -EconomicCalendarData, -EconomicCalendarQueryParams, -) -``` - ---- - -## 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['fmp', 'nasdaq', 'tradingeconomics'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq', 'tradingeconomics'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq', 'tradingeconomics'] | 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 | -| country | Union[str, List[str]] | Country of the event Multiple items allowed for provider(s): nasdaq. | None | 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['fmp', 'nasdaq', 'tradingeconomics'] | 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 | -| country | Union[str, List[str]] | Country of the event. Multiple items allowed for provider(s): tradingeconomics. | None | True | -| importance | Literal['Low', 'Medium', 'High'] | Importance of the event. | None | True | -| group | Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business'] | Grouping of events | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| country | str | Country of event. | -| event | str | Event name. | -| reference | str | Abbreviated period for which released data refers to. | -| source | str | Source of the data. | -| sourceurl | str | Source URL. | -| actual | Union[str, float] | Latest released value. | -| previous | Union[str, float] | Value for the previous period after the revision (if revision is applicable). | -| consensus | Union[str, float] | Average forecast among a representative group of economists. | -| forecast | Union[str, float] | Trading Economics projections | -| url | str | Trading Economics URL | -| importance | Union[Literal[0, 1, 2, 3], str] | Importance of the event. 1-Low, 2-Medium, 3-High | -| currency | str | Currency of the data. | -| unit | str | Unit of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| country | str | Country of event. | -| event | str | Event name. | -| reference | str | Abbreviated period for which released data refers to. | -| source | str | Source of the data. | -| sourceurl | str | Source URL. | -| actual | Union[str, float] | Latest released value. | -| previous | Union[str, float] | Value for the previous period after the revision (if revision is applicable). | -| consensus | Union[str, float] | Average forecast among a representative group of economists. | -| forecast | Union[str, float] | Trading Economics projections | -| url | str | Trading Economics URL | -| importance | Union[Literal[0, 1, 2, 3], str] | Importance of the event. 1-Low, 2-Medium, 3-High | -| currency | str | Currency of the data. | -| unit | str | Unit of the data. | -| change | float | Value change since previous. | -| change_percent | float | Percentage change since previous. | -| updated_at | datetime | Last updated timestamp. | -| created_at | datetime | Created at timestamp. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| country | str | Country of event. | -| event | str | Event name. | -| reference | str | Abbreviated period for which released data refers to. | -| source | str | Source of the data. | -| sourceurl | str | Source URL. | -| actual | Union[str, float] | Latest released value. | -| previous | Union[str, float] | Value for the previous period after the revision (if revision is applicable). | -| consensus | Union[str, float] | Average forecast among a representative group of economists. | -| forecast | Union[str, float] | Trading Economics projections | -| url | str | Trading Economics URL | -| importance | Union[Literal[0, 1, 2, 3], str] | Importance of the event. 1-Low, 2-Medium, 3-High | -| currency | str | Currency of the data. | -| unit | str | Unit of the data. | -| description | str | Event description. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| country | str | Country of event. | -| event | str | Event name. | -| reference | str | Abbreviated period for which released data refers to. | -| source | str | Source of the data. | -| sourceurl | str | Source URL. | -| actual | Union[str, float] | Latest released value. | -| previous | Union[str, float] | Value for the previous period after the revision (if revision is applicable). | -| consensus | Union[str, float] | Average forecast among a representative group of economists. | -| forecast | Union[str, float] | Trading Economics projections | -| url | str | Trading Economics URL | -| importance | Union[Literal[0, 1, 2, 3], str] | Importance of the event. 1-Low, 2-Medium, 3-High | -| currency | str | Currency of the data. | -| unit | str | Unit of the data. | - - - - diff --git a/website/content/platform/data_models/EquityActive.md b/website/content/platform/data_models/EquityActive.md deleted file mode 100644 index b59788156094..000000000000 --- a/website/content/platform/data_models/EquityActive.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Equity Active" -description: "Get the most actively traded stocks based on volume" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityActive` | `EquityActiveQueryParams` | `EquityActiveData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -EquityActiveData, -EquityActiveQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap displayed in billions. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/data_models/EquityAggressiveSmallCaps.md b/website/content/platform/data_models/EquityAggressiveSmallCaps.md deleted file mode 100644 index 85f3bd3489a2..000000000000 --- a/website/content/platform/data_models/EquityAggressiveSmallCaps.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Equity Aggressive Small Caps" -description: "Get top small cap stocks based on earnings growth" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityAggressiveSmallCaps` | `EquityAggressiveSmallCapsQueryParams` | `EquityAggressiveSmallCapsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -EquityAggressiveSmallCapsData, -EquityAggressiveSmallCapsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/data_models/EquityFTD.md b/website/content/platform/data_models/EquityFTD.md deleted file mode 100644 index 7c98182f322c..000000000000 --- a/website/content/platform/data_models/EquityFTD.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "Equity FTD" -description: "Get reported Fail-to-deliver (FTD) data" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityFTD` | `EquityFTDQueryParams` | `EquityFTDData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -EquityFTDData, -EquityFTDQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | -| limit | int | Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009. | 24 | True | -| skip_reports | int | Skip N number of reports from current. A value of 1 will skip the most recent report. | 0 | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| settlement_date | date | The settlement date of the fail. | -| symbol | str | Symbol representing the entity requested in the data. | -| cusip | str | CUSIP of the Security. | -| quantity | int | The number of fails on that settlement date. | -| price | float | The price at the previous closing price from the settlement date. | -| description | str | The description of the Security. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| settlement_date | date | The settlement date of the fail. | -| symbol | str | Symbol representing the entity requested in the data. | -| cusip | str | CUSIP of the Security. | -| quantity | int | The number of fails on that settlement date. | -| price | float | The price at the previous closing price from the settlement date. | -| description | str | The description of the Security. | - - - - diff --git a/website/content/platform/data_models/EquityGainers.md b/website/content/platform/data_models/EquityGainers.md deleted file mode 100644 index 10d541775341..000000000000 --- a/website/content/platform/data_models/EquityGainers.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: "Equity Gainers" -description: "Get the top price gainers in the stock market" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityGainers` | `EquityGainersQueryParams` | `EquityGainersData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -EquityGainersData, -EquityGainersQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | -| category | Literal['dividend', 'energy', 'healthcare', 'industrials', 'price_performer', 'rising_stars', 'real_estate', 'tech', 'utilities', '52w_high', 'volume'] | The category of list to retrieve. Defaults to `price_performer`. | price_performer | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| rank | int | The rank of the stock in the list. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/data_models/EquityHistorical.md b/website/content/platform/data_models/EquityHistorical.md deleted file mode 100644 index f0c670f08ad5..000000000000 --- a/website/content/platform/data_models/EquityHistorical.md +++ /dev/null @@ -1,345 +0,0 @@ ---- -title: "Equity Historical" -description: "Get historical price data for a given stock" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityHistorical` | `EquityHistoricalQueryParams` | `EquityHistoricalData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.equity_historical import ( -EquityHistoricalData, -EquityHistoricalQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'splits_and_dividends', 'unadjusted'] | The adjustment factor to apply. 'splits_only' is not supported for intraday data. | splits_only | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| adjusted | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| use_cache | bool | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| start_time | datetime.time | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. | None | True | -| end_time | datetime.time | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. | None | True | -| timezone | str | Timezone of the data, in the IANA format (Continent/City). | America/New_York | True | -| source | Literal['realtime', 'delayed', 'nasdaq_basic'] | The source of the data. | realtime | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'unadjusted'] | The adjustment factor to apply. Default is splits only. | splits_only | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'splits_and_dividends', 'unadjusted'] | The adjustment factor to apply. Only valid for daily data. | splits_only | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| include_actions | bool | Include dividends and stock splits in results. | True | True | -| adjustment | Literal['splits_only', 'splits_and_dividends'] | The adjustment factor to apply. Default is splits only. | splits_only | True | -| adjusted | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. | False | True | -| prepost | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead. | False | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_close | float, Gt(gt=0) | The adjusted close price. | -| dividend | float, Ge(ge=0) | Dividend amount, if a dividend was paid. | -| split_ratio | float, Ge(ge=0) | Split coefficient, if a split occurred. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| calls_volume | int | Number of calls traded during the most recent trading period. Only valid if interval is 1m. | -| puts_volume | int | Number of puts traded during the most recent trading period. Only valid if interval is 1m. | -| total_options_volume | int | Total number of options traded during the most recent trading period. Only valid if interval is 1m. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_close | float | The adjusted close price. | -| unadjusted_volume | float | Unadjusted volume of the symbol. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| average | float | Average trade price of an individual equity during the interval. | -| change | float | Change in the price of the symbol from the previous day. | -| change_percent | float | Percent change in the price of the symbol from the previous day. | -| adj_open | float | The adjusted open price. | -| adj_high | float | The adjusted high price. | -| adj_low | float | The adjusted low price. | -| adj_close | float | The adjusted close price. | -| adj_volume | float | The adjusted volume. | -| fifty_two_week_high | float | 52 week high price for the symbol. | -| fifty_two_week_low | float | 52 week low price for the symbol. | -| factor | float | factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount, if a dividend was paid. | -| close_time | datetime | The timestamp that represents the end of the interval span. | -| interval | str | The data time frequency. | -| intra_period | bool | 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 | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_open | float | The adjusted open price. | -| adj_high | float | The adjusted high price. | -| adj_low | float | The adjusted low price. | -| adj_close | float | The adjusted close price. | -| adj_volume | float | The adjusted volume. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount, if a dividend was paid. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| change | float | Change in price. | -| change_percent | float | Change in price, as a normalized percentage. | -| transactions | int | Total number of transactions recorded. | -| transactions_value | float | Nominal value of recorded transactions. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| last_price | float | The last price of the equity. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount (split-adjusted), if a dividend was paid. | - - - - diff --git a/website/content/platform/data_models/EquityInfo.md b/website/content/platform/data_models/EquityInfo.md deleted file mode 100644 index cf4d0be6ce16..000000000000 --- a/website/content/platform/data_models/EquityInfo.md +++ /dev/null @@ -1,399 +0,0 @@ ---- -title: "Equity Info" -description: "Get general information about a company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityInfo` | `EquityInfoQueryParams` | `EquityInfoData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.equity_info import ( -EquityInfoData, -EquityInfoQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | -| index | str | Included in indices - i.e., Dow, Nasdaq, or S&P. | -| optionable | str | Whether options trade against the ticker. | -| shortable | str | If the asset is shortable. | -| shares_outstanding | str | The number of shares outstanding, as an abbreviated string. | -| shares_float | str | The number of shares in the public float, as an abbreviated string. | -| short_interest | str | The last reported number of shares sold short, as an abbreviated string. | -| institutional_ownership | float | The institutional ownership of the stock, as a normalized percent. | -| market_cap | str | The market capitalization of the stock, as an abbreviated string. | -| dividend_yield | float | The dividend yield of the stock, as a normalized percent. | -| earnings_date | str | The last, or next confirmed, earnings date and announcement time, as a string. The format is Nov 02 AMC - for after market close. | -| beta | float | The beta of the stock relative to the broad market. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | -| is_etf | bool | If the symbol is an ETF. | -| is_actively_trading | bool | If the company is actively trading. | -| is_adr | bool | If the stock is an ADR. | -| is_fund | bool | If the company is a fund. | -| image | str | Image of the company. | -| currency | str | Currency in which the stock is traded. | -| market_cap | int | Market capitalization of the company. | -| last_price | float | The last traded price. | -| year_high | float | The one-year high of the price. | -| year_low | float | The one-year low of the price. | -| volume_avg | int | Average daily trading volume. | -| annualized_dividend_amount | float | The annualized dividend payment based on the most recent regular dividend payment. | -| beta | float | Beta of the stock relative to the market. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | -| id | str | Intrinio ID for the company. | -| thea_enabled | bool | Whether the company has been enabled for Thea. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | -| email | str | The email of the company. | -| issue_type | str | The issuance type of the asset. | -| shares_outstanding | int | The number of listed shares outstanding. | -| shares_escrow | int | The number of shares held in escrow. | -| shares_total | int | The total number of shares outstanding from all classes. | -| dividend_frequency | str | The dividend frequency. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | -| exchange_timezone | str | The timezone of the exchange. | -| issue_type | str | The issuance type of the asset. | -| currency | str | The currency in which the asset is traded. | -| market_cap | int | The market capitalization of the asset. | -| shares_outstanding | int | The number of listed shares outstanding. | -| shares_float | int | The number of shares in the public float. | -| shares_implied_outstanding | int | Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common. | -| shares_short | int | The reported number of shares short. | -| dividend_yield | float | The dividend yield of the asset, as a normalized percent. | -| beta | float | The beta of the asset relative to the broad market. | - - - - diff --git a/website/content/platform/data_models/EquityLosers.md b/website/content/platform/data_models/EquityLosers.md deleted file mode 100644 index a3e2ee89b87a..000000000000 --- a/website/content/platform/data_models/EquityLosers.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Equity Losers" -description: "Get the top price losers in the stock market" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityLosers` | `EquityLosersQueryParams` | `EquityLosersData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -EquityLosersData, -EquityLosersQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/data_models/EquityNBBO.md b/website/content/platform/data_models/EquityNBBO.md deleted file mode 100644 index 8e49e783698d..000000000000 --- a/website/content/platform/data_models/EquityNBBO.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "Equity NBBO" -description: "Get the National Best Bid and Offer for a given stock" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityNBBO` | `EquityNBBOQueryParams` | `EquityNBBOData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.equity_nbbo import ( -EquityNBBOData, -EquityNBBOQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['polygon'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default. | polygon | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['polygon'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default. | polygon | True | -| limit | int | 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. | 50000 | True | -| date | Union[date, str] | A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges. | None | True | -| timestamp_lt | Union[datetime, str] | 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. | None | True | -| timestamp_gt | Union[datetime, str] | 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. | None | True | -| timestamp_lte | Union[datetime, str] | 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. | None | True | -| timestamp_gte | Union[datetime, str] | 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. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ask_exchange | str | The exchange ID for the ask. | -| ask | float | The last ask price. | -| ask_size | int | The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. | -| bid_size | int | The bid size in round lots. | -| bid | float | The last bid price. | -| bid_exchange | str | The exchange ID for the bid. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ask_exchange | str | The exchange ID for the ask. | -| ask | float | The last ask price. | -| ask_size | int | The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. | -| bid_size | int | The bid size in round lots. | -| bid | float | The last bid price. | -| bid_exchange | str | The exchange ID for the bid. | -| tape | str | The exchange tape. | -| conditions | Union[str, List[int], List[str]] | A list of condition codes. | -| indicators | List[int] | A list of indicator codes. | -| sequence_num | int | 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 | datetime | The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. | -| sip_timestamp | datetime | The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. | -| trf_timestamp | datetime | The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote. | - - - - diff --git a/website/content/platform/data_models/EquityOwnership.md b/website/content/platform/data_models/EquityOwnership.md deleted file mode 100644 index d9b374ebb916..000000000000 --- a/website/content/platform/data_models/EquityOwnership.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: "Equity Ownership" -description: "Get data about major holders for a given company over time" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityOwnership` | `EquityOwnershipQueryParams` | `EquityOwnershipData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.equity_ownership import ( -EquityOwnershipData, -EquityOwnershipQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| date | Union[date, str] | A specific date to get data for. | None | True | -| page | int | Page number of the data to fetch. | 0 | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| date | Union[date, str] | A specific date to get data for. | None | True | -| page | int | Page number of the data to fetch. | 0 | 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 | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| cik | int | Central Index Key (CIK) for the requested entity. | -| filing_date | date | Filing date of the stock ownership. | -| investor_name | str | Investor name of the stock ownership. | -| symbol | str | Symbol representing the entity requested in the data. | -| security_name | str | Security name of the stock ownership. | -| type_of_security | str | Type of security of the stock ownership. | -| security_cusip | str | Security cusip of the stock ownership. | -| shares_type | str | Shares type of the stock ownership. | -| put_call_share | str | Put call share of the stock ownership. | -| investment_discretion | str | Investment discretion of the stock ownership. | -| industry_title | str | Industry title of the stock ownership. | -| weight | float | Weight of the stock ownership. | -| last_weight | float | Last weight of the stock ownership. | -| change_in_weight | float | Change in weight of the stock ownership. | -| change_in_weight_percentage | float | Change in weight percentage of the stock ownership. | -| market_value | int | Market value of the stock ownership. | -| last_market_value | int | Last market value of the stock ownership. | -| change_in_market_value | int | Change in market value of the stock ownership. | -| change_in_market_value_percentage | float | Change in market value percentage of the stock ownership. | -| shares_number | int | Shares number of the stock ownership. | -| last_shares_number | int | Last shares number of the stock ownership. | -| change_in_shares_number | float | Change in shares number of the stock ownership. | -| change_in_shares_number_percentage | float | Change in shares number percentage of the stock ownership. | -| quarter_end_price | float | Quarter end price of the stock ownership. | -| avg_price_paid | float | Average price paid of the stock ownership. | -| is_new | bool | Is the stock ownership new. | -| is_sold_out | bool | Is the stock ownership sold out. | -| ownership | float | How much is the ownership. | -| last_ownership | float | Last ownership amount. | -| change_in_ownership | float | Change in ownership amount. | -| change_in_ownership_percentage | float | Change in ownership percentage. | -| holding_period | int | Holding period of the stock ownership. | -| first_added | date | First added date of the stock ownership. | -| performance | float | Performance of the stock ownership. | -| performance_percentage | float | Performance percentage of the stock ownership. | -| last_performance | float | Last performance of the stock ownership. | -| change_in_performance | float | Change in performance of the stock ownership. | -| is_counted_for_performance | bool | Is the stock ownership counted for performance. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| cik | int | Central Index Key (CIK) for the requested entity. | -| filing_date | date | Filing date of the stock ownership. | -| investor_name | str | Investor name of the stock ownership. | -| symbol | str | Symbol representing the entity requested in the data. | -| security_name | str | Security name of the stock ownership. | -| type_of_security | str | Type of security of the stock ownership. | -| security_cusip | str | Security cusip of the stock ownership. | -| shares_type | str | Shares type of the stock ownership. | -| put_call_share | str | Put call share of the stock ownership. | -| investment_discretion | str | Investment discretion of the stock ownership. | -| industry_title | str | Industry title of the stock ownership. | -| weight | float | Weight of the stock ownership. | -| last_weight | float | Last weight of the stock ownership. | -| change_in_weight | float | Change in weight of the stock ownership. | -| change_in_weight_percentage | float | Change in weight percentage of the stock ownership. | -| market_value | int | Market value of the stock ownership. | -| last_market_value | int | Last market value of the stock ownership. | -| change_in_market_value | int | Change in market value of the stock ownership. | -| change_in_market_value_percentage | float | Change in market value percentage of the stock ownership. | -| shares_number | int | Shares number of the stock ownership. | -| last_shares_number | int | Last shares number of the stock ownership. | -| change_in_shares_number | float | Change in shares number of the stock ownership. | -| change_in_shares_number_percentage | float | Change in shares number percentage of the stock ownership. | -| quarter_end_price | float | Quarter end price of the stock ownership. | -| avg_price_paid | float | Average price paid of the stock ownership. | -| is_new | bool | Is the stock ownership new. | -| is_sold_out | bool | Is the stock ownership sold out. | -| ownership | float | How much is the ownership. | -| last_ownership | float | Last ownership amount. | -| change_in_ownership | float | Change in ownership amount. | -| change_in_ownership_percentage | float | Change in ownership percentage. | -| holding_period | int | Holding period of the stock ownership. | -| first_added | date | First added date of the stock ownership. | -| performance | float | Performance of the stock ownership. | -| performance_percentage | float | Performance percentage of the stock ownership. | -| last_performance | float | Last performance of the stock ownership. | -| change_in_performance | float | Change in performance of the stock ownership. | -| is_counted_for_performance | bool | Is the stock ownership counted for performance. | - - - - diff --git a/website/content/platform/data_models/EquityPeers.md b/website/content/platform/data_models/EquityPeers.md deleted file mode 100644 index 0d3f38978267..000000000000 --- a/website/content/platform/data_models/EquityPeers.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Equity Peers" -description: "Get the closest peers for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityPeers` | `EquityPeersQueryParams` | `EquityPeersData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.equity_peers import ( -EquityPeersData, -EquityPeersQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | -| ---- | ---- | ----------- | -| peers_list | List[str] | A list of equity peers based on sector, exchange and market cap. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| peers_list | List[str] | A list of equity peers based on sector, exchange and market cap. | - - - - diff --git a/website/content/platform/data_models/EquityQuote.md b/website/content/platform/data_models/EquityQuote.md deleted file mode 100644 index d44b6ce6b070..000000000000 --- a/website/content/platform/data_models/EquityQuote.md +++ /dev/null @@ -1,464 +0,0 @@ ---- -title: "Equity Quote" -description: "Get the latest quote for a given stock" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityQuote` | `EquityQuoteQueryParams` | `EquityQuoteData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.equity_quote import ( -EquityQuoteData, -EquityQuoteQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| use_cache | bool | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| source | Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip'] | Source of the data. | iex | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| iv30 | float | The 30-day implied volatility of the stock. | -| iv30_change | float | Change in 30-day implied volatility of the stock. | -| iv30_change_percent | float | Change in 30-day implied volatility of the stock as a normalized percentage value. | -| iv30_annual_high | float | The 1-year high of 30-day implied volatility. | -| hv30_annual_high | float | The 1-year high of 30-day realized volatility. | -| iv30_annual_low | float | The 1-year low of 30-day implied volatility. | -| hv30_annual_low | float | The 1-year low of 30-dayrealized volatility. | -| iv60_annual_high | float | The 1-year high of 60-day implied volatility. | -| hv60_annual_high | float | The 1-year high of 60-day realized volatility. | -| iv60_annual_low | float | The 1-year low of 60-day implied volatility. | -| hv60_annual_low | float | The 1-year low of 60-day realized volatility. | -| iv90_annual_high | float | The 1-year high of 90-day implied volatility. | -| hv90_annual_high | float | The 1-year high of 90-day realized volatility. | -| iv90_annual_low | float | The 1-year low of 90-day implied volatility. | -| hv90_annual_low | float | The 1-year low of 90-day realized volatility. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| price_avg50 | float | 50 day moving average price. | -| price_avg200 | float | 200 day moving average price. | -| avg_volume | int | Average volume over the last 10 trading days. | -| market_cap | float | Market cap of the company. | -| shares_outstanding | int | Number of shares outstanding. | -| eps | float | Earnings per share. | -| pe | float | Price earnings ratio. | -| earnings_announcement | Union[datetime, str] | Upcoming earnings announcement date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| is_darkpool | bool | Whether or not the current trade is from a darkpool. | -| source | str | Source of the Intrinio data. | -| updated_on | datetime | Date and Time when the data was last updated. | -| security | openbb_intrinio.utils.references.IntrinioSecurity | Security details related to the quote. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| security_type | str | The issuance type of the asset. | -| sector | str | The sector of the asset. | -| industry_category | str | The industry category of the asset. | -| industry_group | str | The industry group of the asset. | -| vwap | float | Volume Weighted Average Price over the period. | -| ma_21 | float | Twenty-one day moving average. | -| ma_50 | float | Fifty day moving average. | -| ma_200 | float | Two-hundred day moving average. | -| volume_avg_10d | int | Ten day average volume. | -| volume_avg_30d | int | Thirty day average volume. | -| volume_avg_50d | int | Fifty day average volume. | -| market_cap | int | Market capitalization. | -| market_cap_all_classes | int | Market capitalization of all share classes. | -| div_amount | float | The most recent dividend amount. | -| div_currency | str | The currency the dividend is paid in. | -| div_yield | float | The dividend yield as a normalized percentage. | -| div_freq | str | The frequency of dividend payments. | -| div_ex_date | date | The ex-dividend date. | -| div_pay_date | date | The next dividend ayment date. | -| div_growth_3y | Union[str, float] | The three year dividend growth as a normalized percentage. | -| div_growth_5y | Union[str, float] | The five year dividend growth as a normalized percentage. | -| pe | Union[str, float] | The price to earnings ratio. | -| eps | Union[str, float] | The earnings per share. | -| debt_to_equity | Union[str, float] | The debt to equity ratio. | -| price_to_book | Union[str, float] | The price to book ratio. | -| price_to_cf | Union[str, float] | The price to cash flow ratio. | -| return_on_equity | Union[str, float] | The return on equity, as a normalized percentage. | -| return_on_assets | Union[str, float] | The return on assets, as a normalized percentage. | -| beta | Union[str, float] | The beta relative to the TSX Composite. | -| alpha | Union[str, float] | The alpha relative to the TSX Composite. | -| shares_outstanding | int | The number of listed shares outstanding. | -| shares_escrow | int | The number of shares held in escrow. | -| shares_total | int | The total number of shares outstanding from all classes. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| last_volume | int | The last trade volume. | -| volume_avg | int | The average daily trading volume. | -| bid_timestamp | datetime | Timestamp of the bid price. | -| ask_timestamp | datetime | Timestamp of the ask price. | -| greeks_timestamp | datetime | Timestamp of the greeks data. | -| underlying | str | The underlying symbol for the option. | -| root_symbol | str | The root symbol for the option. | -| option_type | Literal['call', 'put'] | Type of option - call or put. | -| contract_size | int | The number of shares in a standard contract. | -| expiration_type | str | The expiration type of the option - i.e, standard, weekly, etc. | -| expiration_date | date | The expiration date of the option. | -| strike | float | The strike price of the option. | -| open_interest | int | The number of open contracts for the option. | -| bid_iv | float | Implied volatility of the bid price. | -| ask_iv | float | Implied volatility of the ask price. | -| mid_iv | float | Mid-point implied volatility of the option. | -| orats_final_iv | float | ORATS final implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | -| phi | float | Phi of the option. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| ma_50d | float | 50-day moving average price. | -| ma_200d | float | 200-day moving average price. | -| volume_average | float | Average daily trading volume. | -| volume_average_10d | float | Average daily trading volume in the last 10 days. | -| currency | str | Currency of the price. | - - - - diff --git a/website/content/platform/data_models/EquityScreener.md b/website/content/platform/data_models/EquityScreener.md deleted file mode 100644 index 645348c8cbd0..000000000000 --- a/website/content/platform/data_models/EquityScreener.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: "Equity Screener" -description: "Screen for companies meeting various criteria" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityScreener` | `EquityScreenerQueryParams` | `EquityScreenerData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.equity_screener import ( -EquityScreenerData, -EquityScreenerQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | -| mktcap_min | int | Filter by market cap greater than this value. | None | True | -| mktcap_max | int | Filter by market cap less than this value. | None | True | -| price_min | float | Filter by price greater than this value. | None | True | -| price_max | float | Filter by price less than this value. | None | True | -| beta_min | float | Filter by a beta greater than this value. | None | True | -| beta_max | float | Filter by a beta less than this value. | None | True | -| volume_min | int | Filter by volume greater than this value. | None | True | -| volume_max | int | Filter by volume less than this value. | None | True | -| dividend_min | float | Filter by dividend amount greater than this value. | None | True | -| dividend_max | float | Filter by dividend amount less than this value. | None | True | -| is_etf | bool | If true, returns only ETFs. | False | True | -| is_active | bool | If false, returns only inactive tickers. | True | True | -| sector | Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates'] | Filter by sector. | None | True | -| industry | str | Filter by industry. | None | True | -| country | str | Filter by country, as a two-letter country code. | None | True | -| exchange | Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra'] | Filter by exchange. | None | True | -| limit | int | Limit the number of results to return. | 50000 | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| market_cap | int | The market cap of ticker. | -| sector | str | The sector the ticker belongs to. | -| industry | str | The industry ticker belongs to. | -| beta | float | The beta of the ETF. | -| price | float | The current price. | -| last_annual_dividend | float | The last annual amount dividend paid. | -| volume | int | The current trading volume. | -| exchange | str | The exchange code the asset trades on. | -| exchange_name | str | The full name of the primary exchange. | -| country | str | The two-letter country abbreviation where the head office is located. | -| is_etf | Literal[True, False] | Whether the ticker is an ETF. | -| actively_trading | Literal[True, False] | Whether the ETF is actively trading. | - - - - diff --git a/website/content/platform/data_models/EquitySearch.md b/website/content/platform/data_models/EquitySearch.md deleted file mode 100644 index 0c9a4115132f..000000000000 --- a/website/content/platform/data_models/EquitySearch.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -title: "Equity Search" -description: "Search for stock symbol, CIK, LEI, or company name" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquitySearch` | `EquitySearchQueryParams` | `EquitySearchData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.equity_search import ( -EquitySearchData, -EquitySearchQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| active | bool | 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. | True | True | -| limit | int | The number of data entries to return. | 10000 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| is_etf | bool | If True, returns ETFs. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| is_fund | bool | Whether to direct the search to the list of mutual funds and ETFs. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| dpm_name | str | Name of the primary market maker. | -| post_station | str | Post and station location on the CBOE trading floor. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| cik | str | | -| lei | str | The Legal Entity Identifier (LEI) of the company. | -| intrinio_id | str | The Intrinio ID of the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| nasdaq_traded | str | Is Nasdaq traded? | -| exchange | str | Primary Exchange | -| market_category | str | Market Category | -| etf | str | Is ETF? | -| round_lot_size | float | Round Lot Size | -| test_issue | str | Is test Issue? | -| financial_status | str | Financial Status | -| cqs_symbol | str | CQS Symbol | -| nasdaq_symbol | str | NASDAQ Symbol | -| next_shares | str | Is NextShares? | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| cik | str | Central Index Key | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| exchange | str | Exchange where the security is listed. | -| security_type | Literal['stock', 'option', 'etf', 'index', 'mutual_fund'] | Type of security. | - - - - diff --git a/website/content/platform/data_models/EquityShortInterest.md b/website/content/platform/data_models/EquityShortInterest.md deleted file mode 100644 index 1064953930c8..000000000000 --- a/website/content/platform/data_models/EquityShortInterest.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: "Equity Short Interest" -description: "Get reported short volume and days to cover data" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityShortInterest` | `EquityShortInterestQueryParams` | `EquityShortInterestData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -EquityShortInterestData, -EquityShortInterestQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['finra'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default. | finra | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['finra'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default. | finra | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| settlement_date | date | The mid-month short interest report is based on short positions held by members on the settlement date of the 15th of each month. If the 15th falls on a weekend or another non-settlement date, the designated settlement date will be the previous business day on which transactions settled. The end-of-month short interest report is based on short positions held on the last business day of the month on which transactions settle. Once the short position reports are received, the short interest data is compiled for each equity security and provided for publication on the 7th business day after the reporting settlement date. | -| symbol | str | Symbol representing the entity requested in the data. | -| issue_name | str | Unique identifier of the issue. | -| market_class | str | Primary listing market. | -| current_short_position | float | The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the current cycle’s designated settlement date. | -| previous_short_position | float | The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the previous cycle’s designated settlement date. | -| avg_daily_volume | float | Total Volume or Adjusted Volume in case of splits / Total trade days between (previous settlement date + 1) to (current settlement date). The NULL values are translated as zero. | -| days_to_cover | float | The number of days of average share volume it would require to buy all of the shares that were sold short during the reporting cycle. Formula: Short Interest / Average Daily Share Volume, Rounded to Hundredths. 1.00 will be displayed for any values equal or less than 1 (i.e., Average Daily Share is equal to or greater than Short Interest). N/A will be displayed If the days to cover is Zero (i.e., Average Daily Share Volume is Zero). | -| change | float | Change in Shares Short from Previous Cycle: Difference in short interest between the current cycle and the previous cycle. | -| change_pct | float | Change in Shares Short from Previous Cycle as a percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| settlement_date | date | The mid-month short interest report is based on short positions held by members on the settlement date of the 15th of each month. If the 15th falls on a weekend or another non-settlement date, the designated settlement date will be the previous business day on which transactions settled. The end-of-month short interest report is based on short positions held on the last business day of the month on which transactions settle. Once the short position reports are received, the short interest data is compiled for each equity security and provided for publication on the 7th business day after the reporting settlement date. | -| symbol | str | Symbol representing the entity requested in the data. | -| issue_name | str | Unique identifier of the issue. | -| market_class | str | Primary listing market. | -| current_short_position | float | The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the current cycle’s designated settlement date. | -| previous_short_position | float | The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the previous cycle’s designated settlement date. | -| avg_daily_volume | float | Total Volume or Adjusted Volume in case of splits / Total trade days between (previous settlement date + 1) to (current settlement date). The NULL values are translated as zero. | -| days_to_cover | float | The number of days of average share volume it would require to buy all of the shares that were sold short during the reporting cycle. Formula: Short Interest / Average Daily Share Volume, Rounded to Hundredths. 1.00 will be displayed for any values equal or less than 1 (i.e., Average Daily Share is equal to or greater than Short Interest). N/A will be displayed If the days to cover is Zero (i.e., Average Daily Share Volume is Zero). | -| change | float | Change in Shares Short from Previous Cycle: Difference in short interest between the current cycle and the previous cycle. | -| change_pct | float | Change in Shares Short from Previous Cycle as a percent. | - - - - diff --git a/website/content/platform/data_models/EquityUndervaluedGrowth.md b/website/content/platform/data_models/EquityUndervaluedGrowth.md deleted file mode 100644 index 2ef33aafc338..000000000000 --- a/website/content/platform/data_models/EquityUndervaluedGrowth.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Equity Undervalued Growth" -description: "Get potentially undervalued growth stocks" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityUndervaluedGrowth` | `EquityUndervaluedGrowthQueryParams` | `EquityUndervaluedGrowthData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -EquityUndervaluedGrowthData, -EquityUndervaluedGrowthQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/data_models/EquityUndervaluedLargeCaps.md b/website/content/platform/data_models/EquityUndervaluedLargeCaps.md deleted file mode 100644 index 66bc4649dd1a..000000000000 --- a/website/content/platform/data_models/EquityUndervaluedLargeCaps.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Equity Undervalued Large Caps" -description: "Get potentially undervalued large cap stocks" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityUndervaluedLargeCaps` | `EquityUndervaluedLargeCapsQueryParams` | `EquityUndervaluedLargeCapsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -EquityUndervaluedLargeCapsData, -EquityUndervaluedLargeCapsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/data_models/EquityValuationMultiples.md b/website/content/platform/data_models/EquityValuationMultiples.md deleted file mode 100644 index 83253db49f53..000000000000 --- a/website/content/platform/data_models/EquityValuationMultiples.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -title: "Equity Valuation Multiples" -description: "Get equity valuation multiples for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EquityValuationMultiples` | `EquityValuationMultiplesQueryParams` | `EquityValuationMultiplesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.equity_valuation_multiples import ( -EquityValuationMultiplesData, -EquityValuationMultiplesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fmp. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fmp. | | False | -| 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. | -| revenue_per_share_ttm | float | Revenue per share calculated as trailing twelve months. | -| net_income_per_share_ttm | float | Net income per share calculated as trailing twelve months. | -| operating_cash_flow_per_share_ttm | float | Operating cash flow per share calculated as trailing twelve months. | -| free_cash_flow_per_share_ttm | float | Free cash flow per share calculated as trailing twelve months. | -| cash_per_share_ttm | float | Cash per share calculated as trailing twelve months. | -| book_value_per_share_ttm | float | Book value per share calculated as trailing twelve months. | -| tangible_book_value_per_share_ttm | float | Tangible book value per share calculated as trailing twelve months. | -| shareholders_equity_per_share_ttm | float | Shareholders equity per share calculated as trailing twelve months. | -| interest_debt_per_share_ttm | float | Interest debt per share calculated as trailing twelve months. | -| market_cap_ttm | float | Market capitalization calculated as trailing twelve months. | -| enterprise_value_ttm | float | Enterprise value calculated as trailing twelve months. | -| pe_ratio_ttm | float | Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months. | -| price_to_sales_ratio_ttm | float | Price-to-sales ratio calculated as trailing twelve months. | -| pocf_ratio_ttm | float | Price-to-operating cash flow ratio calculated as trailing twelve months. | -| pfcf_ratio_ttm | float | Price-to-free cash flow ratio calculated as trailing twelve months. | -| pb_ratio_ttm | float | Price-to-book ratio calculated as trailing twelve months. | -| ptb_ratio_ttm | float | Price-to-tangible book ratio calculated as trailing twelve months. | -| ev_to_sales_ttm | float | Enterprise value-to-sales ratio calculated as trailing twelve months. | -| enterprise_value_over_ebitda_ttm | float | Enterprise value-to-EBITDA ratio calculated as trailing twelve months. | -| ev_to_operating_cash_flow_ttm | float | Enterprise value-to-operating cash flow ratio calculated as trailing twelve months. | -| ev_to_free_cash_flow_ttm | float | Enterprise value-to-free cash flow ratio calculated as trailing twelve months. | -| earnings_yield_ttm | float | Earnings yield calculated as trailing twelve months. | -| free_cash_flow_yield_ttm | float | Free cash flow yield calculated as trailing twelve months. | -| debt_to_equity_ttm | float | Debt-to-equity ratio calculated as trailing twelve months. | -| debt_to_assets_ttm | float | Debt-to-assets ratio calculated as trailing twelve months. | -| net_debt_to_ebitda_ttm | float | Net debt-to-EBITDA ratio calculated as trailing twelve months. | -| current_ratio_ttm | float | Current ratio calculated as trailing twelve months. | -| interest_coverage_ttm | float | Interest coverage calculated as trailing twelve months. | -| income_quality_ttm | float | Income quality calculated as trailing twelve months. | -| dividend_yield_ttm | float | Dividend yield calculated as trailing twelve months. | -| dividend_yield_percentage_ttm | float | Dividend yield percentage calculated as trailing twelve months. | -| dividend_to_market_cap_ttm | float | Dividend to market capitalization ratio calculated as trailing twelve months. | -| dividend_per_share_ttm | float | Dividend per share calculated as trailing twelve months. | -| payout_ratio_ttm | float | Payout ratio calculated as trailing twelve months. | -| sales_general_and_administrative_to_revenue_ttm | float | Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months. | -| research_and_development_to_revenue_ttm | float | Research and development expenses-to-revenue ratio calculated as trailing twelve months. | -| intangibles_to_total_assets_ttm | float | Intangibles-to-total assets ratio calculated as trailing twelve months. | -| capex_to_operating_cash_flow_ttm | float | Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months. | -| capex_to_revenue_ttm | float | Capital expenditures-to-revenue ratio calculated as trailing twelve months. | -| capex_to_depreciation_ttm | float | Capital expenditures-to-depreciation ratio calculated as trailing twelve months. | -| stock_based_compensation_to_revenue_ttm | float | Stock-based compensation-to-revenue ratio calculated as trailing twelve months. | -| graham_number_ttm | float | Graham number calculated as trailing twelve months. | -| roic_ttm | float | Return on invested capital calculated as trailing twelve months. | -| return_on_tangible_assets_ttm | float | Return on tangible assets calculated as trailing twelve months. | -| graham_net_net_ttm | float | Graham net-net working capital calculated as trailing twelve months. | -| working_capital_ttm | float | Working capital calculated as trailing twelve months. | -| tangible_asset_value_ttm | float | Tangible asset value calculated as trailing twelve months. | -| net_current_asset_value_ttm | float | Net current asset value calculated as trailing twelve months. | -| invested_capital_ttm | float | Invested capital calculated as trailing twelve months. | -| average_receivables_ttm | float | Average receivables calculated as trailing twelve months. | -| average_payables_ttm | float | Average payables calculated as trailing twelve months. | -| average_inventory_ttm | float | Average inventory calculated as trailing twelve months. | -| days_sales_outstanding_ttm | float | Days sales outstanding calculated as trailing twelve months. | -| days_payables_outstanding_ttm | float | Days payables outstanding calculated as trailing twelve months. | -| days_of_inventory_on_hand_ttm | float | Days of inventory on hand calculated as trailing twelve months. | -| receivables_turnover_ttm | float | Receivables turnover calculated as trailing twelve months. | -| payables_turnover_ttm | float | Payables turnover calculated as trailing twelve months. | -| inventory_turnover_ttm | float | Inventory turnover calculated as trailing twelve months. | -| roe_ttm | float | Return on equity calculated as trailing twelve months. | -| capex_per_share_ttm | float | Capital expenditures per share calculated as trailing twelve months. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| revenue_per_share_ttm | float | Revenue per share calculated as trailing twelve months. | -| net_income_per_share_ttm | float | Net income per share calculated as trailing twelve months. | -| operating_cash_flow_per_share_ttm | float | Operating cash flow per share calculated as trailing twelve months. | -| free_cash_flow_per_share_ttm | float | Free cash flow per share calculated as trailing twelve months. | -| cash_per_share_ttm | float | Cash per share calculated as trailing twelve months. | -| book_value_per_share_ttm | float | Book value per share calculated as trailing twelve months. | -| tangible_book_value_per_share_ttm | float | Tangible book value per share calculated as trailing twelve months. | -| shareholders_equity_per_share_ttm | float | Shareholders equity per share calculated as trailing twelve months. | -| interest_debt_per_share_ttm | float | Interest debt per share calculated as trailing twelve months. | -| market_cap_ttm | float | Market capitalization calculated as trailing twelve months. | -| enterprise_value_ttm | float | Enterprise value calculated as trailing twelve months. | -| pe_ratio_ttm | float | Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months. | -| price_to_sales_ratio_ttm | float | Price-to-sales ratio calculated as trailing twelve months. | -| pocf_ratio_ttm | float | Price-to-operating cash flow ratio calculated as trailing twelve months. | -| pfcf_ratio_ttm | float | Price-to-free cash flow ratio calculated as trailing twelve months. | -| pb_ratio_ttm | float | Price-to-book ratio calculated as trailing twelve months. | -| ptb_ratio_ttm | float | Price-to-tangible book ratio calculated as trailing twelve months. | -| ev_to_sales_ttm | float | Enterprise value-to-sales ratio calculated as trailing twelve months. | -| enterprise_value_over_ebitda_ttm | float | Enterprise value-to-EBITDA ratio calculated as trailing twelve months. | -| ev_to_operating_cash_flow_ttm | float | Enterprise value-to-operating cash flow ratio calculated as trailing twelve months. | -| ev_to_free_cash_flow_ttm | float | Enterprise value-to-free cash flow ratio calculated as trailing twelve months. | -| earnings_yield_ttm | float | Earnings yield calculated as trailing twelve months. | -| free_cash_flow_yield_ttm | float | Free cash flow yield calculated as trailing twelve months. | -| debt_to_equity_ttm | float | Debt-to-equity ratio calculated as trailing twelve months. | -| debt_to_assets_ttm | float | Debt-to-assets ratio calculated as trailing twelve months. | -| net_debt_to_ebitda_ttm | float | Net debt-to-EBITDA ratio calculated as trailing twelve months. | -| current_ratio_ttm | float | Current ratio calculated as trailing twelve months. | -| interest_coverage_ttm | float | Interest coverage calculated as trailing twelve months. | -| income_quality_ttm | float | Income quality calculated as trailing twelve months. | -| dividend_yield_ttm | float | Dividend yield calculated as trailing twelve months. | -| dividend_yield_percentage_ttm | float | Dividend yield percentage calculated as trailing twelve months. | -| dividend_to_market_cap_ttm | float | Dividend to market capitalization ratio calculated as trailing twelve months. | -| dividend_per_share_ttm | float | Dividend per share calculated as trailing twelve months. | -| payout_ratio_ttm | float | Payout ratio calculated as trailing twelve months. | -| sales_general_and_administrative_to_revenue_ttm | float | Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months. | -| research_and_development_to_revenue_ttm | float | Research and development expenses-to-revenue ratio calculated as trailing twelve months. | -| intangibles_to_total_assets_ttm | float | Intangibles-to-total assets ratio calculated as trailing twelve months. | -| capex_to_operating_cash_flow_ttm | float | Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months. | -| capex_to_revenue_ttm | float | Capital expenditures-to-revenue ratio calculated as trailing twelve months. | -| capex_to_depreciation_ttm | float | Capital expenditures-to-depreciation ratio calculated as trailing twelve months. | -| stock_based_compensation_to_revenue_ttm | float | Stock-based compensation-to-revenue ratio calculated as trailing twelve months. | -| graham_number_ttm | float | Graham number calculated as trailing twelve months. | -| roic_ttm | float | Return on invested capital calculated as trailing twelve months. | -| return_on_tangible_assets_ttm | float | Return on tangible assets calculated as trailing twelve months. | -| graham_net_net_ttm | float | Graham net-net working capital calculated as trailing twelve months. | -| working_capital_ttm | float | Working capital calculated as trailing twelve months. | -| tangible_asset_value_ttm | float | Tangible asset value calculated as trailing twelve months. | -| net_current_asset_value_ttm | float | Net current asset value calculated as trailing twelve months. | -| invested_capital_ttm | float | Invested capital calculated as trailing twelve months. | -| average_receivables_ttm | float | Average receivables calculated as trailing twelve months. | -| average_payables_ttm | float | Average payables calculated as trailing twelve months. | -| average_inventory_ttm | float | Average inventory calculated as trailing twelve months. | -| days_sales_outstanding_ttm | float | Days sales outstanding calculated as trailing twelve months. | -| days_payables_outstanding_ttm | float | Days payables outstanding calculated as trailing twelve months. | -| days_of_inventory_on_hand_ttm | float | Days of inventory on hand calculated as trailing twelve months. | -| receivables_turnover_ttm | float | Receivables turnover calculated as trailing twelve months. | -| payables_turnover_ttm | float | Payables turnover calculated as trailing twelve months. | -| inventory_turnover_ttm | float | Inventory turnover calculated as trailing twelve months. | -| roe_ttm | float | Return on equity calculated as trailing twelve months. | -| capex_per_share_ttm | float | Capital expenditures per share calculated as trailing twelve months. | - - - - diff --git a/website/content/platform/data_models/EtfCountries.md b/website/content/platform/data_models/EtfCountries.md deleted file mode 100644 index 517432b837ea..000000000000 --- a/website/content/platform/data_models/EtfCountries.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: "Etf Countries" -description: "ETF Country weighting" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EtfCountries` | `EtfCountriesQueryParams` | `EtfCountriesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.etf_countries import ( -EtfCountriesData, -EtfCountriesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, tmx. | | False | -| provider | Literal['fmp', 'tmx'] | 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. (ETF) Multiple items allowed for provider(s): fmp, tmx. | | False | -| provider | Literal['fmp', 'tmx'] | 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. (ETF) Multiple items allowed for provider(s): fmp, tmx. | | False | -| provider | Literal['fmp', 'tmx'] | 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 | -| use_cache | bool | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. | True | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| country | str | The country of the exposure. Corresponding values are normalized percentage points. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| country | str | The country of the exposure. Corresponding values are normalized percentage points. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| country | str | The country of the exposure. Corresponding values are normalized percentage points. | - - - - diff --git a/website/content/platform/data_models/EtfEquityExposure.md b/website/content/platform/data_models/EtfEquityExposure.md deleted file mode 100644 index a2970736508b..000000000000 --- a/website/content/platform/data_models/EtfEquityExposure.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "Etf Equity Exposure" -description: "Get the exposure to ETFs for a specific stock" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EtfEquityExposure` | `EtfEquityExposureQueryParams` | `EtfEquityExposureData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.etf_equity_exposure import ( -EtfEquityExposureData, -EtfEquityExposureQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp. | | False | -| 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 | -| ---- | ---- | ----------- | -| equity_symbol | str | The symbol of the equity requested. | -| etf_symbol | str | The symbol of the ETF with exposure to the requested equity. | -| shares | int | The number of shares held in the ETF. | -| weight | float | The weight of the equity in the ETF, as a normalized percent. | -| market_value | Union[int, float] | The market value of the equity position in the ETF. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| equity_symbol | str | The symbol of the equity requested. | -| etf_symbol | str | The symbol of the ETF with exposure to the requested equity. | -| shares | int | The number of shares held in the ETF. | -| weight | float | The weight of the equity in the ETF, as a normalized percent. | -| market_value | Union[int, float] | The market value of the equity position in the ETF. | - - - - diff --git a/website/content/platform/data_models/EtfHistorical.md b/website/content/platform/data_models/EtfHistorical.md deleted file mode 100644 index 35ee5dff59cc..000000000000 --- a/website/content/platform/data_models/EtfHistorical.md +++ /dev/null @@ -1,345 +0,0 @@ ---- -title: "Etf Historical" -description: "ETF Historical Market Price" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EtfHistorical` | `EtfHistoricalQueryParams` | `EtfHistoricalData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.etf_historical import ( -EtfHistoricalData, -EtfHistoricalQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'splits_and_dividends', 'unadjusted'] | The adjustment factor to apply. 'splits_only' is not supported for intraday data. | splits_only | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| adjusted | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| use_cache | bool | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| start_time | datetime.time | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. | None | True | -| end_time | datetime.time | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. | None | True | -| timezone | str | Timezone of the data, in the IANA format (Continent/City). | America/New_York | True | -| source | Literal['realtime', 'delayed', 'nasdaq_basic'] | The source of the data. | realtime | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'unadjusted'] | The adjustment factor to apply. Default is splits only. | splits_only | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'splits_and_dividends', 'unadjusted'] | The adjustment factor to apply. Only valid for daily data. | splits_only | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| include_actions | bool | Include dividends and stock splits in results. | True | True | -| adjustment | Literal['splits_only', 'splits_and_dividends'] | The adjustment factor to apply. Default is splits only. | splits_only | True | -| adjusted | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. | False | True | -| prepost | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead. | False | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_close | float, Gt(gt=0) | The adjusted close price. | -| dividend | float, Ge(ge=0) | Dividend amount, if a dividend was paid. | -| split_ratio | float, Ge(ge=0) | Split coefficient, if a split occurred. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| calls_volume | int | Number of calls traded during the most recent trading period. Only valid if interval is 1m. | -| puts_volume | int | Number of puts traded during the most recent trading period. Only valid if interval is 1m. | -| total_options_volume | int | Total number of options traded during the most recent trading period. Only valid if interval is 1m. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_close | float | The adjusted close price. | -| unadjusted_volume | float | Unadjusted volume of the symbol. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| average | float | Average trade price of an individual equity during the interval. | -| change | float | Change in the price of the symbol from the previous day. | -| change_percent | float | Percent change in the price of the symbol from the previous day. | -| adj_open | float | The adjusted open price. | -| adj_high | float | The adjusted high price. | -| adj_low | float | The adjusted low price. | -| adj_close | float | The adjusted close price. | -| adj_volume | float | The adjusted volume. | -| fifty_two_week_high | float | 52 week high price for the symbol. | -| fifty_two_week_low | float | 52 week low price for the symbol. | -| factor | float | factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount, if a dividend was paid. | -| close_time | datetime | The timestamp that represents the end of the interval span. | -| interval | str | The data time frequency. | -| intra_period | bool | 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 | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_open | float | The adjusted open price. | -| adj_high | float | The adjusted high price. | -| adj_low | float | The adjusted low price. | -| adj_close | float | The adjusted close price. | -| adj_volume | float | The adjusted volume. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount, if a dividend was paid. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| change | float | Change in price. | -| change_percent | float | Change in price, as a normalized percentage. | -| transactions | int | Total number of transactions recorded. | -| transactions_value | float | Nominal value of recorded transactions. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| last_price | float | The last price of the equity. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount (split-adjusted), if a dividend was paid. | - - - - diff --git a/website/content/platform/data_models/EtfHoldings.md b/website/content/platform/data_models/EtfHoldings.md deleted file mode 100644 index 1111f8aaef7d..000000000000 --- a/website/content/platform/data_models/EtfHoldings.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -title: "Etf Holdings" -description: "Get the holdings for an individual ETF" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EtfHoldings` | `EtfHoldingsQueryParams` | `EtfHoldingsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.etf_holdings import ( -EtfHoldingsData, -EtfHoldingsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'sec', 'tmx'] | 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 | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'sec', 'tmx'] | 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 | -| date | Union[Union[str, date], str] | 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. | None | True | -| cik | str | The CIK of the filing entity. Overrides symbol. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'sec', 'tmx'] | 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 | -| date | Union[Union[str, date], str] | A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. | None | True | -| use_cache | bool | Whether or not to use cache for the request. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'sec', 'tmx'] | 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 | -| use_cache | bool | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. | True | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF holding. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF holding. | -| lei | str | The LEI of the holding. | -| title | str | The title of the holding. | -| cusip | str | The CUSIP of the holding. | -| isin | str | The ISIN of the holding. | -| balance | int | The balance of the holding, in shares or units. | -| units | Union[str, float] | The type of units. | -| currency | str | The currency of the holding. | -| value | float | The value of the holding, in dollars. | -| weight | float | The weight of the holding, as a normalized percent. | -| payoff_profile | str | The payoff profile of the holding. | -| asset_category | str | The asset category of the holding. | -| issuer_category | str | The issuer category of the holding. | -| country | str | The country of the holding. | -| is_restricted | str | Whether the holding is restricted. | -| fair_value_level | int | The fair value level of the holding. | -| is_cash_collateral | str | Whether the holding is cash collateral. | -| is_non_cash_collateral | str | Whether the holding is non-cash collateral. | -| is_loan_by_fund | str | Whether the holding is loan by fund. | -| cik | str | The CIK of the filing. | -| acceptance_datetime | str | The acceptance datetime of the filing. | -| updated | Union[date, datetime] | The date the data was updated. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF holding. | -| lei | str | The LEI of the holding. | -| cusip | str | The CUSIP of the holding. | -| isin | str | The ISIN of the holding. | -| other_id | str | Internal identifier for the holding. | -| balance | float | The balance of the holding. | -| weight | float | The weight of the holding in ETF in %. | -| value | float | The value of the holding in USD. | -| payoff_profile | str | The payoff profile of the holding. | -| units | Union[str, float] | The units of the holding. | -| currency | str | The currency of the holding. | -| asset_category | str | The asset category of the holding. | -| issuer_category | str | The issuer category of the holding. | -| country | str | The country of the holding. | -| is_restricted | str | Whether the holding is restricted. | -| fair_value_level | int | The fair value level of the holding. | -| is_cash_collateral | str | Whether the holding is cash collateral. | -| is_non_cash_collateral | str | Whether the holding is non-cash collateral. | -| is_loan_by_fund | str | Whether the holding is loan by fund. | -| loan_value | float | The loan value of the holding. | -| issuer_conditional | str | The issuer conditions of the holding. | -| asset_conditional | str | The asset conditions of the holding. | -| maturity_date | date | The maturity date of the debt security. | -| coupon_kind | str | The type of coupon for the debt security. | -| rate_type | str | The type of rate for the debt security, floating or fixed. | -| annualized_return | float | The annualized return on the debt security. | -| is_default | str | If the debt security is defaulted. | -| in_arrears | str | If the debt security is in arrears. | -| is_paid_kind | str | If the debt security payments are paid in kind. | -| derivative_category | str | The derivative category of the holding. | -| counterparty | str | The counterparty of the derivative. | -| underlying_name | str | The name of the underlying asset associated with the derivative. | -| option_type | str | The type of option. | -| derivative_payoff | str | The payoff profile of the derivative. | -| expiry_date | date | The expiry or termination date of the derivative. | -| exercise_price | float | The exercise price of the option. | -| exercise_currency | str | The currency of the option exercise price. | -| shares_per_contract | float | The number of shares per contract. | -| delta | Union[str, float] | The delta of the option. | -| rate_type_rec | str | The type of rate for reveivable portion of the swap. | -| receive_currency | str | The receive currency of the swap. | -| upfront_receive | float | The upfront amount received of the swap. | -| floating_rate_index_rec | str | The floating rate index for reveivable portion of the swap. | -| floating_rate_spread_rec | float | The floating rate spread for reveivable portion of the swap. | -| rate_tenor_rec | str | The rate tenor for reveivable portion of the swap. | -| rate_tenor_unit_rec | Union[int, str] | The rate tenor unit for reveivable portion of the swap. | -| reset_date_rec | str | The reset date for reveivable portion of the swap. | -| reset_date_unit_rec | Union[int, str] | The reset date unit for reveivable portion of the swap. | -| rate_type_pmnt | str | The type of rate for payment portion of the swap. | -| payment_currency | str | The payment currency of the swap. | -| upfront_payment | float | The upfront amount received of the swap. | -| floating_rate_index_pmnt | str | The floating rate index for payment portion of the swap. | -| floating_rate_spread_pmnt | float | The floating rate spread for payment portion of the swap. | -| rate_tenor_pmnt | str | The rate tenor for payment portion of the swap. | -| rate_tenor_unit_pmnt | Union[int, str] | The rate tenor unit for payment portion of the swap. | -| reset_date_pmnt | str | The reset date for payment portion of the swap. | -| reset_date_unit_pmnt | Union[int, str] | The reset date unit for payment portion of the swap. | -| repo_type | str | The type of repo. | -| is_cleared | str | If the repo is cleared. | -| is_tri_party | str | If the repo is tri party. | -| principal_amount | float | The principal amount of the repo. | -| principal_currency | str | The currency of the principal amount. | -| collateral_type | str | The collateral type of the repo. | -| collateral_amount | float | The collateral amount of the repo. | -| collateral_currency | str | The currency of the collateral amount. | -| exchange_currency | str | The currency of the exchange rate. | -| exchange_rate | float | The exchange rate. | -| currency_sold | str | The currency sold in a Forward Derivative. | -| currency_amount_sold | float | The amount of currency sold in a Forward Derivative. | -| currency_bought | str | The currency bought in a Forward Derivative. | -| currency_amount_bought | float | The amount of currency bought in a Forward Derivative. | -| notional_amount | float | The notional amount of the derivative. | -| notional_currency | str | The currency of the derivative's notional amount. | -| unrealized_gain | float | The unrealized gain or loss on the derivative. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF holding. | -| weight | float | The weight of the asset in the portfolio, as a normalized percentage. | -| shares | Union[int, str] | The value of the assets under management. | -| market_value | Union[str, float] | The market value of the holding. | -| currency | str | The currency of the holding. | -| share_percentage | float | The share percentage of the holding, as a normalized percentage. | -| share_change | Union[str, float] | The change in shares of the holding. | -| country | str | The country of the holding. | -| exchange | str | The exchange code of the holding. | -| type_id | str | The holding type ID of the asset. | -| fund_id | str | The fund ID of the asset. | - - - - diff --git a/website/content/platform/data_models/EtfHoldingsDate.md b/website/content/platform/data_models/EtfHoldingsDate.md deleted file mode 100644 index e9d37612bf59..000000000000 --- a/website/content/platform/data_models/EtfHoldingsDate.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: "Etf Holdings Date" -description: "Use this function to get the holdings dates, if available" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EtfHoldingsDate` | `EtfHoldingsDateQueryParams` | `EtfHoldingsDateData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.etf_holdings_date import ( -EtfHoldingsDateData, -EtfHoldingsDateQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| 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 | -| cik | str | The CIK of the filing entity. Overrides symbol. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - diff --git a/website/content/platform/data_models/EtfHoldingsPerformance.md b/website/content/platform/data_models/EtfHoldingsPerformance.md deleted file mode 100644 index fb88126d20b4..000000000000 --- a/website/content/platform/data_models/EtfHoldingsPerformance.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: "Etf Holdings Performance" -description: "Get the recent price performance of each ticker held in the ETF" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EtfHoldingsPerformance` | `EtfHoldingsPerformanceQueryParams` | `EtfHoldingsPerformanceData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -EtfHoldingsPerformanceData, -EtfHoldingsPerformanceQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| 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 | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | -| symbol | str | The ticker symbol. | - - - - diff --git a/website/content/platform/data_models/EtfInfo.md b/website/content/platform/data_models/EtfInfo.md deleted file mode 100644 index d4ba23f05998..000000000000 --- a/website/content/platform/data_models/EtfInfo.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -title: "Etf Info" -description: "ETF Information Overview" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EtfInfo` | `EtfInfoQueryParams` | `EtfInfoData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.etf_info import ( -EtfInfoData, -EtfInfoQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['fmp', 'intrinio', 'tmx', '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. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['fmp', 'intrinio', 'tmx', '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. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['fmp', 'intrinio', 'tmx', '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. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['fmp', 'intrinio', 'tmx', '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 | -| use_cache | bool | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['fmp', 'intrinio', 'tmx', '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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF. | -| description | str | Description of the fund. | -| inception_date | str | Inception date of the ETF. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF. | -| description | str | Description of the fund. | -| inception_date | str | Inception date of the ETF. | -| issuer | str | Company of the ETF. | -| cusip | str | CUSIP of the ETF. | -| isin | str | ISIN of the ETF. | -| domicile | str | Domicile of the ETF. | -| asset_class | str | Asset class of the ETF. | -| aum | float | Assets under management. | -| nav | float | Net asset value of the ETF. | -| nav_currency | str | Currency of the ETF's net asset value. | -| expense_ratio | float | The expense ratio, as a normalized percent. | -| holdings_count | int | Number of holdings. | -| avg_volume | float | Average daily trading volume. | -| website | str | Website of the issuer. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF. | -| description | str | Description of the fund. | -| inception_date | str | Inception date of the ETF. | -| fund_listing_date | date | The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange. | -| data_change_date | date | The last date on which there was a change in a classifications data field for this ETF. | -| etn_maturity_date | date | If the product is an ETN, this field identifies the maturity date for the ETN. | -| is_listed | bool | If true, the ETF is still listed on an exchange. | -| close_date | date | The date on which the ETF was de-listed if it is no longer listed. | -| exchange | str | The exchange Market Identifier Code (MIC). | -| isin | str | International Securities Identification Number (ISIN). | -| ric | str | Reuters Instrument Code (RIC). | -| sedol | str | Stock Exchange Daily Official List (SEDOL). | -| figi_symbol | str | Financial Instrument Global Identifier (FIGI) symbol. | -| share_class_figi | str | Financial Instrument Global Identifier (FIGI). | -| firstbridge_id | str | The FirstBridge unique identifier for the Exchange Traded Fund (ETF). | -| firstbridge_parent_id | str | The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable. | -| intrinio_id | str | Intrinio unique identifier for the security. | -| intraday_nav_symbol | str | Intraday Net Asset Value (NAV) symbol. | -| primary_symbol | str | The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes. | -| etp_structure_type | str | Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure. | -| legal_structure | str | Legal structure of the fund. | -| issuer | str | Issuer of the ETF. | -| etn_issuing_bank | str | If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank. | -| fund_family | str | This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor. | -| investment_style | str | Investment style of the ETF. | -| derivatives_based | str | This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio. | -| income_category | str | Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income | -| asset_class | str | Captures the underlying nature of the securities in the Exchanged Traded Product (ETP). | -| other_asset_types | str | If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets. | -| single_category_designation | str | This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market. | -| beta_type | str | This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately. | -| beta_details | str | This field provides further detail within the traditional and smart beta categories. | -| market_cap_range | str | Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.) | -| market_cap_weighting_type | str | For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type. | -| index_weighting_scheme | str | For ETFs that track an underlying index, this field provides detail on the index weighting type. | -| index_linked | str | This field identifies whether an ETF is index linked or active. | -| index_name | str | This field identifies the name of the underlying index tracked by the ETF, if applicable. | -| index_symbol | str | This field identifies the OpenFIGI ticker for the Index underlying the ETF. | -| parent_index | str | This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable. | -| index_family | str | This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider. | -| broader_index_family | str | This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider. | -| index_provider | str | This field identifies the Index provider for the index underlying the ETF, if applicable. | -| index_provider_code | str | This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable. | -| replication_structure | str | The replication structure of the Exchange Traded Product (ETP). | -| growth_value_tilt | str | Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'. | -| growth_type | str | For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores. | -| value_type | str | For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores. | -| sector | str | For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to. | -| industry | str | For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to. | -| industry_group | str | For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to. | -| cross_sector_theme | str | For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.) | -| natural_resources_type | str | For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure. | -| us_or_excludes_us | str | Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US. | -| developed_emerging | str | This field identifies the stage of development of the markets that the ETF provides exposure to. | -| specialized_region | str | This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.) | -| continent | str | This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent. | -| latin_america_sub_group | str | For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure. | -| europe_sub_group | str | For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure. | -| asia_sub_group | str | For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure. | -| specific_country | str | This field is populated if the ETF provides targeted exposure to a specific country. | -| china_listing_location | str | For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities. | -| us_state | str | Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies. | -| real_estate | str | For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market. | -| fundamental_weighting_type | str | For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology. | -| dividend_weighting_type | str | For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology. | -| bond_type | str | For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF. | -| government_bond_types | str | For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure. | -| municipal_bond_region | str | For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure. | -| municipal_vrdo | bool | For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations. | -| mortgage_bond_types | str | For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities. | -| bond_tax_status | str | For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities. | -| credit_quality | str | For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range. | -| average_maturity | str | For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range. | -| specific_maturity_year | int | For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year. | -| commodity_types | str | For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF. | -| energy_type | str | For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF. | -| agricultural_type | str | For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF. | -| livestock_type | str | For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF. | -| metal_type | str | For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF. | -| inverse_leveraged | str | This field is populated if the ETF provides inverse or leveraged exposure. | -| target_date_multi_asset_type | str | For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF. | -| currency_pair | str | This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure. | -| social_environmental_type | str | This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme. | -| clean_energy_type | str | This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field. | -| dividend_type | str | This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus. | -| regular_dividend_payor_type | str | This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field. | -| quant_strategies_type | str | This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy. | -| other_quant_models | str | For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF. | -| hedge_fund_type | str | For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy. | -| excludes_financials | bool | For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective. | -| excludes_technology | bool | For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective. | -| holds_only_nyse_stocks | bool | If true, the ETF is an equity ETF and holds only stocks listed on NYSE. | -| holds_only_nasdaq_stocks | bool | If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq. | -| holds_mlp | bool | If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy. | -| holds_preferred_stock | bool | If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy. | -| holds_closed_end_funds | bool | If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy. | -| holds_adr | bool | If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy. | -| laddered | bool | For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure. | -| zero_coupon | bool | For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills. | -| floating_rate | bool | For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds. | -| build_america_bonds | bool | For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds. | -| dynamic_futures_roll | bool | If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs. | -| currency_hedged | bool | This field is populated if the ETF's strategy involves hedging currency exposure. | -| includes_short_exposure | bool | This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF. | -| ucits | bool | If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant | -| registered_countries | str | The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe. | -| issuer_country | str | 2 letter ISO country code for the country where the issuer is located. | -| domicile | str | 2 letter ISO country code for the country where the ETP is domiciled. | -| listing_country | str | 2 letter ISO country code for the country of the primary listing. | -| listing_region | str | Geographic region in the country of the primary listing falls. | -| bond_currency_denomination | str | For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities. | -| base_currency | str | Base currency in which NAV is reported. | -| listing_currency | str | Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code. | -| number_of_holdings | int | The number of holdings in the ETF. | -| month_end_assets | float | Net assets in millions of dollars as of the most recent month end. | -| net_expense_ratio | float | Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer. | -| etf_portfolio_turnover | float | The percentage of positions turned over in the last 12 months. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF. | -| description | str | Description of the fund. | -| inception_date | str | Inception date of the ETF. | -| issuer | str | The issuer of the ETF. | -| investment_style | str | The investment style of the ETF. | -| esg | bool | Whether the ETF qualifies as an ESG fund. | -| currency | str | The currency of the ETF. | -| unit_price | float | The unit price of the ETF. | -| close | float | The closing price of the ETF. | -| prev_close | float | The previous closing price of the ETF. | -| return_1m | float | The one-month return of the ETF, as a normalized percent | -| return_3m | float | The three-month return of the ETF, as a normalized percent. | -| return_6m | float | The six-month return of the ETF, as a normalized percent. | -| return_ytd | float | The year-to-date return of the ETF, as a normalized percent. | -| return_1y | float | The one-year return of the ETF, as a normalized percent. | -| return_3y | float | The three-year return of the ETF, as a normalized percent. | -| return_5y | float | The five-year return of the ETF, as a normalized percent. | -| return_10y | float | The ten-year return of the ETF, as a normalized percent. | -| return_from_inception | float | The return from inception of the ETF, as a normalized percent. | -| avg_volume | int | The average daily volume of the ETF. | -| avg_volume_30d | int | The 30-day average volume of the ETF. | -| aum | float | The AUM of the ETF. | -| pe_ratio | float | The price-to-earnings ratio of the ETF. | -| pb_ratio | float | The price-to-book ratio of the ETF. | -| management_fee | float | The management fee of the ETF, as a normalized percent. | -| mer | float | The management expense ratio of the ETF, as a normalized percent. | -| distribution_yield | float | The distribution yield of the ETF, as a normalized percent. | -| dividend_frequency | str | The dividend payment frequency of the ETF. | -| website | str | The website of the ETF. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF. | -| description | str | Description of the fund. | -| inception_date | str | Inception date of the ETF. | -| fund_type | str | The legal type of fund. | -| fund_family | str | The fund family. | -| category | str | The fund category. | -| exchange | str | The exchange the fund is listed on. | -| exchange_timezone | str | The timezone of the exchange. | -| currency | str | The currency in which the fund is listed. | -| nav_price | float | The net asset value per unit of the fund. | -| total_assets | int | The total value of assets held by the fund. | -| trailing_pe | float | The trailing twelve month P/E ratio of the fund's assets. | -| dividend_yield | float | The dividend yield of the fund, as a normalized percent. | -| dividend_rate_ttm | float | The trailing twelve month annual dividend rate of the fund, in currency units. | -| dividend_yield_ttm | float | The trailing twelve month annual dividend yield of the fund, as a normalized percent. | -| year_high | float | The fifty-two week high price. | -| year_low | float | The fifty-two week low price. | -| ma_50d | float | 50-day moving average price. | -| ma_200d | float | 200-day moving average price. | -| return_ytd | float | The year-to-date return of the fund, as a normalized percent. | -| return_3y_avg | float | The three year average return of the fund, as a normalized percent. | -| return_5y_avg | float | The five year average return of the fund, as a normalized percent. | -| beta_3y_avg | float | The three year average beta of the fund. | -| volume_avg | float | The average daily trading volume of the fund. | -| volume_avg_10d | float | The average daily trading volume of the fund over the past ten days. | -| bid | float | The current bid price. | -| bid_size | float | The current bid size. | -| ask | float | The current ask price. | -| ask_size | float | The current ask size. | -| open | float | The open price of the most recent trading session. | -| high | float | The highest price of the most recent trading session. | -| low | float | The lowest price of the most recent trading session. | -| volume | int | The trading volume of the most recent trading session. | -| prev_close | float | The previous closing price. | - - - - diff --git a/website/content/platform/data_models/EtfSearch.md b/website/content/platform/data_models/EtfSearch.md deleted file mode 100644 index dc8bbdd1245e..000000000000 --- a/website/content/platform/data_models/EtfSearch.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -title: "Etf Search" -description: "Search for ETFs" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EtfSearch` | `EtfSearchQueryParams` | `EtfSearchData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.etf_search import ( -EtfSearchData, -EtfSearchQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| exchange | Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT'] | The exchange code the ETF trades on. | None | True | -| is_active | Literal[True, False] | Whether the ETF is actively trading. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| exchange | Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist'] | Target a specific exchange by providing the MIC code. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| div_freq | Literal['monthly', 'annually', 'quarterly'] | The dividend payment frequency. | None | True | -| sort_by | Literal['nav', 'return_1m', 'return_3m', 'return_6m', 'return_1y', 'return_3y', 'return_ytd', 'beta_1y', 'volume_avg_daily', 'management_fee', 'distribution_yield', 'pb_ratio', 'pe_ratio'] | The column to sort by. | None | True | -| use_cache | bool | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. | True | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data.(ETF) | -| name | str | Name of the ETF. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data.(ETF) | -| name | str | Name of the ETF. | -| market_cap | float | The market cap of the ETF. | -| sector | str | The sector of the ETF. | -| industry | str | The industry of the ETF. | -| beta | float | The beta of the ETF. | -| price | float | The current price of the ETF. | -| last_annual_dividend | float | The last annual dividend paid. | -| volume | float | The current trading volume of the ETF. | -| exchange | str | The exchange code the ETF trades on. | -| exchange_name | str | The full name of the exchange the ETF trades on. | -| country | str | The country the ETF is registered in. | -| actively_trading | Literal[True, False] | Whether the ETF is actively trading. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data.(ETF) | -| name | str | Name of the ETF. | -| exchange | str | The exchange MIC code. | -| figi_ticker | str | The OpenFIGI ticker. | -| ric | str | The Reuters Instrument Code. | -| isin | str | The International Securities Identification Number. | -| sedol | str | The Stock Exchange Daily Official List. | -| intrinio_id | str | The unique Intrinio ID for the security. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data.(ETF) | -| name | str | Name of the ETF. | -| short_name | str | The short name of the ETF. | -| inception_date | str | The inception date of the ETF. | -| issuer | str | The issuer of the ETF. | -| investment_style | str | The investment style of the ETF. | -| esg | bool | Whether the ETF qualifies as an ESG fund. | -| currency | str | The currency of the ETF. | -| unit_price | float | The unit price of the ETF. | -| close | float | The closing price of the ETF. | -| prev_close | float | The previous closing price of the ETF. | -| return_1m | float | The one-month return of the ETF, as a normalized percent. | -| return_3m | float | The three-month return of the ETF, as a normalized percent. | -| return_6m | float | The six-month return of the ETF, as a normalized percent. | -| return_ytd | float | The year-to-date return of the ETF, as a normalized percent. | -| return_1y | float | The one-year return of the ETF, as a normalized percent. | -| beta_1y | float | The one-year beta of the ETF, as a normalized percent. | -| return_3y | float | The three-year return of the ETF, as a normalized percent. | -| beta_3y | float | The three-year beta of the ETF, as a normalized percent. | -| return_5y | float | The five-year return of the ETF, as a normalized percent. | -| beta_5y | float | The five-year beta of the ETF, as a normalized percent. | -| return_10y | float | The ten-year return of the ETF, as a normalized percent. | -| beta_10y | float | The ten-year beta of the ETF. | -| beta_15y | float | The fifteen-year beta of the ETF. | -| return_from_inception | float | The return from inception of the ETF, as a normalized percent. | -| avg_volume | int | The average daily volume of the ETF. | -| avg_volume_30d | int | The 30-day average volume of the ETF. | -| aum | float | The AUM of the ETF. | -| pe_ratio | float | The price-to-earnings ratio of the ETF. | -| pb_ratio | float | The price-to-book ratio of the ETF. | -| management_fee | float | The management fee of the ETF, as a normalized percent. | -| mer | float | The management expense ratio of the ETF, as a normalized percent. | -| distribution_yield | float | The distribution yield of the ETF, as a normalized percent. | -| dividend_frequency | str | The dividend payment frequency of the ETF. | - - - - diff --git a/website/content/platform/data_models/EtfSectors.md b/website/content/platform/data_models/EtfSectors.md deleted file mode 100644 index 1eeff0732e84..000000000000 --- a/website/content/platform/data_models/EtfSectors.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "Etf Sectors" -description: "ETF Sector weighting" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EtfSectors` | `EtfSectorsQueryParams` | `EtfSectorsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.etf_sectors import ( -EtfSectorsData, -EtfSectorsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'tmx'] | 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 | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'tmx'] | 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 | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'tmx'] | 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 | -| use_cache | bool | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. | True | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sector | str | Sector of exposure. | -| weight | float | Exposure of the ETF to the sector in normalized percentage points. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sector | str | Sector of exposure. | -| weight | float | Exposure of the ETF to the sector in normalized percentage points. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sector | str | Sector of exposure. | -| weight | float | Exposure of the ETF to the sector in normalized percentage points. | - - - - diff --git a/website/content/platform/data_models/EuropeanCentralBankInterestRates.md b/website/content/platform/data_models/EuropeanCentralBankInterestRates.md deleted file mode 100644 index f0c9e58b5d4a..000000000000 --- a/website/content/platform/data_models/EuropeanCentralBankInterestRates.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "European Central Bank Interest Rates" -description: "European Central Bank Interest Rates" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `EuropeanCentralBankInterestRates` | `EuropeanCentralBankInterestRatesQueryParams` | `EuropeanCentralBankInterestRatesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.ecb_interest_rates import ( -EuropeanCentralBankInterestRatesData, -EuropeanCentralBankInterestRatesQueryParams, -) -``` - ---- - -## 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 | -| interest_rate_type | Literal['deposit', 'lending', 'refinancing'] | The type of interest rate. | lending | 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 | -| interest_rate_type | Literal['deposit', 'lending', 'refinancing'] | The type of interest rate. | lending | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | European Central Bank Interest Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | European Central Bank Interest Rate. | - - - - diff --git a/website/content/platform/data_models/ExecutiveCompensation.md b/website/content/platform/data_models/ExecutiveCompensation.md deleted file mode 100644 index 4c172c3eff0d..000000000000 --- a/website/content/platform/data_models/ExecutiveCompensation.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: "Executive Compensation" -description: "Get executive management team compensation for a given company over time" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `ExecutiveCompensation` | `ExecutiveCompensationQueryParams` | `ExecutiveCompensationData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.executive_compensation import ( -ExecutiveCompensationData, -ExecutiveCompensationQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fmp. | | False | -| 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['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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fmp. | | False | -| 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['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. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| filing_date | date | Date of the filing. | -| accepted_date | datetime | Date the filing was accepted. | -| name_and_position | str | Name and position of the executive. | -| year | int | Year of the compensation. | -| salary | float | Salary of the executive. | -| bonus | float | Bonus of the executive. | -| stock_award | float | Stock award of the executive. | -| incentive_plan_compensation | float | Incentive plan compensation of the executive. | -| all_other_compensation | float | All other compensation of the executive. | -| total | float | Total compensation of the executive. | -| url | str | URL of the filing data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| filing_date | date | Date of the filing. | -| accepted_date | datetime | Date the filing was accepted. | -| name_and_position | str | Name and position of the executive. | -| year | int | Year of the compensation. | -| salary | float | Salary of the executive. | -| bonus | float | Bonus of the executive. | -| stock_award | float | Stock award of the executive. | -| incentive_plan_compensation | float | Incentive plan compensation of the executive. | -| all_other_compensation | float | All other compensation of the executive. | -| total | float | Total compensation of the executive. | -| url | str | URL of the filing data. | - - - - diff --git a/website/content/platform/data_models/FEDFUNDS.md b/website/content/platform/data_models/FEDFUNDS.md deleted file mode 100644 index 15a2a3aeb4d5..000000000000 --- a/website/content/platform/data_models/FEDFUNDS.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "Fedfunds" -description: "Fed Funds Rate" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `FEDFUNDS` | `FEDFUNDSQueryParams` | `FEDFUNDSData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -FEDFUNDSData, -FEDFUNDSQueryParams, -) -``` - ---- - -## 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['federal_reserve', 'fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | 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['federal_reserve', 'fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | 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['federal_reserve', 'fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | True | -| parameter | Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume'] | Period of FED rate. | weekly | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | FED rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | FED rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | FED rate. | - - - - diff --git a/website/content/platform/data_models/FinancialRatios.md b/website/content/platform/data_models/FinancialRatios.md deleted file mode 100644 index c448c3527475..000000000000 --- a/website/content/platform/data_models/FinancialRatios.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: "Financial Ratios" -description: "Get an extensive set of financial and accounting ratios for a given company over time" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `FinancialRatios` | `FinancialRatiosQueryParams` | `FinancialRatiosData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.financial_ratios import ( -FinancialRatiosData, -FinancialRatiosQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 12 | True | -| provider | Literal['fmp', 'intrinio'] | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 12 | True | -| provider | Literal['fmp', 'intrinio'] | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 12 | True | -| provider | Literal['fmp', 'intrinio'] | 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 | -| fiscal_year | int | The specific fiscal year. Reports do not go beyond 2008. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | str | The date of the data. | -| fiscal_period | str | Period of the financial ratios. | -| fiscal_year | int | Fiscal year. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | str | The date of the data. | -| fiscal_period | str | Period of the financial ratios. | -| fiscal_year | int | Fiscal year. | -| current_ratio | float | Current ratio. | -| quick_ratio | float | Quick ratio. | -| cash_ratio | float | Cash ratio. | -| days_of_sales_outstanding | float | Days of sales outstanding. | -| days_of_inventory_outstanding | float | Days of inventory outstanding. | -| operating_cycle | float | Operating cycle. | -| days_of_payables_outstanding | float | Days of payables outstanding. | -| cash_conversion_cycle | float | Cash conversion cycle. | -| gross_profit_margin | float | Gross profit margin. | -| operating_profit_margin | float | Operating profit margin. | -| pretax_profit_margin | float | Pretax profit margin. | -| net_profit_margin | float | Net profit margin. | -| effective_tax_rate | float | Effective tax rate. | -| return_on_assets | float | Return on assets. | -| return_on_equity | float | Return on equity. | -| return_on_capital_employed | float | Return on capital employed. | -| net_income_per_ebt | float | Net income per EBT. | -| ebt_per_ebit | float | EBT per EBIT. | -| ebit_per_revenue | float | EBIT per revenue. | -| debt_ratio | float | Debt ratio. | -| debt_equity_ratio | float | Debt equity ratio. | -| long_term_debt_to_capitalization | float | Long term debt to capitalization. | -| total_debt_to_capitalization | float | Total debt to capitalization. | -| interest_coverage | float | Interest coverage. | -| cash_flow_to_debt_ratio | float | Cash flow to debt ratio. | -| company_equity_multiplier | float | Company equity multiplier. | -| receivables_turnover | float | Receivables turnover. | -| payables_turnover | float | Payables turnover. | -| inventory_turnover | float | Inventory turnover. | -| fixed_asset_turnover | float | Fixed asset turnover. | -| asset_turnover | float | Asset turnover. | -| operating_cash_flow_per_share | float | Operating cash flow per share. | -| free_cash_flow_per_share | float | Free cash flow per share. | -| cash_per_share | float | Cash per share. | -| payout_ratio | float | Payout ratio. | -| operating_cash_flow_sales_ratio | float | Operating cash flow sales ratio. | -| free_cash_flow_operating_cash_flow_ratio | float | Free cash flow operating cash flow ratio. | -| cash_flow_coverage_ratios | float | Cash flow coverage ratios. | -| short_term_coverage_ratios | float | Short term coverage ratios. | -| capital_expenditure_coverage_ratio | float | Capital expenditure coverage ratio. | -| dividend_paid_and_capex_coverage_ratio | float | Dividend paid and capex coverage ratio. | -| dividend_payout_ratio | float | Dividend payout ratio. | -| price_book_value_ratio | float | Price book value ratio. | -| price_to_book_ratio | float | Price to book ratio. | -| price_to_sales_ratio | float | Price to sales ratio. | -| price_earnings_ratio | float | Price earnings ratio. | -| price_to_free_cash_flows_ratio | float | Price to free cash flows ratio. | -| price_to_operating_cash_flows_ratio | float | Price to operating cash flows ratio. | -| price_cash_flow_ratio | float | Price cash flow ratio. | -| price_earnings_to_growth_ratio | float | Price earnings to growth ratio. | -| price_sales_ratio | float | Price sales ratio. | -| dividend_yield | float | Dividend yield. | -| dividend_yield_percentage | float | Dividend yield percentage. | -| dividend_per_share | float | Dividend per share. | -| enterprise_value_multiple | float | Enterprise value multiple. | -| price_fair_value | float | Price fair value. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | str | The date of the data. | -| fiscal_period | str | Period of the financial ratios. | -| fiscal_year | int | Fiscal year. | - - - - diff --git a/website/content/platform/data_models/Form13FHR.md b/website/content/platform/data_models/Form13FHR.md deleted file mode 100644 index 60bd0c1aae2f..000000000000 --- a/website/content/platform/data_models/Form13FHR.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: "Form 13FHR" -description: "The Securities and Exchange Commission's (SEC) Form 13F is a quarterly report -that is required to be filed by all institutional investment managers with at least -$100 million in assets under management" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `Form13FHR` | `Form13FHRQueryParams` | `Form13FHRData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.form_13FHR import ( -Form13FHRData, -Form13FHRQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. A CIK or Symbol can be used. | | False | -| date | Union[date, str] | 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. | None | True | -| limit | int | The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter. | 1 | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. A CIK or Symbol can be used. | | False | -| date | Union[date, str] | 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. | None | True | -| limit | int | The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter. | 1 | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end-of-quarter date of the filing. | -| issuer | str | The name of the issuer. | -| cusip | str | The CUSIP of the security. | -| asset_class | str | The title of the asset class for the security. | -| security_type | Literal['SH', 'PRN'] | The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'. | -| option_type | Literal['call', 'put'] | Defined when the holdings being reported are put or call options. Only long positions are reported. | -| voting_authority_sole | int | The number of shares for which the Manager exercises sole voting authority (none). | -| voting_authority_shared | int | The number of shares for which the Manager exercises a defined shared voting authority (none). | -| voting_authority_other | int | The number of shares for which the Manager exercises other shared voting authority (none). | -| principal_amount | int | The total number of shares of the class of security or the principal amount of such class. Only long positions are reported | -| value | int | The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end-of-quarter date of the filing. | -| issuer | str | The name of the issuer. | -| cusip | str | The CUSIP of the security. | -| asset_class | str | The title of the asset class for the security. | -| security_type | Literal['SH', 'PRN'] | The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'. | -| option_type | Literal['call', 'put'] | Defined when the holdings being reported are put or call options. Only long positions are reported. | -| voting_authority_sole | int | The number of shares for which the Manager exercises sole voting authority (none). | -| voting_authority_shared | int | The number of shares for which the Manager exercises a defined shared voting authority (none). | -| voting_authority_other | int | The number of shares for which the Manager exercises other shared voting authority (none). | -| principal_amount | int | The total number of shares of the class of security or the principal amount of such class. Only long positions are reported | -| value | int | The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter. | -| weight | float | The weight of the security relative to the market value of all securities in the filing , as a normalized percent. | - - - - diff --git a/website/content/platform/data_models/FredRegional.md b/website/content/platform/data_models/FredRegional.md deleted file mode 100644 index 92bc98b74119..000000000000 --- a/website/content/platform/data_models/FredRegional.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Fred Regional" -description: "Query the Geo Fred API for regional economic data by series group" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `FredRegional` | `FredRegionalQueryParams` | `FredRegionalData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -FredRegionalData, -FredRegionalQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fred. | | False | -| 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 | -| limit | int | The number of data entries to return. | 100000 | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fred. | | False | -| 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 | -| limit | int | The number of data entries to return. | 100000 | 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 | -| is_series_group | bool | When True, the symbol provided is for a series_group, else it is for a series ID. | False | True | -| region_type | Literal['bea', 'msa', 'frb', 'necta', 'state', 'country', 'county', 'censusregion'] | The type of regional data. Parameter is only valid when `is_series_group` is True. | None | True | -| season | Literal['SA', 'NSA', 'SSA'] | The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True. | NSA | True | -| units | str | 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. | None | True | -| frequency | Literal['d', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem'] | Frequency aggregation to convert high frequency data to lower frequency. Parameter is only valid when `is_series_group` is True. a = Annual sa= Semiannual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday | None | True | -| aggregation_method | Literal['avg', 'sum', 'eop'] | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. Only valid when `is_series_group` is True. avg = Average sum = Sum eop = End of Period | avg | True | -| transform | Literal['lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log'] | Transformation type. Only valid when `is_series_group` is True. lin = Levels (No transformation) chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log | lin | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| region | str | The name of the region. | -| code | Union[str, int] | The code of the region. | -| value | Union[int, float] | The obersvation value. The units are defined in the search results by series ID. | -| series_id | str | The individual series ID for the region. | - - - - diff --git a/website/content/platform/data_models/FredSearch.md b/website/content/platform/data_models/FredSearch.md deleted file mode 100644 index b244ec029f3b..000000000000 --- a/website/content/platform/data_models/FredSearch.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: "Fred Search" -description: "Search for FRED series or economic releases by ID or string" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `FredSearch` | `FredSearchQueryParams` | `FredSearchData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -FredSearchData, -FredSearchQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | The search word(s). | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | The search word(s). | 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 | -| is_release | bool | Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True. | False | True | -| release_id | Union[int, str] | A specific release ID to target. | None | True | -| limit | int | The number of data entries to return. (1-1000) | None | True | -| offset | int, Ge(ge=0) | Offset the results in conjunction with limit. | 0 | True | -| filter_variable | Literal[None, 'frequency', 'units', 'seasonal_adjustment'] | Filter by an attribute. | None | True | -| filter_value | str | String value to filter the variable by. Used in conjunction with filter_variable. | None | True | -| tag_names | str | A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' | None | True | -| exclude_tag_names | str | 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. | None | True | -| series_id | str | 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. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| release_id | Union[int, str] | The release ID for queries. | -| series_id | str | The series ID for the item in the release. | -| name | str | The name of the release. | -| title | str | The title of the series. | -| observation_start | date | The date of the first observation in the series. | -| observation_end | date | The date of the last observation in the series. | -| frequency | str | The frequency of the data. | -| frequency_short | str | Short form of the data frequency. | -| units | str | The units of the data. | -| units_short | str | Short form of the data units. | -| seasonal_adjustment | str | The seasonal adjustment of the data. | -| seasonal_adjustment_short | str | Short form of the data seasonal adjustment. | -| last_updated | datetime | The datetime of the last update to the data. | -| notes | str | Description of the release. | -| press_release | bool | If the release is a press release. | -| url | str | URL to the release. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| release_id | Union[int, str] | The release ID for queries. | -| series_id | str | The series ID for the item in the release. | -| name | str | The name of the release. | -| title | str | The title of the series. | -| observation_start | date | The date of the first observation in the series. | -| observation_end | date | The date of the last observation in the series. | -| frequency | str | The frequency of the data. | -| frequency_short | str | Short form of the data frequency. | -| units | str | The units of the data. | -| units_short | str | Short form of the data units. | -| seasonal_adjustment | str | The seasonal adjustment of the data. | -| seasonal_adjustment_short | str | Short form of the data seasonal adjustment. | -| last_updated | datetime | The datetime of the last update to the data. | -| notes | str | Description of the release. | -| press_release | bool | If the release is a press release. | -| url | str | URL to the release. | -| popularity | int | Popularity of the series | -| group_popularity | int | Group popularity of the release | -| region_type | str | The region type of the series. | -| series_group | Union[int, str] | The series group ID of the series. This value is used to query for regional data. | - - - - diff --git a/website/content/platform/data_models/FredSeries.md b/website/content/platform/data_models/FredSeries.md deleted file mode 100644 index ec1830233b2e..000000000000 --- a/website/content/platform/data_models/FredSeries.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: "Fred Series" -description: "Get data by series ID from FRED" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `FredSeries` | `FredSeriesQueryParams` | `FredSeriesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -FredSeriesData, -FredSeriesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fred. | | False | -| 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 | -| limit | int | The number of data entries to return. | 100000 | True | -| provider | Literal['fred', 'intrinio'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fred. | | False | -| 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 | -| limit | int | The number of data entries to return. | 100000 | True | -| provider | Literal['fred', 'intrinio'] | 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 | -| frequency | Literal[None, 'a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem'] | Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday | None | True | -| aggregation_method | Literal[None, 'avg', 'sum', 'eop'] | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period | eop | True | -| transform | Literal[None, 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log'] | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fred. | | False | -| 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 | -| limit | int | The number of data entries to return. | 100000 | True | -| provider | Literal['fred', 'intrinio'] | 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 | -| all_pages | bool | Returns all pages of data from the API call at once. | False | True | -| sleep | float | Time to sleep between requests to avoid rate limiting. | 1.0 | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Value of the index. | - - - - diff --git a/website/content/platform/data_models/FuturesCurve.md b/website/content/platform/data_models/FuturesCurve.md deleted file mode 100644 index c876bdac0690..000000000000 --- a/website/content/platform/data_models/FuturesCurve.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "Futures Curve" -description: "Futures Term Structure, current or historical" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `FuturesCurve` | `FuturesCurveQueryParams` | `FuturesCurveData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.futures_curve import ( -FuturesCurveData, -FuturesCurveQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| date | Union[date, str] | A specific date to get data for. | None | True | -| provider | Literal['cboe', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| date | Union[date, str] | A specific date to get data for. | None | True | -| provider | Literal['cboe', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| date | Union[date, str] | A specific date to get data for. | None | True | -| provider | Literal['cboe', '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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| expiration | str | Futures expiration month. | -| price | float | The close price. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| expiration | str | Futures expiration month. | -| price | float | The close price. | -| symbol | str | The trading symbol for the tenor of future. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| expiration | str | Futures expiration month. | -| price | float | The close price. | - - - - diff --git a/website/content/platform/data_models/FuturesHistorical.md b/website/content/platform/data_models/FuturesHistorical.md deleted file mode 100644 index 74bb26084480..000000000000 --- a/website/content/platform/data_models/FuturesHistorical.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Futures Historical" -description: "Historical futures prices" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `FuturesHistorical` | `FuturesHistoricalQueryParams` | `FuturesHistoricalData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.futures_historical import ( -FuturesHistoricalData, -FuturesHistoricalQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): yfinance. | | False | -| 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 | -| expiration | str | Future expiry date with format YYYY-MM | None | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): yfinance. | | False | -| 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 | -| expiration | str | Future expiry date with format YYYY-MM | None | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | -| interval | Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q'] | Time interval of the data to return. | 1d | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | - - - - diff --git a/website/content/platform/data_models/GdpForecast.md b/website/content/platform/data_models/GdpForecast.md deleted file mode 100644 index f4e5f329d618..000000000000 --- a/website/content/platform/data_models/GdpForecast.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "Gdp Forecast" -description: "Forecasted GDP Data" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `GdpForecast` | `GdpForecastQueryParams` | `GdpForecastData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.gdp_forecast import ( -GdpForecastData, -GdpForecastQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| period | Literal['quarter', 'annual'] | Time period of the data to return. Units for nominal GDP period. Either quarter or annual. | annual | True | -| 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 | -| type | Literal['nominal', 'real'] | Type of GDP to get forecast of. Either nominal or real. | real | True | -| provider | Literal['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| period | Literal['quarter', 'annual'] | Time period of the data to return. Units for nominal GDP period. Either quarter or annual. | annual | True | -| 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 | -| type | Literal['nominal', 'real'] | Type of GDP to get forecast of. Either nominal or real. | real | True | -| provider | Literal['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['argentina', 'asia', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_17', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'non-oecd', 'norway', 'oecd_total', 'peru', 'poland', 'portugal', 'romania', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'world'] | Country to get GDP for. | united_states | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - diff --git a/website/content/platform/data_models/GdpNominal.md b/website/content/platform/data_models/GdpNominal.md deleted file mode 100644 index 68947a1358aa..000000000000 --- a/website/content/platform/data_models/GdpNominal.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "Gdp Nominal" -description: "Nominal GDP Data" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `GdpNominal` | `GdpNominalQueryParams` | `GdpNominalData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.gdp_nominal import ( -GdpNominalData, -GdpNominalQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| units | Literal['usd', 'usd_cap'] | The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita. | usd | True | -| 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| units | Literal['usd', 'usd_cap'] | The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita. | usd | True | -| 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['australia', 'austria', 'belgium', 'brazil', 'canada', 'chile', 'colombia', 'costa_rica', 'czech_republic', 'denmark', 'estonia', 'euro_area', 'european_union', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all'] | Country to get GDP for. | united_states | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - diff --git a/website/content/platform/data_models/GdpReal.md b/website/content/platform/data_models/GdpReal.md deleted file mode 100644 index 91d0b304d285..000000000000 --- a/website/content/platform/data_models/GdpReal.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "Gdp Real" -description: "Real GDP Data" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `GdpReal` | `GdpRealQueryParams` | `GdpRealData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.gdp_real import ( -GdpRealData, -GdpRealQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| units | Literal['idx', 'qoq', 'yoy'] | The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).) | yoy | True | -| 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| units | Literal['idx', 'qoq', 'yoy'] | The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).) | yoy | True | -| 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_19', 'europe', 'european_union_27', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'oecd_total', 'poland', 'portugal', 'romania', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all'] | Country to get GDP for. | united_states | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - diff --git a/website/content/platform/data_models/GrowthTechEquities.md b/website/content/platform/data_models/GrowthTechEquities.md deleted file mode 100644 index 370e7b4abca7..000000000000 --- a/website/content/platform/data_models/GrowthTechEquities.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Growth Tech Equities" -description: "Get top tech stocks based on revenue and earnings growth" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `GrowthTechEquities` | `GrowthTechEquitiesQueryParams` | `GrowthTechEquitiesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -GrowthTechEquitiesData, -GrowthTechEquitiesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/data_models/HighQualityMarketCorporateBond.md b/website/content/platform/data_models/HighQualityMarketCorporateBond.md deleted file mode 100644 index 1053c32eb7bd..000000000000 --- a/website/content/platform/data_models/HighQualityMarketCorporateBond.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "High Quality Market Corporate Bond" -description: "High Quality Market Corporate Bond" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `HighQualityMarketCorporateBond` | `HighQualityMarketCorporateBondQueryParams` | `HighQualityMarketCorporateBondData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.hqm import ( -HighQualityMarketCorporateBondData, -HighQualityMarketCorporateBondQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. | None | True | -| yield_curve | Literal['spot', 'par'] | The yield curve type. | spot | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. | None | True | -| yield_curve | Literal['spot', 'par'] | The yield curve type. | spot | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | HighQualityMarketCorporateBond Rate. | -| maturity | str | Maturity. | -| yield_curve | Literal['spot', 'par'] | The yield curve type. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | HighQualityMarketCorporateBond Rate. | -| maturity | str | Maturity. | -| yield_curve | Literal['spot', 'par'] | The yield curve type. | -| series_id | str | FRED series id. | - - - - diff --git a/website/content/platform/data_models/HistoricalAttributes.md b/website/content/platform/data_models/HistoricalAttributes.md deleted file mode 100644 index dab90878f9d1..000000000000 --- a/website/content/platform/data_models/HistoricalAttributes.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "Historical Attributes" -description: "Get the historical values of a data tag from Intrinio" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `HistoricalAttributes` | `HistoricalAttributesQueryParams` | `HistoricalAttributesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.historical_attributes import ( -HistoricalAttributesData, -HistoricalAttributesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): intrinio. | | False | -| tag | Union[str, List[str]] | Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio. | | False | -| 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 | -| frequency | Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly'] | The frequency of the data. | yearly | True | -| limit | int | The number of data entries to return. | 1000 | True | -| tag_type | str | Filter by type, when applicable. | None | True | -| sort | Literal['asc', 'desc'] | Sort order. | desc | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): intrinio. | | False | -| tag | Union[str, List[str]] | Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio. | | False | -| 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 | -| frequency | Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly'] | The frequency of the data. | yearly | True | -| limit | int | The number of data entries to return. | 1000 | True | -| tag_type | str | Filter by type, when applicable. | None | True | -| sort | Literal['asc', 'desc'] | Sort order. | desc | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| tag | str | Tag name for the fetched data. | -| value | float | The value of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| tag | str | Tag name for the fetched data. | -| value | float | The value of the data. | - - - - diff --git a/website/content/platform/data_models/HistoricalDividends.md b/website/content/platform/data_models/HistoricalDividends.md deleted file mode 100644 index a4c3a1e3569f..000000000000 --- a/website/content/platform/data_models/HistoricalDividends.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -title: "Historical Dividends" -description: "Get historical dividend data for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `HistoricalDividends` | `HistoricalDividendsQueryParams` | `HistoricalDividendsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.historical_dividends import ( -HistoricalDividendsData, -HistoricalDividendsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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 | -| limit | int | The number of data entries to return. | 100 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | -| label | str | Label of the historical dividends. | -| adj_dividend | float | Adjusted dividend of the historical dividends. | -| record_date | date | Record date of the historical dividends. | -| payment_date | date | Payment date of the historical dividends. | -| declaration_date | date | Declaration date of the historical dividends. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | -| factor | float | factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices. | -| currency | str | The currency in which the dividend is paid. | -| split_ratio | float | The ratio of the stock split, if a stock split occurred. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | -| dividend_type | str | The type of dividend - i.e., cash, stock. | -| currency | str | The currency in which the dividend is paid. | -| record_date | date | The record date of ownership for eligibility. | -| payment_date | date | The payment date of the dividend. | -| declaration_date | date | Declaration date of the dividend. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | -| currency | str | The currency the dividend is paid in. | -| decalaration_date | date | The date of the announcement. | -| record_date | date | The record date of ownership for rights to the dividend. | -| payment_date | date | The date the dividend is paid. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | - - - - diff --git a/website/content/platform/data_models/HistoricalEmployees.md b/website/content/platform/data_models/HistoricalEmployees.md deleted file mode 100644 index 631ec404d6d4..000000000000 --- a/website/content/platform/data_models/HistoricalEmployees.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: "Historical Employees" -description: "Get historical employee count data for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `HistoricalEmployees` | `HistoricalEmployeesQueryParams` | `HistoricalEmployeesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.historical_employees import ( -HistoricalEmployeesData, -HistoricalEmployeesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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. | -| cik | int | Central Index Key (CIK) for the requested entity. | -| acceptance_time | datetime | Time of acceptance of the company employee. | -| period_of_report | date | Date of reporting of the company employee. | -| company_name | str | Registered name of the company to retrieve the historical employees of. | -| form_type | str | Form type of the company employee. | -| filing_date | date | Filing date of the company employee | -| employee_count | int | Count of employees of the company. | -| source | str | Source URL which retrieves this data for the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | int | Central Index Key (CIK) for the requested entity. | -| acceptance_time | datetime | Time of acceptance of the company employee. | -| period_of_report | date | Date of reporting of the company employee. | -| company_name | str | Registered name of the company to retrieve the historical employees of. | -| form_type | str | Form type of the company employee. | -| filing_date | date | Filing date of the company employee | -| employee_count | int | Count of employees of the company. | -| source | str | Source URL which retrieves this data for the company. | - - - - diff --git a/website/content/platform/data_models/HistoricalEps.md b/website/content/platform/data_models/HistoricalEps.md deleted file mode 100644 index b5389a2fe7de..000000000000 --- a/website/content/platform/data_models/HistoricalEps.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: "Historical Eps" -description: "Get historical earnings per share data for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `HistoricalEps` | `HistoricalEpsQueryParams` | `HistoricalEpsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.historical_eps import ( -HistoricalEpsData, -HistoricalEpsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage. | | False | -| provider | Literal['alpha_vantage', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage. | | False | -| provider | Literal['alpha_vantage', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | quarter | True | -| limit | int | The number of data entries to return. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage. | | False | -| provider | Literal['alpha_vantage', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| limit | int | The number of data entries to return. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| announce_time | str | Timing of the earnings announcement. | -| eps_actual | float | Actual EPS from the earnings date. | -| eps_estimated | float | Estimated EPS for the earnings date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| announce_time | str | Timing of the earnings announcement. | -| eps_actual | float | Actual EPS from the earnings date. | -| eps_estimated | float | Estimated EPS for the earnings date. | -| surprise | float | Surprise in EPS (Actual - Estimated). | -| surprise_percent | Union[float, str] | EPS surprise as a normalized percent. | -| reported_date | date | Date of the earnings report. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| announce_time | str | Timing of the earnings announcement. | -| eps_actual | float | Actual EPS from the earnings date. | -| eps_estimated | float | Estimated EPS for the earnings date. | -| revenue_estimated | float | Estimated consensus revenue for the reporting period. | -| revenue_actual | float | The actual reported revenue. | -| reporting_time | str | The reporting time - e.g. after market close. | -| updated_at | date | The date when the data was last updated. | -| period_ending | date | The fiscal period end date. | - - - - diff --git a/website/content/platform/data_models/HistoricalSplits.md b/website/content/platform/data_models/HistoricalSplits.md deleted file mode 100644 index feaa37faad70..000000000000 --- a/website/content/platform/data_models/HistoricalSplits.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "Historical Splits" -description: "Get historical stock splits for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `HistoricalSplits` | `HistoricalSplitsQueryParams` | `HistoricalSplitsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.historical_splits import ( -HistoricalSplitsData, -HistoricalSplitsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| label | str | Label of the historical stock splits. | -| numerator | float | Numerator of the historical stock splits. | -| denominator | float | Denominator of the historical stock splits. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| label | str | Label of the historical stock splits. | -| numerator | float | Numerator of the historical stock splits. | -| denominator | float | Denominator of the historical stock splits. | - - - - diff --git a/website/content/platform/data_models/ICEBofA.md b/website/content/platform/data_models/ICEBofA.md deleted file mode 100644 index f4005527ec17..000000000000 --- a/website/content/platform/data_models/ICEBofA.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "ICE Bof A" -description: "ICE BofA US Corporate Bond Indices" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `ICEBofA` | `ICEBofAQueryParams` | `ICEBofAData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.ice_bofa import ( -ICEBofAData, -ICEBofAQueryParams, -) -``` - ---- - -## 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 | -| index_type | Literal['yield', 'yield_to_worst', 'total_return', 'spread'] | The type of series. | yield | 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 | -| index_type | Literal['yield', 'yield_to_worst', 'total_return', 'spread'] | The type of series. | yield | 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 | -| category | Literal['all', 'duration', 'eur', 'usd'] | The type of category. | all | True | -| area | Literal['asia', 'emea', 'eu', 'ex_g10', 'latin_america', 'us'] | The type of area. | us | True | -| grade | Literal['a', 'aa', 'aaa', 'b', 'bb', 'bbb', 'ccc', 'crossover', 'high_grade', 'high_yield', 'non_financial', 'non_sovereign', 'private_sector', 'public_sector'] | The type of grade. | non_sovereign | True | -| options | bool | Whether to include options in the results. | False | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | ICE BofA US Corporate Bond Indices Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | ICE BofA US Corporate Bond Indices Rate. | - - - - diff --git a/website/content/platform/data_models/IORB.md b/website/content/platform/data_models/IORB.md deleted file mode 100644 index bcaa4efcfb03..000000000000 --- a/website/content/platform/data_models/IORB.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "IORB" -description: "Interest on Reserve Balances" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `IORB` | `IORBQueryParams` | `IORBData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.iorb_rates import ( -IORBData, -IORBQueryParams, -) -``` - ---- - -## 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | IORB rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | IORB rate. | - - - - diff --git a/website/content/platform/data_models/IncomeStatement.md b/website/content/platform/data_models/IncomeStatement.md deleted file mode 100644 index f2a538cfd4ef..000000000000 --- a/website/content/platform/data_models/IncomeStatement.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -title: "Income Statement" -description: "Get the income statement for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `IncomeStatement` | `IncomeStatementQueryParams` | `IncomeStatementData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.income_statement import ( -IncomeStatementData, -IncomeStatementQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | -| fiscal_year | int | The specific fiscal year. Reports do not go beyond 2008. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| filing_date | date | The date when the filing was made. | -| accepted_date | datetime | The date and time when the filing was accepted. | -| reported_currency | str | The currency in which the balance sheet was reported. | -| revenue | float | Total revenue. | -| cost_of_revenue | float | Cost of revenue. | -| gross_profit | float | Gross profit. | -| gross_profit_margin | float | Gross profit margin. | -| general_and_admin_expense | float | General and administrative expenses. | -| research_and_development_expense | float | Research and development expenses. | -| selling_and_marketing_expense | float | Selling and marketing expenses. | -| selling_general_and_admin_expense | float | Selling, general and administrative expenses. | -| other_expenses | float | Other expenses. | -| total_operating_expenses | float | Total operating expenses. | -| cost_and_expenses | float | Cost and expenses. | -| interest_income | float | Interest income. | -| total_interest_expense | float | Total interest expenses. | -| depreciation_and_amortization | float | Depreciation and amortization. | -| ebitda | float | EBITDA. | -| ebitda_margin | float | EBITDA margin. | -| total_operating_income | float | Total operating income. | -| operating_income_margin | float | Operating income margin. | -| total_other_income_expenses | float | Total other income and expenses. | -| total_pre_tax_income | float | Total pre-tax income. | -| pre_tax_income_margin | float | Pre-tax income margin. | -| income_tax_expense | float | Income tax expense. | -| consolidated_net_income | float | Consolidated net income. | -| net_income_margin | float | Net income margin. | -| basic_earnings_per_share | float | Basic earnings per share. | -| diluted_earnings_per_share | float | Diluted earnings per share. | -| weighted_average_basic_shares_outstanding | float | Weighted average basic shares outstanding. | -| weighted_average_diluted_shares_outstanding | float | Weighted average diluted shares outstanding. | -| link | str | Link to the filing. | -| final_link | str | Link to the filing document. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| reported_currency | str | The currency in which the balance sheet is reported. | -| revenue | float | Total revenue | -| operating_revenue | float | Total operating revenue | -| cost_of_revenue | float | Total cost of revenue | -| operating_cost_of_revenue | float | Total operating cost of revenue | -| gross_profit | float | Total gross profit | -| gross_profit_margin | float | Gross margin ratio. | -| provision_for_credit_losses | float | Provision for credit losses | -| research_and_development_expense | float | Research and development expense | -| selling_general_and_admin_expense | float | Selling, general, and admin expense | -| salaries_and_employee_benefits | float | Salaries and employee benefits | -| marketing_expense | float | Marketing expense | -| net_occupancy_and_equipment_expense | float | Net occupancy and equipment expense | -| other_operating_expenses | float | Other operating expenses | -| depreciation_expense | float | Depreciation expense | -| amortization_expense | float | Amortization expense | -| amortization_of_deferred_policy_acquisition_costs | float | Amortization of deferred policy acquisition costs | -| exploration_expense | float | Exploration expense | -| depletion_expense | float | Depletion expense | -| total_operating_expenses | float | Total operating expenses | -| total_operating_income | float | Total operating income | -| deposits_and_money_market_investments_interest_income | float | Deposits and money market investments interest income | -| federal_funds_sold_and_securities_borrowed_interest_income | float | Federal funds sold and securities borrowed interest income | -| investment_securities_interest_income | float | Investment securities interest income | -| loans_and_leases_interest_income | float | Loans and leases interest income | -| trading_account_interest_income | float | Trading account interest income | -| other_interest_income | float | Other interest income | -| total_non_interest_income | float | Total non-interest income | -| interest_and_investment_income | float | Interest and investment income | -| short_term_borrowings_interest_expense | float | Short-term borrowings interest expense | -| long_term_debt_interest_expense | float | Long-term debt interest expense | -| capitalized_lease_obligations_interest_expense | float | Capitalized lease obligations interest expense | -| deposits_interest_expense | float | Deposits interest expense | -| federal_funds_purchased_and_securities_sold_interest_expense | float | Federal funds purchased and securities sold interest expense | -| other_interest_expense | float | Other interest expense | -| total_interest_expense | float | Total interest expense | -| net_interest_income | float | Net interest income | -| other_non_interest_income | float | Other non-interest income | -| investment_banking_income | float | Investment banking income | -| trust_fees_by_commissions | float | Trust fees by commissions | -| premiums_earned | float | Premiums earned | -| insurance_policy_acquisition_costs | float | Insurance policy acquisition costs | -| current_and_future_benefits | float | Current and future benefits | -| property_and_liability_insurance_claims | float | Property and liability insurance claims | -| total_non_interest_expense | float | Total non-interest expense | -| net_realized_and_unrealized_capital_gains_on_investments | float | Net realized and unrealized capital gains on investments | -| other_gains | float | Other gains | -| non_operating_income | float | Non-operating income | -| other_income | float | Other income | -| other_revenue | float | Other revenue | -| extraordinary_income | float | Extraordinary income | -| total_other_income | float | Total other income | -| ebitda | float | Earnings Before Interest, Taxes, Depreciation and Amortization. | -| ebitda_margin | float | Margin on Earnings Before Interest, Taxes, Depreciation and Amortization. | -| total_pre_tax_income | float | Total pre-tax income | -| ebit | float | Earnings Before Interest and Taxes. | -| pre_tax_income_margin | float | Pre-Tax Income Margin. | -| income_tax_expense | float | Income tax expense | -| impairment_charge | float | Impairment charge | -| restructuring_charge | float | Restructuring charge | -| service_charges_on_deposit_accounts | float | Service charges on deposit accounts | -| other_service_charges | float | Other service charges | -| other_special_charges | float | Other special charges | -| other_cost_of_revenue | float | Other cost of revenue | -| net_income_continuing_operations | float | Net income (continuing operations) | -| net_income_discontinued_operations | float | Net income (discontinued operations) | -| consolidated_net_income | float | Consolidated net income | -| other_adjustments_to_consolidated_net_income | float | Other adjustments to consolidated net income | -| other_adjustment_to_net_income_attributable_to_common_shareholders | float | Other adjustment to net income attributable to common shareholders | -| net_income_attributable_to_noncontrolling_interest | float | Net income attributable to noncontrolling interest | -| net_income_attributable_to_common_shareholders | float | Net income attributable to common shareholders | -| basic_earnings_per_share | float | Basic earnings per share | -| diluted_earnings_per_share | float | Diluted earnings per share | -| basic_and_diluted_earnings_per_share | float | Basic and diluted earnings per share | -| cash_dividends_to_common_per_share | float | Cash dividends to common per share | -| preferred_stock_dividends_declared | float | Preferred stock dividends declared | -| weighted_average_basic_shares_outstanding | float | Weighted average basic shares outstanding | -| weighted_average_diluted_shares_outstanding | float | Weighted average diluted shares outstanding | -| weighted_average_basic_and_diluted_shares_outstanding | float | Weighted average basic and diluted shares outstanding | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| revenue | float | Total Revenue | -| cost_of_revenue_goods | float | Cost of Revenue - Goods | -| cost_of_revenue_services | float | Cost of Revenue - Services | -| cost_of_revenue | float | Cost of Revenue | -| gross_profit | float | Gross Profit | -| provisions_for_loan_lease_and_other_losses | float | Provisions for loan lease and other losses | -| depreciation_and_amortization | float | Depreciation and Amortization | -| income_tax_expense_benefit_current | float | Income tax expense benefit current | -| deferred_tax_benefit | float | Deferred tax benefit | -| benefits_costs_expenses | float | Benefits, costs and expenses | -| selling_general_and_administrative_expense | float | Selling, general and administrative expense | -| research_and_development | float | Research and development | -| costs_and_expenses | float | Costs and expenses | -| other_operating_expenses | float | Other Operating Expenses | -| operating_expenses | float | Operating expenses | -| operating_income | float | Operating Income/Loss | -| non_operating_income | float | Non Operating Income/Loss | -| interest_and_dividend_income | float | Interest and Dividend Income | -| total_interest_expense | float | Interest Expense | -| interest_and_debt_expense | float | Interest and Debt Expense | -| net_interest_income | float | Interest Income Net | -| interest_income_after_provision_for_losses | float | Interest Income After Provision for Losses | -| non_interest_expense | float | Non-Interest Expense | -| non_interest_income | float | Non-Interest Income | -| income_from_discontinued_operations_net_of_tax_on_disposal | float | Income From Discontinued Operations Net of Tax on Disposal | -| income_from_discontinued_operations_net_of_tax | float | Income From Discontinued Operations Net of Tax | -| income_before_equity_method_investments | float | Income Before Equity Method Investments | -| income_from_equity_method_investments | float | Income From Equity Method Investments | -| total_pre_tax_income | float | Income Before Tax | -| income_tax_expense | float | Income Tax Expense | -| income_after_tax | float | Income After Tax | -| consolidated_net_income | float | Net Income/Loss | -| net_income_attributable_noncontrolling_interest | float | Net income (loss) attributable to noncontrolling interest | -| net_income_attributable_to_parent | float | Net income (loss) attributable to parent | -| net_income_attributable_to_common_shareholders | float | Net Income/Loss Available To Common Stockholders Basic | -| participating_securities_earnings | float | Participating Securities Distributed And Undistributed Earnings Loss Basic | -| undistributed_earnings_allocated_to_participating_securities | float | Undistributed Earnings Allocated To Participating Securities | -| common_stock_dividends | float | Common Stock Dividends | -| preferred_stock_dividends_and_other_adjustments | float | Preferred stock dividends and other adjustments | -| basic_earnings_per_share | float | Earnings Per Share | -| diluted_earnings_per_share | float | Diluted Earnings Per Share | -| weighted_average_basic_shares_outstanding | float | Basic Average Shares | -| weighted_average_diluted_shares_outstanding | float | Diluted Average Shares | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - diff --git a/website/content/platform/data_models/IncomeStatementGrowth.md b/website/content/platform/data_models/IncomeStatementGrowth.md deleted file mode 100644 index d0b18b42f64b..000000000000 --- a/website/content/platform/data_models/IncomeStatementGrowth.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: "Income Statement Growth" -description: "Get the growth of a company's income statement items over time" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `IncomeStatementGrowth` | `IncomeStatementGrowthQueryParams` | `IncomeStatementGrowthData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.income_statement_growth import ( -IncomeStatementGrowthData, -IncomeStatementGrowthQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | True | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | True | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | 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. | -| period | str | Period the statement is returned for. | -| growth_revenue | float | Growth rate of total revenue. | -| growth_cost_of_revenue | float | Growth rate of cost of goods sold. | -| growth_gross_profit | float | Growth rate of gross profit. | -| growth_gross_profit_ratio | float | Growth rate of gross profit as a percentage of revenue. | -| growth_research_and_development_expenses | float | Growth rate of expenses on research and development. | -| growth_general_and_administrative_expenses | float | Growth rate of general and administrative expenses. | -| growth_selling_and_marketing_expenses | float | Growth rate of expenses on selling and marketing activities. | -| growth_other_expenses | float | Growth rate of other operating expenses. | -| growth_operating_expenses | float | Growth rate of total operating expenses. | -| growth_cost_and_expenses | float | Growth rate of total costs and expenses. | -| growth_interest_expense | float | Growth rate of interest expenses. | -| growth_depreciation_and_amortization | float | Growth rate of depreciation and amortization expenses. | -| growth_ebitda | float | Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization. | -| growth_ebitda_ratio | float | Growth rate of EBITDA as a percentage of revenue. | -| growth_operating_income | float | Growth rate of operating income. | -| growth_operating_income_ratio | float | Growth rate of operating income as a percentage of revenue. | -| growth_total_other_income_expenses_net | float | Growth rate of net total other income and expenses. | -| growth_income_before_tax | float | Growth rate of income before taxes. | -| growth_income_before_tax_ratio | float | Growth rate of income before taxes as a percentage of revenue. | -| growth_income_tax_expense | float | Growth rate of income tax expenses. | -| growth_net_income | float | Growth rate of net income. | -| growth_net_income_ratio | float | Growth rate of net income as a percentage of revenue. | -| growth_eps | float | Growth rate of Earnings Per Share (EPS). | -| growth_eps_diluted | float | Growth rate of diluted Earnings Per Share (EPS). | -| growth_weighted_average_shs_out | float | Growth rate of weighted average shares outstanding. | -| growth_weighted_average_shs_out_dil | float | Growth rate of diluted weighted average shares outstanding. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| period | str | Period the statement is returned for. | -| growth_revenue | float | Growth rate of total revenue. | -| growth_cost_of_revenue | float | Growth rate of cost of goods sold. | -| growth_gross_profit | float | Growth rate of gross profit. | -| growth_gross_profit_ratio | float | Growth rate of gross profit as a percentage of revenue. | -| growth_research_and_development_expenses | float | Growth rate of expenses on research and development. | -| growth_general_and_administrative_expenses | float | Growth rate of general and administrative expenses. | -| growth_selling_and_marketing_expenses | float | Growth rate of expenses on selling and marketing activities. | -| growth_other_expenses | float | Growth rate of other operating expenses. | -| growth_operating_expenses | float | Growth rate of total operating expenses. | -| growth_cost_and_expenses | float | Growth rate of total costs and expenses. | -| growth_interest_expense | float | Growth rate of interest expenses. | -| growth_depreciation_and_amortization | float | Growth rate of depreciation and amortization expenses. | -| growth_ebitda | float | Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization. | -| growth_ebitda_ratio | float | Growth rate of EBITDA as a percentage of revenue. | -| growth_operating_income | float | Growth rate of operating income. | -| growth_operating_income_ratio | float | Growth rate of operating income as a percentage of revenue. | -| growth_total_other_income_expenses_net | float | Growth rate of net total other income and expenses. | -| growth_income_before_tax | float | Growth rate of income before taxes. | -| growth_income_before_tax_ratio | float | Growth rate of income before taxes as a percentage of revenue. | -| growth_income_tax_expense | float | Growth rate of income tax expenses. | -| growth_net_income | float | Growth rate of net income. | -| growth_net_income_ratio | float | Growth rate of net income as a percentage of revenue. | -| growth_eps | float | Growth rate of Earnings Per Share (EPS). | -| growth_eps_diluted | float | Growth rate of diluted Earnings Per Share (EPS). | -| growth_weighted_average_shs_out | float | Growth rate of weighted average shares outstanding. | -| growth_weighted_average_shs_out_dil | float | Growth rate of diluted weighted average shares outstanding. | - - - - diff --git a/website/content/platform/data_models/IndexConstituents.md b/website/content/platform/data_models/IndexConstituents.md deleted file mode 100644 index 26a15f913f93..000000000000 --- a/website/content/platform/data_models/IndexConstituents.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: "Index Constituents" -description: "Index Constituents" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `IndexConstituents` | `IndexConstituentsQueryParams` | `IndexConstituentsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.index_constituents import ( -IndexConstituentsData, -IndexConstituentsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'fmp', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'fmp', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'fmp', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'fmp', 'tmx'] | 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 | -| use_cache | bool | Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. | True | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the constituent company in the index. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the constituent company in the index. | -| security_type | str | The type of security represented. | -| last_price | float | Last price for the symbol. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | Change in price. | -| change_percent | float | Change in price as a normalized percentage. | -| tick | str | Whether the last sale was an up or down tick. | -| last_trade_time | datetime | Last trade timestamp for the symbol. | -| asset_type | str | Type of asset. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the constituent company in the index. | -| sector | str | Sector the constituent company in the index belongs to. | -| sub_sector | str | Sub-sector the constituent company in the index belongs to. | -| headquarter | str | Location of the headquarter of the constituent company in the index. | -| date_first_added | Union[str, date] | Date the constituent company was added to the index. | -| cik | int | Central Index Key (CIK) for the requested entity. | -| founded | Union[str, date] | Founding year of the constituent company in the index. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the constituent company in the index. | -| market_value | float | The quoted market value of the asset. | - - - - diff --git a/website/content/platform/data_models/IndexHistorical.md b/website/content/platform/data_models/IndexHistorical.md deleted file mode 100644 index d9ce0a3d4ea3..000000000000 --- a/website/content/platform/data_models/IndexHistorical.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -title: "Index Historical" -description: "Historical Index Levels" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `IndexHistorical` | `IndexHistoricalQueryParams` | `IndexHistoricalData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.index_historical import ( -IndexHistoricalData, -IndexHistoricalQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| use_cache | bool | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| limit | int | The number of data entries to return. | 10000 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| calls_volume | float | Number of calls traded during the most recent trading period. Only valid if interval is 1m. | -| puts_volume | float | Number of puts traded during the most recent trading period. Only valid if interval is 1m. | -| total_options_volume | float | Total number of options traded during the most recent trading period. Only valid if interval is 1m. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - diff --git a/website/content/platform/data_models/IndexSearch.md b/website/content/platform/data_models/IndexSearch.md deleted file mode 100644 index 05ce98d63b54..000000000000 --- a/website/content/platform/data_models/IndexSearch.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "Index Search" -description: "Filters indices for rows containing the query" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `IndexSearch` | `IndexSearchQueryParams` | `IndexSearchData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.index_search import ( -IndexSearchData, -IndexSearchQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| provider | Literal['cboe'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| provider | Literal['cboe'] | 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 | -| use_cache | bool | When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass. | True | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the index. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the index. | -| description | str | Description for the index. | -| data_delay | int | Data delay for the index. Valid only for US indices. | -| currency | str | Currency for the index. | -| time_zone | str | Time zone 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. | -| tick_days | str | The trading days for the index. Valid only for US indices. | -| tick_frequency | str | Tick frequency for the index. Valid only for US indices. | -| tick_period | str | Tick period for the index. Valid only for US indices. | - - - - diff --git a/website/content/platform/data_models/IndexSectors.md b/website/content/platform/data_models/IndexSectors.md deleted file mode 100644 index 4b4fac72adbb..000000000000 --- a/website/content/platform/data_models/IndexSectors.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Index Sectors" -description: "Index Sectors" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `IndexSectors` | `IndexSectorsQueryParams` | `IndexSectorsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.index_sectors import ( -IndexSectorsData, -IndexSectorsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | -| use_cache | bool | Whether to use a cached request. All Index data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 1 day. | True | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sector | str | The sector name. | -| weight | float | The weight of the sector in the index. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sector | str | The sector name. | -| weight | float | The weight of the sector in the index. | - - - - diff --git a/website/content/platform/data_models/IndexSnapshots.md b/website/content/platform/data_models/IndexSnapshots.md deleted file mode 100644 index 1e0363e4638b..000000000000 --- a/website/content/platform/data_models/IndexSnapshots.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: "Index Snapshots" -description: "Index Snapshots" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `IndexSnapshots` | `IndexSnapshotsQueryParams` | `IndexSnapshotsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.index_snapshots import ( -IndexSnapshotsData, -IndexSnapshotsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| region | str | The region of focus for the data - i.e., us, eu. | us | True | -| provider | Literal['cboe', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| region | str | The region of focus for the data - i.e., us, eu. | us | True | -| provider | Literal['cboe', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| region | str | The region of focus for the data - i.e., us, eu. | us | True | -| provider | Literal['cboe', 'tmx'] | 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 | -| use_cache | bool | Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. | True | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the index. | -| currency | str | Currency of the index. | -| price | float | Current price of the index. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | Change in value of the index. | -| change_percent | float | Change, in normalized percentage points, of the index. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the index. | -| currency | str | Currency of the index. | -| price | float | Current price of the index. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | Change in value of the index. | -| change_percent | float | Change, in normalized percentage points, of the index. | -| bid | float | Current bid price. | -| ask | float | Current ask price. | -| last_trade_time | datetime | Last trade timestamp for the symbol. | -| status | str | Status of the market, open or closed. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the index. | -| currency | str | Currency of the index. | -| price | float | Current price of the index. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | Change in value of the index. | -| change_percent | float | Change, in normalized percentage points, of the index. | -| year_high | float | The 52-week high of the index. | -| year_low | float | The 52-week low of the index. | -| return_mtd | float | The month-to-date return of the index, as a normalized percent. | -| return_qtd | float | The quarter-to-date return of the index, as a normalized percent. | -| return_ytd | float | The year-to-date return of the index, as a normalized percent. | -| total_market_value | float | The total quoted market value of the index. | -| number_of_constituents | int | The number of constituents in the index. | -| constituent_average_market_value | float | The average quoted market value of the index constituents. | -| constituent_median_market_value | float | The median quoted market value of the index constituents. | -| constituent_top10_market_value | float | The sum of the top 10 quoted market values of the index constituents. | -| constituent_largest_market_value | float | The largest quoted market value of the index constituents. | -| constituent_largest_weight | float | The largest weight of the index constituents, as a normalized percent. | -| constituent_smallest_market_value | float | The smallest quoted market value of the index constituents. | -| constituent_smallest_weight | float | The smallest weight of the index constituents, as a normalized percent. | - - - - diff --git a/website/content/platform/data_models/InsiderTrading.md b/website/content/platform/data_models/InsiderTrading.md deleted file mode 100644 index 3d5b3394cbdf..000000000000 --- a/website/content/platform/data_models/InsiderTrading.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -title: "Insider Trading" -description: "Get data about trading by a company's management team and board of directors" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `InsiderTrading` | `InsiderTradingQueryParams` | `InsiderTradingData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.insider_trading import ( -InsiderTradingData, -InsiderTradingQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 500 | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 500 | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| transaction_type | Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust'] | Type of the transaction. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 500 | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | | False | -| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | | False | -| ownership_type | Literal['D', 'I'] | Type of ownership. | None | True | -| sort_by | Literal['filing_date', 'updated_on'] | Field to sort by. | updated_on | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 500 | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| summary | bool | Return a summary of the insider activity instead of the individuals. | False | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| company_cik | Union[int, str] | CIK number of the company. | -| filing_date | Union[date, datetime] | Filing date of the trade. | -| transaction_date | date | Date of the transaction. | -| owner_cik | Union[int, str] | Reporting individual's CIK. | -| owner_name | str | Name of the reporting individual. | -| owner_title | str | The title held by the reporting individual. | -| transaction_type | str | Type of transaction being reported. | -| acquisition_or_disposition | str | Acquisition or disposition of the shares. | -| security_type | str | The type of security transacted. | -| securities_owned | float | Number of securities owned by the reporting individual. | -| securities_transacted | float | Number of securities transacted by the reporting individual. | -| transaction_price | float | The price of the transaction. | -| filing_url | str | Link to the filing. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| company_cik | Union[int, str] | CIK number of the company. | -| filing_date | Union[date, datetime] | Filing date of the trade. | -| transaction_date | date | Date of the transaction. | -| owner_cik | Union[int, str] | Reporting individual's CIK. | -| owner_name | str | Name of the reporting individual. | -| owner_title | str | The title held by the reporting individual. | -| transaction_type | str | Type of transaction being reported. | -| acquisition_or_disposition | str | Acquisition or disposition of the shares. | -| security_type | str | The type of security transacted. | -| securities_owned | float | Number of securities owned by the reporting individual. | -| securities_transacted | float | Number of securities transacted by the reporting individual. | -| transaction_price | float | The price of the transaction. | -| filing_url | str | Link to the filing. | -| form_type | str | Form type of the insider trading. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| company_cik | Union[int, str] | CIK number of the company. | -| filing_date | Union[date, datetime] | Filing date of the trade. | -| transaction_date | date | Date of the transaction. | -| owner_cik | Union[int, str] | Reporting individual's CIK. | -| owner_name | str | Name of the reporting individual. | -| owner_title | str | The title held by the reporting individual. | -| transaction_type | str | Type of transaction being reported. | -| acquisition_or_disposition | str | Acquisition or disposition of the shares. | -| security_type | str | The type of security transacted. | -| securities_owned | float | Number of securities owned by the reporting individual. | -| securities_transacted | float | Number of securities transacted by the reporting individual. | -| transaction_price | float | The price of the transaction. | -| filing_url | str | Link to the filing. | -| company_name | str | Name of the company. | -| conversion_exercise_price | float | Conversion/Exercise price of the shares. | -| deemed_execution_date | date | Deemed execution date of the trade. | -| exercise_date | date | Exercise date of the trade. | -| expiration_date | date | Expiration date of the derivative. | -| underlying_security_title | str | Name of the underlying non-derivative security related to this derivative transaction. | -| underlying_shares | Union[int, float] | Number of underlying shares related to this derivative transaction. | -| nature_of_ownership | str | Nature of ownership of the insider trading. | -| director | bool | Whether the owner is a director. | -| officer | bool | Whether the owner is an officer. | -| ten_percent_owner | bool | Whether the owner is a 10% owner. | -| other_relation | bool | Whether the owner is having another relation. | -| derivative_transaction | bool | Whether the owner is having a derivative transaction. | -| report_line_number | int | Report line number of the insider trading. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| company_cik | Union[int, str] | CIK number of the company. | -| filing_date | Union[date, datetime] | Filing date of the trade. | -| transaction_date | date | Date of the transaction. | -| owner_cik | Union[int, str] | Reporting individual's CIK. | -| owner_name | str | Name of the reporting individual. | -| owner_title | str | The title held by the reporting individual. | -| transaction_type | str | Type of transaction being reported. | -| acquisition_or_disposition | str | Acquisition or disposition of the shares. | -| security_type | str | The type of security transacted. | -| securities_owned | float | Number of securities owned by the reporting individual. | -| securities_transacted | float | Number of securities transacted by the reporting individual. | -| transaction_price | float | The price of the transaction. | -| filing_url | str | Link to the filing. | -| period | str | The period of the activity. Bucketed by three, six, and twelve months. | -| acquisition_or_deposition | str | Whether the insider bought or sold the shares. | -| number_of_trades | int | The number of shares traded over the period. | -| trade_value | float | The value of the shares traded by the insider. | -| securities_bought | int | The total number of shares bought by all insiders over the period. | -| securities_sold | int | The total number of shares sold by all insiders over the period. | -| net_activity | int | The total net activity by all insiders over the period. | - - - - diff --git a/website/content/platform/data_models/InstitutionalOwnership.md b/website/content/platform/data_models/InstitutionalOwnership.md deleted file mode 100644 index 808cab67f853..000000000000 --- a/website/content/platform/data_models/InstitutionalOwnership.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: "Institutional Ownership" -description: "Get data about institutional ownership for a given company over time" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `InstitutionalOwnership` | `InstitutionalOwnershipQueryParams` | `InstitutionalOwnershipData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.institutional_ownership import ( -InstitutionalOwnershipData, -InstitutionalOwnershipQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | -| include_current_quarter | bool | Include current quarter data. | False | True | -| date | Union[date, str] | A specific date to get data for. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| date | date | The date of the data. | -| investors_holding | int | Number of investors holding the stock. | -| last_investors_holding | int | Number of investors holding the stock in the last quarter. | -| investors_holding_change | int | Change in the number of investors holding the stock. | -| number_of_13f_shares | int | Number of 13F shares. | -| last_number_of_13f_shares | int | Number of 13F shares in the last quarter. | -| number_of_13f_shares_change | int | Change in the number of 13F shares. | -| total_invested | float | Total amount invested. | -| last_total_invested | float | Total amount invested in the last quarter. | -| total_invested_change | float | Change in the total amount invested. | -| ownership_percent | float | Ownership percent. | -| last_ownership_percent | float | Ownership percent in the last quarter. | -| ownership_percent_change | float | Change in the ownership percent. | -| new_positions | int | Number of new positions. | -| last_new_positions | int | Number of new positions in the last quarter. | -| new_positions_change | int | Change in the number of new positions. | -| increased_positions | int | Number of increased positions. | -| last_increased_positions | int | Number of increased positions in the last quarter. | -| increased_positions_change | int | Change in the number of increased positions. | -| closed_positions | int | Number of closed positions. | -| last_closed_positions | int | Number of closed positions in the last quarter. | -| closed_positions_change | int | Change in the number of closed positions. | -| reduced_positions | int | Number of reduced positions. | -| last_reduced_positions | int | Number of reduced positions in the last quarter. | -| reduced_positions_change | int | Change in the number of reduced positions. | -| total_calls | int | Total number of call options contracts traded for Apple Inc. on the specified date. | -| last_total_calls | int | Total number of call options contracts traded for Apple Inc. on the previous reporting date. | -| total_calls_change | int | Change in the total number of call options contracts traded between the current and previous reporting dates. | -| total_puts | int | Total number of put options contracts traded for Apple Inc. on the specified date. | -| last_total_puts | int | Total number of put options contracts traded for Apple Inc. on the previous reporting date. | -| total_puts_change | int | Change in the total number of put options contracts traded between the current and previous reporting dates. | -| put_call_ratio | float | Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date. | -| last_put_call_ratio | float | Put-call ratio on the previous reporting date. | -| put_call_ratio_change | float | Change in the put-call ratio between the current and previous reporting dates. | - - - - diff --git a/website/content/platform/data_models/InstitutionsSearch.md b/website/content/platform/data_models/InstitutionsSearch.md deleted file mode 100644 index d338590bd155..000000000000 --- a/website/content/platform/data_models/InstitutionsSearch.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Institutions Search" -description: "Search SEC-regulated institutions by name and return a list of results with CIK numbers" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `InstitutionsSearch` | `InstitutionsSearchQueryParams` | `InstitutionsSearchData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -InstitutionsSearchData, -InstitutionsSearchQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | The name of the institution. | -| cik | Union[int, str] | Central Index Key (CIK) | - - - - diff --git a/website/content/platform/data_models/KeyExecutives.md b/website/content/platform/data_models/KeyExecutives.md deleted file mode 100644 index f226656a1454..000000000000 --- a/website/content/platform/data_models/KeyExecutives.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: "Key Executives" -description: "Get executive management team data for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `KeyExecutives` | `KeyExecutivesQueryParams` | `KeyExecutivesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.key_executives import ( -KeyExecutivesData, -KeyExecutivesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['fmp', '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 | str | Symbol to get data for. | | False | -| provider | Literal['fmp', '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 | str | Symbol to get data for. | | False | -| provider | Literal['fmp', '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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| title | str | Designation of the key executive. | -| name | str | Name of the key executive. | -| pay | int | Pay of the key executive. | -| currency_pay | str | Currency of the pay. | -| gender | str | Gender of the key executive. | -| year_born | int | Birth year of the key executive. | -| title_since | int | Date the tile was held since. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| title | str | Designation of the key executive. | -| name | str | Name of the key executive. | -| pay | int | Pay of the key executive. | -| currency_pay | str | Currency of the pay. | -| gender | str | Gender of the key executive. | -| year_born | int | Birth year of the key executive. | -| title_since | int | Date the tile was held since. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| title | str | Designation of the key executive. | -| name | str | Name of the key executive. | -| pay | int | Pay of the key executive. | -| currency_pay | str | Currency of the pay. | -| gender | str | Gender of the key executive. | -| year_born | int | Birth year of the key executive. | -| title_since | int | Date the tile was held since. | -| exercised_value | int | Value of shares exercised. | -| unexercised_value | int | Value of shares not exercised. | - - - - diff --git a/website/content/platform/data_models/KeyMetrics.md b/website/content/platform/data_models/KeyMetrics.md deleted file mode 100644 index 61bb5498b7e6..000000000000 --- a/website/content/platform/data_models/KeyMetrics.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -title: "Key Metrics" -description: "Get fundamental metrics for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `KeyMetrics` | `KeyMetricsQueryParams` | `KeyMetricsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.key_metrics import ( -KeyMetricsData, -KeyMetricsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['finviz', 'fmp', 'intrinio', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['finviz', 'fmp', 'intrinio', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['finviz', 'fmp', 'intrinio', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | -| with_ttm | bool | Include trailing twelve months (TTM) data. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['finviz', 'fmp', 'intrinio', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['finviz', 'fmp', 'intrinio', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| market_cap | float | Market capitalization | -| pe_ratio | float | Price-to-earnings ratio (P/E ratio) | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| market_cap | float | Market capitalization | -| pe_ratio | float | Price-to-earnings ratio (P/E ratio) | -| foward_pe | float | Forward price-to-earnings ratio (forward P/E) | -| eps | float | Earnings per share (EPS) | -| price_to_sales | float | Price-to-sales ratio (P/S) | -| price_to_book | float | Price-to-book ratio (P/B) | -| book_value_per_share | float | Book value per share (Book/sh) | -| price_to_cash | float | Price-to-cash ratio (P/C) | -| cash_per_share | float | Cash per share (Cash/sh) | -| price_to_free_cash_flow | float | Price-to-free cash flow ratio (P/FCF) | -| debt_to_equity | float | Debt-to-equity ratio (Debt/Eq) | -| long_term_debt_to_equity | float | Long-term debt-to-equity ratio (LT Debt/Eq) | -| quick_ratio | float | Quick ratio | -| current_ratio | float | Current ratio | -| gross_margin | float | Gross margin, as a normalized percent. | -| profit_margin | float | Profit margin, as a normalized percent. | -| operating_margin | float | Operating margin, as a normalized percent. | -| return_on_assets | float | Return on assets (ROA), as a normalized percent. | -| return_on_investment | float | Return on investment (ROI), as a normalized percent. | -| return_on_equity | float | Return on equity (ROE), as a normalized percent. | -| payout_ratio | float | Payout ratio, as a normalized percent. | -| dividend_yield | float | Dividend yield, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| market_cap | float | Market capitalization | -| pe_ratio | float | Price-to-earnings ratio (P/E ratio) | -| date | date | The date of the data. | -| period | str | Period of the data. | -| calendar_year | int | Calendar year. | -| revenue_per_share | float | Revenue per share | -| net_income_per_share | float | Net income per share | -| operating_cash_flow_per_share | float | Operating cash flow per share | -| free_cash_flow_per_share | float | Free cash flow per share | -| cash_per_share | float | Cash per share | -| book_value_per_share | float | Book value per share | -| tangible_book_value_per_share | float | Tangible book value per share | -| shareholders_equity_per_share | float | Shareholders equity per share | -| interest_debt_per_share | float | Interest debt per share | -| enterprise_value | float | Enterprise value | -| price_to_sales_ratio | float | Price-to-sales ratio | -| pocf_ratio | float | Price-to-operating cash flow ratio | -| pfcf_ratio | float | Price-to-free cash flow ratio | -| pb_ratio | float | Price-to-book ratio | -| ptb_ratio | float | Price-to-tangible book ratio | -| ev_to_sales | float | Enterprise value-to-sales ratio | -| enterprise_value_over_ebitda | float | Enterprise value-to-EBITDA ratio | -| ev_to_operating_cash_flow | float | Enterprise value-to-operating cash flow ratio | -| ev_to_free_cash_flow | float | Enterprise value-to-free cash flow ratio | -| earnings_yield | float | Earnings yield | -| free_cash_flow_yield | float | Free cash flow yield | -| debt_to_equity | float | Debt-to-equity ratio | -| debt_to_assets | float | Debt-to-assets ratio | -| net_debt_to_ebitda | float | Net debt-to-EBITDA ratio | -| current_ratio | float | Current ratio | -| interest_coverage | float | Interest coverage | -| income_quality | float | Income quality | -| dividend_yield | float | Dividend yield, as a normalized percent. | -| payout_ratio | float | Payout ratio | -| sales_general_and_administrative_to_revenue | float | Sales general and administrative expenses-to-revenue ratio | -| research_and_development_to_revenue | float | Research and development expenses-to-revenue ratio | -| intangibles_to_total_assets | float | Intangibles-to-total assets ratio | -| capex_to_operating_cash_flow | float | Capital expenditures-to-operating cash flow ratio | -| capex_to_revenue | float | Capital expenditures-to-revenue ratio | -| capex_to_depreciation | float | Capital expenditures-to-depreciation ratio | -| stock_based_compensation_to_revenue | float | Stock-based compensation-to-revenue ratio | -| graham_number | float | Graham number | -| roic | float | Return on invested capital | -| return_on_tangible_assets | float | Return on tangible assets | -| graham_net_net | float | Graham net-net working capital | -| working_capital | float | Working capital | -| tangible_asset_value | float | Tangible asset value | -| net_current_asset_value | float | Net current asset value | -| invested_capital | float | Invested capital | -| average_receivables | float | Average receivables | -| average_payables | float | Average payables | -| average_inventory | float | Average inventory | -| days_sales_outstanding | float | Days sales outstanding | -| days_payables_outstanding | float | Days payables outstanding | -| days_of_inventory_on_hand | float | Days of inventory on hand | -| receivables_turnover | float | Receivables turnover | -| payables_turnover | float | Payables turnover | -| inventory_turnover | float | Inventory turnover | -| roe | float | Return on equity | -| capex_per_share | float | Capital expenditures per share | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| market_cap | float | Market capitalization | -| pe_ratio | float | Price-to-earnings ratio (P/E ratio) | -| price_to_book | float | Price to book ratio. | -| price_to_tangible_book | float | Price to tangible book ratio. | -| price_to_revenue | float | Price to revenue ratio. | -| quick_ratio | float | Quick ratio. | -| gross_margin | float | Gross margin, as a normalized percent. | -| ebit_margin | float | EBIT margin, as a normalized percent. | -| profit_margin | float | Profit margin, as a normalized percent. | -| eps | float | Basic earnings per share. | -| eps_growth | float | EPS growth, as a normalized percent. | -| revenue_growth | float | Revenue growth, as a normalized percent. | -| ebitda_growth | float | EBITDA growth, as a normalized percent. | -| ebit_growth | float | EBIT growth, as a normalized percent. | -| net_income_growth | float | Net income growth, as a normalized percent. | -| free_cash_flow_to_firm_growth | float | Free cash flow to firm growth, as a normalized percent. | -| invested_capital_growth | float | Invested capital growth, as a normalized percent. | -| return_on_assets | float | Return on assets, as a normalized percent. | -| return_on_equity | float | Return on equity, as a normalized percent. | -| return_on_invested_capital | float | Return on invested capital, as a normalized percent. | -| ebitda | int | Earnings before interest, taxes, depreciation, and amortization. | -| ebit | int | Earnings before interest and taxes. | -| long_term_debt | int | Long-term debt. | -| total_debt | int | Total debt. | -| total_capital | int | The sum of long-term debt and total shareholder equity. | -| enterprise_value | int | Enterprise value. | -| free_cash_flow_to_firm | int | Free cash flow to firm. | -| altman_z_score | float | Altman Z-score. | -| beta | float | Beta relative to the broad market (rolling three-year). | -| dividend_yield | float | Dividend yield, as a normalized percent. | -| earnings_yield | float | Earnings yield, as a normalized percent. | -| last_price | float | Last price of the stock. | -| year_high | float | 52 week high | -| year_low | float | 52 week low | -| volume_avg | int | Average daily volume. | -| short_interest | int | Number of shares reported as sold short. | -| shares_outstanding | int | Weighted average shares outstanding (TTM). | -| days_to_cover | float | Days to cover short interest, based on average daily volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| market_cap | float | Market capitalization | -| pe_ratio | float | Price-to-earnings ratio (P/E ratio) | -| forward_pe | float | Forward price-to-earnings ratio. | -| peg_ratio | float | PEG ratio (5-year expected). | -| peg_ratio_ttm | float | PEG ratio (TTM). | -| eps_ttm | float | Earnings per share (TTM). | -| eps_forward | float | Forward earnings per share. | -| enterprise_to_ebitda | float | Enterprise value to EBITDA ratio. | -| earnings_growth | float | Earnings growth (Year Over Year), as a normalized percent. | -| earnings_growth_quarterly | float | Quarterly earnings growth (Year Over Year), as a normalized percent. | -| revenue_per_share | float | Revenue per share (TTM). | -| revenue_growth | float | Revenue growth (Year Over Year), as a normalized percent. | -| enterprise_to_revenue | float | Enterprise value to revenue ratio. | -| cash_per_share | float | Cash per share. | -| quick_ratio | float | Quick ratio. | -| current_ratio | float | Current ratio. | -| debt_to_equity | float | Debt-to-equity ratio. | -| gross_margin | float | Gross margin, as a normalized percent. | -| operating_margin | float | Operating margin, as a normalized percent. | -| ebitda_margin | float | EBITDA margin, as a normalized percent. | -| profit_margin | float | Profit margin, as a normalized percent. | -| return_on_assets | float | Return on assets, as a normalized percent. | -| return_on_equity | float | Return on equity, as a normalized percent. | -| dividend_yield | float | Dividend yield, as a normalized percent. | -| dividend_yield_5y_avg | float | 5-year average dividend yield, as a normalized percent. | -| payout_ratio | float | Payout ratio. | -| book_value | float | Book value per share. | -| price_to_book | float | Price-to-book ratio. | -| enterprise_value | int | Enterprise value. | -| overall_risk | float | Overall risk score. | -| audit_risk | float | Audit risk score. | -| board_risk | float | Board risk score. | -| compensation_risk | float | Compensation risk score. | -| shareholder_rights_risk | float | Shareholder rights risk score. | -| beta | float | Beta relative to the broad market (5-year monthly). | -| price_return_1y | float | One-year price return, as a normalized percent. | -| currency | str | Currency in which the data is presented. | - - - - diff --git a/website/content/platform/data_models/LTIR.md b/website/content/platform/data_models/LTIR.md deleted file mode 100644 index 0fb7f3e21012..000000000000 --- a/website/content/platform/data_models/LTIR.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "LTIR" -description: "Long-term interest rates refer to government bonds maturing in ten years" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `LTIR` | `LTIRQueryParams` | `LTIRData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.long_term_interest_rate import ( -LTIRData, -LTIRQueryParams, -) -``` - ---- - -## 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all'] | Country to get GDP for. | united_states | True | -| frequency | Literal['monthly', 'quarterly', 'annual'] | Frequency to get interest rate for for. | monthly | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Interest rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which interest rate is given | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Interest rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which interest rate is given | - - - - diff --git a/website/content/platform/data_models/LatestAttributes.md b/website/content/platform/data_models/LatestAttributes.md deleted file mode 100644 index e9f6f305075b..000000000000 --- a/website/content/platform/data_models/LatestAttributes.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "Latest Attributes" -description: "Get the latest value of a data tag from Intrinio" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `LatestAttributes` | `LatestAttributesQueryParams` | `LatestAttributesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.latest_attributes import ( -LatestAttributesData, -LatestAttributesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): intrinio. | | False | -| tag | Union[str, List[str]] | Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio. | | False | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): intrinio. | | False | -| tag | Union[str, List[str]] | Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio. | | False | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| tag | str | Tag name for the fetched data. | -| value | Union[str, float] | The value of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| tag | str | Tag name for the fetched data. | -| value | Union[str, float] | The value of the data. | - - - - diff --git a/website/content/platform/data_models/LbmaFixing.md b/website/content/platform/data_models/LbmaFixing.md deleted file mode 100644 index cad095ff0cf4..000000000000 --- a/website/content/platform/data_models/LbmaFixing.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: "Lbma Fixing" -description: "Daily LBMA Fixing Prices in USD/EUR/GBP" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `LbmaFixing` | `LbmaFixingQueryParams` | `LbmaFixingData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.lbma_fixing import ( -LbmaFixingData, -LbmaFixingQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| asset | Literal['gold', 'silver'] | The metal to get price fixing rates for. | gold | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| asset | Literal['gold', 'silver'] | The metal to get price fixing rates for. | gold | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| usd_am | float | AM fixing price in USD. | -| usd_pm | float | PM fixing price in USD. | -| gbp_am | float | AM fixing price in GBP. | -| gbp_pm | float | PM fixing price in GBP. | -| euro_am | float | AM fixing price in EUR. | -| euro_pm | float | PM fixing price in EUR. | -| usd | float | Daily fixing price in USD. | -| gbp | float | Daily fixing price in GBP. | -| eur | float | Daily fixing price in EUR. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| usd_am | float | AM fixing price in USD. | -| usd_pm | float | PM fixing price in USD. | -| gbp_am | float | AM fixing price in GBP. | -| gbp_pm | float | PM fixing price in GBP. | -| euro_am | float | AM fixing price in EUR. | -| euro_pm | float | PM fixing price in EUR. | -| usd | float | Daily fixing price in USD. | -| gbp | float | Daily fixing price in GBP. | -| eur | float | Daily fixing price in EUR. | - - - - diff --git a/website/content/platform/data_models/MarketIndices.md b/website/content/platform/data_models/MarketIndices.md deleted file mode 100644 index dfa9410d3029..000000000000 --- a/website/content/platform/data_models/MarketIndices.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -title: "Market Indices" -description: "Historical Market Indices" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `MarketIndices` | `MarketIndicesQueryParams` | `MarketIndicesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.market_indices import ( -MarketIndicesData, -MarketIndicesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| use_cache | bool | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| limit | int | The number of data entries to return. | 10000 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| calls_volume | float | Number of calls traded during the most recent trading period. Only valid if interval is 1m. | -| puts_volume | float | Number of puts traded during the most recent trading period. Only valid if interval is 1m. | -| total_options_volume | float | Total number of options traded during the most recent trading period. Only valid if interval is 1m. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - diff --git a/website/content/platform/data_models/MarketSnapshots.md b/website/content/platform/data_models/MarketSnapshots.md deleted file mode 100644 index 73ccede667a4..000000000000 --- a/website/content/platform/data_models/MarketSnapshots.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: "Market Snapshots" -description: "Get an updated equity market snapshot" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `MarketSnapshots` | `MarketSnapshotsQueryParams` | `MarketSnapshotsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.market_snapshots import ( -MarketSnapshotsData, -MarketSnapshotsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'polygon'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'polygon'] | 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 | -| market | Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra'] | The market to fetch data for. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'polygon'] | 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. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | The change in price from the previous close. | -| change_percent | float | The change in price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | The change in price from the previous close. | -| change_percent | float | The change in price from the previous close, as a normalized percent. | -| last_price | float | The last price of the stock. | -| last_price_timestamp | Union[date, datetime] | The timestamp of the last price. | -| ma50 | float | The 50-day moving average. | -| ma200 | float | The 200-day moving average. | -| year_high | float | The 52-week high. | -| year_low | float | The 52-week low. | -| volume_avg | int | Average daily trading volume. | -| market_cap | int | Market cap of the stock. | -| eps | float | Earnings per share. | -| pe | float | Price to earnings ratio. | -| shares_outstanding | int | Number of shares outstanding. | -| name | str | The company name associated with the symbol. | -| exchange | str | The exchange of the stock. | -| earnings_date | Union[date, datetime] | The upcoming earnings announcement date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | The change in price from the previous close. | -| change_percent | float | The change in price from the previous close, as a normalized percent. | -| vwap | float | The volume weighted average price of the stock on the current trading day. | -| prev_open | float | The previous trading session opening price. | -| prev_high | float | The previous trading session high price. | -| prev_low | float | The previous trading session low price. | -| prev_volume | float | The previous trading session volume. | -| prev_vwap | float | The previous trading session VWAP. | -| last_updated | datetime | The last time the data was updated. | -| bid | float | The current bid price. | -| bid_size | int | The current bid size. | -| ask_size | int | The current ask size. | -| ask | float | The current ask price. | -| quote_timestamp | datetime | The timestamp of the last quote. | -| last_trade_price | float | The last trade price. | -| last_trade_size | int | The last trade size. | -| last_trade_conditions | List[int] | The last trade condition codes. | -| last_trade_exchange | int | The last trade exchange ID code. | -| last_trade_timestamp | datetime | The last trade timestamp. | - - - - diff --git a/website/content/platform/data_models/MoneyMeasures.md b/website/content/platform/data_models/MoneyMeasures.md deleted file mode 100644 index 8369291a1e91..000000000000 --- a/website/content/platform/data_models/MoneyMeasures.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: "Money Measures" -description: "Money Measures (M1/M2 and components)" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `MoneyMeasures` | `MoneyMeasuresQueryParams` | `MoneyMeasuresData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.money_measures import ( -MoneyMeasuresData, -MoneyMeasuresQueryParams, -) -``` - ---- - -## 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 | -| adjusted | bool | Whether to return seasonally adjusted data. | True | True | -| provider | Literal['federal_reserve'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | 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 | -| adjusted | bool | Whether to return seasonally adjusted data. | True | True | -| provider | Literal['federal_reserve'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| month | date | The date of the data. | -| M1 | float | Value of the M1 money supply in billions. | -| M2 | float | Value of the M2 money supply in billions. | -| currency | float | Value of currency in circulation in billions. | -| demand_deposits | float | Value of demand deposits in billions. | -| retail_money_market_funds | float | Value of retail money market funds in billions. | -| other_liquid_deposits | float | Value of other liquid deposits in billions. | -| small_denomination_time_deposits | float | Value of small denomination time deposits in billions. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| month | date | The date of the data. | -| M1 | float | Value of the M1 money supply in billions. | -| M2 | float | Value of the M2 money supply in billions. | -| currency | float | Value of currency in circulation in billions. | -| demand_deposits | float | Value of demand deposits in billions. | -| retail_money_market_funds | float | Value of retail money market funds in billions. | -| other_liquid_deposits | float | Value of other liquid deposits in billions. | -| small_denomination_time_deposits | float | Value of small denomination time deposits in billions. | - - - - diff --git a/website/content/platform/data_models/MoodyCorporateBondIndex.md b/website/content/platform/data_models/MoodyCorporateBondIndex.md deleted file mode 100644 index a812589fe508..000000000000 --- a/website/content/platform/data_models/MoodyCorporateBondIndex.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "Moody Corporate Bond Index" -description: "Moody Corporate Bond Index" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `MoodyCorporateBondIndex` | `MoodyCorporateBondIndexQueryParams` | `MoodyCorporateBondIndexData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.moody import ( -MoodyCorporateBondIndexData, -MoodyCorporateBondIndexQueryParams, -) -``` - ---- - -## 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 | -| index_type | Literal['aaa', 'baa'] | The type of series. | aaa | 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 | -| index_type | Literal['aaa', 'baa'] | The type of series. | aaa | 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 | -| spread | Literal['treasury', 'fed_funds'] | The type of spread. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Moody Corporate Bond Index Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Moody Corporate Bond Index Rate. | - - - - diff --git a/website/content/platform/data_models/OTCAggregate.md b/website/content/platform/data_models/OTCAggregate.md deleted file mode 100644 index e8f0cff369d4..000000000000 --- a/website/content/platform/data_models/OTCAggregate.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "OTC Aggregate" -description: "Get the weekly aggregate trade data for Over The Counter deals" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `OTCAggregate` | `OTCAggregateQueryParams` | `OTCAggregateData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.otc_aggregate import ( -OTCAggregateData, -OTCAggregateQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| provider | Literal['finra'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default. | finra | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| provider | Literal['finra'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default. | finra | True | -| tier | Literal['T1', 'T2', 'OTCE'] | 'T1 - Securities included in the S&P 500, Russell 1000 and selected exchange-traded products; T2 - All other NMS stocks; OTC - Over-the-Counter equity securities | T1 | True | -| is_ats | bool | ATS data if true, NON-ATS otherwise | True | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| update_date | date | Most recent date on which total trades is updated based on data received from each ATS/OTC. | -| share_quantity | float | Aggregate weekly total number of shares reported by each ATS for the Symbol. | -| trade_quantity | float | Aggregate weekly total number of trades reported by each ATS for the Symbol | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| update_date | date | Most recent date on which total trades is updated based on data received from each ATS/OTC. | -| share_quantity | float | Aggregate weekly total number of shares reported by each ATS for the Symbol. | -| trade_quantity | float | Aggregate weekly total number of trades reported by each ATS for the Symbol | - - - - diff --git a/website/content/platform/data_models/OptionsChains.md b/website/content/platform/data_models/OptionsChains.md deleted file mode 100644 index dd0cf5d45c05..000000000000 --- a/website/content/platform/data_models/OptionsChains.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -title: "Options Chains" -description: "Get the complete options chain for a ticker" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `OptionsChains` | `OptionsChainsQueryParams` | `OptionsChainsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.options_chains import ( -OptionsChainsData, -OptionsChainsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'intrinio', 'tmx', 'tradier'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'intrinio', 'tmx', 'tradier'] | 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 | -| use_cache | bool | When True, the company directories will be cached for24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'intrinio', 'tmx', 'tradier'] | 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 | -| date | Union[date, str] | The end-of-day date for options chains data. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'intrinio', 'tmx', 'tradier'] | 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 | -| date | Union[date, str] | A specific date to get data for. | None | True | -| use_cache | bool | Caching is used to validate the supplied ticker symbol, or if a historical EOD chain is requested. To bypass, set to False. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'intrinio', 'tmx', 'tradier'] | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option. | -| contract_symbol | str | Contract symbol for the option. | -| eod_date | date | Date for which the options chains are returned. | -| expiration | date | Expiration date of the contract. | -| strike | float | Strike price of the contract. | -| option_type | str | Call or Put. | -| open_interest | int | Open interest on the contract. | -| volume | int | The trading volume. | -| theoretical_price | float | Theoretical value of the option. | -| last_trade_price | float | Last trade price of the option. | -| tick | str | Whether the last tick was up or down in price. | -| bid | float | Current bid price for the option. | -| bid_size | int | Bid size for the option. | -| ask | float | Current ask price for the option. | -| ask_size | int | Ask size for the option. | -| mark | float | The mid-price between the latest bid and ask. | -| open | float | The open price. | -| open_bid | float | The opening bid price for the option that day. | -| open_ask | float | The opening ask price for the option that day. | -| high | float | The high price. | -| bid_high | float | The highest bid price for the option that day. | -| ask_high | float | The highest ask price for the option that day. | -| low | float | The low price. | -| bid_low | float | The lowest bid price for the option that day. | -| ask_low | float | The lowest ask price for the option that day. | -| close | float | The close price. | -| close_size | int | The closing trade size for the option that day. | -| close_time | datetime | The time of the closing price for the option that day. | -| close_bid | float | The closing bid price for the option that day. | -| close_bid_size | int | The closing bid size for the option that day. | -| close_bid_time | datetime | The time of the bid closing price for the option that day. | -| close_ask | float | The closing ask price for the option that day. | -| close_ask_size | int | The closing ask size for the option that day. | -| close_ask_time | datetime | The time of the ask closing price for the option that day. | -| prev_close | float | The previous close price. | -| change | float | The change in the price of the option. | -| change_percent | float | Change, in normalizezd percentage points, of the option. | -| implied_volatility | float | Implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option. | -| contract_symbol | str | Contract symbol for the option. | -| eod_date | date | Date for which the options chains are returned. | -| expiration | date | Expiration date of the contract. | -| strike | float | Strike price of the contract. | -| option_type | str | Call or Put. | -| open_interest | int | Open interest on the contract. | -| volume | int | The trading volume. | -| theoretical_price | float | Theoretical value of the option. | -| last_trade_price | float | Last trade price of the option. | -| tick | str | Whether the last tick was up or down in price. | -| bid | float | Current bid price for the option. | -| bid_size | int | Bid size for the option. | -| ask | float | Current ask price for the option. | -| ask_size | int | Ask size for the option. | -| mark | float | The mid-price between the latest bid and ask. | -| open | float | The open price. | -| open_bid | float | The opening bid price for the option that day. | -| open_ask | float | The opening ask price for the option that day. | -| high | float | The high price. | -| bid_high | float | The highest bid price for the option that day. | -| ask_high | float | The highest ask price for the option that day. | -| low | float | The low price. | -| bid_low | float | The lowest bid price for the option that day. | -| ask_low | float | The lowest ask price for the option that day. | -| close | float | The close price. | -| close_size | int | The closing trade size for the option that day. | -| close_time | datetime | The time of the closing price for the option that day. | -| close_bid | float | The closing bid price for the option that day. | -| close_bid_size | int | The closing bid size for the option that day. | -| close_bid_time | datetime | The time of the bid closing price for the option that day. | -| close_ask | float | The closing ask price for the option that day. | -| close_ask_size | int | The closing ask size for the option that day. | -| close_ask_time | datetime | The time of the ask closing price for the option that day. | -| prev_close | float | The previous close price. | -| change | float | The change in the price of the option. | -| change_percent | float | Change, in normalizezd percentage points, of the option. | -| implied_volatility | float | Implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | -| last_trade_timestamp | datetime | Last trade timestamp of the option. | -| dte | int | Days to expiration for the option. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option. | -| contract_symbol | str | Contract symbol for the option. | -| eod_date | date | Date for which the options chains are returned. | -| expiration | date | Expiration date of the contract. | -| strike | float | Strike price of the contract. | -| option_type | str | Call or Put. | -| open_interest | int | Open interest on the contract. | -| volume | int | The trading volume. | -| theoretical_price | float | Theoretical value of the option. | -| last_trade_price | float | Last trade price of the option. | -| tick | str | Whether the last tick was up or down in price. | -| bid | float | Current bid price for the option. | -| bid_size | int | Bid size for the option. | -| ask | float | Current ask price for the option. | -| ask_size | int | Ask size for the option. | -| mark | float | The mid-price between the latest bid and ask. | -| open | float | The open price. | -| open_bid | float | The opening bid price for the option that day. | -| open_ask | float | The opening ask price for the option that day. | -| high | float | The high price. | -| bid_high | float | The highest bid price for the option that day. | -| ask_high | float | The highest ask price for the option that day. | -| low | float | The low price. | -| bid_low | float | The lowest bid price for the option that day. | -| ask_low | float | The lowest ask price for the option that day. | -| close | float | The close price. | -| close_size | int | The closing trade size for the option that day. | -| close_time | datetime | The time of the closing price for the option that day. | -| close_bid | float | The closing bid price for the option that day. | -| close_bid_size | int | The closing bid size for the option that day. | -| close_bid_time | datetime | The time of the bid closing price for the option that day. | -| close_ask | float | The closing ask price for the option that day. | -| close_ask_size | int | The closing ask size for the option that day. | -| close_ask_time | datetime | The time of the ask closing price for the option that day. | -| prev_close | float | The previous close price. | -| change | float | The change in the price of the option. | -| change_percent | float | Change, in normalizezd percentage points, of the option. | -| implied_volatility | float | Implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | -| exercise_style | str | The exercise style of the option, American or European. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option. | -| contract_symbol | str | Contract symbol for the option. | -| eod_date | date | Date for which the options chains are returned. | -| expiration | date | Expiration date of the contract. | -| strike | float | Strike price of the contract. | -| option_type | str | Call or Put. | -| open_interest | int | Open interest on the contract. | -| volume | int | The trading volume. | -| theoretical_price | float | Theoretical value of the option. | -| last_trade_price | float | Last trade price of the option. | -| tick | str | Whether the last tick was up or down in price. | -| bid | float | Current bid price for the option. | -| bid_size | int | Bid size for the option. | -| ask | float | Current ask price for the option. | -| ask_size | int | Ask size for the option. | -| mark | float | The mid-price between the latest bid and ask. | -| open | float | The open price. | -| open_bid | float | The opening bid price for the option that day. | -| open_ask | float | The opening ask price for the option that day. | -| high | float | The high price. | -| bid_high | float | The highest bid price for the option that day. | -| ask_high | float | The highest ask price for the option that day. | -| low | float | The low price. | -| bid_low | float | The lowest bid price for the option that day. | -| ask_low | float | The lowest ask price for the option that day. | -| close | float | The close price. | -| close_size | int | The closing trade size for the option that day. | -| close_time | datetime | The time of the closing price for the option that day. | -| close_bid | float | The closing bid price for the option that day. | -| close_bid_size | int | The closing bid size for the option that day. | -| close_bid_time | datetime | The time of the bid closing price for the option that day. | -| close_ask | float | The closing ask price for the option that day. | -| close_ask_size | int | The closing ask size for the option that day. | -| close_ask_time | datetime | The time of the ask closing price for the option that day. | -| prev_close | float | The previous close price. | -| change | float | The change in the price of the option. | -| change_percent | float | Change, in normalizezd percentage points, of the option. | -| implied_volatility | float | Implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | -| transactions | int | Number of transactions for the contract. | -| total_value | float | Total value of the transactions. | -| settlement_price | float | Settlement price on that date. | -| underlying_price | float | Price of the underlying stock on that date. | -| dte | int | Days to expiration for the option. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option. | -| contract_symbol | str | Contract symbol for the option. | -| eod_date | date | Date for which the options chains are returned. | -| expiration | date | Expiration date of the contract. | -| strike | float | Strike price of the contract. | -| option_type | str | Call or Put. | -| open_interest | int | Open interest on the contract. | -| volume | int | The trading volume. | -| theoretical_price | float | Theoretical value of the option. | -| last_trade_price | float | Last trade price of the option. | -| tick | str | Whether the last tick was up or down in price. | -| bid | float | Current bid price for the option. | -| bid_size | int | Bid size for the option. | -| ask | float | Current ask price for the option. | -| ask_size | int | Ask size for the option. | -| mark | float | The mid-price between the latest bid and ask. | -| open | float | The open price. | -| open_bid | float | The opening bid price for the option that day. | -| open_ask | float | The opening ask price for the option that day. | -| high | float | The high price. | -| bid_high | float | The highest bid price for the option that day. | -| ask_high | float | The highest ask price for the option that day. | -| low | float | The low price. | -| bid_low | float | The lowest bid price for the option that day. | -| ask_low | float | The lowest ask price for the option that day. | -| close | float | The close price. | -| close_size | int | The closing trade size for the option that day. | -| close_time | datetime | The time of the closing price for the option that day. | -| close_bid | float | The closing bid price for the option that day. | -| close_bid_size | int | The closing bid size for the option that day. | -| close_bid_time | datetime | The time of the bid closing price for the option that day. | -| close_ask | float | The closing ask price for the option that day. | -| close_ask_size | int | The closing ask size for the option that day. | -| close_ask_time | datetime | The time of the ask closing price for the option that day. | -| prev_close | float | The previous close price. | -| change | float | The change in the price of the option. | -| change_percent | float | Change, in normalizezd percentage points, of the option. | -| implied_volatility | float | Implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | -| phi | float | Phi of the option. The sensitivity of the option relative to dividend yield. | -| bid_iv | float | Implied volatility of the bid price. | -| ask_iv | float | Implied volatility of the ask price. | -| orats_final_iv | float | ORATS final implied volatility of the option, updated once per hour. | -| year_high | float | 52-week high price of the option. | -| year_low | float | 52-week low price of the option. | -| last_trade_volume | int | Volume of the last trade. | -| dte | int | Days to expiration. | -| contract_size | int | Size of the contract. | -| bid_exchange | str | Exchange of the bid price. | -| bid_timestamp | datetime | Timestamp of the bid price. | -| ask_exchange | str | Exchange of the ask price. | -| ask_timestamp | datetime | Timestamp of the ask price. | -| greeks_timestamp | datetime | Timestamp of the last greeks update. Greeks/IV data is updated once per hour. | -| last_trade_timestamp | datetime | Timestamp of the last trade. | - - - - diff --git a/website/content/platform/data_models/OptionsUnusual.md b/website/content/platform/data_models/OptionsUnusual.md deleted file mode 100644 index 8532cd4014e1..000000000000 --- a/website/content/platform/data_models/OptionsUnusual.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "Options Unusual" -description: "Get the complete options chain for a ticker" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `OptionsUnusual` | `OptionsUnusualQueryParams` | `OptionsUnusualData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.options_unusual import ( -OptionsUnusualData, -OptionsUnusualQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (the underlying symbol) | None | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (the underlying symbol) | None | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | -| start_date | Union[date, str] | 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. | None | True | -| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date. | None | True | -| trade_type | Literal['block', 'sweep', 'large'] | The type of unusual activity to query for. | None | True | -| sentiment | Literal['bullish', 'bearish', 'neutral'] | The sentiment type to query for. | None | True | -| min_value | Union[int, float] | The inclusive minimum total value for the unusual activity. | None | True | -| max_value | Union[int, float] | The inclusive maximum total value for the unusual activity. | None | True | -| limit | int | 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. | 100000 | True | -| source | Literal['delayed', 'realtime'] | The source of the data. Either realtime or delayed. | delayed | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| underlying_symbol | str | Symbol representing the entity requested in the data. (the underlying symbol) | -| contract_symbol | str | Contract symbol for the option. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| underlying_symbol | str | Symbol representing the entity requested in the data. (the underlying symbol) | -| contract_symbol | str | Contract symbol for the option. | -| trade_timestamp | datetime | The datetime of order placement. | -| trade_type | Literal['block', 'sweep', 'large'] | The type of unusual trade. | -| sentiment | Literal['bullish', 'bearish', 'neutral'] | Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price. | -| bid_at_execution | float | Bid price at execution. | -| ask_at_execution | float | Ask price at execution. | -| average_price | float | The average premium paid per option contract. | -| underlying_price_at_execution | float | Price of the underlying security at execution of trade. | -| total_size | int | The total number of contracts involved in a single transaction. | -| total_value | Union[int, float] | The aggregated value of all option contract premiums included in the trade. | - - - - diff --git a/website/content/platform/data_models/PROJECTIONS.md b/website/content/platform/data_models/PROJECTIONS.md deleted file mode 100644 index 5998d2b69132..000000000000 --- a/website/content/platform/data_models/PROJECTIONS.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Projections" -description: "Fed Funds Rate Projections" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `PROJECTIONS` | `PROJECTIONSQueryParams` | `PROJECTIONSData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -PROJECTIONSData, -PROJECTIONSQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | -| long_run | bool | Flag to show long run projections | False | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| range_high | float | High projection of rates. | -| central_tendency_high | float | Central tendency of high projection of rates. | -| median | float | Median projection of rates. | -| range_midpoint | float | Midpoint projection of rates. | -| central_tendency_midpoint | float | Central tendency of midpoint projection of rates. | -| range_low | float | Low projection of rates. | -| central_tendency_low | float | Central tendency of low projection of rates. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| range_high | float | High projection of rates. | -| central_tendency_high | float | Central tendency of high projection of rates. | -| median | float | Median projection of rates. | -| range_midpoint | float | Midpoint projection of rates. | -| central_tendency_midpoint | float | Central tendency of midpoint projection of rates. | -| range_low | float | Low projection of rates. | -| central_tendency_low | float | Central tendency of low projection of rates. | - - - - diff --git a/website/content/platform/data_models/PricePerformance.md b/website/content/platform/data_models/PricePerformance.md deleted file mode 100644 index 7a7338807843..000000000000 --- a/website/content/platform/data_models/PricePerformance.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -title: "Price Performance" -description: "Price performance as a return, over different periods" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `PricePerformance` | `PricePerformanceQueryParams` | `PricePerformanceData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -PricePerformanceData, -PricePerformanceQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| provider | Literal['finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| provider | Literal['finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| provider | Literal['finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | -| volatility_week | float | One-week realized volatility, as a normalized percent. | -| volatility_month | float | One-month realized volatility, as a normalized percent. | -| price | float | Last Price. | -| volume | float | Current volume. | -| average_volume | float | Average daily volume. | -| relative_volume | float | Relative volume as a ratio of current volume to average volume. | -| analyst_recommendation | float | The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. | -| symbol | str | The ticker symbol. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | -| symbol | str | The ticker symbol. | - - - - diff --git a/website/content/platform/data_models/PriceTarget.md b/website/content/platform/data_models/PriceTarget.md deleted file mode 100644 index f92aadfac483..000000000000 --- a/website/content/platform/data_models/PriceTarget.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -title: "Price Target" -description: "Get analyst price targets by company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `PriceTarget` | `PriceTargetQueryParams` | `PriceTargetData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.price_target import ( -PriceTargetData, -PriceTargetQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): benzinga, finviz. | None | True | -| limit | int | The number of data entries to return. | 200 | True | -| provider | Literal['benzinga', 'finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): benzinga, finviz. | None | True | -| limit | int | The number of data entries to return. | 200 | True | -| provider | Literal['benzinga', 'finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| page | int | 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. | 0 | True | -| date | Union[date, str] | Date for calendar data, shorthand for date_from and date_to. | None | True | -| 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 | -| updated | Union[date, int] | 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. | None | True | -| importance | int | Importance level to filter by. Uses Greater Than or Equal To the importance indicated | None | True | -| action | Literal['downgrades', 'maintains', 'reinstates', 'reiterates', 'upgrades', 'assumes', 'initiates', 'terminates', 'removes', 'suspends', 'firm_dissolved'] | Filter by a specific action_company. | None | True | -| analyst_ids | Union[str, List[str]] | Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. | None | True | -| firm_ids | Union[str, List[str]] | Comma-separated list of firm IDs. | None | True | -| fields | Union[str, List[str]] | 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. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): benzinga, finviz. | None | True | -| limit | int | The number of data entries to return. | 200 | True | -| provider | Literal['benzinga', 'finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): benzinga, finviz. | None | True | -| limit | int | The number of data entries to return. | 200 | True | -| provider | Literal['benzinga', 'finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| with_grade | bool | Include upgrades and downgrades in the response. | False | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| published_date | Union[date, datetime] | Published date of the price target. | -| published_time | datetime.time | Time of the original rating, UTC. | -| symbol | str | Symbol representing the entity requested in the data. | -| exchange | str | Exchange where the company is traded. | -| company_name | str | Name of company that is the subject of rating. | -| analyst_name | str | Analyst name. | -| analyst_firm | str | Name of the analyst firm that published the price target. | -| currency | str | Currency the data is denominated in. | -| price_target | float | The current price target. | -| adj_price_target | float | Adjusted price target for splits and stock dividends. | -| price_target_previous | float | Previous price target. | -| previous_adj_price_target | float | Previous adjusted price target. | -| price_when_posted | float | Price when posted. | -| rating_current | str | The analyst's rating for the company. | -| rating_previous | str | Previous analyst rating for the company. | -| action | str | Description of the change in rating from firm's last rating. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| published_date | Union[date, datetime] | Published date of the price target. | -| published_time | datetime.time | Time of the original rating, UTC. | -| symbol | str | Symbol representing the entity requested in the data. | -| exchange | str | Exchange where the company is traded. | -| company_name | str | Name of company that is the subject of rating. | -| analyst_name | str | Analyst name. | -| analyst_firm | str | Name of the analyst firm that published the price target. | -| currency | str | Currency the data is denominated in. | -| price_target | float | The current price target. | -| adj_price_target | float | Adjusted price target for splits and stock dividends. | -| price_target_previous | float | Previous price target. | -| previous_adj_price_target | float | Previous adjusted price target. | -| price_when_posted | float | Price when posted. | -| rating_current | str | The analyst's rating for the company. | -| rating_previous | str | Previous analyst rating for the company. | -| action | str | Description of the change in rating from firm's last rating. | -| action_change | Literal['Announces', 'Maintains', 'Lowers', 'Raises', 'Removes', 'Adjusts'] | Description of the change in price target from firm's last price target. | -| importance | Literal[0, 1, 2, 3, 4, 5] | Subjective Basis of How Important Event is to Market. 5 = High | -| notes | str | Notes of the price target. | -| analyst_id | str | Id of the analyst. | -| url_news | str | URL for analyst ratings news articles for this ticker on Benzinga.com. | -| url_analyst | str | URL for analyst ratings page for this ticker on Benzinga.com. | -| id | str | Unique ID of this entry. | -| last_updated | datetime | Last updated timestamp, UTC. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| published_date | Union[date, datetime] | Published date of the price target. | -| published_time | datetime.time | Time of the original rating, UTC. | -| symbol | str | Symbol representing the entity requested in the data. | -| exchange | str | Exchange where the company is traded. | -| company_name | str | Name of company that is the subject of rating. | -| analyst_name | str | Analyst name. | -| analyst_firm | str | Name of the analyst firm that published the price target. | -| currency | str | Currency the data is denominated in. | -| price_target | float | The current price target. | -| adj_price_target | float | Adjusted price target for splits and stock dividends. | -| price_target_previous | float | Previous price target. | -| previous_adj_price_target | float | Previous adjusted price target. | -| price_when_posted | float | Price when posted. | -| rating_current | str | The analyst's rating for the company. | -| rating_previous | str | Previous analyst rating for the company. | -| action | str | Description of the change in rating from firm's last rating. | -| status | str | The action taken by the firm. This could be 'Upgrade', 'Downgrade', 'Reiterated', etc. | -| rating_change | str | The rating given by the analyst. This could be 'Buy', 'Sell', 'Underweight', etc. If the rating is a revision, the change is indicated by '->' | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| published_date | Union[date, datetime] | Published date of the price target. | -| published_time | datetime.time | Time of the original rating, UTC. | -| symbol | str | Symbol representing the entity requested in the data. | -| exchange | str | Exchange where the company is traded. | -| company_name | str | Name of company that is the subject of rating. | -| analyst_name | str | Analyst name. | -| analyst_firm | str | Name of the analyst firm that published the price target. | -| currency | str | Currency the data is denominated in. | -| price_target | float | The current price target. | -| adj_price_target | float | Adjusted price target for splits and stock dividends. | -| price_target_previous | float | Previous price target. | -| previous_adj_price_target | float | Previous adjusted price target. | -| price_when_posted | float | Price when posted. | -| rating_current | str | The analyst's rating for the company. | -| rating_previous | str | Previous analyst rating for the company. | -| action | str | Description of the change in rating from firm's last rating. | -| news_url | str | News URL of the price target. | -| news_title | str | News title of the price target. | -| news_publisher | str | News publisher of the price target. | -| news_base_url | str | News base URL of the price target. | - - - - diff --git a/website/content/platform/data_models/PriceTargetConsensus.md b/website/content/platform/data_models/PriceTargetConsensus.md deleted file mode 100644 index f6486ed50ecd..000000000000 --- a/website/content/platform/data_models/PriceTargetConsensus.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: "Price Target Consensus" -description: "Get consensus price target and recommendation" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `PriceTargetConsensus` | `PriceTargetConsensusQueryParams` | `PriceTargetConsensusData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.price_target_consensus import ( -PriceTargetConsensusData, -PriceTargetConsensusQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): tmx, yfinance. | | False | -| provider | Literal['fmp', 'tmx', '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. Multiple items allowed for provider(s): tmx, yfinance. | | False | -| provider | Literal['fmp', 'tmx', '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. Multiple items allowed for provider(s): tmx, yfinance. | | False | -| provider | Literal['fmp', 'tmx', '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. Multiple items allowed for provider(s): tmx, yfinance. | | False | -| provider | Literal['fmp', 'tmx', '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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| target_high | float | High target of the price target consensus. | -| target_low | float | Low target of the price target consensus. | -| target_consensus | float | Consensus target of the price target consensus. | -| target_median | float | Median target of the price target consensus. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| target_high | float | High target of the price target consensus. | -| target_low | float | Low target of the price target consensus. | -| target_consensus | float | Consensus target of the price target consensus. | -| target_median | float | Median target of the price target consensus. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| target_high | float | High target of the price target consensus. | -| target_low | float | Low target of the price target consensus. | -| target_consensus | float | Consensus target of the price target consensus. | -| target_median | float | Median target of the price target consensus. | -| target_upside | float | Percent of upside, as a normalized percent. | -| total_analysts | int | Total number of analyst. | -| buy_ratings | int | Number of buy ratings. | -| sell_ratings | int | Number of sell ratings. | -| hold_ratings | int | Number of hold ratings. | -| consensus_action | str | Consensus action. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| target_high | float | High target of the price target consensus. | -| target_low | float | Low target of the price target consensus. | -| target_consensus | float | Consensus target of the price target consensus. | -| target_median | float | Median target of the price target consensus. | -| recommendation | str | Recommendation - buy, sell, etc. | -| recommendation_mean | float | Mean recommendation score where 1 is strong buy and 5 is strong sell. | -| number_of_analysts | int | Number of analysts providing opinions. | -| current_price | float | Current price of the stock. | -| currency | str | Currency the stock is priced in. | - - - - diff --git a/website/content/platform/data_models/ReportedFinancials.md b/website/content/platform/data_models/ReportedFinancials.md deleted file mode 100644 index db567f453c74..000000000000 --- a/website/content/platform/data_models/ReportedFinancials.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "Reported Financials" -description: "Get financial statements as reported by the company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `ReportedFinancials` | `ReportedFinancialsQueryParams` | `ReportedFinancialsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.reported_financials import ( -ReportedFinancialsData, -ReportedFinancialsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| statement_type | str | The type of financial statement - i.e, balance, income, cash. | balance | True | -| limit | int | 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. | 100 | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| statement_type | str | The type of financial statement - i.e, balance, income, cash. | balance | True | -| limit | int | 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. | 100 | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | -| fiscal_year | int | The specific fiscal year. Reports do not go beyond 2008. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The ending date of the reporting period. | -| fiscal_period | str | The fiscal period of the report (e.g. FY, Q1, etc.). | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The ending date of the reporting period. | -| fiscal_period | str | The fiscal period of the report (e.g. FY, Q1, etc.). | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - diff --git a/website/content/platform/data_models/RevenueBusinessLine.md b/website/content/platform/data_models/RevenueBusinessLine.md deleted file mode 100644 index 9f4cda636c69..000000000000 --- a/website/content/platform/data_models/RevenueBusinessLine.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "Revenue Business Line" -description: "Get the revenue breakdown by business segment for a given company over time" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `RevenueBusinessLine` | `RevenueBusinessLineQueryParams` | `RevenueBusinessLineData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.revenue_business_line import ( -RevenueBusinessLineData, -RevenueBusinessLineQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | Literal['quarter', 'annual'] | Time period of the data to return. | annual | True | -| structure | Literal['hierarchical', 'flat'] | Structure of the returned data. | flat | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | Literal['quarter', 'annual'] | Time period of the data to return. | annual | True | -| structure | Literal['hierarchical', 'flat'] | Structure of the returned data. | flat | 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 | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the reporting period. | -| fiscal_year | int | The fiscal year of the reporting period. | -| filing_date | date | The filing date of the report. | -| business_line | int | Dictionary containing the revenue of the business line. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the reporting period. | -| fiscal_year | int | The fiscal year of the reporting period. | -| filing_date | date | The filing date of the report. | -| business_line | int | Dictionary containing the revenue of the business line. | - - - - diff --git a/website/content/platform/data_models/RevenueGeographic.md b/website/content/platform/data_models/RevenueGeographic.md deleted file mode 100644 index 396688f01ce8..000000000000 --- a/website/content/platform/data_models/RevenueGeographic.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "Revenue Geographic" -description: "Get the revenue geographic breakdown for a given company over time" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `RevenueGeographic` | `RevenueGeographicQueryParams` | `RevenueGeographicData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.revenue_geographic import ( -RevenueGeographicData, -RevenueGeographicQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | Literal['quarter', 'annual'] | Time period of the data to return. | annual | True | -| structure | Literal['hierarchical', 'flat'] | Structure of the returned data. | flat | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | Literal['quarter', 'annual'] | Time period of the data to return. | annual | True | -| structure | Literal['hierarchical', 'flat'] | Structure of the returned data. | flat | 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 | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the reporting period. | -| fiscal_year | int | The fiscal year of the reporting period. | -| filing_date | date | The filing date of the report. | -| geographic_segment | int | Dictionary of the revenue by geographic segment. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the reporting period. | -| fiscal_year | int | The fiscal year of the reporting period. | -| filing_date | date | The filing date of the report. | -| geographic_segment | int | Dictionary of the revenue by geographic segment. | - - - - diff --git a/website/content/platform/data_models/RiskPremium.md b/website/content/platform/data_models/RiskPremium.md deleted file mode 100644 index cdf7cdf96f8d..000000000000 --- a/website/content/platform/data_models/RiskPremium.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "Risk Premium" -description: "Market Risk Premium by country" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `RiskPremium` | `RiskPremiumQueryParams` | `RiskPremiumData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.risk_premium import ( -RiskPremiumData, -RiskPremiumQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | -| ---- | ---- | ----------- | -| country | str | Market country. | -| continent | str | Continent of the country. | -| total_equity_risk_premium | float, Gt(gt=0) | Total equity risk premium for the country. | -| country_risk_premium | float, Ge(ge=0) | Country-specific risk premium. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| country | str | Market country. | -| continent | str | Continent of the country. | -| total_equity_risk_premium | float, Gt(gt=0) | Total equity risk premium for the country. | -| country_risk_premium | float, Ge(ge=0) | Country-specific risk premium. | - - - - diff --git a/website/content/platform/data_models/RssLitigation.md b/website/content/platform/data_models/RssLitigation.md deleted file mode 100644 index 46914e26a2b2..000000000000 --- a/website/content/platform/data_models/RssLitigation.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "Rss Litigation" -description: "The RSS feed provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `RssLitigation` | `RssLitigationQueryParams` | `RssLitigationData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -RssLitigationData, -RssLitigationQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| published | datetime | The date of publication. | -| title | str | The title of the release. | -| summary | str | Short summary of the release. | -| id | str | The identifier associated with the release. | -| link | str | URL to the release. | - - - - diff --git a/website/content/platform/data_models/SOFR.md b/website/content/platform/data_models/SOFR.md deleted file mode 100644 index db02ff47fb88..000000000000 --- a/website/content/platform/data_models/SOFR.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "SOFR" -description: "Secured Overnight Financing Rate" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `SOFR` | `SOFRQueryParams` | `SOFRData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.sofr_rates import ( -SOFRData, -SOFRQueryParams, -) -``` - ---- - -## 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 | -| period | Literal['overnight', '30_day', '90_day', '180_day', 'index'] | Period of SOFR rate. | overnight | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SOFR rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SOFR rate. | - - - - diff --git a/website/content/platform/data_models/SONIA.md b/website/content/platform/data_models/SONIA.md deleted file mode 100644 index 8127d8c7b8a0..000000000000 --- a/website/content/platform/data_models/SONIA.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "Sonia" -description: "Sterling Overnight Index Average" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `SONIA` | `SONIAQueryParams` | `SONIAData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.sonia_rates import ( -SONIAData, -SONIAQueryParams, -) -``` - ---- - -## 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['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value'] | Period of SONIA rate. | rate | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SONIA rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SONIA rate. | - - - - diff --git a/website/content/platform/data_models/SP500Multiples.md b/website/content/platform/data_models/SP500Multiples.md deleted file mode 100644 index 22e74179580a..000000000000 --- a/website/content/platform/data_models/SP500Multiples.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "SP500 Multiples" -description: "Historical S&P 500 multiples and Shiller PE ratios" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `SP500Multiples` | `SP500MultiplesQueryParams` | `SP500MultiplesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.sp500_multiples import ( -SP500MultiplesData, -SP500MultiplesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| series_name | Literal['shiller_pe_month', 'shiller_pe_year', 'pe_year', 'pe_month', 'dividend_year', 'dividend_month', 'dividend_growth_quarter', 'dividend_growth_year', 'dividend_yield_year', 'dividend_yield_month', 'earnings_year', 'earnings_month', 'earnings_growth_year', 'earnings_growth_quarter', 'real_earnings_growth_year', 'real_earnings_growth_quarter', 'earnings_yield_year', 'earnings_yield_month', 'real_price_year', 'real_price_month', 'inflation_adjusted_price_year', 'inflation_adjusted_price_month', 'sales_year', 'sales_quarter', 'sales_growth_year', 'sales_growth_quarter', 'real_sales_year', 'real_sales_quarter', 'real_sales_growth_year', 'real_sales_growth_quarter', 'price_to_sales_year', 'price_to_sales_quarter', 'price_to_book_value_year', 'price_to_book_value_quarter', 'book_value_year', 'book_value_quarter'] | The name of the series. Defaults to 'pe_month'. | pe_month | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| series_name | Literal['shiller_pe_month', 'shiller_pe_year', 'pe_year', 'pe_month', 'dividend_year', 'dividend_month', 'dividend_growth_quarter', 'dividend_growth_year', 'dividend_yield_year', 'dividend_yield_month', 'earnings_year', 'earnings_month', 'earnings_growth_year', 'earnings_growth_quarter', 'real_earnings_growth_year', 'real_earnings_growth_quarter', 'earnings_yield_year', 'earnings_yield_month', 'real_price_year', 'real_price_month', 'inflation_adjusted_price_year', 'inflation_adjusted_price_month', 'sales_year', 'sales_quarter', 'sales_growth_year', 'sales_growth_quarter', 'real_sales_year', 'real_sales_quarter', 'real_sales_growth_year', 'real_sales_growth_quarter', 'price_to_sales_year', 'price_to_sales_quarter', 'price_to_book_value_year', 'price_to_book_value_quarter', 'book_value_year', 'book_value_quarter'] | The name of the series. Defaults to 'pe_month'. | pe_month | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - diff --git a/website/content/platform/data_models/STIR.md b/website/content/platform/data_models/STIR.md deleted file mode 100644 index eca76732333d..000000000000 --- a/website/content/platform/data_models/STIR.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "STIR" -description: "Short-term interest rates are the rates at which short-term borrowings are effected between -financial institutions or the rate at which short-term government paper is issued or traded in the market" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `STIR` | `STIRQueryParams` | `STIRData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.short_term_interest_rate import ( -STIRData, -STIRQueryParams, -) -``` - ---- - -## 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all'] | Country to get GDP for. | united_states | True | -| frequency | Literal['monthly', 'quarterly', 'annual'] | Frequency to get interest rate for for. | monthly | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Interest rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which interest rate is given | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Interest rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which interest rate is given | - - - - diff --git a/website/content/platform/data_models/SchemaFiles.md b/website/content/platform/data_models/SchemaFiles.md deleted file mode 100644 index 3b2a95f6c19d..000000000000 --- a/website/content/platform/data_models/SchemaFiles.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Schema Files" -description: "A tool for navigating the directory of SEC XML schema files by year" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `SchemaFiles` | `SchemaFilesQueryParams` | `SchemaFilesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -SchemaFilesData, -SchemaFilesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | -| url | str | Enter an optional URL path to fetch the next level. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| files | List[str] | Dictionary of URLs to SEC Schema Files | - - - - diff --git a/website/content/platform/data_models/SearchAttributes.md b/website/content/platform/data_models/SearchAttributes.md deleted file mode 100644 index b16489b196d0..000000000000 --- a/website/content/platform/data_models/SearchAttributes.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "Search Attributes" -description: "Search Intrinio data tags to search in latest or historical attributes" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `SearchAttributes` | `SearchAttributesQueryParams` | `SearchAttributesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.search_attributes import ( -SearchAttributesData, -SearchAttributesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Query to search for. | | False | -| limit | int | The number of data entries to return. | 1000 | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Query to search for. | | False | -| limit | int | The number of data entries to return. | 1000 | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| id | str | ID of the financial attribute. | -| name | str | Name of the financial attribute. | -| tag | str | Tag of the financial attribute. | -| statement_code | str | Code of the financial statement. | -| statement_type | str | Type of the financial statement. | -| parent_name | str | Parent's name of the financial attribute. | -| sequence | int | Sequence of the financial statement. | -| factor | str | Unit of the financial attribute. | -| transaction | str | Transaction type (credit/debit) of the financial attribute. | -| type | str | Type of the financial attribute. | -| unit | str | Unit of the financial attribute. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| id | str | ID of the financial attribute. | -| name | str | Name of the financial attribute. | -| tag | str | Tag of the financial attribute. | -| statement_code | str | Code of the financial statement. | -| statement_type | str | Type of the financial statement. | -| parent_name | str | Parent's name of the financial attribute. | -| sequence | int | Sequence of the financial statement. | -| factor | str | Unit of the financial attribute. | -| transaction | str | Transaction type (credit/debit) of the financial attribute. | -| type | str | Type of the financial attribute. | -| unit | str | Unit of the financial attribute. | - - - - diff --git a/website/content/platform/data_models/SelectedTreasuryBill.md b/website/content/platform/data_models/SelectedTreasuryBill.md deleted file mode 100644 index 1222d98d2b4e..000000000000 --- a/website/content/platform/data_models/SelectedTreasuryBill.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "Selected Treasury Bill" -description: "Select Treasury Bill" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `SelectedTreasuryBill` | `SelectedTreasuryBillQueryParams` | `SelectedTreasuryBillData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.tbffr import ( -SelectedTreasuryBillData, -SelectedTreasuryBillQueryParams, -) -``` - ---- - -## 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 | -| maturity | Literal['3m', '6m'] | The maturity | 3m | 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 | -| maturity | Literal['3m', '6m'] | The maturity | 3m | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SelectedTreasuryBill Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SelectedTreasuryBill Rate. | - - - - diff --git a/website/content/platform/data_models/SelectedTreasuryConstantMaturity.md b/website/content/platform/data_models/SelectedTreasuryConstantMaturity.md deleted file mode 100644 index 5d4b5331168e..000000000000 --- a/website/content/platform/data_models/SelectedTreasuryConstantMaturity.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "Selected Treasury Constant Maturity" -description: "Select Treasury Constant Maturity" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `SelectedTreasuryConstantMaturity` | `SelectedTreasuryConstantMaturityQueryParams` | `SelectedTreasuryConstantMaturityData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.ffrmc import ( -SelectedTreasuryConstantMaturityData, -SelectedTreasuryConstantMaturityQueryParams, -) -``` - ---- - -## 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 | -| maturity | Literal['10y', '5y', '1y', '6m', '3m'] | The maturity | 10y | 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 | -| maturity | Literal['10y', '5y', '1y', '6m', '3m'] | The maturity | 10y | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Selected Treasury Constant Maturity Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Selected Treasury Constant Maturity Rate. | - - - - diff --git a/website/content/platform/data_models/ShareStatistics.md b/website/content/platform/data_models/ShareStatistics.md deleted file mode 100644 index 159196c07996..000000000000 --- a/website/content/platform/data_models/ShareStatistics.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: "Share Statistics" -description: "Get data about share float for a given company" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `ShareStatistics` | `ShareStatisticsQueryParams` | `ShareStatisticsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.share_statistics import ( -ShareStatisticsData, -ShareStatisticsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): yfinance. | | False | -| provider | Literal['fmp', 'intrinio', '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. Multiple items allowed for provider(s): yfinance. | | False | -| provider | Literal['fmp', 'intrinio', '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. Multiple items allowed for provider(s): yfinance. | | False | -| provider | Literal['fmp', 'intrinio', '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. Multiple items allowed for provider(s): yfinance. | | False | -| provider | Literal['fmp', 'intrinio', '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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| free_float | float | Percentage of unrestricted shares of a publicly-traded company. | -| float_shares | float | Number of shares available for trading by the general public. | -| outstanding_shares | float | Total number of shares of a publicly-traded company. | -| source | str | Source of the received data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| free_float | float | Percentage of unrestricted shares of a publicly-traded company. | -| float_shares | float | Number of shares available for trading by the general public. | -| outstanding_shares | float | Total number of shares of a publicly-traded company. | -| source | str | Source of the received data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| free_float | float | Percentage of unrestricted shares of a publicly-traded company. | -| float_shares | float | Number of shares available for trading by the general public. | -| outstanding_shares | float | Total number of shares of a publicly-traded company. | -| source | str | Source of the received data. | -| adjusted_outstanding_shares | float | Total number of shares of a publicly-traded company, adjusted for splits. | -| public_float | float | Aggregate market value of the shares of a publicly-traded company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| free_float | float | Percentage of unrestricted shares of a publicly-traded company. | -| float_shares | float | Number of shares available for trading by the general public. | -| outstanding_shares | float | Total number of shares of a publicly-traded company. | -| source | str | Source of the received data. | -| implied_shares_outstanding | int | Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common. | -| short_interest | int | Number of shares that are reported short. | -| short_percent_of_float | float | Percentage of shares that are reported short, as a normalized percent. | -| days_to_cover | float | Number of days to repurchase the shares as a ratio of average daily volume | -| short_interest_prev_month | int | Number of shares that were reported short in the previous month. | -| short_interest_prev_date | date | Date of the previous month's report. | -| insider_ownership | float | Percentage of shares held by insiders, as a normalized percent. | -| institution_ownership | float | Percentage of shares held by institutions, as a normalized percent. | -| institution_float_ownership | float | Percentage of float held by institutions, as a normalized percent. | -| institutions_count | int | Number of institutions holding shares. | - - - - diff --git a/website/content/platform/data_models/ShortVolume.md b/website/content/platform/data_models/ShortVolume.md deleted file mode 100644 index a59cd4c2e57a..000000000000 --- a/website/content/platform/data_models/ShortVolume.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "Short Volume" -description: "Get reported Fail-to-deliver (FTD) data" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `ShortVolume` | `ShortVolumeQueryParams` | `ShortVolumeData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.short_volume import ( -ShortVolumeData, -ShortVolumeQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['stockgrid'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'stockgrid' if there is no default. | stockgrid | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['stockgrid'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'stockgrid' if there is no default. | stockgrid | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| market | str | Reporting Facility ID. N=NYSE TRF, Q=NASDAQ TRF Carteret, B=NASDAQ TRY Chicago, D=FINRA ADF | -| short_volume | int | Aggregate reported share volume of executed short sale and short sale exempt trades during regular trading hours | -| short_exempt_volume | int | Aggregate reported share volume of executed short sale exempt trades during regular trading hours | -| total_volume | int | Aggregate reported share volume of executed trades during regular trading hours | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| market | str | Reporting Facility ID. N=NYSE TRF, Q=NASDAQ TRF Carteret, B=NASDAQ TRY Chicago, D=FINRA ADF | -| short_volume | int | Aggregate reported share volume of executed short sale and short sale exempt trades during regular trading hours | -| short_exempt_volume | int | Aggregate reported share volume of executed short sale exempt trades during regular trading hours | -| total_volume | int | Aggregate reported share volume of executed trades during regular trading hours | -| close | float | Closing price of the stock on the date. | -| short_volume_percent | float | Percentage of the total volume that was short volume. | - - - - diff --git a/website/content/platform/data_models/SicSearch.md b/website/content/platform/data_models/SicSearch.md deleted file mode 100644 index 629864bbb9a6..000000000000 --- a/website/content/platform/data_models/SicSearch.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "Sic Search" -description: "Search for Industry Titles, Reporting Office, and SIC Codes" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `SicSearch` | `SicSearchQueryParams` | `SicSearchData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -SicSearchData, -SicSearchQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sic | int | Sector Industrial Code (SIC) | -| industry | str | Industry title. | -| office | str | Reporting office within the Corporate Finance Office | - - - - diff --git a/website/content/platform/data_models/SpotRate.md b/website/content/platform/data_models/SpotRate.md deleted file mode 100644 index 7ea4ebd76e46..000000000000 --- a/website/content/platform/data_models/SpotRate.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "Spot Rate" -description: "Spot Rates" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `SpotRate` | `SpotRateQueryParams` | `SpotRateData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.spot import ( -SpotRateData, -SpotRateQueryParams, -) -``` - ---- - -## 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 | -| maturity | Union[Union[float, str], List[Union[float, str]]] | Maturities in years. Multiple items allowed for provider(s): fred. | 10.0 | True | -| category | Union[str, List[str]] | Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred. | spot_rate | 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 | -| maturity | Union[Union[float, str], List[Union[float, str]]] | Maturities in years. Multiple items allowed for provider(s): fred. | 10.0 | True | -| category | Union[str, List[str]] | Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred. | spot_rate | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Spot Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Spot Rate. | - - - - diff --git a/website/content/platform/data_models/SymbolMap.md b/website/content/platform/data_models/SymbolMap.md deleted file mode 100644 index d9dc48353b8d..000000000000 --- a/website/content/platform/data_models/SymbolMap.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "Symbol Map" -description: "Map a CIK number to a ticker symbol, leading 0s can be omitted or included" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `SymbolMap` | `SymbolMapQueryParams` | `SymbolMapData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -SymbolMapData, -SymbolMapQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | False | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | False | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | - - - - diff --git a/website/content/platform/data_models/TopRetail.md b/website/content/platform/data_models/TopRetail.md deleted file mode 100644 index 5825d7f60de8..000000000000 --- a/website/content/platform/data_models/TopRetail.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "Top Retail" -description: "Tracks over $30B USD/day of individual investors trades" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `TopRetail` | `TopRetailQueryParams` | `TopRetailData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.top_retail import ( -TopRetailData, -TopRetailQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. | 5 | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. | 5 | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| activity | float | Activity of the symbol. | -| sentiment | float | Sentiment of the symbol. 1 is bullish, -1 is bearish. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| activity | float | Activity of the symbol. | -| sentiment | float | Sentiment of the symbol. 1 is bullish, -1 is bearish. | - - - - diff --git a/website/content/platform/data_models/TrailingDividendYield.md b/website/content/platform/data_models/TrailingDividendYield.md deleted file mode 100644 index fd977a98fcb2..000000000000 --- a/website/content/platform/data_models/TrailingDividendYield.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "Trailing Dividend Yield" -description: "Get the 1 year trailing dividend yield for a given company over time" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `TrailingDividendYield` | `TrailingDividendYieldQueryParams` | `TrailingDividendYieldData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -TrailingDividendYieldData, -TrailingDividendYieldQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. Default is 252, the number of trading days in a year. | 252 | True | -| provider | Literal['tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default. | tiingo | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. Default is 252, the number of trading days in a year. | 252 | True | -| provider | Literal['tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default. | tiingo | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| trailing_dividend_yield | float | Trailing dividend yield. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| trailing_dividend_yield | float | Trailing dividend yield. | - - - - diff --git a/website/content/platform/data_models/TreasuryAuctions.md b/website/content/platform/data_models/TreasuryAuctions.md deleted file mode 100644 index 7bcbb9127869..000000000000 --- a/website/content/platform/data_models/TreasuryAuctions.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -title: "Treasury Auctions" -description: "Government Treasury Auctions" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `TreasuryAuctions` | `TreasuryAuctionsQueryParams` | `TreasuryAuctionsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models. import ( -TreasuryAuctionsData, -TreasuryAuctionsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| security_type | Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN'] | Used to only return securities of a particular type. | None | True | -| cusip | str | Filter securities by CUSIP. | None | True | -| page_size | int | Maximum number of results to return; you must also include pagenum when using pagesize. | None | True | -| page_num | int | The first page number to display results for; used in combination with page size. | None | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. The default is 90 days ago. | None | True | -| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. The default is today. | None | True | -| provider | Literal['government_us'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default. | government_us | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| security_type | Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN'] | Used to only return securities of a particular type. | None | True | -| cusip | str | Filter securities by CUSIP. | None | True | -| page_size | int | Maximum number of results to return; you must also include pagenum when using pagesize. | None | True | -| page_num | int | The first page number to display results for; used in combination with page size. | None | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. The default is 90 days ago. | None | True | -| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. The default is today. | None | True | -| provider | Literal['government_us'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default. | government_us | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| cusip | str | CUSIP of the Security. | -| issue_date | date | The issue date of the security. | -| security_type | Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN'] | The type of security. | -| security_term | str | The term of the security. | -| maturity_date | date | The maturity date of the security. | -| interest_rate | float | The interest rate of the security. | -| cpi_on_issue_date | float | Reference CPI rate on the issue date of the security. | -| cpi_on_dated_date | float | Reference CPI rate on the dated date of the security. | -| announcement_date | date | The announcement date of the security. | -| auction_date | date | The auction date of the security. | -| auction_date_year | int | The auction date year of the security. | -| dated_date | date | The dated date of the security. | -| first_payment_date | date | The first payment date of the security. | -| accrued_interest_per_100 | float | Accrued interest per $100. | -| accrued_interest_per_1000 | float | Accrued interest per $1000. | -| adjusted_accrued_interest_per_100 | float | Adjusted accrued interest per $100. | -| adjusted_accrued_interest_per_1000 | float | Adjusted accrued interest per $1000. | -| adjusted_price | float | Adjusted price. | -| allocation_percentage | float | Allocation percentage, as normalized percentage points. | -| allocation_percentage_decimals | float | The number of decimals in the Allocation percentage. | -| announced_cusip | str | The announced CUSIP of the security. | -| auction_format | str | The auction format of the security. | -| avg_median_discount_rate | float | The average median discount rate of the security. | -| avg_median_investment_rate | float | The average median investment rate of the security. | -| avg_median_price | float | The average median price paid for the security. | -| avg_median_discount_margin | float | The average median discount margin of the security. | -| avg_median_yield | float | The average median yield of the security. | -| back_dated | Literal['Yes', 'No'] | Whether the security is back dated. | -| back_dated_date | date | The back dated date of the security. | -| bid_to_cover_ratio | float | The bid to cover ratio of the security. | -| call_date | date | The call date of the security. | -| callable | Literal['Yes', 'No'] | Whether the security is callable. | -| called_date | date | The called date of the security. | -| cash_management_bill | Literal['Yes', 'No'] | Whether the security is a cash management bill. | -| closing_time_competitive | str | The closing time for competitive bids on the security. | -| closing_time_non_competitive | str | The closing time for non-competitive bids on the security. | -| competitive_accepted | int | The accepted value for competitive bids on the security. | -| competitive_accepted_decimals | int | The number of decimals in the Competitive Accepted. | -| competitive_tendered | int | The tendered value for competitive bids on the security. | -| competitive_tenders_accepted | Literal['Yes', 'No'] | Whether competitive tenders are accepted on the security. | -| corp_us_cusip | str | The CUSIP of the security. | -| cpi_base_reference_period | str | The CPI base reference period of the security. | -| currently_outstanding | int | The currently outstanding value on the security. | -| direct_bidder_accepted | int | The accepted value from direct bidders on the security. | -| direct_bidder_tendered | int | The tendered value from direct bidders on the security. | -| est_amount_of_publicly_held_maturing_security | int | The estimated amount of publicly held maturing securities on the security. | -| fima_included | Literal['Yes', 'No'] | Whether the security is included in the FIMA (Foreign and International Money Authorities). | -| fima_non_competitive_accepted | int | The non-competitive accepted value on the security from FIMAs. | -| fima_non_competitive_tendered | int | The non-competitive tendered value on the security from FIMAs. | -| first_interest_period | str | The first interest period of the security. | -| first_interest_payment_date | date | The first interest payment date of the security. | -| floating_rate | Literal['Yes', 'No'] | Whether the security is a floating rate. | -| frn_index_determination_date | date | The FRN index determination date of the security. | -| frn_index_determination_rate | float | The FRN index determination rate of the security. | -| high_discount_rate | float | The high discount rate of the security. | -| high_investment_rate | float | The high investment rate of the security. | -| high_price | float | The high price of the security at auction. | -| high_discount_margin | float | The high discount margin of the security. | -| high_yield | float | The high yield of the security at auction. | -| index_ratio_on_issue_date | float | The index ratio on the issue date of the security. | -| indirect_bidder_accepted | int | The accepted value from indirect bidders on the security. | -| indirect_bidder_tendered | int | The tendered value from indirect bidders on the security. | -| interest_payment_frequency | str | The interest payment frequency of the security. | -| low_discount_rate | float | The low discount rate of the security. | -| low_investment_rate | float | The low investment rate of the security. | -| low_price | float | The low price of the security at auction. | -| low_discount_margin | float | The low discount margin of the security. | -| low_yield | float | The low yield of the security at auction. | -| maturing_date | date | The maturing date of the security. | -| max_competitive_award | int | The maximum competitive award at auction. | -| max_non_competitive_award | int | The maximum non-competitive award at auction. | -| max_single_bid | int | The maximum single bid at auction. | -| min_bid_amount | int | The minimum bid amount at auction. | -| min_strip_amount | int | The minimum strip amount at auction. | -| min_to_issue | int | The minimum to issue at auction. | -| multiples_to_bid | int | The multiples to bid at auction. | -| multiples_to_issue | int | The multiples to issue at auction. | -| nlp_exclusion_amount | int | The NLP exclusion amount at auction. | -| nlp_reporting_threshold | int | The NLP reporting threshold at auction. | -| non_competitive_accepted | int | The accepted value from non-competitive bidders on the security. | -| non_competitive_tenders_accepted | Literal['Yes', 'No'] | Whether or not the auction accepted non-competitive tenders. | -| offering_amount | int | The offering amount at auction. | -| original_cusip | str | The original CUSIP of the security. | -| original_dated_date | date | The original dated date of the security. | -| original_issue_date | date | The original issue date of the security. | -| original_security_term | str | The original term of the security. | -| pdf_announcement | str | The PDF filename for the announcement of the security. | -| pdf_competitive_results | str | The PDF filename for the competitive results of the security. | -| pdf_non_competitive_results | str | The PDF filename for the non-competitive results of the security. | -| pdf_special_announcement | str | The PDF filename for the special announcements. | -| price_per_100 | float | The price per 100 of the security. | -| primary_dealer_accepted | int | The primary dealer accepted value on the security. | -| primary_dealer_tendered | int | The primary dealer tendered value on the security. | -| reopening | Literal['Yes', 'No'] | Whether or not the auction was reopened. | -| security_term_day_month | str | The security term in days or months. | -| security_term_week_year | str | The security term in weeks or years. | -| series | str | The series name of the security. | -| soma_accepted | int | The SOMA accepted value on the security. | -| soma_holdings | int | The SOMA holdings on the security. | -| soma_included | Literal['Yes', 'No'] | Whether or not the SOMA (System Open Market Account) was included on the security. | -| soma_tendered | int | The SOMA tendered value on the security. | -| spread | float | The spread on the security. | -| standard_payment_per_1000 | float | The standard payment per 1000 of the security. | -| strippable | Literal['Yes', 'No'] | Whether or not the security is strippable. | -| term | str | The term of the security. | -| tiin_conversion_factor_per_1000 | float | The TIIN conversion factor per 1000 of the security. | -| tips | Literal['Yes', 'No'] | Whether or not the security is TIPS. | -| total_accepted | int | The total accepted value at auction. | -| total_tendered | int | The total tendered value at auction. | -| treasury_retail_accepted | int | The accepted value on the security from retail. | -| treasury_retail_tenders_accepted | Literal['Yes', 'No'] | Whether or not the tender offers from retail are accepted | -| type | str | The type of issuance. This might be different than the security type. | -| unadjusted_accrued_interest_per_1000 | float | The unadjusted accrued interest per 1000 of the security. | -| unadjusted_price | float | The unadjusted price of the security. | -| updated_timestamp | datetime | The updated timestamp of the security. | -| xml_announcement | str | The XML filename for the announcement of the security. | -| xml_competitive_results | str | The XML filename for the competitive results of the security. | -| xml_special_announcement | str | The XML filename for special announcements. | -| tint_cusip1 | str | Tint CUSIP 1. | -| tint_cusip2 | str | Tint CUSIP 2. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| cusip | str | CUSIP of the Security. | -| issue_date | date | The issue date of the security. | -| security_type | Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN'] | The type of security. | -| security_term | str | The term of the security. | -| maturity_date | date | The maturity date of the security. | -| interest_rate | float | The interest rate of the security. | -| cpi_on_issue_date | float | Reference CPI rate on the issue date of the security. | -| cpi_on_dated_date | float | Reference CPI rate on the dated date of the security. | -| announcement_date | date | The announcement date of the security. | -| auction_date | date | The auction date of the security. | -| auction_date_year | int | The auction date year of the security. | -| dated_date | date | The dated date of the security. | -| first_payment_date | date | The first payment date of the security. | -| accrued_interest_per_100 | float | Accrued interest per $100. | -| accrued_interest_per_1000 | float | Accrued interest per $1000. | -| adjusted_accrued_interest_per_100 | float | Adjusted accrued interest per $100. | -| adjusted_accrued_interest_per_1000 | float | Adjusted accrued interest per $1000. | -| adjusted_price | float | Adjusted price. | -| allocation_percentage | float | Allocation percentage, as normalized percentage points. | -| allocation_percentage_decimals | float | The number of decimals in the Allocation percentage. | -| announced_cusip | str | The announced CUSIP of the security. | -| auction_format | str | The auction format of the security. | -| avg_median_discount_rate | float | The average median discount rate of the security. | -| avg_median_investment_rate | float | The average median investment rate of the security. | -| avg_median_price | float | The average median price paid for the security. | -| avg_median_discount_margin | float | The average median discount margin of the security. | -| avg_median_yield | float | The average median yield of the security. | -| back_dated | Literal['Yes', 'No'] | Whether the security is back dated. | -| back_dated_date | date | The back dated date of the security. | -| bid_to_cover_ratio | float | The bid to cover ratio of the security. | -| call_date | date | The call date of the security. | -| callable | Literal['Yes', 'No'] | Whether the security is callable. | -| called_date | date | The called date of the security. | -| cash_management_bill | Literal['Yes', 'No'] | Whether the security is a cash management bill. | -| closing_time_competitive | str | The closing time for competitive bids on the security. | -| closing_time_non_competitive | str | The closing time for non-competitive bids on the security. | -| competitive_accepted | int | The accepted value for competitive bids on the security. | -| competitive_accepted_decimals | int | The number of decimals in the Competitive Accepted. | -| competitive_tendered | int | The tendered value for competitive bids on the security. | -| competitive_tenders_accepted | Literal['Yes', 'No'] | Whether competitive tenders are accepted on the security. | -| corp_us_cusip | str | The CUSIP of the security. | -| cpi_base_reference_period | str | The CPI base reference period of the security. | -| currently_outstanding | int | The currently outstanding value on the security. | -| direct_bidder_accepted | int | The accepted value from direct bidders on the security. | -| direct_bidder_tendered | int | The tendered value from direct bidders on the security. | -| est_amount_of_publicly_held_maturing_security | int | The estimated amount of publicly held maturing securities on the security. | -| fima_included | Literal['Yes', 'No'] | Whether the security is included in the FIMA (Foreign and International Money Authorities). | -| fima_non_competitive_accepted | int | The non-competitive accepted value on the security from FIMAs. | -| fima_non_competitive_tendered | int | The non-competitive tendered value on the security from FIMAs. | -| first_interest_period | str | The first interest period of the security. | -| first_interest_payment_date | date | The first interest payment date of the security. | -| floating_rate | Literal['Yes', 'No'] | Whether the security is a floating rate. | -| frn_index_determination_date | date | The FRN index determination date of the security. | -| frn_index_determination_rate | float | The FRN index determination rate of the security. | -| high_discount_rate | float | The high discount rate of the security. | -| high_investment_rate | float | The high investment rate of the security. | -| high_price | float | The high price of the security at auction. | -| high_discount_margin | float | The high discount margin of the security. | -| high_yield | float | The high yield of the security at auction. | -| index_ratio_on_issue_date | float | The index ratio on the issue date of the security. | -| indirect_bidder_accepted | int | The accepted value from indirect bidders on the security. | -| indirect_bidder_tendered | int | The tendered value from indirect bidders on the security. | -| interest_payment_frequency | str | The interest payment frequency of the security. | -| low_discount_rate | float | The low discount rate of the security. | -| low_investment_rate | float | The low investment rate of the security. | -| low_price | float | The low price of the security at auction. | -| low_discount_margin | float | The low discount margin of the security. | -| low_yield | float | The low yield of the security at auction. | -| maturing_date | date | The maturing date of the security. | -| max_competitive_award | int | The maximum competitive award at auction. | -| max_non_competitive_award | int | The maximum non-competitive award at auction. | -| max_single_bid | int | The maximum single bid at auction. | -| min_bid_amount | int | The minimum bid amount at auction. | -| min_strip_amount | int | The minimum strip amount at auction. | -| min_to_issue | int | The minimum to issue at auction. | -| multiples_to_bid | int | The multiples to bid at auction. | -| multiples_to_issue | int | The multiples to issue at auction. | -| nlp_exclusion_amount | int | The NLP exclusion amount at auction. | -| nlp_reporting_threshold | int | The NLP reporting threshold at auction. | -| non_competitive_accepted | int | The accepted value from non-competitive bidders on the security. | -| non_competitive_tenders_accepted | Literal['Yes', 'No'] | Whether or not the auction accepted non-competitive tenders. | -| offering_amount | int | The offering amount at auction. | -| original_cusip | str | The original CUSIP of the security. | -| original_dated_date | date | The original dated date of the security. | -| original_issue_date | date | The original issue date of the security. | -| original_security_term | str | The original term of the security. | -| pdf_announcement | str | The PDF filename for the announcement of the security. | -| pdf_competitive_results | str | The PDF filename for the competitive results of the security. | -| pdf_non_competitive_results | str | The PDF filename for the non-competitive results of the security. | -| pdf_special_announcement | str | The PDF filename for the special announcements. | -| price_per_100 | float | The price per 100 of the security. | -| primary_dealer_accepted | int | The primary dealer accepted value on the security. | -| primary_dealer_tendered | int | The primary dealer tendered value on the security. | -| reopening | Literal['Yes', 'No'] | Whether or not the auction was reopened. | -| security_term_day_month | str | The security term in days or months. | -| security_term_week_year | str | The security term in weeks or years. | -| series | str | The series name of the security. | -| soma_accepted | int | The SOMA accepted value on the security. | -| soma_holdings | int | The SOMA holdings on the security. | -| soma_included | Literal['Yes', 'No'] | Whether or not the SOMA (System Open Market Account) was included on the security. | -| soma_tendered | int | The SOMA tendered value on the security. | -| spread | float | The spread on the security. | -| standard_payment_per_1000 | float | The standard payment per 1000 of the security. | -| strippable | Literal['Yes', 'No'] | Whether or not the security is strippable. | -| term | str | The term of the security. | -| tiin_conversion_factor_per_1000 | float | The TIIN conversion factor per 1000 of the security. | -| tips | Literal['Yes', 'No'] | Whether or not the security is TIPS. | -| total_accepted | int | The total accepted value at auction. | -| total_tendered | int | The total tendered value at auction. | -| treasury_retail_accepted | int | The accepted value on the security from retail. | -| treasury_retail_tenders_accepted | Literal['Yes', 'No'] | Whether or not the tender offers from retail are accepted | -| type | str | The type of issuance. This might be different than the security type. | -| unadjusted_accrued_interest_per_1000 | float | The unadjusted accrued interest per 1000 of the security. | -| unadjusted_price | float | The unadjusted price of the security. | -| updated_timestamp | datetime | The updated timestamp of the security. | -| xml_announcement | str | The XML filename for the announcement of the security. | -| xml_competitive_results | str | The XML filename for the competitive results of the security. | -| xml_special_announcement | str | The XML filename for special announcements. | -| tint_cusip1 | str | Tint CUSIP 1. | -| tint_cusip2 | str | Tint CUSIP 2. | - - - - diff --git a/website/content/platform/data_models/TreasuryConstantMaturity.md b/website/content/platform/data_models/TreasuryConstantMaturity.md deleted file mode 100644 index 962424cb9cd6..000000000000 --- a/website/content/platform/data_models/TreasuryConstantMaturity.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "Treasury Constant Maturity" -description: "Treasury Constant Maturity" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `TreasuryConstantMaturity` | `TreasuryConstantMaturityQueryParams` | `TreasuryConstantMaturityData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.tmc import ( -TreasuryConstantMaturityData, -TreasuryConstantMaturityQueryParams, -) -``` - ---- - -## 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 | -| maturity | Literal['3m', '2y'] | The maturity | 3m | 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 | -| maturity | Literal['3m', '2y'] | The maturity | 3m | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | TreasuryConstantMaturity Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | TreasuryConstantMaturity Rate. | - - - - diff --git a/website/content/platform/data_models/TreasuryPrices.md b/website/content/platform/data_models/TreasuryPrices.md deleted file mode 100644 index 642410e1a61f..000000000000 --- a/website/content/platform/data_models/TreasuryPrices.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "Treasury Prices" -description: "Government Treasury Prices by date" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `TreasuryPrices` | `TreasuryPricesQueryParams` | `TreasuryPricesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.treasury_prices import ( -TreasuryPricesData, -TreasuryPricesQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. No date will return the current posted data. | None | True | -| provider | Literal['government_us', 'tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default. | government_us | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. No date will return the current posted data. | None | True | -| provider | Literal['government_us', 'tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default. | government_us | True | -| cusip | str | Filter by CUSIP. | None | True | -| security_type | Literal[None, 'bill', 'note', 'bond', 'tips', 'frn'] | Filter by security type. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. No date will return the current posted data. | None | True | -| provider | Literal['government_us', 'tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default. | government_us | True | -| govt_type | Literal['federal', 'provincial', 'municipal'] | The level of government issuer. | federal | True | -| issue_date_min | date | Filter by the minimum original issue date. | None | True | -| issue_date_max | date | Filter by the maximum original issue date. | None | True | -| last_traded_min | date | Filter by the minimum last trade date. | None | True | -| maturity_date_min | date | Filter by the minimum maturity date. | None | True | -| maturity_date_max | date | Filter by the maximum maturity date. | None | True | -| use_cache | bool | All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. | True | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| issuer_name | str | Name of the issuing entity. | -| cusip | str | CUSIP of the security. | -| isin | str | ISIN of the security. | -| security_type | str | The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN. | -| issue_date | date | The original issue date of the security. | -| maturity_date | date | The maturity date of the security. | -| call_date | date | The call date of the security. | -| bid | float | The bid price of the security. | -| offer | float | The offer price of the security. | -| eod_price | float | The end-of-day price of the security. | -| last_traded_date | date | The last trade date of the security. | -| total_trades | int | Total number of trades on the last traded date. | -| last_price | float | The last price of the security. | -| highest_price | float | The highest price for the bond on the last traded date. | -| lowest_price | float | The lowest price for the bond on the last traded date. | -| rate | float | The annualized interest rate or coupon of the security. | -| ytm | float | Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| issuer_name | str | Name of the issuing entity. | -| cusip | str | CUSIP of the security. | -| isin | str | ISIN of the security. | -| security_type | str | The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN. | -| issue_date | date | The original issue date of the security. | -| maturity_date | date | The maturity date of the security. | -| call_date | date | The call date of the security. | -| bid | float | The bid price of the security. | -| offer | float | The offer price of the security. | -| eod_price | float | The end-of-day price of the security. | -| last_traded_date | date | The last trade date of the security. | -| total_trades | int | Total number of trades on the last traded date. | -| last_price | float | The last price of the security. | -| highest_price | float | The highest price for the bond on the last traded date. | -| lowest_price | float | The lowest price for the bond on the last traded date. | -| rate | float | The annualized interest rate or coupon of the security. | -| ytm | float | Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| issuer_name | str | Name of the issuing entity. | -| cusip | str | CUSIP of the security. | -| isin | str | ISIN of the security. | -| security_type | str | The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN. | -| issue_date | date | The original issue date of the security. | -| maturity_date | date | The maturity date of the security. | -| call_date | date | The call date of the security. | -| bid | float | The bid price of the security. | -| offer | float | The offer price of the security. | -| eod_price | float | The end-of-day price of the security. | -| last_traded_date | date | The last trade date of the security. | -| total_trades | int | Total number of trades on the last traded date. | -| last_price | float | The last price of the security. | -| highest_price | float | The highest price for the bond on the last traded date. | -| lowest_price | float | The lowest price for the bond on the last traded date. | -| rate | float | The annualized interest rate or coupon of the security. | -| ytm | float | Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. | - - - - diff --git a/website/content/platform/data_models/TreasuryRates.md b/website/content/platform/data_models/TreasuryRates.md deleted file mode 100644 index ab5f94a90502..000000000000 --- a/website/content/platform/data_models/TreasuryRates.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: "Treasury Rates" -description: "Government Treasury Rates" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `TreasuryRates` | `TreasuryRatesQueryParams` | `TreasuryRatesData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.treasury_rates import ( -TreasuryRatesData, -TreasuryRatesQueryParams, -) -``` - ---- - -## 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['federal_reserve', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | 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['federal_reserve', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | 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['federal_reserve', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| week_4 | float | 4 week Treasury bills rate (secondary market). | -| month_1 | float | 1 month Treasury rate. | -| month_2 | float | 2 month Treasury rate. | -| month_3 | float | 3 month Treasury rate. | -| month_6 | float | 6 month Treasury rate. | -| year_1 | float | 1 year Treasury rate. | -| year_2 | float | 2 year Treasury rate. | -| year_3 | float | 3 year Treasury rate. | -| year_5 | float | 5 year Treasury rate. | -| year_7 | float | 7 year Treasury rate. | -| year_10 | float | 10 year Treasury rate. | -| year_20 | float | 20 year Treasury rate. | -| year_30 | float | 30 year Treasury rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| week_4 | float | 4 week Treasury bills rate (secondary market). | -| month_1 | float | 1 month Treasury rate. | -| month_2 | float | 2 month Treasury rate. | -| month_3 | float | 3 month Treasury rate. | -| month_6 | float | 6 month Treasury rate. | -| year_1 | float | 1 year Treasury rate. | -| year_2 | float | 2 year Treasury rate. | -| year_3 | float | 3 year Treasury rate. | -| year_5 | float | 5 year Treasury rate. | -| year_7 | float | 7 year Treasury rate. | -| year_10 | float | 10 year Treasury rate. | -| year_20 | float | 20 year Treasury rate. | -| year_30 | float | 30 year Treasury rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| week_4 | float | 4 week Treasury bills rate (secondary market). | -| month_1 | float | 1 month Treasury rate. | -| month_2 | float | 2 month Treasury rate. | -| month_3 | float | 3 month Treasury rate. | -| month_6 | float | 6 month Treasury rate. | -| year_1 | float | 1 year Treasury rate. | -| year_2 | float | 2 year Treasury rate. | -| year_3 | float | 3 year Treasury rate. | -| year_5 | float | 5 year Treasury rate. | -| year_7 | float | 7 year Treasury rate. | -| year_10 | float | 10 year Treasury rate. | -| year_20 | float | 20 year Treasury rate. | -| year_30 | float | 30 year Treasury rate. | - - - - diff --git a/website/content/platform/data_models/USYieldCurve.md b/website/content/platform/data_models/USYieldCurve.md deleted file mode 100644 index d0ef8409bbbe..000000000000 --- a/website/content/platform/data_models/USYieldCurve.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "US Yield Curve" -description: "US Yield Curve" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `USYieldCurve` | `USYieldCurveQueryParams` | `USYieldCurveData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.us_yield_curve import ( -USYieldCurveData, -USYieldCurveQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. Defaults to the most recent FRED entry. | None | True | -| inflation_adjusted | bool | Get inflation adjusted rates. | False | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. Defaults to the most recent FRED entry. | None | True | -| inflation_adjusted | bool | Get inflation adjusted rates. | False | 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 | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| maturity | float | Maturity of the treasury rate in years. | -| rate | float | Associated rate given in decimal form (0.05 is 5%) | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| maturity | float | Maturity of the treasury rate in years. | -| rate | float | Associated rate given in decimal form (0.05 is 5%) | - - - - diff --git a/website/content/platform/data_models/Unemployment.md b/website/content/platform/data_models/Unemployment.md deleted file mode 100644 index 96828754a618..000000000000 --- a/website/content/platform/data_models/Unemployment.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "Unemployment" -description: "Global unemployment data" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `Unemployment` | `UnemploymentQueryParams` | `UnemploymentData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.unemployment import ( -UnemploymentData, -UnemploymentQueryParams, -) -``` - ---- - -## 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['colombia', 'new_zealand', 'united_kingdom', 'italy', 'luxembourg', 'euro_area19', 'sweden', 'oecd', 'south_africa', 'denmark', 'canada', 'switzerland', 'slovakia', 'hungary', 'portugal', 'spain', 'france', 'czech_republic', 'costa_rica', 'japan', 'slovenia', 'russia', 'austria', 'latvia', 'netherlands', 'israel', 'iceland', 'united_states', 'ireland', 'mexico', 'germany', 'greece', 'turkey', 'australia', 'poland', 'south_korea', 'chile', 'finland', 'european_union27_2020', 'norway', 'lithuania', 'euro_area20', 'estonia', 'belgium', 'brazil', 'indonesia', 'all'] | Country to get GDP for. | united_states | True | -| sex | Literal['total', 'male', 'female'] | Sex to get unemployment for. | total | True | -| frequency | Literal['monthly', 'quarterly', 'annual'] | Frequency to get unemployment for. | monthly | True | -| age | Literal['total', '15-24', '15-64', '25-54', '55-64'] | Age group to get unemployment for. Total indicates 15 years or over | total | True | -| seasonal_adjustment | bool | Whether to get seasonally adjusted unemployment. Defaults to False. | False | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Unemployment rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which unemployment rate is given | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Unemployment rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which unemployment rate is given | - - - - diff --git a/website/content/platform/data_models/UpcomingReleaseDays.md b/website/content/platform/data_models/UpcomingReleaseDays.md deleted file mode 100644 index 3fc64f3e05e9..000000000000 --- a/website/content/platform/data_models/UpcomingReleaseDays.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "Upcoming Release Days" -description: "Get upcoming earnings release dates" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `UpcomingReleaseDays` | `UpcomingReleaseDaysQueryParams` | `UpcomingReleaseDaysData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.upcoming_release_days import ( -UpcomingReleaseDaysData, -UpcomingReleaseDaysQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['seeking_alpha'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'seeking_alpha' if there is no default. | seeking_alpha | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['seeking_alpha'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'seeking_alpha' if there is no default. | seeking_alpha | True | -| limit | int | The number of data entries to return.In this case, the number of lookahead days. | 10 | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | The full name of the asset. | -| exchange | str | The exchange the asset is traded on. | -| release_time_type | str | The type of release time. | -| release_date | date | The date of the release. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | The full name of the asset. | -| exchange | str | The exchange the asset is traded on. | -| release_time_type | str | The type of release time. | -| release_date | date | The date of the release. | -| sector_id | int | The sector ID of the asset. | - - - - diff --git a/website/content/platform/data_models/WorldNews.md b/website/content/platform/data_models/WorldNews.md deleted file mode 100644 index d54625e2cd5c..000000000000 --- a/website/content/platform/data_models/WorldNews.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -title: "World News" -description: "World News" ---- - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - ---- - -## Implementation details - -### Class names - -| Model name | Parameters class | Data class | -| ---------- | ---------------- | ---------- | -| `WorldNews` | `WorldNewsQueryParams` | `WorldNewsData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.world_news import ( -WorldNewsData, -WorldNewsQueryParams, -) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| date | Union[date, str] | A specific date to get data for. | None | True | -| display | Literal['headline', 'abstract', 'full'] | Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). | full | True | -| updated_since | int | Number of seconds since the news was updated. | None | True | -| published_since | int | Number of seconds since the news was published. | None | True | -| sort | Literal['id', 'created', 'updated'] | Key to sort the news by. | created | True | -| order | Literal['asc', 'desc'] | Order to sort the news by. | desc | True | -| isin | str | The ISIN of the news to retrieve. | None | True | -| cusip | str | The CUSIP of the news to retrieve. | None | True | -| channels | str | Channels of the news to retrieve. | None | True | -| topics | str | Topics of the news to retrieve. | None | True | -| authors | str | Authors of the news to retrieve. | None | True | -| content_types | str | Content types of the news to retrieve. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| filter | Literal['crypto', 'hot', 'latest', 'main', 'media', 'source', 'tag'] | Filter by type of news. | latest | True | -| source | str | Filter by a specific publisher. Only valid when filter is set to source. | bloomberg | True | -| tag | str | Tag, topic, to filter articles by. Only valid when filter is set to tag. | None | True | -| term | str | Search term to filter articles by. This overrides all other filters. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| offset | int | Page offset, used in conjunction with limit. | 0 | True | -| source | str | A comma-separated list of the domains requested. | None | True | - - - - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | -| id | str | Article ID. | -| author | str | Author of the news. | -| teaser | str | Teaser of the news. | -| channels | str | Channels associated with the news. | -| stocks | str | Stocks associated with the news. | -| tags | str | Tags associated with the news. | -| updated | datetime | Updated date of the news. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | -| favicon | str | Icon image for the source of the article. | -| tags | List[str] | Tags for the article. | -| id | str | Unique Article ID. | -| score | float | Search relevance score for the article. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | -| site | str | News source. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | -| id | str | Article ID. | -| company | Dict[str, Any] | Company details related to the news article. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | -| symbols | str | Ticker tagged in the fetched news. | -| article_id | int | Unique ID of the news article. | -| site | str | News source. | -| tags | str | Tags associated with the news article. | -| crawl_date | datetime | Date the news article was crawled. | - - - - diff --git a/website/content/platform/data_models/_category_.json b/website/content/platform/data_models/_category_.json deleted file mode 100644 index ce589d29024d..000000000000 --- a/website/content/platform/data_models/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Data Models", - "position": 6 -} \ No newline at end of file diff --git a/website/content/platform/data_models/index.mdx b/website/content/platform/data_models/index.mdx deleted file mode 100644 index 2c36f16ed85e..000000000000 --- a/website/content/platform/data_models/index.mdx +++ /dev/null @@ -1,721 +0,0 @@ -# Data Models - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - - diff --git a/website/content/platform/reference/_category_.json b/website/content/platform/reference/_category_.json deleted file mode 100644 index 8c64e8e6135b..000000000000 --- a/website/content/platform/reference/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Reference", - "position": 5 -} \ No newline at end of file diff --git a/website/content/platform/reference/commodity/_category_.json b/website/content/platform/reference/commodity/_category_.json deleted file mode 100644 index d48695bdc795..000000000000 --- a/website/content/platform/reference/commodity/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Commodity", - "position": 5 -} \ No newline at end of file diff --git a/website/content/platform/reference/commodity/index.mdx b/website/content/platform/reference/commodity/index.mdx deleted file mode 100644 index f93dcbc6f044..000000000000 --- a/website/content/platform/reference/commodity/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ -# Commodity - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands - - diff --git a/website/content/platform/reference/commodity/lbma_fixing.md b/website/content/platform/reference/commodity/lbma_fixing.md deleted file mode 100644 index 221167d5f233..000000000000 --- a/website/content/platform/reference/commodity/lbma_fixing.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: "lbma_fixing" -description: "Daily LBMA Fixing Prices in USD/EUR/GBP" -keywords: -- commodity -- lbma_fixing ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Daily LBMA Fixing Prices in USD/EUR/GBP. - - -Examples --------- - -```python -from openbb import obb -obb.commodity.lbma_fixing(provider='nasdaq') -# Get the daily LBMA fixing prices for silver in 2023. -obb.commodity.lbma_fixing(asset='silver', start_date='2023-01-01', end_date='2023-12-31', transform='rdiff', collapse='monthly', provider='nasdaq') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| asset | Literal['gold', 'silver'] | The metal to get price fixing rates for. | gold | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| asset | Literal['gold', 'silver'] | The metal to get price fixing rates for. | gold | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : LbmaFixing - Serializable results. - provider : Literal['nasdaq'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| usd_am | float | AM fixing price in USD. | -| usd_pm | float | PM fixing price in USD. | -| gbp_am | float | AM fixing price in GBP. | -| gbp_pm | float | PM fixing price in GBP. | -| euro_am | float | AM fixing price in EUR. | -| euro_pm | float | PM fixing price in EUR. | -| usd | float | Daily fixing price in USD. | -| gbp | float | Daily fixing price in GBP. | -| eur | float | Daily fixing price in EUR. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| usd_am | float | AM fixing price in USD. | -| usd_pm | float | PM fixing price in USD. | -| gbp_am | float | AM fixing price in GBP. | -| gbp_pm | float | PM fixing price in GBP. | -| euro_am | float | AM fixing price in EUR. | -| euro_pm | float | PM fixing price in EUR. | -| usd | float | Daily fixing price in USD. | -| gbp | float | Daily fixing price in GBP. | -| eur | float | Daily fixing price in EUR. | - - - - diff --git a/website/content/platform/reference/crypto/_category_.json b/website/content/platform/reference/crypto/_category_.json deleted file mode 100644 index f594c0456ac3..000000000000 --- a/website/content/platform/reference/crypto/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Crypto", - "position": 2 -} \ No newline at end of file diff --git a/website/content/platform/reference/crypto/index.mdx b/website/content/platform/reference/crypto/index.mdx deleted file mode 100644 index c7dfc6f8bbb4..000000000000 --- a/website/content/platform/reference/crypto/index.mdx +++ /dev/null @@ -1,14 +0,0 @@ -# Crypto - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Menus - - -### Commands - - diff --git a/website/content/platform/reference/crypto/price/_category_.json b/website/content/platform/reference/crypto/price/_category_.json deleted file mode 100644 index 73fbd46944d2..000000000000 --- a/website/content/platform/reference/crypto/price/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Price", - "position": 1 -} \ No newline at end of file diff --git a/website/content/platform/reference/crypto/price/historical.md b/website/content/platform/reference/crypto/price/historical.md deleted file mode 100644 index 5d1872bee193..000000000000 --- a/website/content/platform/reference/crypto/price/historical.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -title: "historical" -description: "Learn how to use the `obb.equity.price.historical` function to load historical price data for a specific stock ticker. Find out about the available parameters and providers, as well as the structure of the returned data and the columns it contains." -keywords: -- equity historical price -- load stock data -- specific ticker -- python function -- equity data parameters -- alpha vantage provider -- fmp provider -- intrinio provider -- polygon provider -- yfinance provider -- equity historical data returns -- equity data columns -- alpha vantage data columns -- cboe data columns -- fmp data columns -- intrinio data columns -- polygon data columns -- yfinance data columns ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get historical price data for cryptocurrency pair(s) within a provider. - - -Examples --------- - -```python -from openbb import obb -obb.crypto.price.historical(symbol='BTCUSD', provider='fmp') -obb.crypto.price.historical(symbol='BTCUSD', start_date='2024-01-01', end_date='2024-01-31', provider='fmp') -obb.crypto.price.historical(symbol='BTCUSD,ETHUSD', start_date='2024-01-01', end_date='2024-01-31', provider='polygon') -# Get monthly historical prices from Yahoo Finance for Ethereum. -obb.crypto.price.historical(symbol='ETH-USD', interval=1m, start_date='2024-01-01', end_date='2024-12-31', provider='yfinance') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'] | Time interval of the data to return. | 1d | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | str | Time 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 | 1d | True | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'] | Time interval of the data to return. | 1d | True | -| exchanges | List[str] | To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q'] | Time interval of the data to return. | 1d | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CryptoHistorical - Serializable results. - provider : Literal['fmp', 'polygon', 'tiingo', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | -| adj_close | float | The adjusted close price. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | -| transactions | int | Number of transactions for the symbol in the time period. | -| volume_notional | float | The last size done for the asset on the specific date in the quote currency. The volume of the asset on the specific date in the quote currency. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | - - - - diff --git a/website/content/platform/reference/crypto/price/index.mdx b/website/content/platform/reference/crypto/price/index.mdx deleted file mode 100644 index c410b87c8c92..000000000000 --- a/website/content/platform/reference/crypto/price/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ -# Price - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - -
- diff --git a/website/content/platform/reference/crypto/search.md b/website/content/platform/reference/crypto/search.md deleted file mode 100644 index 65db1c71e980..000000000000 --- a/website/content/platform/reference/crypto/search.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: "search" -description: "The documentation page provides information on how to perform a cryptocurrency search, including the search query and provider parameters, as well as the resulting crypto search data such as symbol, name, currency, and exchange information." -keywords: -- cryptocurrency search -- available cryptocurrency pairs -- python obb crypto search -- search query parameter -- provider parameter -- crypto search results -- crypto search provider -- crypto search warnings -- crypto search chart -- crypto search metadata -- crypto data -- symbol -- crypto name -- crypto currency -- crypto exchange -- crypto exchange name ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Search available cryptocurrency pairs within a provider. - - -Examples --------- - -```python -from openbb import obb -obb.crypto.search(provider='fmp') -obb.crypto.search(query='BTCUSD', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | None | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | None | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CryptoSearch - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (Crypto) | -| name | str | Name of the crypto. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (Crypto) | -| name | str | Name of the crypto. | -| currency | str | The currency the crypto trades for. | -| exchange | str | The exchange code the crypto trades on. | -| exchange_name | str | The short name of the exchange the crypto trades on. | - - - - diff --git a/website/content/platform/reference/currency/_category_.json b/website/content/platform/reference/currency/_category_.json deleted file mode 100644 index 25a3731d98a1..000000000000 --- a/website/content/platform/reference/currency/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Currency", - "position": 12 -} \ No newline at end of file diff --git a/website/content/platform/reference/currency/index.mdx b/website/content/platform/reference/currency/index.mdx deleted file mode 100644 index ee58a62ec729..000000000000 --- a/website/content/platform/reference/currency/index.mdx +++ /dev/null @@ -1,16 +0,0 @@ -# Currency - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Menus -
    - -
- -### Commands -
    - - - -
- diff --git a/website/content/platform/reference/currency/price/_category_.json b/website/content/platform/reference/currency/price/_category_.json deleted file mode 100644 index 73fbd46944d2..000000000000 --- a/website/content/platform/reference/currency/price/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Price", - "position": 1 -} \ No newline at end of file diff --git a/website/content/platform/reference/currency/price/historical.md b/website/content/platform/reference/currency/price/historical.md deleted file mode 100644 index ef33c536e086..000000000000 --- a/website/content/platform/reference/currency/price/historical.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -title: "historical" -description: "Learn how to use the `obb.equity.price.historical` function to load historical price data for a specific stock ticker. Find out about the available parameters and providers, as well as the structure of the returned data and the columns it contains." -keywords: -- equity historical price -- load stock data -- specific ticker -- python function -- equity data parameters -- alpha vantage provider -- fmp provider -- intrinio provider -- polygon provider -- yfinance provider -- equity historical data returns -- equity data columns -- alpha vantage data columns -- cboe data columns -- fmp data columns -- intrinio data columns -- polygon data columns -- yfinance data columns ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Currency Historical Price. Currency historical data. - -Currency historical prices refer to the past exchange rates of one currency against -another over a specific period. -This data provides insight into the fluctuations and trends in the foreign exchange market, -helping analysts, traders, and economists understand currency performance, -evaluate economic health, and make predictions about future movements. - - -Examples --------- - -```python -from openbb import obb -obb.currency.price.historical(symbol='EURUSD', provider='fmp') -# Filter historical data with specific start and end date. -obb.currency.price.historical(symbol='EURUSD', start_date='2023-01-01', end_date='2023-12-31', provider='fmp') -# Get data with different granularity. -obb.currency.price.historical(symbol='EURUSD', provider='polygon', interval=15m) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'] | Time interval of the data to return. | 1d | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | str | Time 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 | 1d | True | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'] | Time interval of the data to return. | 1d | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance. | | False | -| 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['fmp', 'polygon', 'tiingo', '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 | -| interval | Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q'] | Time interval of the data to return. | 1d | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CurrencyHistorical - Serializable results. - provider : Literal['fmp', 'polygon', 'tiingo', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | -| adj_close | float | The adjusted close price. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | -| vwap | float, Gt(gt=0) | Volume Weighted Average Price over the period. | - - - - diff --git a/website/content/platform/reference/currency/price/index.mdx b/website/content/platform/reference/currency/price/index.mdx deleted file mode 100644 index 455fd0560b4d..000000000000 --- a/website/content/platform/reference/currency/price/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ -# Price - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - -
- diff --git a/website/content/platform/reference/currency/reference_rates.md b/website/content/platform/reference/currency/reference_rates.md deleted file mode 100644 index 3f028ba75da2..000000000000 --- a/website/content/platform/reference/currency/reference_rates.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -title: "reference_rates" -description: "Current, official, currency reference rates" -keywords: -- currency -- reference_rates ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Current, official, currency reference rates. - -Foreign exchange reference rates are the exchange rates set by a major financial institution or regulatory body, -serving as a benchmark for the value of currencies around the world. -These rates are used as a standard to facilitate international trade and financial transactions, -ensuring consistency and reliability in currency conversion. -They are typically updated on a daily basis and reflect the market conditions at a specific time. -Central banks and financial institutions often use these rates to guide their own exchange rates, -impacting global trade, loans, and investments. - - -Examples --------- - -```python -from openbb import obb -obb.currency.reference_rates(provider='ecb') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CurrencyReferenceRates - Serializable results. - provider : Literal['ecb'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| EUR | float | Euro. | -| USD | float | US Dollar. | -| JPY | float | Japanese Yen. | -| BGN | float | Bulgarian Lev. | -| CZK | float | Czech Koruna. | -| DKK | float | Danish Krone. | -| GBP | float | Pound Sterling. | -| HUF | float | Hungarian Forint. | -| PLN | float | Polish Zloty. | -| RON | float | Romanian Leu. | -| SEK | float | Swedish Krona. | -| CHF | float | Swiss Franc. | -| ISK | float | Icelandic Krona. | -| NOK | float | Norwegian Krone. | -| TRY | float | Turkish Lira. | -| AUD | float | Australian Dollar. | -| BRL | float | Brazilian Real. | -| CAD | float | Canadian Dollar. | -| CNY | float | Chinese Yuan. | -| HKD | float | Hong Kong Dollar. | -| IDR | float | Indonesian Rupiah. | -| ILS | float | Israeli Shekel. | -| INR | float | Indian Rupee. | -| KRW | float | South Korean Won. | -| MXN | float | Mexican Peso. | -| MYR | float | Malaysian Ringgit. | -| NZD | float | New Zealand Dollar. | -| PHP | float | Philippine Peso. | -| SGD | float | Singapore Dollar. | -| THB | float | Thai Baht. | -| ZAR | float | South African Rand. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| EUR | float | Euro. | -| USD | float | US Dollar. | -| JPY | float | Japanese Yen. | -| BGN | float | Bulgarian Lev. | -| CZK | float | Czech Koruna. | -| DKK | float | Danish Krone. | -| GBP | float | Pound Sterling. | -| HUF | float | Hungarian Forint. | -| PLN | float | Polish Zloty. | -| RON | float | Romanian Leu. | -| SEK | float | Swedish Krona. | -| CHF | float | Swiss Franc. | -| ISK | float | Icelandic Krona. | -| NOK | float | Norwegian Krone. | -| TRY | float | Turkish Lira. | -| AUD | float | Australian Dollar. | -| BRL | float | Brazilian Real. | -| CAD | float | Canadian Dollar. | -| CNY | float | Chinese Yuan. | -| HKD | float | Hong Kong Dollar. | -| IDR | float | Indonesian Rupiah. | -| ILS | float | Israeli Shekel. | -| INR | float | Indian Rupee. | -| KRW | float | South Korean Won. | -| MXN | float | Mexican Peso. | -| MYR | float | Malaysian Ringgit. | -| NZD | float | New Zealand Dollar. | -| PHP | float | Philippine Peso. | -| SGD | float | Singapore Dollar. | -| THB | float | Thai Baht. | -| ZAR | float | South African Rand. | - - - - diff --git a/website/content/platform/reference/currency/search.md b/website/content/platform/reference/currency/search.md deleted file mode 100644 index 72e14c4e1cf3..000000000000 --- a/website/content/platform/reference/currency/search.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -title: "search" -description: "Learn how to search for available currency pairs using the `obb.currency.search` function, and retrieve a list of results, including provider name, warnings, chart, and metadata. Explore the various parameters such as provider, symbol, date, search terms, active tickers, order data, sort field, and limit. Dive into the details of the returned data, including name, symbol, currency, stock exchange, exchange short name, code, base currency, quote currency, market, locale, currency symbol, currency name, base currency symbol, base currency name, last updated timestamp in UTC, and delisted timestamp in UTC." -keywords: -- currency search -- available currency pairs -- obb.currency.search -- provider -- symbol -- date -- search terms -- active tickers -- order data -- sort field -- limit -- results -- warnings -- chart -- metadata -- name -- symbol -- currency -- stock exchange -- exchange short name -- code -- base currency -- quote currency -- market -- locale -- currency symbol -- currency name -- base currency symbol -- base currency name -- last updated utc -- delisted utc ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Currency Search. - -Search available currency pairs. -Currency pairs are the national currencies from two countries coupled for trading on -the foreign exchange (FX) marketplace. -Both currencies will have exchange rates on which the trade will have its position basis. -All trading within the forex market, whether selling, buying, or trading, will take place through currency pairs. -(ref: Investopedia) -Major currency pairs include pairs such as EUR/USD, USD/JPY, GBP/USD, etc. - - -Examples --------- - -```python -from openbb import obb -obb.currency.search(provider='intrinio') -# Search for 'EURUSD' currency pair using 'intrinio' as provider. -obb.currency.search(provider='intrinio', symbol=EURUSD) -# Search for actively traded currency pairs on the queried date using 'polygon' as provider. -obb.currency.search(provider='polygon', date=2024-01-02, active=True) -# Search for terms using 'polygon' as provider. -obb.currency.search(provider='polygon', search=Euro zone) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'intrinio', 'polygon'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'intrinio', 'polygon'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'intrinio', 'polygon'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'intrinio', 'polygon'] | 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 | -| symbol | str | Symbol of the pair to search. | None | True | -| date | Union[date, str] | A specific date to get data for. | None | True | -| search | str | Search for terms within the ticker and/or company name. | | True | -| active | bool | Specify if the tickers returned should be actively traded on the queried date. | True | True | -| order | Literal['asc', 'desc'] | Order data by ascending or descending. | asc | True | -| sort | Literal['ticker', 'name', 'market', 'locale', 'currency_symbol', 'currency_name', 'base_currency_symbol', 'base_currency_name', 'last_updated_utc', 'delisted_utc'] | Sort field used for ordering. | | True | -| limit | int, Gt(gt=0) | The number of data entries to return. | 1000 | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CurrencyPairs - Serializable results. - provider : Literal['fmp', 'intrinio', 'polygon'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the currency pair. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the currency pair. | -| symbol | str | Symbol of the currency pair. | -| currency | str | Base currency of the currency pair. | -| stock_exchange | str | Stock exchange of the currency pair. | -| exchange_short_name | str | Short name of the stock exchange of the currency pair. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the currency pair. | -| code | str | Code of the currency pair. | -| base_currency | str | ISO 4217 currency code of the base currency. | -| quote_currency | str | ISO 4217 currency code of the quote currency. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name of the currency pair. | -| market | str | Name of the trading market. Always 'fx'. | -| locale | str | Locale of the currency pair. | -| currency_symbol | str | The symbol of the quote currency. | -| currency_name | str | Name of the quote currency. | -| base_currency_symbol | str | The symbol of the base currency. | -| base_currency_name | str | Name of the base currency. | -| last_updated_utc | datetime | The last updated timestamp in UTC. | -| delisted_utc | datetime | The delisted timestamp in UTC. | - - - - diff --git a/website/content/platform/reference/currency/snapshots.md b/website/content/platform/reference/currency/snapshots.md deleted file mode 100644 index adc7079ee2ee..000000000000 --- a/website/content/platform/reference/currency/snapshots.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: "snapshots" -description: "Snapshots of currency exchange rates from an indirect or direct perspective of a base currency" -keywords: -- currency -- snapshots ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Snapshots of currency exchange rates from an indirect or direct perspective of a base currency. - - -Examples --------- - -```python -from openbb import obb -obb.currency.snapshots(provider='fmp') -# Get exchange rates from USD and XAU to EUR, JPY, and GBP using 'fmp' as provider. -obb.currency.snapshots(provider='fmp', base='USD,XAU', counter_currencies='EUR,JPY,GBP', quote_type='indirect') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| base | Union[str, List[str]] | The base currency symbol. Multiple items allowed for provider(s): fmp. | usd | True | -| quote_type | Literal['direct', 'indirect'] | Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency. | indirect | True | -| counter_currencies | Union[str, List[str]] | An optional list of counter currency symbols to filter for. None returns all. | None | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| base | Union[str, List[str]] | The base currency symbol. Multiple items allowed for provider(s): fmp. | usd | True | -| quote_type | Literal['direct', 'indirect'] | Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency. | indirect | True | -| counter_currencies | Union[str, List[str]] | An optional list of counter currency symbols to filter for. None returns all. | None | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CurrencySnapshots - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| base_currency | str | The base, or domestic, currency. | -| counter_currency | str | The counter, or foreign, currency. | -| last_rate | float | 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 | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| base_currency | str | The base, or domestic, currency. | -| counter_currency | str | The counter, or foreign, currency. | -| last_rate | float | 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 | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | The change in the price from the previous close. | -| change_percent | float | The change in the price from the previous close, as a normalized percent. | -| ma50 | float | The 50-day moving average. | -| ma200 | float | The 200-day moving average. | -| year_high | float | The 52-week high. | -| year_low | float | The 52-week low. | -| last_rate_timestamp | datetime | The timestamp of the last rate. | - - - - diff --git a/website/content/platform/reference/derivatives/_category_.json b/website/content/platform/reference/derivatives/_category_.json deleted file mode 100644 index 4ff53ea7f1b6..000000000000 --- a/website/content/platform/reference/derivatives/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Derivatives", - "position": 4 -} \ No newline at end of file diff --git a/website/content/platform/reference/derivatives/futures/_category_.json b/website/content/platform/reference/derivatives/futures/_category_.json deleted file mode 100644 index fc1ed6dae728..000000000000 --- a/website/content/platform/reference/derivatives/futures/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Futures", - "position": 2 -} \ No newline at end of file diff --git a/website/content/platform/reference/derivatives/futures/curve.md b/website/content/platform/reference/derivatives/futures/curve.md deleted file mode 100644 index eece5e486411..000000000000 --- a/website/content/platform/reference/derivatives/futures/curve.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: "curve" -description: "Learn about fetching historical futures price data using Python and an API. Understand the available parameters, such as symbol, date, and provider. Explore the returned results, including FuturesCurve, warnings, chart, and metadata. Analyze the data, including expiration, close price, and trading symbol." -keywords: -- futures historical price -- futures historical data -- Python -- API -- symbol -- date -- provider -- cboe -- yfinance -- results -- FuturesCurve -- warnings -- Chart -- Metadata -- expiration -- close price -- trading symbol ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Futures Term Structure, current or historical. - - -Examples --------- - -```python -from openbb import obb -obb.derivatives.futures.curve(symbol='VX', provider='cboe') -# Enter a date to get the term structure from a historical date. -obb.derivatives.futures.curve(symbol='NG', provider='yfinance', date='2023-01-01') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| date | Union[date, str] | A specific date to get data for. | None | True | -| provider | Literal['cboe', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| date | Union[date, str] | A specific date to get data for. | None | True | -| provider | Literal['cboe', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| date | Union[date, str] | A specific date to get data for. | None | True | -| provider | Literal['cboe', '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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : FuturesCurve - Serializable results. - provider : Literal['cboe', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| expiration | str | Futures expiration month. | -| price | float | The close price. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| expiration | str | Futures expiration month. | -| price | float | The close price. | -| symbol | str | The trading symbol for the tenor of future. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| expiration | str | Futures expiration month. | -| price | float | The close price. | - - - - diff --git a/website/content/platform/reference/derivatives/futures/historical.md b/website/content/platform/reference/derivatives/futures/historical.md deleted file mode 100644 index d9f31f19bfda..000000000000 --- a/website/content/platform/reference/derivatives/futures/historical.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -title: "historical" -description: "Futures Historical Price" -keywords: -- derivatives -- futures -- historical ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Historical futures prices. - - -Examples --------- - -```python -from openbb import obb -obb.derivatives.futures.historical(symbol='ES', provider='yfinance') -# Enter multiple symbols. -obb.derivatives.futures.historical(symbol='ES,NQ', provider='yfinance') -# Enter expiration dates as "YYYY-MM". -obb.derivatives.futures.historical(symbol='ES', provider='yfinance', expiration='2025-12') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): yfinance. | | False | -| 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 | -| expiration | str | Future expiry date with format YYYY-MM | None | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): yfinance. | | False | -| 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 | -| expiration | str | Future expiry date with format YYYY-MM | None | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | -| interval | Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q'] | Time interval of the data to return. | 1d | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : FuturesHistorical - Serializable results. - provider : Literal['yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | float | The trading volume. | - - - - diff --git a/website/content/platform/reference/derivatives/futures/index.mdx b/website/content/platform/reference/derivatives/futures/index.mdx deleted file mode 100644 index e82984289e05..000000000000 --- a/website/content/platform/reference/derivatives/futures/index.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Futures - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - -
- diff --git a/website/content/platform/reference/derivatives/index.mdx b/website/content/platform/reference/derivatives/index.mdx deleted file mode 100644 index c8723582e40e..000000000000 --- a/website/content/platform/reference/derivatives/index.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Derivatives - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Menus -
    - - -
- diff --git a/website/content/platform/reference/derivatives/options/_category_.json b/website/content/platform/reference/derivatives/options/_category_.json deleted file mode 100644 index 181e8d39bcc2..000000000000 --- a/website/content/platform/reference/derivatives/options/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Options", - "position": 1 -} \ No newline at end of file diff --git a/website/content/platform/reference/derivatives/options/chains.md b/website/content/platform/reference/derivatives/options/chains.md deleted file mode 100644 index 529438f74584..000000000000 --- a/website/content/platform/reference/derivatives/options/chains.md +++ /dev/null @@ -1,405 +0,0 @@ ---- -title: "chains" -description: "Learn how to get the complete options chain for a ticker using the OBB.equity.options.chains function. Explore the available parameters like symbol and provider, and understand the data returned, including contract symbol, expiration, strike price, and more." -keywords: -- options chain -- ticker -- complete options chain -- symbol -- provider -- data -- contract symbol -- expiration -- strike price -- option type -- eod date -- trading volume -- open price -- open interest -- high price -- low price -- implied volatility -- delta -- gamma -- theta -- vega -- bid size -- ask size -- theoretical value -- last trade price -- prev close -- change percent -- rho -- last trade timestamp -- dte ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the complete options chain for a ticker. - - -Examples --------- - -```python -from openbb import obb -obb.derivatives.options.chains(symbol='AAPL', provider='intrinio') -# Use the "date" parameter to get the end-of-day-data for a specific date, where supported. -obb.derivatives.options.chains(symbol='AAPL', date=2023-01-25, provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'intrinio', 'tmx', 'tradier'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'intrinio', 'tmx', 'tradier'] | 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 | -| use_cache | bool | When True, the company directories will be cached for24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'intrinio', 'tmx', 'tradier'] | 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 | -| date | Union[date, str] | The end-of-day date for options chains data. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'intrinio', 'tmx', 'tradier'] | 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 | -| date | Union[date, str] | A specific date to get data for. | None | True | -| use_cache | bool | Caching is used to validate the supplied ticker symbol, or if a historical EOD chain is requested. To bypass, set to False. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'intrinio', 'tmx', 'tradier'] | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : OptionsChains - Serializable results. - provider : Literal['cboe', 'intrinio', 'tmx', 'tradier'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option. | -| contract_symbol | str | Contract symbol for the option. | -| eod_date | date | Date for which the options chains are returned. | -| expiration | date | Expiration date of the contract. | -| strike | float | Strike price of the contract. | -| option_type | str | Call or Put. | -| open_interest | int | Open interest on the contract. | -| volume | int | The trading volume. | -| theoretical_price | float | Theoretical value of the option. | -| last_trade_price | float | Last trade price of the option. | -| tick | str | Whether the last tick was up or down in price. | -| bid | float | Current bid price for the option. | -| bid_size | int | Bid size for the option. | -| ask | float | Current ask price for the option. | -| ask_size | int | Ask size for the option. | -| mark | float | The mid-price between the latest bid and ask. | -| open | float | The open price. | -| open_bid | float | The opening bid price for the option that day. | -| open_ask | float | The opening ask price for the option that day. | -| high | float | The high price. | -| bid_high | float | The highest bid price for the option that day. | -| ask_high | float | The highest ask price for the option that day. | -| low | float | The low price. | -| bid_low | float | The lowest bid price for the option that day. | -| ask_low | float | The lowest ask price for the option that day. | -| close | float | The close price. | -| close_size | int | The closing trade size for the option that day. | -| close_time | datetime | The time of the closing price for the option that day. | -| close_bid | float | The closing bid price for the option that day. | -| close_bid_size | int | The closing bid size for the option that day. | -| close_bid_time | datetime | The time of the bid closing price for the option that day. | -| close_ask | float | The closing ask price for the option that day. | -| close_ask_size | int | The closing ask size for the option that day. | -| close_ask_time | datetime | The time of the ask closing price for the option that day. | -| prev_close | float | The previous close price. | -| change | float | The change in the price of the option. | -| change_percent | float | Change, in normalizezd percentage points, of the option. | -| implied_volatility | float | Implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option. | -| contract_symbol | str | Contract symbol for the option. | -| eod_date | date | Date for which the options chains are returned. | -| expiration | date | Expiration date of the contract. | -| strike | float | Strike price of the contract. | -| option_type | str | Call or Put. | -| open_interest | int | Open interest on the contract. | -| volume | int | The trading volume. | -| theoretical_price | float | Theoretical value of the option. | -| last_trade_price | float | Last trade price of the option. | -| tick | str | Whether the last tick was up or down in price. | -| bid | float | Current bid price for the option. | -| bid_size | int | Bid size for the option. | -| ask | float | Current ask price for the option. | -| ask_size | int | Ask size for the option. | -| mark | float | The mid-price between the latest bid and ask. | -| open | float | The open price. | -| open_bid | float | The opening bid price for the option that day. | -| open_ask | float | The opening ask price for the option that day. | -| high | float | The high price. | -| bid_high | float | The highest bid price for the option that day. | -| ask_high | float | The highest ask price for the option that day. | -| low | float | The low price. | -| bid_low | float | The lowest bid price for the option that day. | -| ask_low | float | The lowest ask price for the option that day. | -| close | float | The close price. | -| close_size | int | The closing trade size for the option that day. | -| close_time | datetime | The time of the closing price for the option that day. | -| close_bid | float | The closing bid price for the option that day. | -| close_bid_size | int | The closing bid size for the option that day. | -| close_bid_time | datetime | The time of the bid closing price for the option that day. | -| close_ask | float | The closing ask price for the option that day. | -| close_ask_size | int | The closing ask size for the option that day. | -| close_ask_time | datetime | The time of the ask closing price for the option that day. | -| prev_close | float | The previous close price. | -| change | float | The change in the price of the option. | -| change_percent | float | Change, in normalizezd percentage points, of the option. | -| implied_volatility | float | Implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | -| last_trade_timestamp | datetime | Last trade timestamp of the option. | -| dte | int | Days to expiration for the option. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option. | -| contract_symbol | str | Contract symbol for the option. | -| eod_date | date | Date for which the options chains are returned. | -| expiration | date | Expiration date of the contract. | -| strike | float | Strike price of the contract. | -| option_type | str | Call or Put. | -| open_interest | int | Open interest on the contract. | -| volume | int | The trading volume. | -| theoretical_price | float | Theoretical value of the option. | -| last_trade_price | float | Last trade price of the option. | -| tick | str | Whether the last tick was up or down in price. | -| bid | float | Current bid price for the option. | -| bid_size | int | Bid size for the option. | -| ask | float | Current ask price for the option. | -| ask_size | int | Ask size for the option. | -| mark | float | The mid-price between the latest bid and ask. | -| open | float | The open price. | -| open_bid | float | The opening bid price for the option that day. | -| open_ask | float | The opening ask price for the option that day. | -| high | float | The high price. | -| bid_high | float | The highest bid price for the option that day. | -| ask_high | float | The highest ask price for the option that day. | -| low | float | The low price. | -| bid_low | float | The lowest bid price for the option that day. | -| ask_low | float | The lowest ask price for the option that day. | -| close | float | The close price. | -| close_size | int | The closing trade size for the option that day. | -| close_time | datetime | The time of the closing price for the option that day. | -| close_bid | float | The closing bid price for the option that day. | -| close_bid_size | int | The closing bid size for the option that day. | -| close_bid_time | datetime | The time of the bid closing price for the option that day. | -| close_ask | float | The closing ask price for the option that day. | -| close_ask_size | int | The closing ask size for the option that day. | -| close_ask_time | datetime | The time of the ask closing price for the option that day. | -| prev_close | float | The previous close price. | -| change | float | The change in the price of the option. | -| change_percent | float | Change, in normalizezd percentage points, of the option. | -| implied_volatility | float | Implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | -| exercise_style | str | The exercise style of the option, American or European. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option. | -| contract_symbol | str | Contract symbol for the option. | -| eod_date | date | Date for which the options chains are returned. | -| expiration | date | Expiration date of the contract. | -| strike | float | Strike price of the contract. | -| option_type | str | Call or Put. | -| open_interest | int | Open interest on the contract. | -| volume | int | The trading volume. | -| theoretical_price | float | Theoretical value of the option. | -| last_trade_price | float | Last trade price of the option. | -| tick | str | Whether the last tick was up or down in price. | -| bid | float | Current bid price for the option. | -| bid_size | int | Bid size for the option. | -| ask | float | Current ask price for the option. | -| ask_size | int | Ask size for the option. | -| mark | float | The mid-price between the latest bid and ask. | -| open | float | The open price. | -| open_bid | float | The opening bid price for the option that day. | -| open_ask | float | The opening ask price for the option that day. | -| high | float | The high price. | -| bid_high | float | The highest bid price for the option that day. | -| ask_high | float | The highest ask price for the option that day. | -| low | float | The low price. | -| bid_low | float | The lowest bid price for the option that day. | -| ask_low | float | The lowest ask price for the option that day. | -| close | float | The close price. | -| close_size | int | The closing trade size for the option that day. | -| close_time | datetime | The time of the closing price for the option that day. | -| close_bid | float | The closing bid price for the option that day. | -| close_bid_size | int | The closing bid size for the option that day. | -| close_bid_time | datetime | The time of the bid closing price for the option that day. | -| close_ask | float | The closing ask price for the option that day. | -| close_ask_size | int | The closing ask size for the option that day. | -| close_ask_time | datetime | The time of the ask closing price for the option that day. | -| prev_close | float | The previous close price. | -| change | float | The change in the price of the option. | -| change_percent | float | Change, in normalizezd percentage points, of the option. | -| implied_volatility | float | Implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | -| transactions | int | Number of transactions for the contract. | -| total_value | float | Total value of the transactions. | -| settlement_price | float | Settlement price on that date. | -| underlying_price | float | Price of the underlying stock on that date. | -| dte | int | Days to expiration for the option. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option. | -| contract_symbol | str | Contract symbol for the option. | -| eod_date | date | Date for which the options chains are returned. | -| expiration | date | Expiration date of the contract. | -| strike | float | Strike price of the contract. | -| option_type | str | Call or Put. | -| open_interest | int | Open interest on the contract. | -| volume | int | The trading volume. | -| theoretical_price | float | Theoretical value of the option. | -| last_trade_price | float | Last trade price of the option. | -| tick | str | Whether the last tick was up or down in price. | -| bid | float | Current bid price for the option. | -| bid_size | int | Bid size for the option. | -| ask | float | Current ask price for the option. | -| ask_size | int | Ask size for the option. | -| mark | float | The mid-price between the latest bid and ask. | -| open | float | The open price. | -| open_bid | float | The opening bid price for the option that day. | -| open_ask | float | The opening ask price for the option that day. | -| high | float | The high price. | -| bid_high | float | The highest bid price for the option that day. | -| ask_high | float | The highest ask price for the option that day. | -| low | float | The low price. | -| bid_low | float | The lowest bid price for the option that day. | -| ask_low | float | The lowest ask price for the option that day. | -| close | float | The close price. | -| close_size | int | The closing trade size for the option that day. | -| close_time | datetime | The time of the closing price for the option that day. | -| close_bid | float | The closing bid price for the option that day. | -| close_bid_size | int | The closing bid size for the option that day. | -| close_bid_time | datetime | The time of the bid closing price for the option that day. | -| close_ask | float | The closing ask price for the option that day. | -| close_ask_size | int | The closing ask size for the option that day. | -| close_ask_time | datetime | The time of the ask closing price for the option that day. | -| prev_close | float | The previous close price. | -| change | float | The change in the price of the option. | -| change_percent | float | Change, in normalizezd percentage points, of the option. | -| implied_volatility | float | Implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | -| phi | float | Phi of the option. The sensitivity of the option relative to dividend yield. | -| bid_iv | float | Implied volatility of the bid price. | -| ask_iv | float | Implied volatility of the ask price. | -| orats_final_iv | float | ORATS final implied volatility of the option, updated once per hour. | -| year_high | float | 52-week high price of the option. | -| year_low | float | 52-week low price of the option. | -| last_trade_volume | int | Volume of the last trade. | -| dte | int | Days to expiration. | -| contract_size | int | Size of the contract. | -| bid_exchange | str | Exchange of the bid price. | -| bid_timestamp | datetime | Timestamp of the bid price. | -| ask_exchange | str | Exchange of the ask price. | -| ask_timestamp | datetime | Timestamp of the ask price. | -| greeks_timestamp | datetime | Timestamp of the last greeks update. Greeks/IV data is updated once per hour. | -| last_trade_timestamp | datetime | Timestamp of the last trade. | - - - - diff --git a/website/content/platform/reference/derivatives/options/index.mdx b/website/content/platform/reference/derivatives/options/index.mdx deleted file mode 100644 index 0e3fce34ce2b..000000000000 --- a/website/content/platform/reference/derivatives/options/index.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Options - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - -
- diff --git a/website/content/platform/reference/derivatives/options/unusual.md b/website/content/platform/reference/derivatives/options/unusual.md deleted file mode 100644 index 5b556820869e..000000000000 --- a/website/content/platform/reference/derivatives/options/unusual.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: "unusual" -description: "Learn how to get the complete options chain for a ticker with the equity options unusual API. Explore the available parameters such as symbol and provider. Retrieve valuable data like the underlying symbol, contract symbol, trade type, sentiment, total value, total size, average price, ask/bid prices at execution, underlying price at execution, and timestamp." -keywords: -- complete options chain -- ticker options -- equity options unusual -- symbol -- provider -- intrinio -- source -- data -- underlying symbol -- contract symbol -- trade type -- sentiment -- total value -- total size -- average price -- ask at execution -- bid at execution -- underlying price at execution -- timestamp ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the complete options chain for a ticker. - - -Examples --------- - -```python -from openbb import obb -obb.derivatives.options.unusual(provider='intrinio') -# Use the 'symbol' parameter to get the most recent activity for a specific symbol. -obb.derivatives.options.unusual(symbol='TSLA', provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (the underlying symbol) | None | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (the underlying symbol) | None | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | -| start_date | Union[date, str] | 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. | None | True | -| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date. | None | True | -| trade_type | Literal['block', 'sweep', 'large'] | The type of unusual activity to query for. | None | True | -| sentiment | Literal['bullish', 'bearish', 'neutral'] | The sentiment type to query for. | None | True | -| min_value | Union[int, float] | The inclusive minimum total value for the unusual activity. | None | True | -| max_value | Union[int, float] | The inclusive maximum total value for the unusual activity. | None | True | -| limit | int | 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. | 100000 | True | -| source | Literal['delayed', 'realtime'] | The source of the data. Either realtime or delayed. | delayed | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : OptionsUnusual - Serializable results. - provider : Literal['intrinio'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| underlying_symbol | str | Symbol representing the entity requested in the data. (the underlying symbol) | -| contract_symbol | str | Contract symbol for the option. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| underlying_symbol | str | Symbol representing the entity requested in the data. (the underlying symbol) | -| contract_symbol | str | Contract symbol for the option. | -| trade_timestamp | datetime | The datetime of order placement. | -| trade_type | Literal['block', 'sweep', 'large'] | The type of unusual trade. | -| sentiment | Literal['bullish', 'bearish', 'neutral'] | Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price. | -| bid_at_execution | float | Bid price at execution. | -| ask_at_execution | float | Ask price at execution. | -| average_price | float | The average premium paid per option contract. | -| underlying_price_at_execution | float | Price of the underlying security at execution of trade. | -| total_size | int | The total number of contracts involved in a single transaction. | -| total_value | Union[int, float] | The aggregated value of all option contract premiums included in the trade. | - - - - diff --git a/website/content/platform/reference/econometrics/_category_.json b/website/content/platform/reference/econometrics/_category_.json deleted file mode 100644 index 2a15de19e8aa..000000000000 --- a/website/content/platform/reference/econometrics/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Econometrics", - "position": 6 -} \ No newline at end of file diff --git a/website/content/platform/reference/econometrics/autocorrelation.md b/website/content/platform/reference/econometrics/autocorrelation.md deleted file mode 100644 index a1c984d3f68c..000000000000 --- a/website/content/platform/reference/econometrics/autocorrelation.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "autocorrelation" -description: "Learn how to perform the Durbin-Watson test for autocorrelation in Python. Understand the parameters and return value of the function, and how to use exogenous variables in the analysis. This documentation provides a detailed explanation." -keywords: -- Durbin-Watson test -- autocorrelation -- Python -- data analysis -- exogenous variables -- parameter -- return -- documentation ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform Durbin-Watson test for autocorrelation. - - The Durbin-Watson test is a widely used method for detecting the presence of autocorrelation in the residuals - from a statistical or econometric model. Autocorrelation occurs when past values in the data series influence - future values, which can be a critical issue in time-series analysis, affecting the reliability of - model predictions. The test provides a statistic that ranges from 0 to 4, where a value around 2 suggests - no autocorrelation, values towards 0 indicate positive autocorrelation, and values towards 4 suggest - negative autocorrelation. Understanding the degree of autocorrelation helps in refining models to better capture - the underlying dynamics of the data, ensuring more accurate and trustworthy results. - - -Examples --------- - -```python -from openbb import obb -# Perform Durbin-Watson test for autocorrelation. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.econometrics.autocorrelation(data=stock_data, y_column="close", x_columns=["open", "high", "low"]) -obb.econometrics.autocorrelation(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| y_column | str | Target column. | | False | -| x_columns | List[str] | List of columns to use as exogenous variables. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Dict - OBBject with the results being the score from the test. -``` - diff --git a/website/content/platform/reference/econometrics/causality.md b/website/content/platform/reference/econometrics/causality.md deleted file mode 100644 index d5c7aefc0cee..000000000000 --- a/website/content/platform/reference/econometrics/causality.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "causality" -description: "Learn how to perform a Granger causality test to determine if X causes y. Understand the parameters and the results returned by the test." -keywords: -- Granger causality test -- causality -- perform -- determine -- exogenous variables -- lags -- data -- target column -- results ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform Granger causality test to determine if X 'causes' y. - - The Granger causality test is a statistical hypothesis test to determine if one time series is useful in - forecasting another. While 'causality' in this context does not imply a cause-and-effect relationship in - the philosophical sense, it does test whether changes in one variable are systematically followed by changes - in another variable, suggesting a predictive relationship. By specifying a lag, you set the number of periods to - look back in the time series to assess this relationship. This test is particularly useful in economic and - financial data analysis, where understanding the lead-lag relationship between indicators can inform investment - decisions and policy making. - - -Examples --------- - -```python -from openbb import obb -# Perform Granger causality test to determine if X 'causes' y. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.econometrics.causality(data=stock_data, y_column="close", x_column="open") -# Example with mock data. -obb.econometrics.causality(y_column='close', x_column='open', lag=1, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| y_column | str | Target column. | | False | -| x_column | str | Columns to use as exogenous variables. | | False | -| lag | PositiveInt | Number of lags to use in the test. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Data - OBBject with the results being the score from the test. -``` - diff --git a/website/content/platform/reference/econometrics/cointegration.md b/website/content/platform/reference/econometrics/cointegration.md deleted file mode 100644 index a698ac5f3342..000000000000 --- a/website/content/platform/reference/econometrics/cointegration.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "cointegration" -description: "Learn how to use the two-step Engle-Granger test to show co-integration between two time series in Python. Explore the parameters, input dataset, data columns, and the OBBject returned with the test results." -keywords: -- co-integration -- Engle-Granger test -- time series -- data -- columns -- cointegration -- maxlag -- Python ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Show co-integration between two timeseries using the two step Engle-Granger test. - - The two-step Engle-Granger test is a method designed to detect co-integration between two time series. - Co-integration is a statistical property indicating that two or more time series move together over the long term, - even if they are individually non-stationary. This concept is crucial in economics and finance, where identifying - pairs or groups of assets that share a common stochastic trend can inform long-term investment strategies - and risk management practices. The Engle-Granger test first checks for a stable, long-term relationship by - regressing one time series on the other and then tests the residuals for stationarity. - If the residuals are found to be stationary, it suggests that despite any short-term deviations, - the series are bound by an equilibrium relationship over time. - - -Examples --------- - -```python -from openbb import obb -# Perform co-integration test between two timeseries. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.econometrics.cointegration(data=stock_data, columns=["open", "close"]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| columns | List[str] | Data columns to check cointegration | | False | -| maxlag | PositiveInt | Number of lags to use in the test. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Data - OBBject with the results being the score from the test. -``` - diff --git a/website/content/platform/reference/econometrics/correlation_matrix.md b/website/content/platform/reference/econometrics/correlation_matrix.md deleted file mode 100644 index cc74144a5ffd..000000000000 --- a/website/content/platform/reference/econometrics/correlation_matrix.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "correlation_matrix" -description: "Learn how to get the correlation matrix of an input dataset using Python. Find information on the parameters and return value of the function." -keywords: -- correlation matrix -- input dataset -- Python ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the correlation matrix of an input dataset. - - The correlation matrix provides a view of how different variables in your dataset relate to one another. - By quantifying the degree to which variables move in relation to each other, this matrix can help identify patterns, - trends, and potential areas for deeper analysis. The correlation score ranges from -1 to 1, with -1 indicating a - perfect negative correlation, 0 indicating no correlation, and 1 indicating a perfect positive correlation. - - -Examples --------- - -```python -from openbb import obb -# Get the correlation matrix of a dataset. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.econometrics.correlation_matrix(data=stock_data) -obb.econometrics.correlation_matrix(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - Correlation matrix. -``` - diff --git a/website/content/platform/reference/econometrics/index.mdx b/website/content/platform/reference/econometrics/index.mdx deleted file mode 100644 index 48b4a264f0c4..000000000000 --- a/website/content/platform/reference/econometrics/index.mdx +++ /dev/null @@ -1,22 +0,0 @@ -# Econometrics - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - - - - - - - - - - - -
- diff --git a/website/content/platform/reference/econometrics/ols_regression.md b/website/content/platform/reference/econometrics/ols_regression.md deleted file mode 100644 index 8f0ceae5f386..000000000000 --- a/website/content/platform/reference/econometrics/ols_regression.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "ols_regression" -description: "Learn how to perform OLS regression using statsmodels in Python. This documentation explains the parameters required and the object returned." -keywords: -- OLS regression -- statsmodels -- perform OLS regression -- data -- target column -- exogenous variables -- model -- results objects ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform Ordinary Least Squares (OLS) regression. - - OLS regression is a fundamental statistical method to explore and model the relationship between a - dependent variable and one or more independent variables. By fitting the best possible linear equation to the data, - it helps uncover how changes in the independent variables are associated with changes in the dependent variable. - This returns the model and results objects from statsmodels library. - - -Examples --------- - -```python -from openbb import obb -# Perform Ordinary Least Squares (OLS) regression. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.econometrics.ols_regression(data=stock_data, y_column="close", x_columns=["open", "high", "low"]) -obb.econometrics.ols_regression(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| y_column | str | Target column. | | False | -| x_columns | List[str] | List of columns to use as exogenous variables. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Dict - OBBject with the results being model and results objects. -``` - diff --git a/website/content/platform/reference/econometrics/ols_regression_summary.md b/website/content/platform/reference/econometrics/ols_regression_summary.md deleted file mode 100644 index d0ade639a8fd..000000000000 --- a/website/content/platform/reference/econometrics/ols_regression_summary.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "ols_regression_summary" -description: "Learn how to perform OLS regression using statsmodels in Python. Explore the parameters and returns of the function, including the data, target column, exogenous variables, and summary object." -keywords: -- OLS regression -- statsmodels -- summary object -- parameters -- data -- y_column -- x_columns -- exogenous variables -- returns -- OBBject -- model ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform Ordinary Least Squares (OLS) regression. - - This returns the summary object from statsmodels. - - -Examples --------- - -```python -from openbb import obb -# Perform Ordinary Least Squares (OLS) regression and return the summary. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.econometrics.ols_regression_summary(data=stock_data, y_column="close", x_columns=["open", "high", "low"]) -obb.econometrics.ols_regression_summary(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| y_column | str | Target column. | | False | -| x_columns | List[str] | List of columns to use as exogenous variables. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Data - OBBject with the results being summary object. -``` - diff --git a/website/content/platform/reference/econometrics/panel_between.md b/website/content/platform/reference/econometrics/panel_between.md deleted file mode 100644 index d6a55795c588..000000000000 --- a/website/content/platform/reference/econometrics/panel_between.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "panel_between" -description: "Perform a Between estimator regression on panel data. This page provides details on the parameters required and the returned OBBject with the fit model." -keywords: -- Between estimator -- regression -- panel data -- perform -- parameters -- data -- y_column -- x_columns -- exogenous variables -- returns -- fit model ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform a Between estimator regression on panel data. - - The Between estimator for regression analysis on panel data is focusing on the differences between entities - (such as individuals, companies, or countries) over time. By aggregating the data for each entity and analyzing the - average outcomes, this method provides insights into the overall impact of explanatory variables (x_columns) on - the dependent variable (y_column) across all entities. - - -Examples --------- - -```python -from openbb import obb -obb.econometrics.panel_between(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| y_column | str | Target column. | | False | -| x_columns | List[str] | List of columns to use as exogenous variables. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Dict - OBBject with the fit model returned -``` - diff --git a/website/content/platform/reference/econometrics/panel_first_difference.md b/website/content/platform/reference/econometrics/panel_first_difference.md deleted file mode 100644 index 8fbed9146f14..000000000000 --- a/website/content/platform/reference/econometrics/panel_first_difference.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "panel_first_difference" -description: "Learn how to perform a first-difference estimate for panel data using this Python function. Understand the parameters and the object returned by the function." -keywords: -- panel data -- first-difference estimate -- perform -- parameters -- data -- dataset -- target column -- exogenous variables -- fit model ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform a first-difference estimate for panel data. - - The First-Difference estimator for panel data analysis is focusing on the changes between consecutive observations - for each entity (such as individuals, companies, or countries). By differencing the data, this method effectively - removes entity-specific effects that are constant over time, allowing for the examination of the impact of changes - in explanatory variables (x_columns) on the change in the dependent variable (y_column). - - -Examples --------- - -```python -from openbb import obb -obb.econometrics.panel_first_difference(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| y_column | str | Target column. | | False | -| x_columns | List[str] | List of columns to use as exogenous variables. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Dict - OBBject with the fit model returned -``` - diff --git a/website/content/platform/reference/econometrics/panel_fixed.md b/website/content/platform/reference/econometrics/panel_fixed.md deleted file mode 100644 index 9abbc1afae9c..000000000000 --- a/website/content/platform/reference/econometrics/panel_fixed.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "panel_fixed" -description: "Learn about the one- and two-way fixed effects estimator for panel data analysis. Explore the parameters and returns of this function for panel data regression and modeling." -keywords: -- panel data -- fixed effects estimator -- panel data analysis -- two-way fixed effects -- panel data regression -- panel data modeling ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -One- and two-way fixed effects estimator for panel data. - - The Fixed Effects estimator to panel data is enabling a focused analysis on the unique characteristics of entities - (such as individuals, companies, or countries) and/or time periods. By controlling for entity-specific and/or - time-specific influences, this method isolates the effect of explanatory variables (x_columns) on the dependent - variable (y_column), under the assumption that these entity or time effects capture unobserved heterogeneity. - - -Examples --------- - -```python -from openbb import obb -obb.econometrics.panel_fixed(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| y_column | str | Target column. | | False | -| x_columns | List[str] | List of columns to use as exogenous variables. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Dict - OBBject with the fit model returned -``` - diff --git a/website/content/platform/reference/econometrics/panel_fmac.md b/website/content/platform/reference/econometrics/panel_fmac.md deleted file mode 100644 index 8de179e56529..000000000000 --- a/website/content/platform/reference/econometrics/panel_fmac.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "panel_fmac" -description: "Learn how to use the Fama-MacBeth estimator for panel data analysis in Python. Understand the parameters required and how to specify the input dataset and target column. Explore how this function can help you analyze panel data by incorporating exogenous variables." -keywords: -- Fama-MacBeth estimator -- panel data analysis -- Python function -- parameters -- exogenous variables ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Fama-MacBeth estimator for panel data. - - The Fama-MacBeth estimator, a two-step procedure renowned for its application in finance to estimate the risk - premiums and evaluate the capital asset pricing model. By first estimating cross-sectional regressions for each - time period and then averaging the regression coefficients over time, this method provides insights into the - relationship between the dependent variable (y_column) and explanatory variables (x_columns) across different - entities (such as individuals, companies, or countries). - - -Examples --------- - -```python -from openbb import obb -obb.econometrics.panel_fmac(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| y_column | str | Target column. | | False | -| x_columns | List[str] | List of columns to use as exogenous variables. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Dict - OBBject with the fit model returned -``` - diff --git a/website/content/platform/reference/econometrics/panel_pooled.md b/website/content/platform/reference/econometrics/panel_pooled.md deleted file mode 100644 index ada1531fe773..000000000000 --- a/website/content/platform/reference/econometrics/panel_pooled.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "panel_pooled" -description: "Learn how to perform a pooled coefficient estimator regression on panel data in Python. Understand the parameters and return value of the function." -keywords: -- pooled coefficient estimator regression -- panel data -- Python -- data analysis -- exogenous variables ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform a Pooled coefficient estimator regression on panel data. - - The Pooled coefficient estimator for regression analysis on panel data is treating the data as a large - cross-section without distinguishing between variations across time or entities - (such as individuals, companies, or countries). By assuming that the explanatory variables (x_columns) have a - uniform effect on the dependent variable (y_column) across all entities and time periods, this method simplifies - the analysis and provides a generalized view of the relationships within the data. - - -Examples --------- - -```python -from openbb import obb -obb.econometrics.panel_pooled(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| y_column | str | Target column. | | False | -| x_columns | List[str] | List of columns to use as exogenous variables. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Dict - OBBject with the fit model returned -``` - diff --git a/website/content/platform/reference/econometrics/panel_random_effects.md b/website/content/platform/reference/econometrics/panel_random_effects.md deleted file mode 100644 index 7c8bc67ccd4f..000000000000 --- a/website/content/platform/reference/econometrics/panel_random_effects.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "panel_random_effects" -description: "Learn how to perform One-way Random Effects model for panel data using a Python function. This function takes an input dataset, target column, and exogenous variables as parameters and returns the fit model." -keywords: -- One-way Random Effects model -- panel data -- perform -- Python function ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform One-way Random Effects model for panel data. - - One-way Random Effects model to panel data is offering a nuanced approach to analyzing data that spans across both - time and entities (such as individuals, companies, countries, etc.). By acknowledging and modeling the random - variation that exists within these entities, this method provides insights into the general patterns that - emerge across the dataset. - - -Examples --------- - -```python -from openbb import obb -obb.econometrics.panel_random_effects(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': "['asset_manager', 'time']", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| y_column | str | Target column. | | False | -| x_columns | List[str] | List of columns to use as exogenous variables. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Dict - OBBject with the fit model returned -``` - diff --git a/website/content/platform/reference/econometrics/residual_autocorrelation.md b/website/content/platform/reference/econometrics/residual_autocorrelation.md deleted file mode 100644 index 3a9f94fdaca5..000000000000 --- a/website/content/platform/reference/econometrics/residual_autocorrelation.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "residual_autocorrelation" -description: "Perform Breusch-Godfrey Lagrange Multiplier tests for residual autocorrelation in a Python function. Learn about the parameters used and the returned object." -keywords: -- Breusch-Godfrey Lagrange Multiplier tests -- residual autocorrelation -- Python function -- parameter description -- function returns ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform Breusch-Godfrey Lagrange Multiplier tests for residual autocorrelation. - - The Breusch-Godfrey Lagrange Multiplier test is a sophisticated tool for uncovering autocorrelation within the - residuals of a regression model. Autocorrelation in residuals can indicate that a model fails to capture some - aspect of the underlying data structure, possibly leading to biased or inefficient estimates. - By specifying the number of lags, you can control the depth of the test to check for autocorrelation, - allowing for a tailored analysis that matches the specific characteristics of your data. - This test is particularly valuable in econometrics and time-series analysis, where understanding the independence - of errors is crucial for model validity. - - -Examples --------- - -```python -from openbb import obb -# Perform Breusch-Godfrey Lagrange Multiplier tests for residual autocorrelation. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.econometrics.residual_autocorrelation(data=stock_data, y_column="close", x_columns=["open", "high", "low"]) -obb.econometrics.residual_autocorrelation(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| y_column | str | Target column. | | False | -| x_columns | List[str] | List of columns to use as exogenous variables. | | False | -| lags | PositiveInt | Number of lags to use in the test. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Data - OBBject with the results being the score from the test. -``` - diff --git a/website/content/platform/reference/econometrics/unit_root.md b/website/content/platform/reference/econometrics/unit_root.md deleted file mode 100644 index bdfa61dd6ceb..000000000000 --- a/website/content/platform/reference/econometrics/unit_root.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: "unit_root" -description: "Learn how to use the Augmented Dickey-Fuller unit root test to check for stationarity in time series data. This function takes in an input dataset and performs the test on specified data columns. The regression type can be customized, and the function returns the results." -keywords: -- Augmented Dickey-Fuller -- unit root test -- data -- data columns -- unit root -- regression -- constant -- trend -- trend-squared -- results ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform Augmented Dickey-Fuller (ADF) unit root test. - - The ADF test is a popular method for testing the presence of a unit root in a time series. - A unit root indicates that the series may be non-stationary, meaning its statistical properties such as mean, - variance, and autocorrelation can change over time. The presence of a unit root suggests that the time series might - be influenced by a random walk process, making it unpredictable and challenging for modeling and forecasting. - The 'regression' parameter allows you to specify the model used in the test: 'c' for a constant term, - 'ct' for a constant and trend term, and 'ctt' for a constant, linear, and quadratic trend. - This flexibility helps tailor the test to the specific characteristics of your data, providing a more accurate - assessment of its stationarity. - - -Examples --------- - -```python -from openbb import obb -# Perform Augmented Dickey-Fuller (ADF) unit root test. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.econometrics.unit_root(data=stock_data, column="close") -obb.econometrics.unit_root(data=stock_data, column="close", regression="ct") -obb.econometrics.unit_root(column='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Input dataset. | | False | -| column | str | Data columns to check unit root | | False | -| regression | Literal["c", "ct", "ctt"] | Regression type to use in the test. Either "c" for constant only, "ct" for constant and trend, or "ctt" for | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Data - OBBject with the results being the score from the test. -``` - diff --git a/website/content/platform/reference/economy/_category_.json b/website/content/platform/reference/economy/_category_.json deleted file mode 100644 index a848a9d5b05a..000000000000 --- a/website/content/platform/reference/economy/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Economy", - "position": 3 -} \ No newline at end of file diff --git a/website/content/platform/reference/economy/balance_of_payments.md b/website/content/platform/reference/economy/balance_of_payments.md deleted file mode 100644 index af87dae33217..000000000000 --- a/website/content/platform/reference/economy/balance_of_payments.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -title: "balance_of_payments" -description: "Balance of Payments Reports" -keywords: -- economy -- balance_of_payments ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Balance of Payments Reports. - - -Examples --------- - -```python -from openbb import obb -obb.economy.balance_of_payments(provider='ecb') -obb.economy.balance_of_payments(report_type=summary, provider='ecb') -# The `country` parameter will override the `report_type`. -obb.economy.balance_of_payments(country=united_states, provider='ecb') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | -| report_type | Literal['main', 'summary', 'services', 'investment_income', 'direct_investment', 'portfolio_investment', 'other_investment'] | The report type, the level of detail in the data. | main | True | -| frequency | Literal['monthly', 'quarterly'] | The frequency of the data. Monthly is valid only for ['main', 'summary']. | monthly | True | -| country | Literal['brazil', 'canada', 'china', 'eu_ex_euro_area', 'eu_institutions', 'india', 'japan', 'russia', 'switzerland', 'united_kingdom', 'united_states', 'total'] | The country/region of the data. This parameter will override the 'report_type' parameter. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : BalanceOfPayments - Serializable results. - provider : Literal['ecb'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period | date | The date representing the beginning of the reporting period. | -| current_account | float | Current Account Balance (Billions of EUR) | -| goods | float | Goods Balance (Billions of EUR) | -| services | float | Services Balance (Billions of EUR) | -| primary_income | float | Primary Income Balance (Billions of EUR) | -| secondary_income | float | Secondary Income Balance (Billions of EUR) | -| capital_account | float | Capital Account Balance (Billions of EUR) | -| net_lending_to_rest_of_world | float | Balance of net lending to the rest of the world (Billions of EUR) | -| financial_account | float | Financial Account Balance (Billions of EUR) | -| direct_investment | float | Direct Investment Balance (Billions of EUR) | -| portfolio_investment | float | Portfolio Investment Balance (Billions of EUR) | -| financial_derivatives | float | Financial Derivatives Balance (Billions of EUR) | -| other_investment | float | Other Investment Balance (Billions of EUR) | -| reserve_assets | float | Reserve Assets Balance (Billions of EUR) | -| errors_and_ommissions | float | Errors and Omissions (Billions of EUR) | -| current_account_credit | float | Current Account Credits (Billions of EUR) | -| current_account_debit | float | Current Account Debits (Billions of EUR) | -| current_account_balance | float | Current Account Balance (Billions of EUR) | -| goods_credit | float | Goods Credits (Billions of EUR) | -| goods_debit | float | Goods Debits (Billions of EUR) | -| services_credit | float | Services Credits (Billions of EUR) | -| services_debit | float | Services Debits (Billions of EUR) | -| primary_income_credit | float | Primary Income Credits (Billions of EUR) | -| primary_income_employee_compensation_credit | float | Primary Income Employee Compensation Credit (Billions of EUR) | -| primary_income_debit | float | Primary Income Debits (Billions of EUR) | -| primary_income_employee_compensation_debit | float | Primary Income Employee Compensation Debit (Billions of EUR) | -| secondary_income_credit | float | Secondary Income Credits (Billions of EUR) | -| secondary_income_debit | float | Secondary Income Debits (Billions of EUR) | -| capital_account_credit | float | Capital Account Credits (Billions of EUR) | -| capital_account_debit | float | Capital Account Debits (Billions of EUR) | -| services_total_credit | float | Services Total Credit (Billions of EUR) | -| services_total_debit | float | Services Total Debit (Billions of EUR) | -| transport_credit | float | Transport Credit (Billions of EUR) | -| transport_debit | float | Transport Debit (Billions of EUR) | -| travel_credit | float | Travel Credit (Billions of EUR) | -| travel_debit | float | Travel Debit (Billions of EUR) | -| financial_services_credit | float | Financial Services Credit (Billions of EUR) | -| financial_services_debit | float | Financial Services Debit (Billions of EUR) | -| communications_credit | float | Communications Credit (Billions of EUR) | -| communications_debit | float | Communications Debit (Billions of EUR) | -| other_business_services_credit | float | Other Business Services Credit (Billions of EUR) | -| other_business_services_debit | float | Other Business Services Debit (Billions of EUR) | -| other_services_credit | float | Other Services Credit (Billions of EUR) | -| other_services_debit | float | Other Services Debit (Billions of EUR) | -| investment_total_credit | float | Investment Total Credit (Billions of EUR) | -| investment_total_debit | float | Investment Total Debit (Billions of EUR) | -| equity_credit | float | Equity Credit (Billions of EUR) | -| equity_reinvested_earnings_credit | float | Equity Reinvested Earnings Credit (Billions of EUR) | -| equity_debit | float | Equity Debit (Billions of EUR) | -| equity_reinvested_earnings_debit | float | Equity Reinvested Earnings Debit (Billions of EUR) | -| debt_instruments_credit | float | Debt Instruments Credit (Billions of EUR) | -| debt_instruments_debit | float | Debt Instruments Debit (Billions of EUR) | -| portfolio_investment_equity_credit | float | Portfolio Investment Equity Credit (Billions of EUR) | -| portfolio_investment_equity_debit | float | Portfolio Investment Equity Debit (Billions of EUR) | -| portfolio_investment_debt_instruments_credit | float | Portfolio Investment Debt Instruments Credit (Billions of EUR) | -| portofolio_investment_debt_instruments_debit | float | Portfolio Investment Debt Instruments Debit (Billions of EUR) | -| other_investment_credit | float | Other Investment Credit (Billions of EUR) | -| other_investment_debit | float | Other Investment Debit (Billions of EUR) | -| reserve_assets_credit | float | Reserve Assets Credit (Billions of EUR) | -| assets_total | float | Assets Total (Billions of EUR) | -| assets_equity | float | Assets Equity (Billions of EUR) | -| assets_debt_instruments | float | Assets Debt Instruments (Billions of EUR) | -| assets_mfi | float | Assets MFIs (Billions of EUR) | -| assets_non_mfi | float | Assets Non MFIs (Billions of EUR) | -| assets_direct_investment_abroad | float | Assets Direct Investment Abroad (Billions of EUR) | -| liabilities_total | float | Liabilities Total (Billions of EUR) | -| liabilities_equity | float | Liabilities Equity (Billions of EUR) | -| liabilities_debt_instruments | float | Liabilities Debt Instruments (Billions of EUR) | -| liabilities_mfi | float | Liabilities MFIs (Billions of EUR) | -| liabilities_non_mfi | float | Liabilities Non MFIs (Billions of EUR) | -| liabilities_direct_investment_euro_area | float | Liabilities Direct Investment in Euro Area (Billions of EUR) | -| assets_equity_and_fund_shares | float | Assets Equity and Investment Fund Shares (Billions of EUR) | -| assets_equity_shares | float | Assets Equity Shares (Billions of EUR) | -| assets_investment_fund_shares | float | Assets Investment Fund Shares (Billions of EUR) | -| assets_debt_short_term | float | Assets Debt Short Term (Billions of EUR) | -| assets_debt_long_term | float | Assets Debt Long Term (Billions of EUR) | -| assets_resident_sector_eurosystem | float | Assets Resident Sector Eurosystem (Billions of EUR) | -| assets_resident_sector_mfi_ex_eurosystem | float | Assets Resident Sector MFIs outside Eurosystem (Billions of EUR) | -| assets_resident_sector_government | float | Assets Resident Sector Government (Billions of EUR) | -| assets_resident_sector_other | float | Assets Resident Sector Other (Billions of EUR) | -| liabilities_equity_and_fund_shares | float | Liabilities Equity and Investment Fund Shares (Billions of EUR) | -| liabilities_investment_fund_shares | float | Liabilities Investment Fund Shares (Billions of EUR) | -| liabilities_debt_short_term | float | Liabilities Debt Short Term (Billions of EUR) | -| liabilities_debt_long_term | float | Liabilities Debt Long Term (Billions of EUR) | -| liabilities_resident_sector_government | float | Liabilities Resident Sector Government (Billions of EUR) | -| liabilities_resident_sector_other | float | Liabilities Resident Sector Other (Billions of EUR) | -| assets_currency_and_deposits | float | Assets Currency and Deposits (Billions of EUR) | -| assets_loans | float | Assets Loans (Billions of EUR) | -| assets_trade_credit_and_advances | float | Assets Trade Credits and Advances (Billions of EUR) | -| assets_eurosystem | float | Assets Eurosystem (Billions of EUR) | -| assets_other_mfi_ex_eurosystem | float | Assets Other MFIs outside Eurosystem (Billions of EUR) | -| assets_government | float | Assets Government (Billions of EUR) | -| assets_other_sectors | float | Assets Other Sectors (Billions of EUR) | -| liabilities_currency_and_deposits | float | Liabilities Currency and Deposits (Billions of EUR) | -| liabilities_loans | float | Liabilities Loans (Billions of EUR) | -| liabilities_trade_credit_and_advances | float | Liabilities Trade Credits and Advances (Billions of EUR) | -| liabilities_eurosystem | float | Liabilities Eurosystem (Billions of EUR) | -| liabilities_other_mfi_ex_eurosystem | float | Liabilities Other MFIs outside Eurosystem (Billions of EUR) | -| liabilities_government | float | Liabilities Government (Billions of EUR) | -| liabilities_other_sectors | float | Liabilities Other Sectors (Billions of EUR) | -| goods_balance | float | Goods Balance (Billions of EUR) | -| services_balance | float | Services Balance (Billions of EUR) | -| primary_income_balance | float | Primary Income Balance (Billions of EUR) | -| investment_income_balance | float | Investment Income Balance (Billions of EUR) | -| investment_income_credit | float | Investment Income Credits (Billions of EUR) | -| investment_income_debit | float | Investment Income Debits (Billions of EUR) | -| secondary_income_balance | float | Secondary Income Balance (Billions of EUR) | -| capital_account_balance | float | Capital Account Balance (Billions of EUR) | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period | date | The date representing the beginning of the reporting period. | -| current_account | float | Current Account Balance (Billions of EUR) | -| goods | float | Goods Balance (Billions of EUR) | -| services | float | Services Balance (Billions of EUR) | -| primary_income | float | Primary Income Balance (Billions of EUR) | -| secondary_income | float | Secondary Income Balance (Billions of EUR) | -| capital_account | float | Capital Account Balance (Billions of EUR) | -| net_lending_to_rest_of_world | float | Balance of net lending to the rest of the world (Billions of EUR) | -| financial_account | float | Financial Account Balance (Billions of EUR) | -| direct_investment | float | Direct Investment Balance (Billions of EUR) | -| portfolio_investment | float | Portfolio Investment Balance (Billions of EUR) | -| financial_derivatives | float | Financial Derivatives Balance (Billions of EUR) | -| other_investment | float | Other Investment Balance (Billions of EUR) | -| reserve_assets | float | Reserve Assets Balance (Billions of EUR) | -| errors_and_ommissions | float | Errors and Omissions (Billions of EUR) | -| current_account_credit | float | Current Account Credits (Billions of EUR) | -| current_account_debit | float | Current Account Debits (Billions of EUR) | -| current_account_balance | float | Current Account Balance (Billions of EUR) | -| goods_credit | float | Goods Credits (Billions of EUR) | -| goods_debit | float | Goods Debits (Billions of EUR) | -| services_credit | float | Services Credits (Billions of EUR) | -| services_debit | float | Services Debits (Billions of EUR) | -| primary_income_credit | float | Primary Income Credits (Billions of EUR) | -| primary_income_employee_compensation_credit | float | Primary Income Employee Compensation Credit (Billions of EUR) | -| primary_income_debit | float | Primary Income Debits (Billions of EUR) | -| primary_income_employee_compensation_debit | float | Primary Income Employee Compensation Debit (Billions of EUR) | -| secondary_income_credit | float | Secondary Income Credits (Billions of EUR) | -| secondary_income_debit | float | Secondary Income Debits (Billions of EUR) | -| capital_account_credit | float | Capital Account Credits (Billions of EUR) | -| capital_account_debit | float | Capital Account Debits (Billions of EUR) | -| services_total_credit | float | Services Total Credit (Billions of EUR) | -| services_total_debit | float | Services Total Debit (Billions of EUR) | -| transport_credit | float | Transport Credit (Billions of EUR) | -| transport_debit | float | Transport Debit (Billions of EUR) | -| travel_credit | float | Travel Credit (Billions of EUR) | -| travel_debit | float | Travel Debit (Billions of EUR) | -| financial_services_credit | float | Financial Services Credit (Billions of EUR) | -| financial_services_debit | float | Financial Services Debit (Billions of EUR) | -| communications_credit | float | Communications Credit (Billions of EUR) | -| communications_debit | float | Communications Debit (Billions of EUR) | -| other_business_services_credit | float | Other Business Services Credit (Billions of EUR) | -| other_business_services_debit | float | Other Business Services Debit (Billions of EUR) | -| other_services_credit | float | Other Services Credit (Billions of EUR) | -| other_services_debit | float | Other Services Debit (Billions of EUR) | -| investment_total_credit | float | Investment Total Credit (Billions of EUR) | -| investment_total_debit | float | Investment Total Debit (Billions of EUR) | -| equity_credit | float | Equity Credit (Billions of EUR) | -| equity_reinvested_earnings_credit | float | Equity Reinvested Earnings Credit (Billions of EUR) | -| equity_debit | float | Equity Debit (Billions of EUR) | -| equity_reinvested_earnings_debit | float | Equity Reinvested Earnings Debit (Billions of EUR) | -| debt_instruments_credit | float | Debt Instruments Credit (Billions of EUR) | -| debt_instruments_debit | float | Debt Instruments Debit (Billions of EUR) | -| portfolio_investment_equity_credit | float | Portfolio Investment Equity Credit (Billions of EUR) | -| portfolio_investment_equity_debit | float | Portfolio Investment Equity Debit (Billions of EUR) | -| portfolio_investment_debt_instruments_credit | float | Portfolio Investment Debt Instruments Credit (Billions of EUR) | -| portofolio_investment_debt_instruments_debit | float | Portfolio Investment Debt Instruments Debit (Billions of EUR) | -| other_investment_credit | float | Other Investment Credit (Billions of EUR) | -| other_investment_debit | float | Other Investment Debit (Billions of EUR) | -| reserve_assets_credit | float | Reserve Assets Credit (Billions of EUR) | -| assets_total | float | Assets Total (Billions of EUR) | -| assets_equity | float | Assets Equity (Billions of EUR) | -| assets_debt_instruments | float | Assets Debt Instruments (Billions of EUR) | -| assets_mfi | float | Assets MFIs (Billions of EUR) | -| assets_non_mfi | float | Assets Non MFIs (Billions of EUR) | -| assets_direct_investment_abroad | float | Assets Direct Investment Abroad (Billions of EUR) | -| liabilities_total | float | Liabilities Total (Billions of EUR) | -| liabilities_equity | float | Liabilities Equity (Billions of EUR) | -| liabilities_debt_instruments | float | Liabilities Debt Instruments (Billions of EUR) | -| liabilities_mfi | float | Liabilities MFIs (Billions of EUR) | -| liabilities_non_mfi | float | Liabilities Non MFIs (Billions of EUR) | -| liabilities_direct_investment_euro_area | float | Liabilities Direct Investment in Euro Area (Billions of EUR) | -| assets_equity_and_fund_shares | float | Assets Equity and Investment Fund Shares (Billions of EUR) | -| assets_equity_shares | float | Assets Equity Shares (Billions of EUR) | -| assets_investment_fund_shares | float | Assets Investment Fund Shares (Billions of EUR) | -| assets_debt_short_term | float | Assets Debt Short Term (Billions of EUR) | -| assets_debt_long_term | float | Assets Debt Long Term (Billions of EUR) | -| assets_resident_sector_eurosystem | float | Assets Resident Sector Eurosystem (Billions of EUR) | -| assets_resident_sector_mfi_ex_eurosystem | float | Assets Resident Sector MFIs outside Eurosystem (Billions of EUR) | -| assets_resident_sector_government | float | Assets Resident Sector Government (Billions of EUR) | -| assets_resident_sector_other | float | Assets Resident Sector Other (Billions of EUR) | -| liabilities_equity_and_fund_shares | float | Liabilities Equity and Investment Fund Shares (Billions of EUR) | -| liabilities_investment_fund_shares | float | Liabilities Investment Fund Shares (Billions of EUR) | -| liabilities_debt_short_term | float | Liabilities Debt Short Term (Billions of EUR) | -| liabilities_debt_long_term | float | Liabilities Debt Long Term (Billions of EUR) | -| liabilities_resident_sector_government | float | Liabilities Resident Sector Government (Billions of EUR) | -| liabilities_resident_sector_other | float | Liabilities Resident Sector Other (Billions of EUR) | -| assets_currency_and_deposits | float | Assets Currency and Deposits (Billions of EUR) | -| assets_loans | float | Assets Loans (Billions of EUR) | -| assets_trade_credit_and_advances | float | Assets Trade Credits and Advances (Billions of EUR) | -| assets_eurosystem | float | Assets Eurosystem (Billions of EUR) | -| assets_other_mfi_ex_eurosystem | float | Assets Other MFIs outside Eurosystem (Billions of EUR) | -| assets_government | float | Assets Government (Billions of EUR) | -| assets_other_sectors | float | Assets Other Sectors (Billions of EUR) | -| liabilities_currency_and_deposits | float | Liabilities Currency and Deposits (Billions of EUR) | -| liabilities_loans | float | Liabilities Loans (Billions of EUR) | -| liabilities_trade_credit_and_advances | float | Liabilities Trade Credits and Advances (Billions of EUR) | -| liabilities_eurosystem | float | Liabilities Eurosystem (Billions of EUR) | -| liabilities_other_mfi_ex_eurosystem | float | Liabilities Other MFIs outside Eurosystem (Billions of EUR) | -| liabilities_government | float | Liabilities Government (Billions of EUR) | -| liabilities_other_sectors | float | Liabilities Other Sectors (Billions of EUR) | -| goods_balance | float | Goods Balance (Billions of EUR) | -| services_balance | float | Services Balance (Billions of EUR) | -| primary_income_balance | float | Primary Income Balance (Billions of EUR) | -| investment_income_balance | float | Investment Income Balance (Billions of EUR) | -| investment_income_credit | float | Investment Income Credits (Billions of EUR) | -| investment_income_debit | float | Investment Income Debits (Billions of EUR) | -| secondary_income_balance | float | Secondary Income Balance (Billions of EUR) | -| capital_account_balance | float | Capital Account Balance (Billions of EUR) | - - - - diff --git a/website/content/platform/reference/economy/calendar.md b/website/content/platform/reference/economy/calendar.md deleted file mode 100644 index 887376487891..000000000000 --- a/website/content/platform/reference/economy/calendar.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -title: "calendar" -description: "The Economic Calendar provides information on economic events and data. Use the OBB Python function `obb.economy.calendar()` to retrieve economic calendar data. The function accepts parameters such as start date, end date, provider, country, importance, and group. It returns a list of economic calendar data, including the date, event, reference, source, actual value, previous value, consensus value, and forecast value. The data can be filtered by provider such as FMP, Nasdaq, or Trading Economics." -keywords: -- economic calendar -- python obb.economy.calendar -- parameters -- start date -- end date -- provider -- country -- importance -- group -- returns -- data -- date -- event -- reference -- source -- source url -- actual -- previous -- consensus -- forecast -- url -- currency -- unit -- change -- change percent -- updated at -- created at -- description ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the upcoming, or historical, economic calendar of global events. - - -Examples --------- - -```python -from openbb import obb -# By default, the calendar will be forward-looking. -obb.economy.calendar(provider='fmp') -obb.economy.calendar(provider='fmp', start_date='2020-03-01', end_date='2020-03-31') -# By default, the calendar will be forward-looking. -obb.economy.calendar(provider='nasdaq') -``` - ---- - -## 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['fmp', 'nasdaq', 'tradingeconomics'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq', 'tradingeconomics'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq', 'tradingeconomics'] | 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 | -| country | Union[str, List[str]] | Country of the event Multiple items allowed for provider(s): nasdaq. | None | 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['fmp', 'nasdaq', 'tradingeconomics'] | 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 | -| country | Union[str, List[str]] | Country of the event. Multiple items allowed for provider(s): tradingeconomics. | None | True | -| importance | Literal['Low', 'Medium', 'High'] | Importance of the event. | None | True | -| group | Literal['interest rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business'] | Grouping of events | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EconomicCalendar - Serializable results. - provider : Literal['fmp', 'nasdaq', 'tradingeconomics'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| country | str | Country of event. | -| event | str | Event name. | -| reference | str | Abbreviated period for which released data refers to. | -| source | str | Source of the data. | -| sourceurl | str | Source URL. | -| actual | Union[str, float] | Latest released value. | -| previous | Union[str, float] | Value for the previous period after the revision (if revision is applicable). | -| consensus | Union[str, float] | Average forecast among a representative group of economists. | -| forecast | Union[str, float] | Trading Economics projections | -| url | str | Trading Economics URL | -| importance | Union[Literal[0, 1, 2, 3], str] | Importance of the event. 1-Low, 2-Medium, 3-High | -| currency | str | Currency of the data. | -| unit | str | Unit of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| country | str | Country of event. | -| event | str | Event name. | -| reference | str | Abbreviated period for which released data refers to. | -| source | str | Source of the data. | -| sourceurl | str | Source URL. | -| actual | Union[str, float] | Latest released value. | -| previous | Union[str, float] | Value for the previous period after the revision (if revision is applicable). | -| consensus | Union[str, float] | Average forecast among a representative group of economists. | -| forecast | Union[str, float] | Trading Economics projections | -| url | str | Trading Economics URL | -| importance | Union[Literal[0, 1, 2, 3], str] | Importance of the event. 1-Low, 2-Medium, 3-High | -| currency | str | Currency of the data. | -| unit | str | Unit of the data. | -| change | float | Value change since previous. | -| change_percent | float | Percentage change since previous. | -| updated_at | datetime | Last updated timestamp. | -| created_at | datetime | Created at timestamp. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| country | str | Country of event. | -| event | str | Event name. | -| reference | str | Abbreviated period for which released data refers to. | -| source | str | Source of the data. | -| sourceurl | str | Source URL. | -| actual | Union[str, float] | Latest released value. | -| previous | Union[str, float] | Value for the previous period after the revision (if revision is applicable). | -| consensus | Union[str, float] | Average forecast among a representative group of economists. | -| forecast | Union[str, float] | Trading Economics projections | -| url | str | Trading Economics URL | -| importance | Union[Literal[0, 1, 2, 3], str] | Importance of the event. 1-Low, 2-Medium, 3-High | -| currency | str | Currency of the data. | -| unit | str | Unit of the data. | -| description | str | Event description. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. | -| country | str | Country of event. | -| event | str | Event name. | -| reference | str | Abbreviated period for which released data refers to. | -| source | str | Source of the data. | -| sourceurl | str | Source URL. | -| actual | Union[str, float] | Latest released value. | -| previous | Union[str, float] | Value for the previous period after the revision (if revision is applicable). | -| consensus | Union[str, float] | Average forecast among a representative group of economists. | -| forecast | Union[str, float] | Trading Economics projections | -| url | str | Trading Economics URL | -| importance | Union[Literal[0, 1, 2, 3], str] | Importance of the event. 1-Low, 2-Medium, 3-High | -| currency | str | Currency of the data. | -| unit | str | Unit of the data. | - - - - diff --git a/website/content/platform/reference/economy/composite_leading_indicator.md b/website/content/platform/reference/economy/composite_leading_indicator.md deleted file mode 100644 index 52f4228dcec3..000000000000 --- a/website/content/platform/reference/economy/composite_leading_indicator.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: "composite_leading_indicator" -description: "The composite leading indicator (CLI) is designed to provide early signals of turning points -in business cycles showing fluctuation of the economic activity around its long term potential level" -keywords: -- economy -- composite_leading_indicator ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -The composite leading indicator (CLI) is designed to provide early signals of turning points -in business cycles showing fluctuation of the economic activity around its long term potential level. -CLIs show short-term economic movements in qualitative rather than quantitative terms. - - -Examples --------- - -```python -from openbb import obb -obb.economy.composite_leading_indicator(provider='oecd') -obb.economy.composite_leading_indicator(country=all, provider='oecd') -``` - ---- - -## 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['united_states', 'united_kingdom', 'japan', 'mexico', 'indonesia', 'australia', 'brazil', 'canada', 'italy', 'germany', 'turkey', 'france', 'south_africa', 'south_korea', 'spain', 'india', 'china', 'g7', 'g20', 'all'] | Country to get GDP for. | united_states | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CLI - Serializable results. - provider : Literal['oecd'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | CLI value | -| country | str | Country for which CLI is given | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | CLI value | -| country | str | Country for which CLI is given | - - - - diff --git a/website/content/platform/reference/economy/cpi.md b/website/content/platform/reference/economy/cpi.md deleted file mode 100644 index a36e1ea804ce..000000000000 --- a/website/content/platform/reference/economy/cpi.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: "cpi" -description: "Get Consumer Price Index (CPI) data for various countries and calculate inflation measurements. This economic indicator provides insights into the growth rate of prices on a monthly, quarterly, and annual basis. Harmonized CPI data is also available. Specify the start and end dates for the desired data range. The data provider and metadata information are included in the results." -keywords: -- Consumer Price Index (CPI) Data -- CPI data -- CPI calculation -- inflation measurement -- economic indicator -- country-wise CPI data -- growth rate -- monthly CPI -- quarterly CPI -- annual CPI -- harmonized CPI -- start date -- end date -- data provider -- metadata info ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Consumer Price Index (CPI). Returns either the rescaled index value, or a rate of change (inflation). - - -Examples --------- - -```python -from openbb import obb -obb.economy.cpi(country='japan,china,turkey', provider='fred') -# Use the `units` parameter to define the reference period for the change in values. -obb.economy.cpi(country='united_states,united_kingdom', units='growth_previous', provider='fred') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): fred. | | False | -| units | Literal['growth_previous', 'growth_same', 'index_2015'] | The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100. | growth_same | True | -| frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. Options: `monthly`, `quarter`, and `annual`. | monthly | True | -| harmonized | bool | Whether you wish to obtain harmonized data. | False | True | -| 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 | -| ---- | ---- | ----------- | ------- | -------- | -| country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): fred. | | False | -| units | Literal['growth_previous', 'growth_same', 'index_2015'] | The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100. | growth_same | True | -| frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. Options: `monthly`, `quarter`, and `annual`. | monthly | True | -| harmonized | bool | Whether you wish to obtain harmonized data. | False | True | -| 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : ConsumerPriceIndex - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - diff --git a/website/content/platform/reference/economy/fred_regional.md b/website/content/platform/reference/economy/fred_regional.md deleted file mode 100644 index a15b809893e7..000000000000 --- a/website/content/platform/reference/economy/fred_regional.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: "fred_regional" -description: "Query the Geo Fred API for regional economic data by series group" -keywords: -- economy -- fred_regional ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Query the Geo Fred API for regional economic data by series group. -The series group ID is found by using `fred_search` and the `series_id` parameter. - - -Examples --------- - -```python -from openbb import obb -obb.economy.fred_regional(symbol='NYICLAIMS', provider='fred') -# With a date, time series data is returned. -obb.economy.fred_regional(symbol='NYICLAIMS', start_date='2021-01-01', end_date='2021-12-31', limit=10, provider='fred') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fred. | | False | -| 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 | -| limit | int | The number of data entries to return. | 100000 | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fred. | | False | -| 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 | -| limit | int | The number of data entries to return. | 100000 | 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 | -| is_series_group | bool | When True, the symbol provided is for a series_group, else it is for a series ID. | False | True | -| region_type | Literal['bea', 'msa', 'frb', 'necta', 'state', 'country', 'county', 'censusregion'] | The type of regional data. Parameter is only valid when `is_series_group` is True. | None | True | -| season | Literal['SA', 'NSA', 'SSA'] | The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True. | NSA | True | -| units | str | 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. | None | True | -| frequency | Literal['d', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem'] | Frequency aggregation to convert high frequency data to lower frequency. Parameter is only valid when `is_series_group` is True. a = Annual sa= Semiannual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday | None | True | -| aggregation_method | Literal['avg', 'sum', 'eop'] | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. Only valid when `is_series_group` is True. avg = Average sum = Sum eop = End of Period | avg | True | -| transform | Literal['lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log'] | Transformation type. Only valid when `is_series_group` is True. lin = Levels (No transformation) chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log | lin | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : FredRegional - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| region | str | The name of the region. | -| code | Union[str, int] | The code of the region. | -| value | Union[int, float] | The obersvation value. The units are defined in the search results by series ID. | -| series_id | str | The individual series ID for the region. | - - - - diff --git a/website/content/platform/reference/economy/fred_search.md b/website/content/platform/reference/economy/fred_search.md deleted file mode 100644 index f1ecf2a00c42..000000000000 --- a/website/content/platform/reference/economy/fred_search.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -title: "fred_search" -description: "Search for FRED series or economic releases by ID or string" -keywords: -- economy -- fred_search ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Search for FRED series or economic releases by ID or string. -This does not return the observation values, only the metadata. -Use this function to find series IDs for `fred_series()`. - - -Examples --------- - -```python -from openbb import obb -obb.economy.fred_search(provider='fred') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | The search word(s). | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | The search word(s). | 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 | -| is_release | bool | Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True. | False | True | -| release_id | Union[int, str] | A specific release ID to target. | None | True | -| limit | int | The number of data entries to return. (1-1000) | None | True | -| offset | int, Ge(ge=0) | Offset the results in conjunction with limit. | 0 | True | -| filter_variable | Literal[None, 'frequency', 'units', 'seasonal_adjustment'] | Filter by an attribute. | None | True | -| filter_value | str | String value to filter the variable by. Used in conjunction with filter_variable. | None | True | -| tag_names | str | A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' | None | True | -| exclude_tag_names | str | 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. | None | True | -| series_id | str | 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. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : FredSearch - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| release_id | Union[int, str] | The release ID for queries. | -| series_id | str | The series ID for the item in the release. | -| name | str | The name of the release. | -| title | str | The title of the series. | -| observation_start | date | The date of the first observation in the series. | -| observation_end | date | The date of the last observation in the series. | -| frequency | str | The frequency of the data. | -| frequency_short | str | Short form of the data frequency. | -| units | str | The units of the data. | -| units_short | str | Short form of the data units. | -| seasonal_adjustment | str | The seasonal adjustment of the data. | -| seasonal_adjustment_short | str | Short form of the data seasonal adjustment. | -| last_updated | datetime | The datetime of the last update to the data. | -| notes | str | Description of the release. | -| press_release | bool | If the release is a press release. | -| url | str | URL to the release. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| release_id | Union[int, str] | The release ID for queries. | -| series_id | str | The series ID for the item in the release. | -| name | str | The name of the release. | -| title | str | The title of the series. | -| observation_start | date | The date of the first observation in the series. | -| observation_end | date | The date of the last observation in the series. | -| frequency | str | The frequency of the data. | -| frequency_short | str | Short form of the data frequency. | -| units | str | The units of the data. | -| units_short | str | Short form of the data units. | -| seasonal_adjustment | str | The seasonal adjustment of the data. | -| seasonal_adjustment_short | str | Short form of the data seasonal adjustment. | -| last_updated | datetime | The datetime of the last update to the data. | -| notes | str | Description of the release. | -| press_release | bool | If the release is a press release. | -| url | str | URL to the release. | -| popularity | int | Popularity of the series | -| group_popularity | int | Group popularity of the release | -| region_type | str | The region type of the series. | -| series_group | Union[int, str] | The series group ID of the series. This value is used to query for regional data. | - - - - diff --git a/website/content/platform/reference/economy/fred_series.md b/website/content/platform/reference/economy/fred_series.md deleted file mode 100644 index f6e956b9e7d0..000000000000 --- a/website/content/platform/reference/economy/fred_series.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: "fred_series" -description: "Get data by series ID from FRED" -keywords: -- economy -- fred_series ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get data by series ID from FRED. - - -Examples --------- - -```python -from openbb import obb -obb.economy.fred_series(symbol='NFCI', provider='fred') -# Multiple series can be passed in as a list. -obb.economy.fred_series(symbol='NFCI,STLFSI4', provider='fred') -# Use the `transform` parameter to transform the data as change, log, or percent change. -obb.economy.fred_series(symbol='CBBTCUSD', transform=pc1, provider='fred') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fred. | | False | -| 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 | -| limit | int | The number of data entries to return. | 100000 | True | -| provider | Literal['fred', 'intrinio'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fred. | | False | -| 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 | -| limit | int | The number of data entries to return. | 100000 | True | -| provider | Literal['fred', 'intrinio'] | 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 | -| frequency | Literal[None, 'a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem'] | Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday | None | True | -| aggregation_method | Literal[None, 'avg', 'sum', 'eop'] | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period | eop | True | -| transform | Literal[None, 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log'] | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fred. | | False | -| 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 | -| limit | int | The number of data entries to return. | 100000 | True | -| provider | Literal['fred', 'intrinio'] | 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 | -| all_pages | bool | Returns all pages of data from the API call at once. | False | True | -| sleep | float | Time to sleep between requests to avoid rate limiting. | 1.0 | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : FredSeries - Serializable results. - provider : Literal['fred', 'intrinio'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Value of the index. | - - - - diff --git a/website/content/platform/reference/economy/gdp/_category_.json b/website/content/platform/reference/economy/gdp/_category_.json deleted file mode 100644 index 4a7aaac6eee8..000000000000 --- a/website/content/platform/reference/economy/gdp/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Gdp", - "position": 1 -} \ No newline at end of file diff --git a/website/content/platform/reference/economy/gdp/forecast.md b/website/content/platform/reference/economy/gdp/forecast.md deleted file mode 100644 index 32a950a18b33..000000000000 --- a/website/content/platform/reference/economy/gdp/forecast.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: "forecast" -description: "Forecasted GDP Data" -keywords: -- economy -- gdp -- forecast ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Forecasted GDP Data. - - -Examples --------- - -```python -from openbb import obb -obb.economy.gdp.forecast(provider='oecd') -obb.economy.gdp.forecast(period='annual', type='real', provider='oecd') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| period | Literal['quarter', 'annual'] | Time period of the data to return. Units for nominal GDP period. Either quarter or annual. | annual | True | -| 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 | -| type | Literal['nominal', 'real'] | Type of GDP to get forecast of. Either nominal or real. | real | True | -| provider | Literal['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| period | Literal['quarter', 'annual'] | Time period of the data to return. Units for nominal GDP period. Either quarter or annual. | annual | True | -| 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 | -| type | Literal['nominal', 'real'] | Type of GDP to get forecast of. Either nominal or real. | real | True | -| provider | Literal['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['argentina', 'asia', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_17', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'non-oecd', 'norway', 'oecd_total', 'peru', 'poland', 'portugal', 'romania', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'world'] | Country to get GDP for. | united_states | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : GdpForecast - Serializable results. - provider : Literal['oecd'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - diff --git a/website/content/platform/reference/economy/gdp/index.mdx b/website/content/platform/reference/economy/gdp/index.mdx deleted file mode 100644 index 35bf86cca3d7..000000000000 --- a/website/content/platform/reference/economy/gdp/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ -# Gdp - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - -
- diff --git a/website/content/platform/reference/economy/gdp/nominal.md b/website/content/platform/reference/economy/gdp/nominal.md deleted file mode 100644 index 5558d524958d..000000000000 --- a/website/content/platform/reference/economy/gdp/nominal.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: "nominal" -description: "Nominal GDP Data" -keywords: -- economy -- gdp -- nominal ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Nominal GDP Data. - - -Examples --------- - -```python -from openbb import obb -obb.economy.gdp.nominal(provider='oecd') -obb.economy.gdp.nominal(units='usd', provider='oecd') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| units | Literal['usd', 'usd_cap'] | The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita. | usd | True | -| 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| units | Literal['usd', 'usd_cap'] | The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita. | usd | True | -| 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['australia', 'austria', 'belgium', 'brazil', 'canada', 'chile', 'colombia', 'costa_rica', 'czech_republic', 'denmark', 'estonia', 'euro_area', 'european_union', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all'] | Country to get GDP for. | united_states | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : GdpNominal - Serializable results. - provider : Literal['oecd'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - diff --git a/website/content/platform/reference/economy/gdp/real.md b/website/content/platform/reference/economy/gdp/real.md deleted file mode 100644 index 59569d33545b..000000000000 --- a/website/content/platform/reference/economy/gdp/real.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "real" -description: "Learn about Real GDP Data and how to access it using the provided parameters. Find detailed descriptions of the available parameters and the data returned. Understand the structure of the returns and explore the data attributes." -keywords: -- Real GDP Data -- parameters -- units -- start date -- end date -- provider -- country -- returns -- results -- GdpReal -- warnings -- chart -- metadata -- data -- date -- value -- documentation ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Real GDP Data. - - -Examples --------- - -```python -from openbb import obb -obb.economy.gdp.real(provider='oecd') -obb.economy.gdp.real(units='yoy', provider='oecd') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| units | Literal['idx', 'qoq', 'yoy'] | The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).) | yoy | True | -| 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| units | Literal['idx', 'qoq', 'yoy'] | The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).) | yoy | True | -| 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_19', 'europe', 'european_union_27', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'oecd_total', 'poland', 'portugal', 'romania', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all'] | Country to get GDP for. | united_states | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : GdpReal - Serializable results. - provider : Literal['oecd'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Nominal GDP value on the date. | - - - - diff --git a/website/content/platform/reference/economy/index.mdx b/website/content/platform/reference/economy/index.mdx deleted file mode 100644 index c071ca7bbd91..000000000000 --- a/website/content/platform/reference/economy/index.mdx +++ /dev/null @@ -1,27 +0,0 @@ -# Economy - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Menus -
    - -
- -### Commands -
    - - - - - - - - - - - - -
- diff --git a/website/content/platform/reference/economy/long_term_interest_rate.md b/website/content/platform/reference/economy/long_term_interest_rate.md deleted file mode 100644 index e015eb1629e8..000000000000 --- a/website/content/platform/reference/economy/long_term_interest_rate.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: "long_term_interest_rate" -description: "Long-term interest rates refer to government bonds maturing in ten years" -keywords: -- economy -- long_term_interest_rate ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Long-term interest rates refer to government bonds maturing in ten years. -Rates are mainly determined by the price charged by the lender, the risk from the borrower and the -fall in the capital value. Long-term interest rates are generally averages of daily rates, -measured as a percentage. These interest rates are implied by the prices at which the government bonds are -traded on financial markets, not the interest rates at which the loans were issued. -In all cases, they refer to bonds whose capital repayment is guaranteed by governments. -Long-term interest rates are one of the determinants of business investment. -Low long-term interest rates encourage investment in new equipment and high interest rates discourage it. -Investment is, in turn, a major source of economic growth. - - -Examples --------- - -```python -from openbb import obb -obb.economy.long_term_interest_rate(provider='oecd') -obb.economy.long_term_interest_rate(country=all, frequency=quarterly, provider='oecd') -``` - ---- - -## 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all'] | Country to get GDP for. | united_states | True | -| frequency | Literal['monthly', 'quarterly', 'annual'] | Frequency to get interest rate for for. | monthly | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : LTIR - Serializable results. - provider : Literal['oecd'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Interest rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which interest rate is given | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Interest rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which interest rate is given | - - - - diff --git a/website/content/platform/reference/economy/money_measures.md b/website/content/platform/reference/economy/money_measures.md deleted file mode 100644 index 37051930e761..000000000000 --- a/website/content/platform/reference/economy/money_measures.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: "money_measures" -description: "Money Measures (M1/M2 and components)" -keywords: -- economy -- money_measures ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Money Measures (M1/M2 and components). The Federal Reserve publishes as part of the H.6 Release. - - -Examples --------- - -```python -from openbb import obb -obb.economy.money_measures(provider='federal_reserve') -obb.economy.money_measures(adjusted=False, provider='federal_reserve') -``` - ---- - -## 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 | -| adjusted | bool | Whether to return seasonally adjusted data. | True | True | -| provider | Literal['federal_reserve'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | 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 | -| adjusted | bool | Whether to return seasonally adjusted data. | True | True | -| provider | Literal['federal_reserve'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : MoneyMeasures - Serializable results. - provider : Literal['federal_reserve'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| month | date | The date of the data. | -| M1 | float | Value of the M1 money supply in billions. | -| M2 | float | Value of the M2 money supply in billions. | -| currency | float | Value of currency in circulation in billions. | -| demand_deposits | float | Value of demand deposits in billions. | -| retail_money_market_funds | float | Value of retail money market funds in billions. | -| other_liquid_deposits | float | Value of other liquid deposits in billions. | -| small_denomination_time_deposits | float | Value of small denomination time deposits in billions. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| month | date | The date of the data. | -| M1 | float | Value of the M1 money supply in billions. | -| M2 | float | Value of the M2 money supply in billions. | -| currency | float | Value of currency in circulation in billions. | -| demand_deposits | float | Value of demand deposits in billions. | -| retail_money_market_funds | float | Value of retail money market funds in billions. | -| other_liquid_deposits | float | Value of other liquid deposits in billions. | -| small_denomination_time_deposits | float | Value of small denomination time deposits in billions. | - - - - diff --git a/website/content/platform/reference/economy/risk_premium.md b/website/content/platform/reference/economy/risk_premium.md deleted file mode 100644 index 3372cd72b1fa..000000000000 --- a/website/content/platform/reference/economy/risk_premium.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: "risk_premium" -description: "Learn about Historical Market Risk Premium and the obb.economy.risk_premium function. Explore the parameters, returns, and data available, including results, warnings, chart, metadata, country, continent, total equity risk premium, and country risk premium." -keywords: -- Historical Market Risk Premium -- obb.economy.risk_premium -- parameters -- provider -- returns -- OBBject -- results -- RiskPremium -- warnings -- chart -- metadata -- data -- country -- continent -- total equity risk premium -- country risk premium ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Market Risk Premium by country. - - -Examples --------- - -```python -from openbb import obb -obb.economy.risk_premium(provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : RiskPremium - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| country | str | Market country. | -| continent | str | Continent of the country. | -| total_equity_risk_premium | float, Gt(gt=0) | Total equity risk premium for the country. | -| country_risk_premium | float, Ge(ge=0) | Country-specific risk premium. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| country | str | Market country. | -| continent | str | Continent of the country. | -| total_equity_risk_premium | float, Gt(gt=0) | Total equity risk premium for the country. | -| country_risk_premium | float, Ge(ge=0) | Country-specific risk premium. | - - - - diff --git a/website/content/platform/reference/economy/short_term_interest_rate.md b/website/content/platform/reference/economy/short_term_interest_rate.md deleted file mode 100644 index 37a107b9ddfa..000000000000 --- a/website/content/platform/reference/economy/short_term_interest_rate.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: "short_term_interest_rate" -description: "Short-term interest rates are the rates at which short-term borrowings are effected between -financial institutions or the rate at which short-term government paper is issued or traded in the market" -keywords: -- economy -- short_term_interest_rate ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Short-term interest rates are the rates at which short-term borrowings are effected between -financial institutions or the rate at which short-term government paper is issued or traded in the market. -Short-term interest rates are generally averages of daily rates, measured as a percentage. -Short-term interest rates are based on three-month money market rates where available. -Typical standardised names are "money market rate" and "treasury bill rate". - - -Examples --------- - -```python -from openbb import obb -obb.economy.short_term_interest_rate(provider='oecd') -obb.economy.short_term_interest_rate(country=all, frequency=quarterly, provider='oecd') -``` - ---- - -## 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all'] | Country to get GDP for. | united_states | True | -| frequency | Literal['monthly', 'quarterly', 'annual'] | Frequency to get interest rate for for. | monthly | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : STIR - Serializable results. - provider : Literal['oecd'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Interest rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which interest rate is given | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Interest rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which interest rate is given | - - - - diff --git a/website/content/platform/reference/economy/unemployment.md b/website/content/platform/reference/economy/unemployment.md deleted file mode 100644 index 893c5e47b7f2..000000000000 --- a/website/content/platform/reference/economy/unemployment.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: "unemployment" -description: "Global unemployment data" -keywords: -- economy -- unemployment ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Global unemployment data. - - -Examples --------- - -```python -from openbb import obb -obb.economy.unemployment(provider='oecd') -obb.economy.unemployment(country=all, frequency=quarterly, provider='oecd') -# Demographics for the statistics are selected with the `age` parameter. -obb.economy.unemployment(country=all, frequency=quarterly, age=25-54, provider='oecd') -``` - ---- - -## 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True | -| country | Literal['colombia', 'new_zealand', 'united_kingdom', 'italy', 'luxembourg', 'euro_area19', 'sweden', 'oecd', 'south_africa', 'denmark', 'canada', 'switzerland', 'slovakia', 'hungary', 'portugal', 'spain', 'france', 'czech_republic', 'costa_rica', 'japan', 'slovenia', 'russia', 'austria', 'latvia', 'netherlands', 'israel', 'iceland', 'united_states', 'ireland', 'mexico', 'germany', 'greece', 'turkey', 'australia', 'poland', 'south_korea', 'chile', 'finland', 'european_union27_2020', 'norway', 'lithuania', 'euro_area20', 'estonia', 'belgium', 'brazil', 'indonesia', 'all'] | Country to get GDP for. | united_states | True | -| sex | Literal['total', 'male', 'female'] | Sex to get unemployment for. | total | True | -| frequency | Literal['monthly', 'quarterly', 'annual'] | Frequency to get unemployment for. | monthly | True | -| age | Literal['total', '15-24', '15-64', '25-54', '55-64'] | Age group to get unemployment for. Total indicates 15 years or over | total | True | -| seasonal_adjustment | bool | Whether to get seasonally adjusted unemployment. Defaults to False. | False | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Unemployment - Serializable results. - provider : Literal['oecd'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Unemployment rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which unemployment rate is given | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| value | float | Unemployment rate (given as a whole number, i.e 10=10%) | -| country | str | Country for which unemployment rate is given | - - - - diff --git a/website/content/platform/reference/equity/_category_.json b/website/content/platform/reference/equity/_category_.json deleted file mode 100644 index a3cee322b33d..000000000000 --- a/website/content/platform/reference/equity/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Equity", - "position": 9 -} \ No newline at end of file diff --git a/website/content/platform/reference/equity/calendar/_category_.json b/website/content/platform/reference/equity/calendar/_category_.json deleted file mode 100644 index 53bec2ee3d0c..000000000000 --- a/website/content/platform/reference/equity/calendar/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Calendar", - "position": 1 -} \ No newline at end of file diff --git a/website/content/platform/reference/equity/calendar/dividend.md b/website/content/platform/reference/equity/calendar/dividend.md deleted file mode 100644 index 62cddecbd0dd..000000000000 --- a/website/content/platform/reference/equity/calendar/dividend.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: "dividend" -description: "Get upcoming and historical dividend data with the OBB.equity.calendar.dividend method. This method allows you to retrieve dividend information such as dates, amounts, and provider details. It also provides warnings, charts, and metadata for further analysis." -keywords: -- dividend calendar -- upcoming dividends -- historical dividends -- dividend data -- dividend schedule -- dividend information -- dividend dates -- dividend amounts -- dividend provider -- dividend warnings -- dividend chart -- dividend metadata -- ex-dividend date -- record date -- payment date -- declaration date -- dividend symbol -- dividend name -- dividend adjusted amount -- dividend label -- annualized dividend amount ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get historical and upcoming dividend payments. Includes dividend amount, ex-dividend and payment dates. - - -Examples --------- - -```python -from openbb import obb -obb.equity.calendar.dividend(provider='fmp') -# Get dividend calendar for specific dates. -obb.equity.calendar.dividend(start_date='2024-02-01', end_date='2024-02-07', provider='nasdaq') -``` - ---- - -## 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['fmp', 'nasdaq'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq'] | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CalendarDividend - Serializable results. - provider : Literal['fmp', 'nasdaq'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| symbol | str | Symbol representing the entity requested in the data. | -| amount | float | The dividend amount per share. | -| name | str | Name of the entity. | -| record_date | date | The record date of ownership for eligibility. | -| payment_date | date | The payment date of the dividend. | -| declaration_date | date | Declaration date of the dividend. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| symbol | str | Symbol representing the entity requested in the data. | -| amount | float | The dividend amount per share. | -| name | str | Name of the entity. | -| record_date | date | The record date of ownership for eligibility. | -| payment_date | date | The payment date of the dividend. | -| declaration_date | date | Declaration date of the dividend. | -| adjusted_amount | float | The adjusted-dividend amount. | -| label | str | Ex-dividend date formatted for display. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| symbol | str | Symbol representing the entity requested in the data. | -| amount | float | The dividend amount per share. | -| name | str | Name of the entity. | -| record_date | date | The record date of ownership for eligibility. | -| payment_date | date | The payment date of the dividend. | -| declaration_date | date | Declaration date of the dividend. | -| annualized_amount | float | The indicated annualized dividend amount. | - - - - diff --git a/website/content/platform/reference/equity/calendar/earnings.md b/website/content/platform/reference/equity/calendar/earnings.md deleted file mode 100644 index 2340bd1eb1da..000000000000 --- a/website/content/platform/reference/equity/calendar/earnings.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -title: "earnings" -description: "Learn how to retrieve upcoming and historical earnings calendar data using the OBB.equity.calendar.earnings Python function. The function allows you to specify symbols, limit the number of data entries, and choose a data provider. The returned data includes EPS, revenue, and other important details for the specified symbols and dates." -keywords: -- earnings calendar -- upcoming earnings -- historical earnings -- Python function -- earnings data retrieval -- symbol -- limit -- provider -- data entries -- chart -- metadata -- data -- EPS -- revenue -- estimated EPS -- estimated revenue -- date -- time -- updated from date -- fiscal date ending ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get historical and upcoming company earnings releases. Includes earnings per share (EPS) and revenue data. - - -Examples --------- - -```python -from openbb import obb -obb.equity.calendar.earnings(provider='fmp') -# Get earnings calendar for specific dates. -obb.equity.calendar.earnings(start_date='2024-02-01', end_date='2024-02-07', provider='fmp') -``` - ---- - -## 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['fmp', 'nasdaq', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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['fmp', 'nasdaq', 'tmx'] | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CalendarEarnings - Serializable results. - provider : Literal['fmp', 'nasdaq', 'tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| report_date | date | The date of the earnings report. | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| eps_previous | float | The earnings-per-share from the same previously reported period. | -| eps_consensus | float | The analyst conesus earnings-per-share estimate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| report_date | date | The date of the earnings report. | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| eps_previous | float | The earnings-per-share from the same previously reported period. | -| eps_consensus | float | The analyst conesus earnings-per-share estimate. | -| eps_actual | float | The actual earnings per share announced. | -| revenue_actual | float | The actual reported revenue. | -| revenue_consensus | float | The revenue forecast consensus. | -| period_ending | date | The fiscal period end date. | -| reporting_time | str | The reporting time - e.g. after market close. | -| updated_date | date | The date the data was updated last. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| report_date | date | The date of the earnings report. | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| eps_previous | float | The earnings-per-share from the same previously reported period. | -| eps_consensus | float | The analyst conesus earnings-per-share estimate. | -| eps_actual | float | The actual earnings per share (USD) announced. | -| surprise_percent | float | The earnings surprise as normalized percentage points. | -| num_estimates | int | The number of analysts providing estimates for the consensus. | -| period_ending | str | The fiscal period end date. | -| previous_report_date | date | The previous report date for the same period last year. | -| reporting_time | str | The reporting time - e.g. after market close. | -| market_cap | int | The market cap (USD) of the reporting entity. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| report_date | date | The date of the earnings report. | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| eps_previous | float | The earnings-per-share from the same previously reported period. | -| eps_consensus | float | The analyst conesus earnings-per-share estimate. | -| eps_actual | float | The actual EPS in dollars. | -| eps_surprise | float | The EPS surprise in dollars. | -| surprise_percent | float | The EPS surprise as a normalized percent. | -| reporting_time | str | The time of the report - i.e., before or after market. | - - - - diff --git a/website/content/platform/reference/equity/calendar/index.mdx b/website/content/platform/reference/equity/calendar/index.mdx deleted file mode 100644 index ba7c555e1bf2..000000000000 --- a/website/content/platform/reference/equity/calendar/index.mdx +++ /dev/null @@ -1,12 +0,0 @@ -# Calendar - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - -
- diff --git a/website/content/platform/reference/equity/calendar/ipo.md b/website/content/platform/reference/equity/calendar/ipo.md deleted file mode 100644 index a39d3c6c7522..000000000000 --- a/website/content/platform/reference/equity/calendar/ipo.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -title: "ipo" -description: "Access the Upcoming and Historical IPO Calendars and retrieve IPO information using Python." -keywords: -- Upcoming IPO Calendar -- Historical IPO Calendar -- Python function -- equity.calendar.ipo -- symbol -- start_date -- end_date -- limit -- provider -- intrinio -- nasdaq -- status -- min_value -- max_value -- OBBject -- results -- CalendarIpo -- warnings -- Chart -- Metadata -- data -- ipo_date -- status -- exchange -- offer_amount -- share_price -- share_price_lowest -- share_price_highest -- share_count -- share_count_lowest -- share_count_highest -- announcement_url -- sec_report_url -- open_price -- close_price -- volume -- day_change -- week_change -- month_change -- id -- company -- security -- name -- expected_price_date -- filed_date -- withdraw_date -- deal_status ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get historical and upcoming initial public offerings (IPOs). - - -Examples --------- - -```python -from openbb import obb -obb.equity.calendar.ipo(provider='intrinio') -obb.equity.calendar.ipo(limit=100, provider='nasdaq') -# Get all IPOs available. -obb.equity.calendar.ipo(provider='intrinio') -# Get IPOs for specific dates. -obb.equity.calendar.ipo(start_date='2024-02-01', end_date='2024-02-07', provider='nasdaq') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| 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 | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['intrinio', 'nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| 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 | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['intrinio', 'nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | -| status | Literal['upcoming', 'priced', 'withdrawn'] | Status of the IPO. [upcoming, priced, or withdrawn] | None | True | -| min_value | int | Return IPOs with an offer dollar amount greater than the given amount. | None | True | -| max_value | int | Return IPOs with an offer dollar amount less than the given amount. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| 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 | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['intrinio', 'nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | -| status | Literal['upcoming', 'priced', 'filed', 'withdrawn'] | The status of the IPO. | priced | True | -| is_spo | bool | If True, returns data for secondary public offerings (SPOs). | False | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CalendarIpo - Serializable results. - provider : Literal['intrinio', 'nasdaq'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| ipo_date | date | The date of the IPO, when the stock first trades on a major exchange. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| ipo_date | date | The date of the IPO, when the stock first trades on a major exchange. | -| status | Literal['upcoming', 'priced', 'withdrawn'] | The status of the IPO. Upcoming IPOs have not taken place yet but are expected to. Priced IPOs have taken place. Withdrawn IPOs were expected to take place, but were subsequently withdrawn and did not take place | -| exchange | str | The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ. | -| offer_amount | float | The total dollar amount of shares offered in the IPO. Typically this is share price * share count | -| share_price | float | The price per share at which the IPO was offered. | -| share_price_lowest | float | The expected lowest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs). | -| share_price_highest | float | The expected highest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs). | -| share_count | int | The number of shares offered in the IPO. | -| share_count_lowest | int | The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs). | -| share_count_highest | int | The expected highest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs). | -| announcement_url | str | The URL to the company's announcement of the IPO | -| sec_report_url | str | The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place. | -| open_price | float | The opening price at the beginning of the first trading day (only available for priced IPOs). | -| close_price | float | The closing price at the end of the first trading day (only available for priced IPOs). | -| volume | int | The volume at the end of the first trading day (only available for priced IPOs). | -| day_change | float | The percentage change between the open price and the close price on the first trading day (only available for priced IPOs). | -| week_change | float | The percentage change between the open price on the first trading day and the close price approximately a week after the first trading day (only available for priced IPOs). | -| month_change | float | The percentage change between the open price on the first trading day and the close price approximately a month after the first trading day (only available for priced IPOs). | -| id | str | The Intrinio ID of the IPO. | -| company | openbb_intrinio.utils.references.IntrinioCompany | The company that is going public via the IPO. | -| security | openbb_intrinio.utils.references.IntrinioSecurity | The primary Security for the Company that is going public via the IPO | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| ipo_date | date | The date of the IPO, when the stock first trades on a major exchange. | -| name | str | The name of the company. | -| offer_amount | float | The dollar value of the shares offered. | -| share_count | int | The number of shares offered. | -| expected_price_date | date | The date the pricing is expected. | -| filed_date | date | The date the IPO was filed. | -| withdraw_date | date | The date the IPO was withdrawn. | -| deal_status | str | The status of the deal. | - - - - diff --git a/website/content/platform/reference/equity/calendar/splits.md b/website/content/platform/reference/equity/calendar/splits.md deleted file mode 100644 index 2f3e6fa2a213..000000000000 --- a/website/content/platform/reference/equity/calendar/splits.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: "splits" -description: "Get historical and upcoming stock split operations" -keywords: -- equity -- calendar -- splits ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get historical and upcoming stock split operations. - - -Examples --------- - -```python -from openbb import obb -obb.equity.calendar.splits(provider='fmp') -# Get stock splits calendar for specific dates. -obb.equity.calendar.splits(start_date='2024-02-01', end_date='2024-02-07', provider='fmp') -``` - ---- - -## 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['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 | - - - - -| 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['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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CalendarSplits - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| label | str | Label of the stock splits. | -| symbol | str | Symbol representing the entity requested in the data. | -| numerator | float | Numerator of the stock splits. | -| denominator | float | Denominator of the stock splits. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| label | str | Label of the stock splits. | -| symbol | str | Symbol representing the entity requested in the data. | -| numerator | float | Numerator of the stock splits. | -| denominator | float | Denominator of the stock splits. | - - - - diff --git a/website/content/platform/reference/equity/compare/_category_.json b/website/content/platform/reference/equity/compare/_category_.json deleted file mode 100644 index 4e806d8d800c..000000000000 --- a/website/content/platform/reference/equity/compare/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Compare", - "position": 9 -} \ No newline at end of file diff --git a/website/content/platform/reference/equity/compare/groups.md b/website/content/platform/reference/equity/compare/groups.md deleted file mode 100644 index ca960ce791cf..000000000000 --- a/website/content/platform/reference/equity/compare/groups.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "groups" -description: "Get company data grouped by sector, industry or country and display either performance or valuation metrics" -keywords: -- equity -- compare -- groups ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get company data grouped by sector, industry or country and display either performance or valuation metrics. - -Valuation metrics include price to earnings, price to book, price to sales ratios and price to cash flow. -Performance metrics include the stock price change for different time periods. - - -Examples --------- - -```python -from openbb import obb -obb.equity.compare.groups(provider='finviz') -# Group by sector and analyze valuation. -obb.equity.compare.groups(group='sector', metric='valuation', provider='finviz') -# Group by industry and analyze performance. -obb.equity.compare.groups(group='industry', metric='performance', provider='finviz') -# Group by country and analyze valuation. -obb.equity.compare.groups(group='country', metric='valuation', provider='finviz') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| group | str | The group to compare - i.e., 'sector', 'industry', 'country'. Choices vary by provider. | None | True | -| metric | str | The type of metrics to compare - i.e, 'valuation', 'performance'. Choices vary by provider. | None | True | -| provider | Literal['finviz'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| group | str | The group to compare - i.e., 'sector', 'industry', 'country'. Choices vary by provider. | None | True | -| metric | str | The type of metrics to compare - i.e, 'valuation', 'performance'. Choices vary by provider. | None | True | -| provider | Literal['finviz'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CompareGroups - Serializable results. - provider : Literal['finviz'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name or label of the group. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | Name or label of the group. | -| stocks | int | The number of stocks in the group. | -| market_cap | int | The market cap of the group. | -| performance_1D | float | The performance in the last day, as a normalized percent. | -| performance_1W | float | The performance in the last week, as a normalized percent. | -| performance_1M | float | The performance in the last month, as a normalized percent. | -| performance_3M | float | The performance in the last quarter, as a normalized percent. | -| performance_6M | float | The performance in the last half year, as a normalized percent. | -| performance_1Y | float | The performance in the last year, as a normalized percent. | -| performance_YTD | float | The performance in the year to date, as a normalized percent. | -| dividend_yield | float | The dividend yield of the group, as a normalized percent. | -| pe | float | The P/E ratio of the group. | -| forward_pe | float | The forward P/E ratio of the group. | -| peg | float | The PEG ratio of the group. | -| eps_growth_past_5_years | float | The EPS growth of the group for the past 5 years, as a normalized percent. | -| eps_growth_next_5_years | float | The estimated EPS growth of the groupo for the next 5 years, as a normalized percent. | -| sales_growth_past_5_years | float | The sales growth of the group for the past 5 years, as a normalized percent. | -| float_short | float | The percent of the float shorted for the group, as a normalized value. | -| analyst_recommendation | float | The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. | -| volume | int | The trading volume. | -| volume_average | int | The 3-month average volume of the group. | -| volume_relative | float | The relative volume compared to the 3-month average volume. | - - - - diff --git a/website/content/platform/reference/equity/compare/index.mdx b/website/content/platform/reference/equity/compare/index.mdx deleted file mode 100644 index c7326e938dd2..000000000000 --- a/website/content/platform/reference/equity/compare/index.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Compare - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - -
- diff --git a/website/content/platform/reference/equity/compare/peers.md b/website/content/platform/reference/equity/compare/peers.md deleted file mode 100644 index b3bdc840789e..000000000000 --- a/website/content/platform/reference/equity/compare/peers.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: "peers" -description: "Learn how to compare and analyze equity peers with the `obb.equity.compare.peers` function. This function allows you to retrieve a list of company peers based on symbol, sector, exchange, and market cap. Understand the parameters, returns, and data structure provided by this function." -keywords: -- equity peers -- company peers -- compare peers -- symbol -- provider -- parameter -- returns -- data -- list of peers -- sector -- exchange -- market cap -- serializable results -- chart object -- metadata -- command execution -- warnings ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the closest peers for a given company. - -Peers consist of companies trading on the same exchange, operating within the same sector -and with comparable market capitalizations. - - -Examples --------- - -```python -from openbb import obb -obb.equity.compare.peers(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityPeers - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| peers_list | List[str] | A list of equity peers based on sector, exchange and market cap. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| peers_list | List[str] | A list of equity peers based on sector, exchange and market cap. | - - - - diff --git a/website/content/platform/reference/equity/darkpool/_category_.json b/website/content/platform/reference/equity/darkpool/_category_.json deleted file mode 100644 index 8fda2bd7ccf8..000000000000 --- a/website/content/platform/reference/equity/darkpool/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Darkpool", - "position": 7 -} \ No newline at end of file diff --git a/website/content/platform/reference/equity/darkpool/index.mdx b/website/content/platform/reference/equity/darkpool/index.mdx deleted file mode 100644 index 3f4a4c3b89e2..000000000000 --- a/website/content/platform/reference/equity/darkpool/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ -# Darkpool - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - -
- diff --git a/website/content/platform/reference/equity/darkpool/otc.md b/website/content/platform/reference/equity/darkpool/otc.md deleted file mode 100644 index 627c1a534e3a..000000000000 --- a/website/content/platform/reference/equity/darkpool/otc.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: "otc" -description: "Get weekly aggregate trade data for Over The Counter deals, including ATS trading data and non-ATS trading data. The data is provided for each ATS/firm with trade reporting obligations under FINRA rules." -keywords: -- Over The Counter deals -- ATS trading data -- FINRA rules -- symbol -- provider -- tier -- is_ats -- OBBject -- results -- OTCAggregate -- warnings -- Chart -- Metadata -- data -- update_date -- share_quantity -- trade_quantity ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the weekly aggregate trade data for Over The Counter deals. - -ATS and non-ATS trading data for each ATS/firm -with trade reporting obligations under FINRA rules. - - -Examples --------- - -```python -from openbb import obb -obb.equity.darkpool.otc(provider='finra') -# Get OTC data for a symbol -obb.equity.darkpool.otc(symbol='AAPL', provider='finra') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| provider | Literal['finra'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default. | finra | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| provider | Literal['finra'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default. | finra | True | -| tier | Literal['T1', 'T2', 'OTCE'] | 'T1 - Securities included in the S&P 500, Russell 1000 and selected exchange-traded products; T2 - All other NMS stocks; OTC - Over-the-Counter equity securities | T1 | True | -| is_ats | bool | ATS data if true, NON-ATS otherwise | True | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : OTCAggregate - Serializable results. - provider : Literal['finra'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| update_date | date | Most recent date on which total trades is updated based on data received from each ATS/OTC. | -| share_quantity | float | Aggregate weekly total number of shares reported by each ATS for the Symbol. | -| trade_quantity | float | Aggregate weekly total number of trades reported by each ATS for the Symbol | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| update_date | date | Most recent date on which total trades is updated based on data received from each ATS/OTC. | -| share_quantity | float | Aggregate weekly total number of shares reported by each ATS for the Symbol. | -| trade_quantity | float | Aggregate weekly total number of trades reported by each ATS for the Symbol | - - - - diff --git a/website/content/platform/reference/equity/discovery/_category_.json b/website/content/platform/reference/equity/discovery/_category_.json deleted file mode 100644 index 1056f289e54a..000000000000 --- a/website/content/platform/reference/equity/discovery/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Discovery", - "position": 3 -} \ No newline at end of file diff --git a/website/content/platform/reference/equity/discovery/active.md b/website/content/platform/reference/equity/discovery/active.md deleted file mode 100644 index 51ad900f224d..000000000000 --- a/website/content/platform/reference/equity/discovery/active.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "active" -description: "Learn how to get the most active ETFs using the ETF discovery API. This page provides documentation for the parameters, returns, and data associated with the API endpoint. Understand how to use the sorting, limiting, and provider parameters and explore the returned results, chart object, and metadata. Find details about the data fields including symbol, name, last price, percent change, net change, volume, date, country, mantissa, type, and formatted values. Retrieve the source url for additional information." -keywords: -- ETFs -- most active ETFs -- ETF discovery -- sort order -- limit parameter -- provider parameter -- results -- chart object -- metadata -- symbol -- name -- last price -- percent change -- net change -- volume -- date -- country -- mantissa -- type -- formatted price -- formatted volume -- formatted price change -- formatted percent change -- url ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the most actively traded stocks based on volume. - - -Examples --------- - -```python -from openbb import obb -obb.equity.discovery.active(provider='yfinance') -obb.equity.discovery.active(sort='desc', provider='yfinance') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityActive - Serializable results. - provider : Literal['yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap displayed in billions. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/reference/equity/discovery/aggressive_small_caps.md b/website/content/platform/reference/equity/discovery/aggressive_small_caps.md deleted file mode 100644 index 8b1fd5c859a9..000000000000 --- a/website/content/platform/reference/equity/discovery/aggressive_small_caps.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: "aggressive_small_caps" -description: "Learn how to get aggressive small cap equities with the equity discovery API. Understand the parameters, returns, and data format." -keywords: -- equities -- aggressive small caps -- equity discovery -- parameter -- sort order -- provider -- returns -- data -- symbol -- name -- price -- change -- percent change -- volume -- market cap -- average volume -- PE ratio -- documentation ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get top small cap stocks based on earnings growth. - - -Examples --------- - -```python -from openbb import obb -obb.equity.discovery.aggressive_small_caps(provider='yfinance') -obb.equity.discovery.aggressive_small_caps(sort='desc', provider='yfinance') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityAggressiveSmallCaps - Serializable results. - provider : Literal['yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/reference/equity/discovery/filings.md b/website/content/platform/reference/equity/discovery/filings.md deleted file mode 100644 index d6093f6c3b77..000000000000 --- a/website/content/platform/reference/equity/discovery/filings.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: "filings" -description: "Get the most-recent filings submitted to the SEC" -keywords: -- equity -- discovery -- filings ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC -filings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114, -Foreign Investment Disclosures and others. The annual 10-K report is required to be -filed annually and includes the company's financial statements, management discussion and analysis, -and audited financial statements. - - -Examples --------- - -```python -from openbb import obb -obb.equity.discovery.filings(provider='fmp') -# Get filings for the year 2023, limited to 100 results -obb.equity.discovery.filings(start_date='2023-01-01', end_date='2023-12-31', limit=100, provider='fmp') -``` - ---- - -## 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 | -| form_type | str | Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. | None | True | -| limit | int | The number of data entries to return. | 100 | 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 | - - - - -| 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 | -| form_type | str | Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. | None | True | -| limit | int | The number of data entries to return. | 100 | 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 | -| is_done | bool | Flag for whether or not the filing is done. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : DiscoveryFilings - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| title | str | Title of the filing. | -| date | datetime | The date of the data. | -| form_type | str | The form type of the filing | -| link | str | URL to the filing page on the SEC site. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| title | str | Title of the filing. | -| date | datetime | The date of the data. | -| form_type | str | The form type of the filing | -| link | str | URL to the filing page on the SEC site. | - - - - diff --git a/website/content/platform/reference/equity/discovery/gainers.md b/website/content/platform/reference/equity/discovery/gainers.md deleted file mode 100644 index 33f2d85dce6b..000000000000 --- a/website/content/platform/reference/equity/discovery/gainers.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: "gainers" -description: "Learn how to get the top ETF gainers using Python code. This documentation includes details about the parameters, return values, and data format." -keywords: -- ETF gainers -- ETFGainers -- Python code -- parameters -- sort order -- limit -- provider -- returns -- results -- warnings -- chart -- metadata -- data -- symbol -- name -- last price -- percent change -- net change -- trading volume -- date -- bluegrass channel -- country -- mantissa -- type -- formatted price -- formatted volume -- formatted price change -- formatted percent change -- url ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the top price gainers in the stock market. - - -Examples --------- - -```python -from openbb import obb -obb.equity.discovery.gainers(provider='yfinance') -obb.equity.discovery.gainers(sort='desc', provider='yfinance') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | -| category | Literal['dividend', 'energy', 'healthcare', 'industrials', 'price_performer', 'rising_stars', 'real_estate', 'tech', 'utilities', '52w_high', 'volume'] | The category of list to retrieve. Defaults to `price_performer`. | price_performer | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityGainers - Serializable results. - provider : Literal['tmx', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| rank | int | The rank of the stock in the list. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/reference/equity/discovery/growth_tech.md b/website/content/platform/reference/equity/discovery/growth_tech.md deleted file mode 100644 index b1219cf816bc..000000000000 --- a/website/content/platform/reference/equity/discovery/growth_tech.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: "growth_tech" -description: "Learn how to get growth tech equities, sort them, and retrieve detailed data such as symbol, name, price, volume, and more using the OBB.equity.discovery.growth_tech method in the provided code snippet. This documentation page also covers the parameters, returns, and available data structures." -keywords: -- growth tech equities -- tech equities -- equity discovery -- sorting -- provider -- results -- warnings -- chart -- metadata -- data -- symbol -- name -- price -- change -- percent change -- volume -- market cap -- average volume -- P/E ratio ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get top tech stocks based on revenue and earnings growth. - - -Examples --------- - -```python -from openbb import obb -obb.equity.discovery.growth_tech(provider='yfinance') -obb.equity.discovery.growth_tech(sort='desc', provider='yfinance') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : GrowthTechEquities - Serializable results. - provider : Literal['yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/reference/equity/discovery/index.mdx b/website/content/platform/reference/equity/discovery/index.mdx deleted file mode 100644 index 72125bd33a69..000000000000 --- a/website/content/platform/reference/equity/discovery/index.mdx +++ /dev/null @@ -1,18 +0,0 @@ -# Discovery - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - - - - - - - -
- diff --git a/website/content/platform/reference/equity/discovery/losers.md b/website/content/platform/reference/equity/discovery/losers.md deleted file mode 100644 index ba729523630a..000000000000 --- a/website/content/platform/reference/equity/discovery/losers.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: "losers" -description: "Learn how to get the top ETF losers using the OBB ETF Discovery API endpoint. Explore the available parameters and the returned data, including symbols, names, prices, percentage changes, and trading volumes." -keywords: -- ETF losers -- top ETF losers -- ETFLosers -- sort order -- data entries -- provider -- warnings -- chart -- metadata -- symbol -- name -- last price -- percent change -- net change -- trading volume -- date -- bluegrass channel -- country -- mantissa -- type -- formatted price -- formatted volume -- formatted price change -- formatted percent change -- source url ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the top price losers in the stock market. - - -Examples --------- - -```python -from openbb import obb -obb.equity.discovery.losers(provider='yfinance') -obb.equity.discovery.losers(sort='desc', provider='yfinance') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityLosers - Serializable results. - provider : Literal['yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/reference/equity/discovery/top_retail.md b/website/content/platform/reference/equity/discovery/top_retail.md deleted file mode 100644 index 919ffb25c64e..000000000000 --- a/website/content/platform/reference/equity/discovery/top_retail.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: "top_retail" -description: "Learn about the OBB.equity.discovery.top_retail function in Python, which tracks retail activity and sentiment for over 9,500 US traded stocks, ADRs, and ETPs. Find out how to use the function's parameters and understand the data it returns." -keywords: -- retail activity -- sentiment -- top retail -- equity discovery -- US traded stocks ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Tracks over $30B USD/day of individual investors trades. - -It gives a daily view into retail activity and sentiment for over 9,500 US traded stocks, -ADRs, and ETPs. - - -Examples --------- - -```python -from openbb import obb -obb.equity.discovery.top_retail(provider='nasdaq') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. | 5 | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. | 5 | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : TopRetail - Serializable results. - provider : Literal['nasdaq'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| activity | float | Activity of the symbol. | -| sentiment | float | Sentiment of the symbol. 1 is bullish, -1 is bearish. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| activity | float | Activity of the symbol. | -| sentiment | float | Sentiment of the symbol. 1 is bullish, -1 is bearish. | - - - - diff --git a/website/content/platform/reference/equity/discovery/undervalued_growth.md b/website/content/platform/reference/equity/discovery/undervalued_growth.md deleted file mode 100644 index ae6b9fdeda24..000000000000 --- a/website/content/platform/reference/equity/discovery/undervalued_growth.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: "undervalued_growth" -description: "Learn how to get undervalued growth equities using the equity discovery feature, and understand the various parameters, returns, and data available in the results." -keywords: -- undervalued growth equities -- equity discovery -- sort order -- provider -- results -- warnings -- chart -- metadata -- data -- symbol -- name -- price -- change -- percent change -- volume -- market cap -- average volume -- PE ratio -- TTM -- trading volume ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get potentially undervalued growth stocks. - - -Examples --------- - -```python -from openbb import obb -obb.equity.discovery.undervalued_growth(provider='yfinance') -obb.equity.discovery.undervalued_growth(sort='desc', provider='yfinance') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityUndervaluedGrowth - Serializable results. - provider : Literal['yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/reference/equity/discovery/undervalued_large_caps.md b/website/content/platform/reference/equity/discovery/undervalued_large_caps.md deleted file mode 100644 index e05845cc79d5..000000000000 --- a/website/content/platform/reference/equity/discovery/undervalued_large_caps.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: "undervalued_large_caps" -description: "Learn how to get undervalued large cap equities and explore equity discovery using the OBB equity API. Understand the parameters available, such as sorting undervalued large caps and selecting the yfinance provider. Retrieve useful equity data, including the symbol, name, price, change, percent change, volume, market cap, average volume, and PE ratio." -keywords: -- undervalued large cap equities -- equity discovery -- sorting undervalued large caps -- yfinance provider -- equity data -- symbol -- name -- price -- change -- percent change -- volume -- market cap -- average volume -- PE ratio ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get potentially undervalued large cap stocks. - - -Examples --------- - -```python -from openbb import obb -obb.equity.discovery.undervalued_large_caps(provider='yfinance') -obb.equity.discovery.undervalued_large_caps(sort='desc', provider='yfinance') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityUndervaluedLargeCaps - Serializable results. - provider : Literal['yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| price | float | Last price. | -| change | float | Change in price value. | -| percent_change | float | Percent change. | -| volume | float | The trading volume. | -| market_cap | float | Market Cap. | -| avg_volume_3_months | float | Average volume over the last 3 months in millions. | -| pe_ratio_ttm | float | PE Ratio (TTM). | - - - - diff --git a/website/content/platform/reference/equity/discovery/upcoming_release_days.md b/website/content/platform/reference/equity/discovery/upcoming_release_days.md deleted file mode 100644 index 547263a10741..000000000000 --- a/website/content/platform/reference/equity/discovery/upcoming_release_days.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: "upcoming_release_days" -description: "Learn how to get upcoming release days for equity discovery using the OBB object and the seeking alpha provider. Understand the parameters and data returned by the API." -keywords: -- upcoming release days -- equity discovery -- provider -- seeking alpha -- parameters -- returns -- data ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get upcoming earnings release dates. - - -Examples --------- - -```python -from openbb import obb -obb.equity.discovery.upcoming_release_days(provider='seeking_alpha') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['seeking_alpha'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'seeking_alpha' if there is no default. | seeking_alpha | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['seeking_alpha'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'seeking_alpha' if there is no default. | seeking_alpha | True | -| limit | int | The number of data entries to return.In this case, the number of lookahead days. | 10 | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : UpcomingReleaseDays - Serializable results. - provider : Literal['seeking_alpha'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | The full name of the asset. | -| exchange | str | The exchange the asset is traded on. | -| release_time_type | str | The type of release time. | -| release_date | date | The date of the release. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | The full name of the asset. | -| exchange | str | The exchange the asset is traded on. | -| release_time_type | str | The type of release time. | -| release_date | date | The date of the release. | -| sector_id | int | The sector ID of the asset. | - - - - diff --git a/website/content/platform/reference/equity/estimates/_category_.json b/website/content/platform/reference/equity/estimates/_category_.json deleted file mode 100644 index dd7e89ee8c6e..000000000000 --- a/website/content/platform/reference/equity/estimates/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Estimates", - "position": 2 -} \ No newline at end of file diff --git a/website/content/platform/reference/equity/estimates/analyst_search.md b/website/content/platform/reference/equity/estimates/analyst_search.md deleted file mode 100644 index 340fb8e20e50..000000000000 --- a/website/content/platform/reference/equity/estimates/analyst_search.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: "analyst_search" -description: "Search for specific analysts and get their forecast track record" -keywords: -- equity -- estimates -- analyst_search ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Search for specific analysts and get their forecast track record. - - -Examples --------- - -```python -from openbb import obb -obb.equity.estimates.analyst_search(provider='benzinga') -obb.equity.estimates.analyst_search(firm_name='Wedbush', provider='benzinga') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| analyst_name | str | A comma separated list of analyst names to bring back. Omitting will bring back all available analysts. | None | True | -| firm_name | str | A comma separated list of firm names to bring back. Omitting will bring back all available firms. | None | True | -| provider | Literal['benzinga'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| analyst_name | str | A comma separated list of analyst names to bring back. Omitting will bring back all available analysts. | None | True | -| firm_name | str | A comma separated list of firm names to bring back. Omitting will bring back all available firms. | None | True | -| provider | Literal['benzinga'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| analyst_ids | Union[str, List[str]] | A comma separated list of analyst IDs to bring back. | None | True | -| firm_ids | Union[str, List[str]] | A comma separated list of firm IDs to bring back. | None | True | -| limit | int | Number of results returned. Limit 1000. | 100 | True | -| page | int | 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. | 0 | True | -| fields | Union[str, List[str]] | 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. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : AnalystSearch - Serializable results. - provider : Literal['benzinga'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| last_updated | datetime | Date of the last update. | -| firm_name | str | Firm name of the analyst. | -| name_first | str | Analyst first name. | -| name_last | str | Analyst last name. | -| name_full | str | Analyst full name. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| last_updated | datetime | Date of the last update. | -| firm_name | str | Firm name of the analyst. | -| name_first | str | Analyst first name. | -| name_last | str | Analyst last name. | -| name_full | str | Analyst full name. | -| analyst_id | str | ID of the analyst. | -| firm_id | str | ID of the analyst firm. | -| smart_score | float | A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate | -| overall_success_rate | float | The percentage (normalized) of gain/loss ratings that resulted in a gain overall. | -| overall_avg_return_percentile | float | The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating. | -| total_ratings_percentile | float | The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts | -| total_ratings | int | Number of recommendations made by this analyst. | -| overall_gain_count | int | The number of ratings that have gained value since the date of recommendation | -| overall_loss_count | int | The number of ratings that have lost value since the date of recommendation | -| overall_average_return | float | The average percent (normalized) price difference per rating since the date of recommendation | -| overall_std_dev | float | The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation | -| gain_count_1m | int | The number of ratings that have gained value over the last month | -| loss_count_1m | int | The number of ratings that have lost value over the last month | -| average_return_1m | float | The average percent (normalized) price difference per rating over the last month | -| std_dev_1m | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month | -| gain_count_3m | int | The number of ratings that have gained value over the last 3 months | -| loss_count_3m | int | The number of ratings that have lost value over the last 3 months | -| average_return_3m | float | The average percent (normalized) price difference per rating over the last 3 months | -| std_dev_3m | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months | -| gain_count_6m | int | The number of ratings that have gained value over the last 6 months | -| loss_count_6m | int | The number of ratings that have lost value over the last 6 months | -| average_return_6m | float | The average percent (normalized) price difference per rating over the last 6 months | -| std_dev_6m | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months | -| gain_count_9m | int | The number of ratings that have gained value over the last 9 months | -| loss_count_9m | int | The number of ratings that have lost value over the last 9 months | -| average_return_9m | float | The average percent (normalized) price difference per rating over the last 9 months | -| std_dev_9m | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months | -| gain_count_1y | int | The number of ratings that have gained value over the last 1 year | -| loss_count_1y | int | The number of ratings that have lost value over the last 1 year | -| average_return_1y | float | The average percent (normalized) price difference per rating over the last 1 year | -| std_dev_1y | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year | -| gain_count_2y | int | The number of ratings that have gained value over the last 2 years | -| loss_count_2y | int | The number of ratings that have lost value over the last 2 years | -| average_return_2y | float | The average percent (normalized) price difference per rating over the last 2 years | -| std_dev_2y | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years | -| gain_count_3y | int | The number of ratings that have gained value over the last 3 years | -| loss_count_3y | int | The number of ratings that have lost value over the last 3 years | -| average_return_3y | float | The average percent (normalized) price difference per rating over the last 3 years | -| std_dev_3y | float | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years | - - - - diff --git a/website/content/platform/reference/equity/estimates/consensus.md b/website/content/platform/reference/equity/estimates/consensus.md deleted file mode 100644 index 2e2a3503fd40..000000000000 --- a/website/content/platform/reference/equity/estimates/consensus.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -title: "consensus" -description: "Learn how to access and use the Price Target Consensus functionality in your application. Explore the available parameters and understand the returned data structure." -keywords: -- Price target consensus data -- equity estimates consensus -- symbol parameter -- provider parameter -- results attribute -- provider attribute -- warnings attribute -- chart attribute -- metadata attribute -- data table -- target_high column -- target_low column -- target_consensus column -- target_median column ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get consensus price target and recommendation. - - -Examples --------- - -```python -from openbb import obb -obb.equity.estimates.consensus(symbol='AAPL', provider='fmp') -obb.equity.estimates.consensus(symbol='AAPL,MSFT', provider='yfinance') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): tmx, yfinance. | | False | -| provider | Literal['fmp', 'tmx', '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. Multiple items allowed for provider(s): tmx, yfinance. | | False | -| provider | Literal['fmp', 'tmx', '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. Multiple items allowed for provider(s): tmx, yfinance. | | False | -| provider | Literal['fmp', 'tmx', '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. Multiple items allowed for provider(s): tmx, yfinance. | | False | -| provider | Literal['fmp', 'tmx', '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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : PriceTargetConsensus - Serializable results. - provider : Literal['fmp', 'tmx', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| target_high | float | High target of the price target consensus. | -| target_low | float | Low target of the price target consensus. | -| target_consensus | float | Consensus target of the price target consensus. | -| target_median | float | Median target of the price target consensus. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| target_high | float | High target of the price target consensus. | -| target_low | float | Low target of the price target consensus. | -| target_consensus | float | Consensus target of the price target consensus. | -| target_median | float | Median target of the price target consensus. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| target_high | float | High target of the price target consensus. | -| target_low | float | Low target of the price target consensus. | -| target_consensus | float | Consensus target of the price target consensus. | -| target_median | float | Median target of the price target consensus. | -| target_upside | float | Percent of upside, as a normalized percent. | -| total_analysts | int | Total number of analyst. | -| buy_ratings | int | Number of buy ratings. | -| sell_ratings | int | Number of sell ratings. | -| hold_ratings | int | Number of hold ratings. | -| consensus_action | str | Consensus action. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| target_high | float | High target of the price target consensus. | -| target_low | float | Low target of the price target consensus. | -| target_consensus | float | Consensus target of the price target consensus. | -| target_median | float | Median target of the price target consensus. | -| recommendation | str | Recommendation - buy, sell, etc. | -| recommendation_mean | float | Mean recommendation score where 1 is strong buy and 5 is strong sell. | -| number_of_analysts | int | Number of analysts providing opinions. | -| current_price | float | Current price of the stock. | -| currency | str | Currency the stock is priced in. | - - - - diff --git a/website/content/platform/reference/equity/estimates/historical.md b/website/content/platform/reference/equity/estimates/historical.md deleted file mode 100644 index d1d7625004ee..000000000000 --- a/website/content/platform/reference/equity/estimates/historical.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: "historical" -description: "Learn about historical analyst estimates and analyst stock recommendations with the OBBPy library in Python. Explore the usage of the `obb.equity.estimates.historical` function and its parameters, including `symbol`, `period`, `limit`, and `provider`. Understand the structure of the returned object, `OBBject`, with `results`, `provider`, `warnings`, `chart`, and `metadata` properties. Dive into the available data such as `symbol`, `date`, `estimated revenue`, `ebitda`, `ebit`, `net income`, `SGA expense`, `EPS`, and the number of analysts who estimated revenue and EPS." -keywords: -- historical analyst estimates -- analyst stock recommendations -- python obb.equity.estimates.historical -- parameters -- standard -- symbol -- union[str, list[str]] -- period -- literal['quarter', 'annual'] -- limit -- int -- provider -- literal['fmp'] -- returns -- obbject -- list[analystestimates] -- serializable results -- optional[literal['fmp']] -- optional[list[warning_]] -- optional[chart] -- optional[metadata] -- data -- symbol -- str -- date -- estimated revenue low -- estimated revenue high -- estimated revenue average -- estimated ebitda low -- estimated ebitda high -- estimated ebitda average -- estimated ebit low -- estimated ebit high -- estimated ebit average -- estimated net income low -- estimated net income high -- estimated net income average -- estimated sga expense low -- estimated sga expense high -- estimated sga expense average -- estimated eps average -- estimated eps high -- estimated eps low -- number of analysts who estimated revenue -- number of analysts who estimated eps ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get historical analyst estimates for earnings and revenue. - - -Examples --------- - -```python -from openbb import obb -obb.equity.estimates.historical(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : AnalystEstimates - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## 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. | - - - - -| 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/reference/equity/estimates/index.mdx b/website/content/platform/reference/equity/estimates/index.mdx deleted file mode 100644 index 2a9d4e84fee8..000000000000 --- a/website/content/platform/reference/equity/estimates/index.mdx +++ /dev/null @@ -1,12 +0,0 @@ -# Estimates - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - -
- diff --git a/website/content/platform/reference/equity/estimates/price_target.md b/website/content/platform/reference/equity/estimates/price_target.md deleted file mode 100644 index 44be58a5baea..000000000000 --- a/website/content/platform/reference/equity/estimates/price_target.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -title: "price_target" -description: "Get price target data for an equity symbol. Retrieve information such as publication date, analyst details, price target, and more. Supports multiple symbols and customizable providers." -keywords: -- price target data -- equity estimates -- symbol -- provider -- grade -- published date -- news URL -- news title -- analyst name -- analyst company -- price target -- adjusted price target -- price when posted -- news publisher -- news base URL ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get analyst price targets by company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.estimates.price_target(provider='benzinga') -# Get price targets for Microsoft using 'benzinga' as provider. -obb.equity.estimates.price_target(start_date=2020-01-01, end_date=2024-02-16, limit=10, symbol='msft', provider='benzinga', action=downgrades) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): benzinga, finviz. | None | True | -| limit | int | The number of data entries to return. | 200 | True | -| provider | Literal['benzinga', 'finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): benzinga, finviz. | None | True | -| limit | int | The number of data entries to return. | 200 | True | -| provider | Literal['benzinga', 'finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| page | int | 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. | 0 | True | -| date | Union[date, str] | Date for calendar data, shorthand for date_from and date_to. | None | True | -| 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 | -| updated | Union[date, int] | 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. | None | True | -| importance | int | Importance level to filter by. Uses Greater Than or Equal To the importance indicated | None | True | -| action | Literal['downgrades', 'maintains', 'reinstates', 'reiterates', 'upgrades', 'assumes', 'initiates', 'terminates', 'removes', 'suspends', 'firm_dissolved'] | Filter by a specific action_company. | None | True | -| analyst_ids | Union[str, List[str]] | Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. | None | True | -| firm_ids | Union[str, List[str]] | Comma-separated list of firm IDs. | None | True | -| fields | Union[str, List[str]] | 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. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): benzinga, finviz. | None | True | -| limit | int | The number of data entries to return. | 200 | True | -| provider | Literal['benzinga', 'finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): benzinga, finviz. | None | True | -| limit | int | The number of data entries to return. | 200 | True | -| provider | Literal['benzinga', 'finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| with_grade | bool | Include upgrades and downgrades in the response. | False | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : PriceTarget - Serializable results. - provider : Literal['benzinga', 'finviz', 'fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| published_date | Union[date, datetime] | Published date of the price target. | -| published_time | datetime.time | Time of the original rating, UTC. | -| symbol | str | Symbol representing the entity requested in the data. | -| exchange | str | Exchange where the company is traded. | -| company_name | str | Name of company that is the subject of rating. | -| analyst_name | str | Analyst name. | -| analyst_firm | str | Name of the analyst firm that published the price target. | -| currency | str | Currency the data is denominated in. | -| price_target | float | The current price target. | -| adj_price_target | float | Adjusted price target for splits and stock dividends. | -| price_target_previous | float | Previous price target. | -| previous_adj_price_target | float | Previous adjusted price target. | -| price_when_posted | float | Price when posted. | -| rating_current | str | The analyst's rating for the company. | -| rating_previous | str | Previous analyst rating for the company. | -| action | str | Description of the change in rating from firm's last rating. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| published_date | Union[date, datetime] | Published date of the price target. | -| published_time | datetime.time | Time of the original rating, UTC. | -| symbol | str | Symbol representing the entity requested in the data. | -| exchange | str | Exchange where the company is traded. | -| company_name | str | Name of company that is the subject of rating. | -| analyst_name | str | Analyst name. | -| analyst_firm | str | Name of the analyst firm that published the price target. | -| currency | str | Currency the data is denominated in. | -| price_target | float | The current price target. | -| adj_price_target | float | Adjusted price target for splits and stock dividends. | -| price_target_previous | float | Previous price target. | -| previous_adj_price_target | float | Previous adjusted price target. | -| price_when_posted | float | Price when posted. | -| rating_current | str | The analyst's rating for the company. | -| rating_previous | str | Previous analyst rating for the company. | -| action | str | Description of the change in rating from firm's last rating. | -| action_change | Literal['Announces', 'Maintains', 'Lowers', 'Raises', 'Removes', 'Adjusts'] | Description of the change in price target from firm's last price target. | -| importance | Literal[0, 1, 2, 3, 4, 5] | Subjective Basis of How Important Event is to Market. 5 = High | -| notes | str | Notes of the price target. | -| analyst_id | str | Id of the analyst. | -| url_news | str | URL for analyst ratings news articles for this ticker on Benzinga.com. | -| url_analyst | str | URL for analyst ratings page for this ticker on Benzinga.com. | -| id | str | Unique ID of this entry. | -| last_updated | datetime | Last updated timestamp, UTC. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| published_date | Union[date, datetime] | Published date of the price target. | -| published_time | datetime.time | Time of the original rating, UTC. | -| symbol | str | Symbol representing the entity requested in the data. | -| exchange | str | Exchange where the company is traded. | -| company_name | str | Name of company that is the subject of rating. | -| analyst_name | str | Analyst name. | -| analyst_firm | str | Name of the analyst firm that published the price target. | -| currency | str | Currency the data is denominated in. | -| price_target | float | The current price target. | -| adj_price_target | float | Adjusted price target for splits and stock dividends. | -| price_target_previous | float | Previous price target. | -| previous_adj_price_target | float | Previous adjusted price target. | -| price_when_posted | float | Price when posted. | -| rating_current | str | The analyst's rating for the company. | -| rating_previous | str | Previous analyst rating for the company. | -| action | str | Description of the change in rating from firm's last rating. | -| status | str | The action taken by the firm. This could be 'Upgrade', 'Downgrade', 'Reiterated', etc. | -| rating_change | str | The rating given by the analyst. This could be 'Buy', 'Sell', 'Underweight', etc. If the rating is a revision, the change is indicated by '->' | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| published_date | Union[date, datetime] | Published date of the price target. | -| published_time | datetime.time | Time of the original rating, UTC. | -| symbol | str | Symbol representing the entity requested in the data. | -| exchange | str | Exchange where the company is traded. | -| company_name | str | Name of company that is the subject of rating. | -| analyst_name | str | Analyst name. | -| analyst_firm | str | Name of the analyst firm that published the price target. | -| currency | str | Currency the data is denominated in. | -| price_target | float | The current price target. | -| adj_price_target | float | Adjusted price target for splits and stock dividends. | -| price_target_previous | float | Previous price target. | -| previous_adj_price_target | float | Previous adjusted price target. | -| price_when_posted | float | Price when posted. | -| rating_current | str | The analyst's rating for the company. | -| rating_previous | str | Previous analyst rating for the company. | -| action | str | Description of the change in rating from firm's last rating. | -| news_url | str | News URL of the price target. | -| news_title | str | News title of the price target. | -| news_publisher | str | News publisher of the price target. | -| news_base_url | str | News base URL of the price target. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/_category_.json b/website/content/platform/reference/equity/fundamental/_category_.json deleted file mode 100644 index d2386ab07154..000000000000 --- a/website/content/platform/reference/equity/fundamental/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Fundamental", - "position": 4 -} \ No newline at end of file diff --git a/website/content/platform/reference/equity/fundamental/balance.md b/website/content/platform/reference/equity/fundamental/balance.md deleted file mode 100644 index 23acc63d0546..000000000000 --- a/website/content/platform/reference/equity/fundamental/balance.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -title: "balance" -description: "Learn how to use the balance sheet function in Python to retrieve financial statement data. This documentation provides details about the function parameters, return values, and available data types." -keywords: -- balance sheet statement -- balance sheet function -- python function -- financial statement function -- balance sheet data parameters -- balance sheet data returns -- balance sheet data types ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the balance sheet for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.balance(symbol='AAPL', provider='fmp') -obb.equity.fundamental.balance(symbol='AAPL', period='annual', limit=5, provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | -| fiscal_year | int | The specific fiscal year. Reports do not go beyond 2008. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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. | True | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : BalanceSheet - Serializable results. - provider : Literal['fmp', 'intrinio', 'polygon', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| filing_date | date | The date when the filing was made. | -| accepted_date | datetime | The date and time when the filing was accepted. | -| reported_currency | str | The currency in which the balance sheet was reported. | -| cash_and_cash_equivalents | float | Cash and cash equivalents. | -| short_term_investments | float | Short term investments. | -| cash_and_short_term_investments | float | Cash and short term investments. | -| net_receivables | float | Net receivables. | -| inventory | float | Inventory. | -| other_current_assets | float | Other current assets. | -| total_current_assets | float | Total current assets. | -| plant_property_equipment_net | float | Plant property equipment net. | -| goodwill | float | Goodwill. | -| intangible_assets | float | Intangible assets. | -| goodwill_and_intangible_assets | float | Goodwill and intangible assets. | -| long_term_investments | float | Long term investments. | -| tax_assets | float | Tax assets. | -| other_non_current_assets | float | Other non current assets. | -| non_current_assets | float | Total non current assets. | -| other_assets | float | Other assets. | -| total_assets | float | Total assets. | -| accounts_payable | float | Accounts payable. | -| short_term_debt | float | Short term debt. | -| tax_payables | float | Tax payables. | -| current_deferred_revenue | float | Current deferred revenue. | -| other_current_liabilities | float | Other current liabilities. | -| total_current_liabilities | float | Total current liabilities. | -| long_term_debt | float | Long term debt. | -| deferred_revenue_non_current | float | Non current deferred revenue. | -| deferred_tax_liabilities_non_current | float | Deferred tax liabilities non current. | -| other_non_current_liabilities | float | Other non current liabilities. | -| total_non_current_liabilities | float | Total non current liabilities. | -| other_liabilities | float | Other liabilities. | -| capital_lease_obligations | float | Capital lease obligations. | -| total_liabilities | float | Total liabilities. | -| preferred_stock | float | Preferred stock. | -| common_stock | float | Common stock. | -| retained_earnings | float | Retained earnings. | -| accumulated_other_comprehensive_income | float | Accumulated other comprehensive income (loss). | -| other_shareholders_equity | float | Other shareholders equity. | -| other_total_shareholders_equity | float | Other total shareholders equity. | -| total_common_equity | float | Total common equity. | -| total_equity_non_controlling_interests | float | Total equity non controlling interests. | -| total_liabilities_and_shareholders_equity | float | Total liabilities and shareholders equity. | -| minority_interest | float | Minority interest. | -| total_liabilities_and_total_equity | float | Total liabilities and total equity. | -| total_investments | float | Total investments. | -| total_debt | float | Total debt. | -| net_debt | float | Net debt. | -| link | str | Link to the filing. | -| final_link | str | Link to the filing document. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| reported_currency | str | The currency in which the balance sheet is reported. | -| cash_and_cash_equivalents | float | Cash and cash equivalents. | -| cash_and_due_from_banks | float | Cash and due from banks. | -| restricted_cash | float | Restricted cash. | -| short_term_investments | float | Short term investments. | -| federal_funds_sold | float | Federal funds sold. | -| accounts_receivable | float | Accounts receivable. | -| note_and_lease_receivable | float | Note and lease receivable. (Vendor non-trade receivables) | -| inventories | float | Net Inventories. | -| customer_and_other_receivables | float | Customer and other receivables. | -| interest_bearing_deposits_at_other_banks | float | Interest bearing deposits at other banks. | -| time_deposits_placed_and_other_short_term_investments | float | Time deposits placed and other short term investments. | -| trading_account_securities | float | Trading account securities. | -| loans_and_leases | float | Loans and leases. | -| allowance_for_loan_and_lease_losses | float | Allowance for loan and lease losses. | -| current_deferred_refundable_income_taxes | float | Current deferred refundable income taxes. | -| other_current_assets | float | Other current assets. | -| loans_and_leases_net_of_allowance | float | Loans and leases net of allowance. | -| accrued_investment_income | float | Accrued investment income. | -| other_current_non_operating_assets | float | Other current non-operating assets. | -| loans_held_for_sale | float | Loans held for sale. | -| prepaid_expenses | float | Prepaid expenses. | -| total_current_assets | float | Total current assets. | -| plant_property_equipment_gross | float | Plant property equipment gross. | -| accumulated_depreciation | float | Accumulated depreciation. | -| premises_and_equipment_net | float | Net premises and equipment. | -| plant_property_equipment_net | float | Net plant property equipment. | -| long_term_investments | float | Long term investments. | -| mortgage_servicing_rights | float | Mortgage servicing rights. | -| unearned_premiums_asset | float | Unearned premiums asset. | -| non_current_note_lease_receivables | float | Non-current note lease receivables. | -| deferred_acquisition_cost | float | Deferred acquisition cost. | -| goodwill | float | Goodwill. | -| separate_account_business_assets | float | Separate account business assets. | -| non_current_deferred_refundable_income_taxes | float | Noncurrent deferred refundable income taxes. | -| intangible_assets | float | Intangible assets. | -| employee_benefit_assets | float | Employee benefit assets. | -| other_assets | float | Other assets. | -| other_non_current_operating_assets | float | Other noncurrent operating assets. | -| other_non_current_non_operating_assets | float | Other noncurrent non-operating assets. | -| interest_bearing_deposits | float | Interest bearing deposits. | -| total_non_current_assets | float | Total noncurrent assets. | -| total_assets | float | Total assets. | -| non_interest_bearing_deposits | float | Non interest bearing deposits. | -| federal_funds_purchased_and_securities_sold | float | Federal funds purchased and securities sold. | -| bankers_acceptance_outstanding | float | Bankers acceptance outstanding. | -| short_term_debt | float | Short term debt. | -| accounts_payable | float | Accounts payable. | -| current_deferred_revenue | float | Current deferred revenue. | -| current_deferred_payable_income_tax_liabilities | float | Current deferred payable income tax liabilities. | -| accrued_interest_payable | float | Accrued interest payable. | -| accrued_expenses | float | Accrued expenses. | -| other_short_term_payables | float | Other short term payables. | -| customer_deposits | float | Customer deposits. | -| dividends_payable | float | Dividends payable. | -| claims_and_claim_expense | float | Claims and claim expense. | -| future_policy_benefits | float | Future policy benefits. | -| current_employee_benefit_liabilities | float | Current employee benefit liabilities. | -| unearned_premiums_liability | float | Unearned premiums liability. | -| other_taxes_payable | float | Other taxes payable. | -| policy_holder_funds | float | Policy holder funds. | -| other_current_liabilities | float | Other current liabilities. | -| other_current_non_operating_liabilities | float | Other current non-operating liabilities. | -| separate_account_business_liabilities | float | Separate account business liabilities. | -| total_current_liabilities | float | Total current liabilities. | -| long_term_debt | float | Long term debt. | -| other_long_term_liabilities | float | Other long term liabilities. | -| non_current_deferred_revenue | float | Non-current deferred revenue. | -| non_current_deferred_payable_income_tax_liabilities | float | Non-current deferred payable income tax liabilities. | -| non_current_employee_benefit_liabilities | float | Non-current employee benefit liabilities. | -| other_non_current_operating_liabilities | float | Other non-current operating liabilities. | -| other_non_current_non_operating_liabilities | float | Other non-current, non-operating liabilities. | -| total_non_current_liabilities | float | Total non-current liabilities. | -| capital_lease_obligations | float | Capital lease obligations. | -| asset_retirement_reserve_litigation_obligation | float | Asset retirement reserve litigation obligation. | -| total_liabilities | float | Total liabilities. | -| commitments_contingencies | float | Commitments contingencies. | -| redeemable_non_controlling_interest | float | Redeemable non-controlling interest. | -| preferred_stock | float | Preferred stock. | -| common_stock | float | Common stock. | -| retained_earnings | float | Retained earnings. | -| treasury_stock | float | Treasury stock. | -| accumulated_other_comprehensive_income | float | Accumulated other comprehensive income. | -| participating_policy_holder_equity | float | Participating policy holder equity. | -| other_equity_adjustments | float | Other equity adjustments. | -| total_common_equity | float | Total common equity. | -| total_preferred_common_equity | float | Total preferred common equity. | -| non_controlling_interest | float | Non-controlling interest. | -| total_equity_non_controlling_interests | float | Total equity non-controlling interests. | -| total_liabilities_shareholders_equity | float | Total liabilities and shareholders equity. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| accounts_receivable | int | Accounts receivable | -| marketable_securities | int | Marketable securities | -| prepaid_expenses | int | Prepaid expenses | -| other_current_assets | int | Other current assets | -| total_current_assets | int | Total current assets | -| property_plant_equipment_net | int | Property plant and equipment net | -| inventory | int | Inventory | -| other_non_current_assets | int | Other non-current assets | -| total_non_current_assets | int | Total non-current assets | -| intangible_assets | int | Intangible assets | -| total_assets | int | Total assets | -| accounts_payable | int | Accounts payable | -| employee_wages | int | Employee wages | -| other_current_liabilities | int | Other current liabilities | -| total_current_liabilities | int | Total current liabilities | -| other_non_current_liabilities | int | Other non-current liabilities | -| total_non_current_liabilities | int | Total non-current liabilities | -| long_term_debt | int | Long term debt | -| total_liabilities | int | Total liabilities | -| minority_interest | int | Minority interest | -| temporary_equity_attributable_to_parent | int | Temporary equity attributable to parent | -| equity_attributable_to_parent | int | Equity attributable to parent | -| temporary_equity | int | Temporary equity | -| preferred_stock | int | Preferred stock | -| redeemable_non_controlling_interest | int | Redeemable non-controlling interest | -| redeemable_non_controlling_interest_other | int | Redeemable non-controlling interest other | -| total_stock_holders_equity | int | Total stock holders equity | -| total_liabilities_and_stock_holders_equity | int | Total liabilities and stockholders equity | -| total_equity | int | Total equity | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/balance_growth.md b/website/content/platform/reference/equity/fundamental/balance_growth.md deleted file mode 100644 index fe188a8f1d61..000000000000 --- a/website/content/platform/reference/equity/fundamental/balance_growth.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -title: "balance_growth" -description: "Learn about balance sheet statement growth, equity data for a company, parameters like symbol, limit, and provider, and explore the returned results, warnings, charts, and metadata. Retrieve detailed data on various balance sheet growth metrics like cash and cash equivalents, short-term investments, inventory, total assets, total liabilities, and more." -keywords: -- balance sheet statement growth -- company balance sheet growth -- equity data -- symbol -- limit parameter -- provider parameter -- results -- balance sheet growth -- warnings -- chart -- metadata -- data -- cash and cash equivalents -- short-term investments -- net receivables -- inventory -- current assets -- property, plant, and equipment -- goodwill -- intangible assets -- long-term investments -- tax assets -- other non-current assets -- total non-current assets -- other assets -- total assets -- accounts payable -- short-term debt -- total current liabilities -- long-term debt -- non-current deferred revenue -- non-current deferred tax liabilities -- total non-current liabilities -- common stock -- retained earnings -- accumulated other comprehensive income/loss -- total stockholders' equity -- total liabilities and stockholders' equity -- total investments -- total debt -- net debt ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the growth of a company's balance sheet items over time. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.balance_growth(symbol='AAPL', provider='fmp') -obb.equity.fundamental.balance_growth(symbol='AAPL', limit=10, provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : BalanceSheetGrowth - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| period | str | Reporting period. | -| growth_cash_and_cash_equivalents | float | Growth rate of cash and cash equivalents. | -| growth_short_term_investments | float | Growth rate of short-term investments. | -| growth_cash_and_short_term_investments | float | Growth rate of cash and short-term investments. | -| growth_net_receivables | float | Growth rate of net receivables. | -| growth_inventory | float | Growth rate of inventory. | -| growth_other_current_assets | float | Growth rate of other current assets. | -| growth_total_current_assets | float | Growth rate of total current assets. | -| growth_property_plant_equipment_net | float | Growth rate of net property, plant, and equipment. | -| growth_goodwill | float | Growth rate of goodwill. | -| growth_intangible_assets | float | Growth rate of intangible assets. | -| growth_goodwill_and_intangible_assets | float | Growth rate of goodwill and intangible assets. | -| growth_long_term_investments | float | Growth rate of long-term investments. | -| growth_tax_assets | float | Growth rate of tax assets. | -| growth_other_non_current_assets | float | Growth rate of other non-current assets. | -| growth_total_non_current_assets | float | Growth rate of total non-current assets. | -| growth_other_assets | float | Growth rate of other assets. | -| growth_total_assets | float | Growth rate of total assets. | -| growth_account_payables | float | Growth rate of accounts payable. | -| growth_short_term_debt | float | Growth rate of short-term debt. | -| growth_tax_payables | float | Growth rate of tax payables. | -| growth_deferred_revenue | float | Growth rate of deferred revenue. | -| growth_other_current_liabilities | float | Growth rate of other current liabilities. | -| growth_total_current_liabilities | float | Growth rate of total current liabilities. | -| growth_long_term_debt | float | Growth rate of long-term debt. | -| growth_deferred_revenue_non_current | float | Growth rate of non-current deferred revenue. | -| growth_deferrred_tax_liabilities_non_current | float | Growth rate of non-current deferred tax liabilities. | -| growth_other_non_current_liabilities | float | Growth rate of other non-current liabilities. | -| growth_total_non_current_liabilities | float | Growth rate of total non-current liabilities. | -| growth_other_liabilities | float | Growth rate of other liabilities. | -| growth_total_liabilities | float | Growth rate of total liabilities. | -| growth_common_stock | float | Growth rate of common stock. | -| growth_retained_earnings | float | Growth rate of retained earnings. | -| growth_accumulated_other_comprehensive_income_loss | float | Growth rate of accumulated other comprehensive income/loss. | -| growth_othertotal_stockholders_equity | float | Growth rate of other total stockholders' equity. | -| growth_total_stockholders_equity | float | Growth rate of total stockholders' equity. | -| growth_total_liabilities_and_stockholders_equity | float | Growth rate of total liabilities and stockholders' equity. | -| growth_total_investments | float | Growth rate of total investments. | -| growth_total_debt | float | Growth rate of total debt. | -| growth_net_debt | float | Growth rate of net debt. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| period | str | Reporting period. | -| growth_cash_and_cash_equivalents | float | Growth rate of cash and cash equivalents. | -| growth_short_term_investments | float | Growth rate of short-term investments. | -| growth_cash_and_short_term_investments | float | Growth rate of cash and short-term investments. | -| growth_net_receivables | float | Growth rate of net receivables. | -| growth_inventory | float | Growth rate of inventory. | -| growth_other_current_assets | float | Growth rate of other current assets. | -| growth_total_current_assets | float | Growth rate of total current assets. | -| growth_property_plant_equipment_net | float | Growth rate of net property, plant, and equipment. | -| growth_goodwill | float | Growth rate of goodwill. | -| growth_intangible_assets | float | Growth rate of intangible assets. | -| growth_goodwill_and_intangible_assets | float | Growth rate of goodwill and intangible assets. | -| growth_long_term_investments | float | Growth rate of long-term investments. | -| growth_tax_assets | float | Growth rate of tax assets. | -| growth_other_non_current_assets | float | Growth rate of other non-current assets. | -| growth_total_non_current_assets | float | Growth rate of total non-current assets. | -| growth_other_assets | float | Growth rate of other assets. | -| growth_total_assets | float | Growth rate of total assets. | -| growth_account_payables | float | Growth rate of accounts payable. | -| growth_short_term_debt | float | Growth rate of short-term debt. | -| growth_tax_payables | float | Growth rate of tax payables. | -| growth_deferred_revenue | float | Growth rate of deferred revenue. | -| growth_other_current_liabilities | float | Growth rate of other current liabilities. | -| growth_total_current_liabilities | float | Growth rate of total current liabilities. | -| growth_long_term_debt | float | Growth rate of long-term debt. | -| growth_deferred_revenue_non_current | float | Growth rate of non-current deferred revenue. | -| growth_deferrred_tax_liabilities_non_current | float | Growth rate of non-current deferred tax liabilities. | -| growth_other_non_current_liabilities | float | Growth rate of other non-current liabilities. | -| growth_total_non_current_liabilities | float | Growth rate of total non-current liabilities. | -| growth_other_liabilities | float | Growth rate of other liabilities. | -| growth_total_liabilities | float | Growth rate of total liabilities. | -| growth_common_stock | float | Growth rate of common stock. | -| growth_retained_earnings | float | Growth rate of retained earnings. | -| growth_accumulated_other_comprehensive_income_loss | float | Growth rate of accumulated other comprehensive income/loss. | -| growth_othertotal_stockholders_equity | float | Growth rate of other total stockholders' equity. | -| growth_total_stockholders_equity | float | Growth rate of total stockholders' equity. | -| growth_total_liabilities_and_stockholders_equity | float | Growth rate of total liabilities and stockholders' equity. | -| growth_total_investments | float | Growth rate of total investments. | -| growth_total_debt | float | Growth rate of total debt. | -| growth_net_debt | float | Growth rate of net debt. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/cash.md b/website/content/platform/reference/equity/fundamental/cash.md deleted file mode 100644 index f2da3fffc2ed..000000000000 --- a/website/content/platform/reference/equity/fundamental/cash.md +++ /dev/null @@ -1,307 +0,0 @@ ---- -title: "cash" -description: "Learn how to use the Cash Flow Statement API endpoint to retrieve information about cash flow statements. Understand the parameters and return values of the API, and explore the available data fields for cash flow statements." -keywords: -- Cash Flow Statement -- cash flow statement parameters -- cash flow statement returns -- cash flow statement data -- python obb.equity.fundamental.cash -- symbol -- period -- limit -- provider -- cik -- filing date -- period of report date -- include sources -- order -- sort -- net income -- depreciation and amortization -- stock based compensation -- deferred income tax -- other non-cash items -- changes in operating assets and liabilities -- accounts receivables -- inventory -- vendor non-trade receivables -- other current and non-current assets -- accounts payables -- deferred revenue -- other current and non-current liabilities -- net cash flow from operating activities -- purchases of marketable securities -- sales from maturities of investments -- investments in property plant and equipment -- payments from acquisitions -- other investing activities -- net cash flow from investing activities -- taxes paid on net share settlement -- dividends paid -- common stock repurchased -- debt proceeds -- debt repayment -- other financing activities -- net cash flow from financing activities -- net change in cash ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the cash flow statement for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.cash(symbol='AAPL', provider='fmp') -obb.equity.fundamental.cash(symbol='AAPL', period='annual', limit=5, provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | -| fiscal_year | int | The specific fiscal year. Reports do not go beyond 2008. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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. | False | True | -| order | Literal[None, 'asc', 'desc'] | Order of the financial statement. | None | True | -| sort | Literal[None, 'filing_date', 'period_of_report_date'] | Sort of the financial statement. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CashFlowStatement - Serializable results. - provider : Literal['fmp', 'intrinio', 'polygon', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | The date the filing was accepted. | -| reported_currency | str | The currency in which the cash flow statement was reported. | -| net_income | float | Net income. | -| depreciation_and_amortization | float | Depreciation and amortization. | -| deferred_income_tax | float | Deferred income tax. | -| stock_based_compensation | float | Stock-based compensation. | -| change_in_working_capital | float | Change in working capital. | -| change_in_account_receivables | float | Change in account receivables. | -| change_in_inventory | float | Change in inventory. | -| change_in_account_payable | float | Change in account payable. | -| change_in_other_working_capital | float | Change in other working capital. | -| change_in_other_non_cash_items | float | Change in other non-cash items. | -| net_cash_from_operating_activities | float | Net cash from operating activities. | -| purchase_of_property_plant_and_equipment | float | Purchase of property, plant and equipment. | -| acquisitions | float | Acquisitions. | -| purchase_of_investment_securities | float | Purchase of investment securities. | -| sale_and_maturity_of_investments | float | Sale and maturity of investments. | -| other_investing_activities | float | Other investing activities. | -| net_cash_from_investing_activities | float | Net cash from investing activities. | -| repayment_of_debt | float | Repayment of debt. | -| issuance_of_common_equity | float | Issuance of common equity. | -| repurchase_of_common_equity | float | Repurchase of common equity. | -| payment_of_dividends | float | Payment of dividends. | -| other_financing_activities | float | Other financing activities. | -| net_cash_from_financing_activities | float | Net cash from financing activities. | -| effect_of_exchange_rate_changes_on_cash | float | Effect of exchange rate changes on cash. | -| net_change_in_cash_and_equivalents | float | Net change in cash and equivalents. | -| cash_at_beginning_of_period | float | Cash at beginning of period. | -| cash_at_end_of_period | float | Cash at end of period. | -| operating_cash_flow | float | Operating cash flow. | -| capital_expenditure | float | Capital expenditure. | -| free_cash_flow | float | None | -| link | str | Link to the filing. | -| final_link | str | Link to the filing document. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| reported_currency | str | The currency in which the balance sheet is reported. | -| net_income_continuing_operations | float | Net Income (Continuing Operations) | -| net_income_discontinued_operations | float | Net Income (Discontinued Operations) | -| net_income | float | Consolidated Net Income. | -| provision_for_loan_losses | float | Provision for Loan Losses | -| provision_for_credit_losses | float | Provision for credit losses | -| depreciation_expense | float | Depreciation Expense. | -| amortization_expense | float | Amortization Expense. | -| share_based_compensation | float | Share-based compensation. | -| non_cash_adjustments_to_reconcile_net_income | float | Non-Cash Adjustments to Reconcile Net Income. | -| changes_in_operating_assets_and_liabilities | float | Changes in Operating Assets and Liabilities (Net) | -| net_cash_from_continuing_operating_activities | float | Net Cash from Continuing Operating Activities | -| net_cash_from_discontinued_operating_activities | float | Net Cash from Discontinued Operating Activities | -| net_cash_from_operating_activities | float | Net Cash from Operating Activities | -| divestitures | float | Divestitures | -| sale_of_property_plant_and_equipment | float | Sale of Property, Plant, and Equipment | -| acquisitions | float | Acquisitions | -| purchase_of_investments | float | Purchase of Investments | -| purchase_of_investment_securities | float | Purchase of Investment Securities | -| sale_and_maturity_of_investments | float | Sale and Maturity of Investments | -| loans_held_for_sale | float | Loans Held for Sale (Net) | -| purchase_of_property_plant_and_equipment | float | Purchase of Property, Plant, and Equipment | -| other_investing_activities | float | Other Investing Activities (Net) | -| net_cash_from_continuing_investing_activities | float | Net Cash from Continuing Investing Activities | -| net_cash_from_discontinued_investing_activities | float | Net Cash from Discontinued Investing Activities | -| net_cash_from_investing_activities | float | Net Cash from Investing Activities | -| payment_of_dividends | float | Payment of Dividends | -| repurchase_of_common_equity | float | Repurchase of Common Equity | -| repurchase_of_preferred_equity | float | Repurchase of Preferred Equity | -| issuance_of_common_equity | float | Issuance of Common Equity | -| issuance_of_preferred_equity | float | Issuance of Preferred Equity | -| issuance_of_debt | float | Issuance of Debt | -| repayment_of_debt | float | Repayment of Debt | -| other_financing_activities | float | Other Financing Activities (Net) | -| cash_interest_received | float | Cash Interest Received | -| net_change_in_deposits | float | Net Change in Deposits | -| net_increase_in_fed_funds_sold | float | Net Increase in Fed Funds Sold | -| net_cash_from_continuing_financing_activities | float | Net Cash from Continuing Financing Activities | -| net_cash_from_discontinued_financing_activities | float | Net Cash from Discontinued Financing Activities | -| net_cash_from_financing_activities | float | Net Cash from Financing Activities | -| effect_of_exchange_rate_changes | float | Effect of Exchange Rate Changes | -| other_net_changes_in_cash | float | Other Net Changes in Cash | -| net_change_in_cash_and_equivalents | float | Net Change in Cash and Equivalents | -| cash_income_taxes_paid | float | Cash Income Taxes Paid | -| cash_interest_paid | float | Cash Interest Paid | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| net_cash_flow_from_operating_activities_continuing | int | Net cash flow from operating activities continuing. | -| net_cash_flow_from_operating_activities_discontinued | int | Net cash flow from operating activities discontinued. | -| net_cash_flow_from_operating_activities | int | Net cash flow from operating activities. | -| net_cash_flow_from_investing_activities_continuing | int | Net cash flow from investing activities continuing. | -| net_cash_flow_from_investing_activities_discontinued | int | Net cash flow from investing activities discontinued. | -| net_cash_flow_from_investing_activities | int | Net cash flow from investing activities. | -| net_cash_flow_from_financing_activities_continuing | int | Net cash flow from financing activities continuing. | -| net_cash_flow_from_financing_activities_discontinued | int | Net cash flow from financing activities discontinued. | -| net_cash_flow_from_financing_activities | int | Net cash flow from financing activities. | -| net_cash_flow_continuing | int | Net cash flow continuing. | -| net_cash_flow_discontinued | int | Net cash flow discontinued. | -| exchange_gains_losses | int | Exchange gains losses. | -| net_cash_flow | int | Net cash flow. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/cash_growth.md b/website/content/platform/reference/equity/fundamental/cash_growth.md deleted file mode 100644 index 769f19c40c10..000000000000 --- a/website/content/platform/reference/equity/fundamental/cash_growth.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: "cash_growth" -description: "Learn about Cash Flow Statement Growth and how to retrieve cash growth data using the Python function obb.equity.fundamental.cash_growth(). This page provides details on the function's parameters and the data it returns, including information on net income, depreciation and amortization, working capital, investments, financing activities, and more." -keywords: -- Cash Flow Statement Growth -- company cash flow -- cash growth -- Python -- function -- parameters -- symbol -- limit -- provider -- data -- returns -- net income -- depreciation and amortization -- deferred income tax -- stock-based compensation -- working capital -- accounts receivables -- inventory -- accounts payables -- other non-cash items -- net cash provided by operating activities -- investments in property, plant, and equipment -- net acquisitions -- purchases of investments -- sales maturities of investments -- net cash used for investing activities -- debt repayment -- common stock issued -- common stock repurchased -- dividends paid -- net cash used/provided by financing activities -- foreign exchange changes on cash -- net change in cash -- cash at end of period -- cash at beginning of period -- operating cash flow -- capital expenditure -- free cash flow ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the growth of a company's cash flow statement items over time. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.cash_growth(symbol='AAPL', provider='fmp') -obb.equity.fundamental.cash_growth(symbol='AAPL', limit=10, provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CashFlowStatementGrowth - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| period | str | Period the statement is returned for. | -| growth_net_income | float | Growth rate of net income. | -| growth_depreciation_and_amortization | float | Growth rate of depreciation and amortization. | -| growth_deferred_income_tax | float | Growth rate of deferred income tax. | -| growth_stock_based_compensation | float | Growth rate of stock-based compensation. | -| growth_change_in_working_capital | float | Growth rate of change in working capital. | -| growth_accounts_receivables | float | Growth rate of accounts receivables. | -| growth_inventory | float | Growth rate of inventory. | -| growth_accounts_payables | float | Growth rate of accounts payables. | -| growth_other_working_capital | float | Growth rate of other working capital. | -| growth_other_non_cash_items | float | Growth rate of other non-cash items. | -| growth_net_cash_provided_by_operating_activities | float | Growth rate of net cash provided by operating activities. | -| growth_investments_in_property_plant_and_equipment | float | Growth rate of investments in property, plant, and equipment. | -| growth_acquisitions_net | float | Growth rate of net acquisitions. | -| growth_purchases_of_investments | float | Growth rate of purchases of investments. | -| growth_sales_maturities_of_investments | float | Growth rate of sales maturities of investments. | -| growth_other_investing_activities | float | Growth rate of other investing activities. | -| growth_net_cash_used_for_investing_activities | float | Growth rate of net cash used for investing activities. | -| growth_debt_repayment | float | Growth rate of debt repayment. | -| growth_common_stock_issued | float | Growth rate of common stock issued. | -| growth_common_stock_repurchased | float | Growth rate of common stock repurchased. | -| growth_dividends_paid | float | Growth rate of dividends paid. | -| growth_other_financing_activities | float | Growth rate of other financing activities. | -| growth_net_cash_used_provided_by_financing_activities | float | Growth rate of net cash used/provided by financing activities. | -| growth_effect_of_forex_changes_on_cash | float | Growth rate of the effect of foreign exchange changes on cash. | -| growth_net_change_in_cash | float | Growth rate of net change in cash. | -| growth_cash_at_end_of_period | float | Growth rate of cash at the end of the period. | -| growth_cash_at_beginning_of_period | float | Growth rate of cash at the beginning of the period. | -| growth_operating_cash_flow | float | Growth rate of operating cash flow. | -| growth_capital_expenditure | float | Growth rate of capital expenditure. | -| growth_free_cash_flow | float | Growth rate of free cash flow. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| period | str | Period the statement is returned for. | -| growth_net_income | float | Growth rate of net income. | -| growth_depreciation_and_amortization | float | Growth rate of depreciation and amortization. | -| growth_deferred_income_tax | float | Growth rate of deferred income tax. | -| growth_stock_based_compensation | float | Growth rate of stock-based compensation. | -| growth_change_in_working_capital | float | Growth rate of change in working capital. | -| growth_accounts_receivables | float | Growth rate of accounts receivables. | -| growth_inventory | float | Growth rate of inventory. | -| growth_accounts_payables | float | Growth rate of accounts payables. | -| growth_other_working_capital | float | Growth rate of other working capital. | -| growth_other_non_cash_items | float | Growth rate of other non-cash items. | -| growth_net_cash_provided_by_operating_activities | float | Growth rate of net cash provided by operating activities. | -| growth_investments_in_property_plant_and_equipment | float | Growth rate of investments in property, plant, and equipment. | -| growth_acquisitions_net | float | Growth rate of net acquisitions. | -| growth_purchases_of_investments | float | Growth rate of purchases of investments. | -| growth_sales_maturities_of_investments | float | Growth rate of sales maturities of investments. | -| growth_other_investing_activities | float | Growth rate of other investing activities. | -| growth_net_cash_used_for_investing_activities | float | Growth rate of net cash used for investing activities. | -| growth_debt_repayment | float | Growth rate of debt repayment. | -| growth_common_stock_issued | float | Growth rate of common stock issued. | -| growth_common_stock_repurchased | float | Growth rate of common stock repurchased. | -| growth_dividends_paid | float | Growth rate of dividends paid. | -| growth_other_financing_activities | float | Growth rate of other financing activities. | -| growth_net_cash_used_provided_by_financing_activities | float | Growth rate of net cash used/provided by financing activities. | -| growth_effect_of_forex_changes_on_cash | float | Growth rate of the effect of foreign exchange changes on cash. | -| growth_net_change_in_cash | float | Growth rate of net change in cash. | -| growth_cash_at_end_of_period | float | Growth rate of cash at the end of the period. | -| growth_cash_at_beginning_of_period | float | Growth rate of cash at the beginning of the period. | -| growth_operating_cash_flow | float | Growth rate of operating cash flow. | -| growth_capital_expenditure | float | Growth rate of capital expenditure. | -| growth_free_cash_flow | float | Growth rate of free cash flow. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/dividends.md b/website/content/platform/reference/equity/fundamental/dividends.md deleted file mode 100644 index 13d5670ee116..000000000000 --- a/website/content/platform/reference/equity/fundamental/dividends.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -title: "dividends" -description: "Get historical dividends data for a given company with the OBB.equity.fundamental.dividends function. Explore parameters like symbol and provider, and understand the returned results, warnings, and metadata. View the data fields, including date, label, adj_dividend, dividend, record_date, payment_date, and declaration_date." -keywords: -- historical dividends -- dividends data -- company dividends -- symbol -- data provider -- default provider -- results -- warnings -- chart -- metadata -- date -- label -- adj_dividend -- dividend -- record_date -- payment_date -- declaration_date ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get historical dividend data for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.dividends(symbol='AAPL', provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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 | -| limit | int | The number of data entries to return. | 100 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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. Multiple items allowed for provider(s): nasdaq. | | False | -| 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['fmp', 'intrinio', 'nasdaq', 'tmx', '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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : HistoricalDividends - Serializable results. - provider : Literal['fmp', 'intrinio', 'nasdaq', 'tmx', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | -| label | str | Label of the historical dividends. | -| adj_dividend | float | Adjusted dividend of the historical dividends. | -| record_date | date | Record date of the historical dividends. | -| payment_date | date | Payment date of the historical dividends. | -| declaration_date | date | Declaration date of the historical dividends. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | -| factor | float | factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices. | -| currency | str | The currency in which the dividend is paid. | -| split_ratio | float | The ratio of the stock split, if a stock split occurred. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | -| dividend_type | str | The type of dividend - i.e., cash, stock. | -| currency | str | The currency in which the dividend is paid. | -| record_date | date | The record date of ownership for eligibility. | -| payment_date | date | The payment date of the dividend. | -| declaration_date | date | Declaration date of the dividend. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | -| currency | str | The currency the dividend is paid in. | -| decalaration_date | date | The date of the announcement. | -| record_date | date | The record date of ownership for rights to the dividend. | -| payment_date | date | The date the dividend is paid. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. | -| amount | float | The dividend amount per share. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/employee_count.md b/website/content/platform/reference/equity/fundamental/employee_count.md deleted file mode 100644 index c5561e92c87b..000000000000 --- a/website/content/platform/reference/equity/fundamental/employee_count.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: "employee_count" -description: "Learn how to retrieve historical employee count data using the Python API. Understand the parameters, returns, and data structure for the OBB.equity.fundamental.employee_count method." -keywords: -- historical employees -- employee count -- Python API -- data retrieval -- symbol -- provider -- warnings -- chart object -- metadata -- data -- CIK -- acceptance time -- period of report -- company name -- form type -- filing date -- source URL ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get historical employee count data for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.employee_count(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : HistoricalEmployees - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | int | Central Index Key (CIK) for the requested entity. | -| acceptance_time | datetime | Time of acceptance of the company employee. | -| period_of_report | date | Date of reporting of the company employee. | -| company_name | str | Registered name of the company to retrieve the historical employees of. | -| form_type | str | Form type of the company employee. | -| filing_date | date | Filing date of the company employee | -| employee_count | int | Count of employees of the company. | -| source | str | Source URL which retrieves this data for the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | int | Central Index Key (CIK) for the requested entity. | -| acceptance_time | datetime | Time of acceptance of the company employee. | -| period_of_report | date | Date of reporting of the company employee. | -| company_name | str | Registered name of the company to retrieve the historical employees of. | -| form_type | str | Form type of the company employee. | -| filing_date | date | Filing date of the company employee | -| employee_count | int | Count of employees of the company. | -| source | str | Source URL which retrieves this data for the company. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/filings.md b/website/content/platform/reference/equity/fundamental/filings.md deleted file mode 100644 index 3edd6413a8a3..000000000000 --- a/website/content/platform/reference/equity/fundamental/filings.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -title: "filings" -description: "Learn how to retrieve company filings data such as date, type of document, and link. Understand the available parameters to filter the data, including symbol, limit, provider, type, and page. Explore the different fields in the data, such as ticker symbol, accepted date, and final link." -keywords: -- company filings -- data entries -- symbol -- limit -- provider -- type -- page -- cik -- date -- link -- ticker symbol -- accepted date -- final link -- report date -- act -- items -- primary doc description -- primary doc -- accession number -- file number -- film number -- is inline xbrl -- is xbrl -- size -- complete submission url -- filing detail url -- xml ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC -filings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114, -Foreign Investment Disclosures and others. The annual 10-K report is required to be -filed annually and includes the company's financial statements, management discussion and analysis, -and audited financial statements. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.filings(provider='fmp') -obb.equity.fundamental.filings(limit=100, provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| form_type | str | Filter by form type. Check the data provider for available types. | None | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['fmp', 'intrinio', 'sec', 'tmx'] | 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 | str | Symbol to get data for. | None | True | -| form_type | str | Filter by form type. Check the data provider for available types. | None | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['fmp', 'intrinio', 'sec', 'tmx'] | 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 | str | Symbol to get data for. | None | True | -| form_type | str | Filter by form type. Check the data provider for available types. | None | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['fmp', 'intrinio', 'sec', 'tmx'] | 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 | -| 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 | -| thea_enabled | bool | Return filings that have been read by Intrinio's Thea NLP. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| form_type | str | Filter by form type. Check the data provider for available types. | None | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['fmp', 'intrinio', 'sec', 'tmx'] | 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 | Union[int, str] | Lookup filings by Central Index Key (CIK) instead of by symbol. | None | True | -| type | Literal['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 of the SEC filing form. | None | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for one day. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | None | True | -| form_type | str | Filter by form type. Check the data provider for available types. | None | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['fmp', 'intrinio', 'sec', 'tmx'] | 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 | -| start_date | Union[date, str] | The start date to fetch. | None | True | -| end_date | Union[date, str] | The end date to fetch. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CompanyFilings - Serializable results. - provider : Literal['fmp', 'intrinio', 'sec', 'tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | Accepted date of the filing. | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| report_type | str | Type of filing. | -| filing_url | str | URL to the filing page. | -| report_url | str | URL to the actual report. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | Accepted date of the filing. | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| report_type | str | Type of filing. | -| filing_url | str | URL to the filing page. | -| report_url | str | URL to the actual report. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | Accepted date of the filing. | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| report_type | str | Type of filing. | -| filing_url | str | URL to the filing page. | -| report_url | str | URL to the actual report. | -| id | str | Intrinio ID of the filing. | -| period_end_date | date | Ending date of the fiscal period for the filing. | -| sec_unique_id | str | SEC unique ID of the filing. | -| instance_url | str | URL for the XBRL filing for the report. | -| industry_group | str | Industry group of the company. | -| industry_category | str | Industry category of the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | Accepted date of the filing. | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| report_type | str | Type of filing. | -| filing_url | str | URL to the filing page. | -| report_url | str | URL to the actual report. | -| report_date | date | The date of the filing. | -| act | Union[int, str] | The SEC Act number. | -| items | Union[str, float] | The SEC Item numbers. | -| primary_doc_description | str | The description of the primary document. | -| primary_doc | str | The filename of the primary document. | -| accession_number | Union[int, str] | The accession number. | -| file_number | Union[int, str] | The file number. | -| film_number | Union[int, str] | The film number. | -| is_inline_xbrl | Union[int, str] | Whether the filing is an inline XBRL filing. | -| is_xbrl | Union[int, str] | Whether the filing is an XBRL filing. | -| size | Union[int, str] | The size of the filing. | -| complete_submission_url | str | The URL to the complete filing submission. | -| filing_detail_url | str | The URL to the filing details. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| filing_date | date | The date of the filing. | -| accepted_date | datetime | Accepted date of the filing. | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| report_type | str | Type of filing. | -| filing_url | str | URL to the filing page. | -| report_url | str | URL to the actual report. | -| description | str | The description of the filing. | -| size | str | The file size of the PDF document. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/historical_attributes.md b/website/content/platform/reference/equity/fundamental/historical_attributes.md deleted file mode 100644 index 7e68b7dcf6af..000000000000 --- a/website/content/platform/reference/equity/fundamental/historical_attributes.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: "historical_attributes" -description: "Get the historical values of a data tag from Intrinio" -keywords: -- equity -- fundamental -- historical_attributes ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the historical values of a data tag from Intrinio. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.historical_attributes(symbol='AAPL', tag='ebitda', provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): intrinio. | | False | -| tag | Union[str, List[str]] | Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio. | | False | -| 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 | -| frequency | Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly'] | The frequency of the data. | yearly | True | -| limit | int | The number of data entries to return. | 1000 | True | -| tag_type | str | Filter by type, when applicable. | None | True | -| sort | Literal['asc', 'desc'] | Sort order. | desc | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): intrinio. | | False | -| tag | Union[str, List[str]] | Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio. | | False | -| 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 | -| frequency | Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly'] | The frequency of the data. | yearly | True | -| limit | int | The number of data entries to return. | 1000 | True | -| tag_type | str | Filter by type, when applicable. | None | True | -| sort | Literal['asc', 'desc'] | Sort order. | desc | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : HistoricalAttributes - Serializable results. - provider : Literal['intrinio'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| tag | str | Tag name for the fetched data. | -| value | float | The value of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| tag | str | Tag name for the fetched data. | -| value | float | The value of the data. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/historical_eps.md b/website/content/platform/reference/equity/fundamental/historical_eps.md deleted file mode 100644 index cf39eb8af461..000000000000 --- a/website/content/platform/reference/equity/fundamental/historical_eps.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: "historical_eps" -description: "Historical earnings-per-share for a given company" -keywords: -- equity -- fundamental -- historical_eps ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get historical earnings per share data for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.historical_eps(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage. | | False | -| provider | Literal['alpha_vantage', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage. | | False | -| provider | Literal['alpha_vantage', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | quarter | True | -| limit | int | The number of data entries to return. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage. | | False | -| provider | Literal['alpha_vantage', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| limit | int | The number of data entries to return. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : HistoricalEps - Serializable results. - provider : Literal['alpha_vantage', 'fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| announce_time | str | Timing of the earnings announcement. | -| eps_actual | float | Actual EPS from the earnings date. | -| eps_estimated | float | Estimated EPS for the earnings date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| announce_time | str | Timing of the earnings announcement. | -| eps_actual | float | Actual EPS from the earnings date. | -| eps_estimated | float | Estimated EPS for the earnings date. | -| surprise | float | Surprise in EPS (Actual - Estimated). | -| surprise_percent | Union[float, str] | EPS surprise as a normalized percent. | -| reported_date | date | Date of the earnings report. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| symbol | str | Symbol representing the entity requested in the data. | -| announce_time | str | Timing of the earnings announcement. | -| eps_actual | float | Actual EPS from the earnings date. | -| eps_estimated | float | Estimated EPS for the earnings date. | -| revenue_estimated | float | Estimated consensus revenue for the reporting period. | -| revenue_actual | float | The actual reported revenue. | -| reporting_time | str | The reporting time - e.g. after market close. | -| updated_at | date | The date when the data was last updated. | -| period_ending | date | The fiscal period end date. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/historical_splits.md b/website/content/platform/reference/equity/fundamental/historical_splits.md deleted file mode 100644 index 3c09d066c153..000000000000 --- a/website/content/platform/reference/equity/fundamental/historical_splits.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: "historical_splits" -description: "Learn how to retrieve historical stock splits data using the Python obb.equity.fundamental.historical_splits function. Understand the parameters, returns, and data structure for this API call." -keywords: -- historical stock splits -- stock splits data -- python obb.equity.fundamental.historical_splits -- parameters -- symbol -- provider -- returns -- results -- provider name -- warnings -- chart object -- metadata -- data -- date -- label -- numerator -- denominator ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get historical stock splits for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.historical_splits(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : HistoricalSplits - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| label | str | Label of the historical stock splits. | -| numerator | float | Numerator of the historical stock splits. | -| denominator | float | Denominator of the historical stock splits. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| label | str | Label of the historical stock splits. | -| numerator | float | Numerator of the historical stock splits. | -| denominator | float | Denominator of the historical stock splits. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/income.md b/website/content/platform/reference/equity/fundamental/income.md deleted file mode 100644 index 81264da48e6d..000000000000 --- a/website/content/platform/reference/equity/fundamental/income.md +++ /dev/null @@ -1,363 +0,0 @@ ---- -title: "income" -description: "Get income statement and financial performance data for a company. Parameters include symbol, period, limit, provider, and more. Data includes revenue, gross profit, operating expenses, net income, and more." -keywords: -- income statement -- financial performance -- get income data -- period -- limit -- provider -- symbol -- cik -- filing date -- period of report date -- include sources -- order -- sort -- revenue -- cost of revenue -- gross profit -- cost and expenses -- research and development expenses -- general and administrative expenses -- selling and marketing expenses -- other expenses -- operating expenses -- depreciation and amortization -- ebitda -- operating income -- interest income -- interest expense -- income before tax -- income tax expense -- net income -- eps -- weighted average shares outstanding -- link -- reported currency -- filling date -- accepted date -- calendar year ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the income statement for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.income(symbol='AAPL', provider='fmp') -obb.equity.fundamental.income(symbol='AAPL', period='annual', limit=5, provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | -| fiscal_year | int | The specific fiscal year. Reports do not go beyond 2008. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int, Ge(ge=0) | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : IncomeStatement - Serializable results. - provider : Literal['fmp', 'intrinio', 'polygon', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| filing_date | date | The date when the filing was made. | -| accepted_date | datetime | The date and time when the filing was accepted. | -| reported_currency | str | The currency in which the balance sheet was reported. | -| revenue | float | Total revenue. | -| cost_of_revenue | float | Cost of revenue. | -| gross_profit | float | Gross profit. | -| gross_profit_margin | float | Gross profit margin. | -| general_and_admin_expense | float | General and administrative expenses. | -| research_and_development_expense | float | Research and development expenses. | -| selling_and_marketing_expense | float | Selling and marketing expenses. | -| selling_general_and_admin_expense | float | Selling, general and administrative expenses. | -| other_expenses | float | Other expenses. | -| total_operating_expenses | float | Total operating expenses. | -| cost_and_expenses | float | Cost and expenses. | -| interest_income | float | Interest income. | -| total_interest_expense | float | Total interest expenses. | -| depreciation_and_amortization | float | Depreciation and amortization. | -| ebitda | float | EBITDA. | -| ebitda_margin | float | EBITDA margin. | -| total_operating_income | float | Total operating income. | -| operating_income_margin | float | Operating income margin. | -| total_other_income_expenses | float | Total other income and expenses. | -| total_pre_tax_income | float | Total pre-tax income. | -| pre_tax_income_margin | float | Pre-tax income margin. | -| income_tax_expense | float | Income tax expense. | -| consolidated_net_income | float | Consolidated net income. | -| net_income_margin | float | Net income margin. | -| basic_earnings_per_share | float | Basic earnings per share. | -| diluted_earnings_per_share | float | Diluted earnings per share. | -| weighted_average_basic_shares_outstanding | float | Weighted average basic shares outstanding. | -| weighted_average_diluted_shares_outstanding | float | Weighted average diluted shares outstanding. | -| link | str | Link to the filing. | -| final_link | str | Link to the filing document. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| reported_currency | str | The currency in which the balance sheet is reported. | -| revenue | float | Total revenue | -| operating_revenue | float | Total operating revenue | -| cost_of_revenue | float | Total cost of revenue | -| operating_cost_of_revenue | float | Total operating cost of revenue | -| gross_profit | float | Total gross profit | -| gross_profit_margin | float | Gross margin ratio. | -| provision_for_credit_losses | float | Provision for credit losses | -| research_and_development_expense | float | Research and development expense | -| selling_general_and_admin_expense | float | Selling, general, and admin expense | -| salaries_and_employee_benefits | float | Salaries and employee benefits | -| marketing_expense | float | Marketing expense | -| net_occupancy_and_equipment_expense | float | Net occupancy and equipment expense | -| other_operating_expenses | float | Other operating expenses | -| depreciation_expense | float | Depreciation expense | -| amortization_expense | float | Amortization expense | -| amortization_of_deferred_policy_acquisition_costs | float | Amortization of deferred policy acquisition costs | -| exploration_expense | float | Exploration expense | -| depletion_expense | float | Depletion expense | -| total_operating_expenses | float | Total operating expenses | -| total_operating_income | float | Total operating income | -| deposits_and_money_market_investments_interest_income | float | Deposits and money market investments interest income | -| federal_funds_sold_and_securities_borrowed_interest_income | float | Federal funds sold and securities borrowed interest income | -| investment_securities_interest_income | float | Investment securities interest income | -| loans_and_leases_interest_income | float | Loans and leases interest income | -| trading_account_interest_income | float | Trading account interest income | -| other_interest_income | float | Other interest income | -| total_non_interest_income | float | Total non-interest income | -| interest_and_investment_income | float | Interest and investment income | -| short_term_borrowings_interest_expense | float | Short-term borrowings interest expense | -| long_term_debt_interest_expense | float | Long-term debt interest expense | -| capitalized_lease_obligations_interest_expense | float | Capitalized lease obligations interest expense | -| deposits_interest_expense | float | Deposits interest expense | -| federal_funds_purchased_and_securities_sold_interest_expense | float | Federal funds purchased and securities sold interest expense | -| other_interest_expense | float | Other interest expense | -| total_interest_expense | float | Total interest expense | -| net_interest_income | float | Net interest income | -| other_non_interest_income | float | Other non-interest income | -| investment_banking_income | float | Investment banking income | -| trust_fees_by_commissions | float | Trust fees by commissions | -| premiums_earned | float | Premiums earned | -| insurance_policy_acquisition_costs | float | Insurance policy acquisition costs | -| current_and_future_benefits | float | Current and future benefits | -| property_and_liability_insurance_claims | float | Property and liability insurance claims | -| total_non_interest_expense | float | Total non-interest expense | -| net_realized_and_unrealized_capital_gains_on_investments | float | Net realized and unrealized capital gains on investments | -| other_gains | float | Other gains | -| non_operating_income | float | Non-operating income | -| other_income | float | Other income | -| other_revenue | float | Other revenue | -| extraordinary_income | float | Extraordinary income | -| total_other_income | float | Total other income | -| ebitda | float | Earnings Before Interest, Taxes, Depreciation and Amortization. | -| ebitda_margin | float | Margin on Earnings Before Interest, Taxes, Depreciation and Amortization. | -| total_pre_tax_income | float | Total pre-tax income | -| ebit | float | Earnings Before Interest and Taxes. | -| pre_tax_income_margin | float | Pre-Tax Income Margin. | -| income_tax_expense | float | Income tax expense | -| impairment_charge | float | Impairment charge | -| restructuring_charge | float | Restructuring charge | -| service_charges_on_deposit_accounts | float | Service charges on deposit accounts | -| other_service_charges | float | Other service charges | -| other_special_charges | float | Other special charges | -| other_cost_of_revenue | float | Other cost of revenue | -| net_income_continuing_operations | float | Net income (continuing operations) | -| net_income_discontinued_operations | float | Net income (discontinued operations) | -| consolidated_net_income | float | Consolidated net income | -| other_adjustments_to_consolidated_net_income | float | Other adjustments to consolidated net income | -| other_adjustment_to_net_income_attributable_to_common_shareholders | float | Other adjustment to net income attributable to common shareholders | -| net_income_attributable_to_noncontrolling_interest | float | Net income attributable to noncontrolling interest | -| net_income_attributable_to_common_shareholders | float | Net income attributable to common shareholders | -| basic_earnings_per_share | float | Basic earnings per share | -| diluted_earnings_per_share | float | Diluted earnings per share | -| basic_and_diluted_earnings_per_share | float | Basic and diluted earnings per share | -| cash_dividends_to_common_per_share | float | Cash dividends to common per share | -| preferred_stock_dividends_declared | float | Preferred stock dividends declared | -| weighted_average_basic_shares_outstanding | float | Weighted average basic shares outstanding | -| weighted_average_diluted_shares_outstanding | float | Weighted average diluted shares outstanding | -| weighted_average_basic_and_diluted_shares_outstanding | float | Weighted average basic and diluted shares outstanding | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | -| revenue | float | Total Revenue | -| cost_of_revenue_goods | float | Cost of Revenue - Goods | -| cost_of_revenue_services | float | Cost of Revenue - Services | -| cost_of_revenue | float | Cost of Revenue | -| gross_profit | float | Gross Profit | -| provisions_for_loan_lease_and_other_losses | float | Provisions for loan lease and other losses | -| depreciation_and_amortization | float | Depreciation and Amortization | -| income_tax_expense_benefit_current | float | Income tax expense benefit current | -| deferred_tax_benefit | float | Deferred tax benefit | -| benefits_costs_expenses | float | Benefits, costs and expenses | -| selling_general_and_administrative_expense | float | Selling, general and administrative expense | -| research_and_development | float | Research and development | -| costs_and_expenses | float | Costs and expenses | -| other_operating_expenses | float | Other Operating Expenses | -| operating_expenses | float | Operating expenses | -| operating_income | float | Operating Income/Loss | -| non_operating_income | float | Non Operating Income/Loss | -| interest_and_dividend_income | float | Interest and Dividend Income | -| total_interest_expense | float | Interest Expense | -| interest_and_debt_expense | float | Interest and Debt Expense | -| net_interest_income | float | Interest Income Net | -| interest_income_after_provision_for_losses | float | Interest Income After Provision for Losses | -| non_interest_expense | float | Non-Interest Expense | -| non_interest_income | float | Non-Interest Income | -| income_from_discontinued_operations_net_of_tax_on_disposal | float | Income From Discontinued Operations Net of Tax on Disposal | -| income_from_discontinued_operations_net_of_tax | float | Income From Discontinued Operations Net of Tax | -| income_before_equity_method_investments | float | Income Before Equity Method Investments | -| income_from_equity_method_investments | float | Income From Equity Method Investments | -| total_pre_tax_income | float | Income Before Tax | -| income_tax_expense | float | Income Tax Expense | -| income_after_tax | float | Income After Tax | -| consolidated_net_income | float | Net Income/Loss | -| net_income_attributable_noncontrolling_interest | float | Net income (loss) attributable to noncontrolling interest | -| net_income_attributable_to_parent | float | Net income (loss) attributable to parent | -| net_income_attributable_to_common_shareholders | float | Net Income/Loss Available To Common Stockholders Basic | -| participating_securities_earnings | float | Participating Securities Distributed And Undistributed Earnings Loss Basic | -| undistributed_earnings_allocated_to_participating_securities | float | Undistributed Earnings Allocated To Participating Securities | -| common_stock_dividends | float | Common Stock Dividends | -| preferred_stock_dividends_and_other_adjustments | float | Preferred stock dividends and other adjustments | -| basic_earnings_per_share | float | Earnings Per Share | -| diluted_earnings_per_share | float | Diluted Earnings Per Share | -| weighted_average_basic_shares_outstanding | float | Basic Average Shares | -| weighted_average_diluted_shares_outstanding | float | Diluted Average Shares | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the report. | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/income_growth.md b/website/content/platform/reference/equity/fundamental/income_growth.md deleted file mode 100644 index 199b16ffb41e..000000000000 --- a/website/content/platform/reference/equity/fundamental/income_growth.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -title: "income_growth" -description: "Explore the growth of a company's income statement with the Python function obb.equity.fundamental.income_growth. Retrieve data for symbols, specify the limit, period, and provider, and get detailed information on various aspects of the income statement growth." -keywords: -- income statement growth -- company income statement -- python obb.equity.fundamental.income_growth -- symbol -- limit -- period -- provider -- data entries -- time period -- provider name -- warnings -- chart object -- metadata -- symbol data -- date -- growth revenue -- cost of goods sold -- gross profit -- gross profit ratio -- research and development expenses -- general and administrative expenses -- selling and marketing expenses -- operating expenses -- total costs and expenses -- interest expenses -- depreciation and amortization expenses -- ebitda -- ebitda ratio -- operating income -- operating income ratio -- total other income expenses net -- income before tax -- income tax expenses -- net income -- eps -- eps diluted -- weighted average shares outstanding ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the growth of a company's income statement items over time. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.income_growth(symbol='AAPL', provider='fmp') -obb.equity.fundamental.income_growth(symbol='AAPL', limit=10, period='annual', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | True | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 10 | True | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : IncomeStatementGrowth - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| period | str | Period the statement is returned for. | -| growth_revenue | float | Growth rate of total revenue. | -| growth_cost_of_revenue | float | Growth rate of cost of goods sold. | -| growth_gross_profit | float | Growth rate of gross profit. | -| growth_gross_profit_ratio | float | Growth rate of gross profit as a percentage of revenue. | -| growth_research_and_development_expenses | float | Growth rate of expenses on research and development. | -| growth_general_and_administrative_expenses | float | Growth rate of general and administrative expenses. | -| growth_selling_and_marketing_expenses | float | Growth rate of expenses on selling and marketing activities. | -| growth_other_expenses | float | Growth rate of other operating expenses. | -| growth_operating_expenses | float | Growth rate of total operating expenses. | -| growth_cost_and_expenses | float | Growth rate of total costs and expenses. | -| growth_interest_expense | float | Growth rate of interest expenses. | -| growth_depreciation_and_amortization | float | Growth rate of depreciation and amortization expenses. | -| growth_ebitda | float | Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization. | -| growth_ebitda_ratio | float | Growth rate of EBITDA as a percentage of revenue. | -| growth_operating_income | float | Growth rate of operating income. | -| growth_operating_income_ratio | float | Growth rate of operating income as a percentage of revenue. | -| growth_total_other_income_expenses_net | float | Growth rate of net total other income and expenses. | -| growth_income_before_tax | float | Growth rate of income before taxes. | -| growth_income_before_tax_ratio | float | Growth rate of income before taxes as a percentage of revenue. | -| growth_income_tax_expense | float | Growth rate of income tax expenses. | -| growth_net_income | float | Growth rate of net income. | -| growth_net_income_ratio | float | Growth rate of net income as a percentage of revenue. | -| growth_eps | float | Growth rate of Earnings Per Share (EPS). | -| growth_eps_diluted | float | Growth rate of diluted Earnings Per Share (EPS). | -| growth_weighted_average_shs_out | float | Growth rate of weighted average shares outstanding. | -| growth_weighted_average_shs_out_dil | float | Growth rate of diluted weighted average shares outstanding. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| period | str | Period the statement is returned for. | -| growth_revenue | float | Growth rate of total revenue. | -| growth_cost_of_revenue | float | Growth rate of cost of goods sold. | -| growth_gross_profit | float | Growth rate of gross profit. | -| growth_gross_profit_ratio | float | Growth rate of gross profit as a percentage of revenue. | -| growth_research_and_development_expenses | float | Growth rate of expenses on research and development. | -| growth_general_and_administrative_expenses | float | Growth rate of general and administrative expenses. | -| growth_selling_and_marketing_expenses | float | Growth rate of expenses on selling and marketing activities. | -| growth_other_expenses | float | Growth rate of other operating expenses. | -| growth_operating_expenses | float | Growth rate of total operating expenses. | -| growth_cost_and_expenses | float | Growth rate of total costs and expenses. | -| growth_interest_expense | float | Growth rate of interest expenses. | -| growth_depreciation_and_amortization | float | Growth rate of depreciation and amortization expenses. | -| growth_ebitda | float | Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization. | -| growth_ebitda_ratio | float | Growth rate of EBITDA as a percentage of revenue. | -| growth_operating_income | float | Growth rate of operating income. | -| growth_operating_income_ratio | float | Growth rate of operating income as a percentage of revenue. | -| growth_total_other_income_expenses_net | float | Growth rate of net total other income and expenses. | -| growth_income_before_tax | float | Growth rate of income before taxes. | -| growth_income_before_tax_ratio | float | Growth rate of income before taxes as a percentage of revenue. | -| growth_income_tax_expense | float | Growth rate of income tax expenses. | -| growth_net_income | float | Growth rate of net income. | -| growth_net_income_ratio | float | Growth rate of net income as a percentage of revenue. | -| growth_eps | float | Growth rate of Earnings Per Share (EPS). | -| growth_eps_diluted | float | Growth rate of diluted Earnings Per Share (EPS). | -| growth_weighted_average_shs_out | float | Growth rate of weighted average shares outstanding. | -| growth_weighted_average_shs_out_dil | float | Growth rate of diluted weighted average shares outstanding. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/index.mdx b/website/content/platform/reference/equity/fundamental/index.mdx deleted file mode 100644 index a680618dfc0a..000000000000 --- a/website/content/platform/reference/equity/fundamental/index.mdx +++ /dev/null @@ -1,33 +0,0 @@ -# Fundamental - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
- diff --git a/website/content/platform/reference/equity/fundamental/latest_attributes.md b/website/content/platform/reference/equity/fundamental/latest_attributes.md deleted file mode 100644 index f3ba77972ff0..000000000000 --- a/website/content/platform/reference/equity/fundamental/latest_attributes.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: "latest_attributes" -description: "Get the latest value of a data tag from Intrinio" -keywords: -- equity -- fundamental -- latest_attributes ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the latest value of a data tag from Intrinio. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.latest_attributes(symbol='AAPL', tag='ceo', provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): intrinio. | | False | -| tag | Union[str, List[str]] | Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio. | | False | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): intrinio. | | False | -| tag | Union[str, List[str]] | Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio. | | False | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : LatestAttributes - Serializable results. - provider : Literal['intrinio'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| tag | str | Tag name for the fetched data. | -| value | Union[str, float] | The value of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| tag | str | Tag name for the fetched data. | -| value | Union[str, float] | The value of the data. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/management.md b/website/content/platform/reference/equity/fundamental/management.md deleted file mode 100644 index 172af1ab0192..000000000000 --- a/website/content/platform/reference/equity/fundamental/management.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: "management" -description: "Learn about key executives for a company and how to retrieve their data using the `obb.equity.fundamental.management` function. Get details such as designation, name, pay, currency, gender, birth year, and title since." -keywords: -- key executives -- company executives -- symbol -- data -- designation -- name -- pay -- currency -- gender -- birth year -- title since ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get executive management team data for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.management(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['fmp', '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 | str | Symbol to get data for. | | False | -| provider | Literal['fmp', '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 | str | Symbol to get data for. | | False | -| provider | Literal['fmp', '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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : KeyExecutives - Serializable results. - provider : Literal['fmp', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| title | str | Designation of the key executive. | -| name | str | Name of the key executive. | -| pay | int | Pay of the key executive. | -| currency_pay | str | Currency of the pay. | -| gender | str | Gender of the key executive. | -| year_born | int | Birth year of the key executive. | -| title_since | int | Date the tile was held since. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| title | str | Designation of the key executive. | -| name | str | Name of the key executive. | -| pay | int | Pay of the key executive. | -| currency_pay | str | Currency of the pay. | -| gender | str | Gender of the key executive. | -| year_born | int | Birth year of the key executive. | -| title_since | int | Date the tile was held since. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| title | str | Designation of the key executive. | -| name | str | Name of the key executive. | -| pay | int | Pay of the key executive. | -| currency_pay | str | Currency of the pay. | -| gender | str | Gender of the key executive. | -| year_born | int | Birth year of the key executive. | -| title_since | int | Date the tile was held since. | -| exercised_value | int | Value of shares exercised. | -| unexercised_value | int | Value of shares not exercised. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/management_compensation.md b/website/content/platform/reference/equity/fundamental/management_compensation.md deleted file mode 100644 index 8ca5f75d11af..000000000000 --- a/website/content/platform/reference/equity/fundamental/management_compensation.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -title: "management_compensation" -description: "Learn how to retrieve executive compensation data for a company using the equity management compensation function in Python. Understand the parameters, return values, and available data fields such as symbol, salary, bonus, stock award, and more." -keywords: -- executive compensation -- company executive compensation -- equity management compensation -- symbol parameter -- provider parameter -- return values -- data -- symbol -- cik -- filing date -- accepted date -- name and position -- year of compensation -- salary -- bonus -- stock award -- incentive plan compensation -- all other compensation -- total compensation -- URL ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get executive management team compensation for a given company over time. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.management_compensation(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fmp. | | False | -| 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['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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fmp. | | False | -| 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['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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : ExecutiveCompensation - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| filing_date | date | Date of the filing. | -| accepted_date | datetime | Date the filing was accepted. | -| name_and_position | str | Name and position of the executive. | -| year | int | Year of the compensation. | -| salary | float | Salary of the executive. | -| bonus | float | Bonus of the executive. | -| stock_award | float | Stock award of the executive. | -| incentive_plan_compensation | float | Incentive plan compensation of the executive. | -| all_other_compensation | float | All other compensation of the executive. | -| total | float | Total compensation of the executive. | -| url | str | URL of the filing data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| filing_date | date | Date of the filing. | -| accepted_date | datetime | Date the filing was accepted. | -| name_and_position | str | Name and position of the executive. | -| year | int | Year of the compensation. | -| salary | float | Salary of the executive. | -| bonus | float | Bonus of the executive. | -| stock_award | float | Stock award of the executive. | -| incentive_plan_compensation | float | Incentive plan compensation of the executive. | -| all_other_compensation | float | All other compensation of the executive. | -| total | float | Total compensation of the executive. | -| url | str | URL of the filing data. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/metrics.md b/website/content/platform/reference/equity/fundamental/metrics.md deleted file mode 100644 index ce5cc89e93ae..000000000000 --- a/website/content/platform/reference/equity/fundamental/metrics.md +++ /dev/null @@ -1,373 +0,0 @@ ---- -title: "metrics" -description: "Learn about key metrics for a given company using the `obb.equity.fundamental.metrics` Python function. This API endpoint provides data such as revenue per share, net income per share, market capitalization, price-to-earnings ratio, and more. Explore the available parameters and returned data to analyze financial performance. Full documentation and usage examples available." -keywords: -- key metrics -- python function -- documentation -- API -- parameters -- returns -- data -- symbol -- period -- limit -- provider -- with_ttm -- revenue per share -- net income per share -- operating cash flow per share -- free cash flow per share -- cash per share -- book value per share -- tangible book value per share -- shareholders equity per share -- interest debt per share -- market capitalization -- enterprise value -- price-to-earnings ratio -- price-to-sales ratio -- price-to-operating cash flow ratio -- price-to-free cash flow ratio -- price-to-book ratio -- price-to-tangible book ratio -- earnings yield -- free cash flow yield -- debt-to-equity ratio -- debt-to-assets ratio -- net debt-to-EBITDA ratio -- current ratio -- interest coverage -- income quality -- dividend yield -- payout ratio -- sales general and administrative expenses-to-revenue ratio -- research and development expenses-to-revenue ratio -- intangibles-to-total assets ratio -- capital expenditures-to-operating cash flow ratio -- capital expenditures-to-revenue ratio -- capital expenditures-to-depreciation ratio -- stock-based compensation-to-revenue ratio -- Graham number -- return on invested capital -- return on tangible assets -- Graham net-net working capital -- working capital -- tangible asset value -- net current asset value -- invested capital -- average receivables -- average payables -- average inventory -- days sales outstanding -- days payables outstanding -- days of inventory on hand -- receivables turnover -- payables turnover -- inventory turnover -- return on equity -- capital expenditures per share -- calendar year ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get fundamental metrics for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.metrics(symbol='AAPL', provider='fmp') -obb.equity.fundamental.metrics(symbol='AAPL', period='annual', limit=100, provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['finviz', 'fmp', 'intrinio', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['finviz', 'fmp', 'intrinio', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['finviz', 'fmp', 'intrinio', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | -| with_ttm | bool | Include trailing twelve months (TTM) data. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['finviz', 'fmp', 'intrinio', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance. | | False | -| period | Literal['annual', 'quarter'] | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 100 | True | -| provider | Literal['finviz', 'fmp', 'intrinio', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : KeyMetrics - Serializable results. - provider : Literal['finviz', 'fmp', 'intrinio', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| market_cap | float | Market capitalization | -| pe_ratio | float | Price-to-earnings ratio (P/E ratio) | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| market_cap | float | Market capitalization | -| pe_ratio | float | Price-to-earnings ratio (P/E ratio) | -| foward_pe | float | Forward price-to-earnings ratio (forward P/E) | -| eps | float | Earnings per share (EPS) | -| price_to_sales | float | Price-to-sales ratio (P/S) | -| price_to_book | float | Price-to-book ratio (P/B) | -| book_value_per_share | float | Book value per share (Book/sh) | -| price_to_cash | float | Price-to-cash ratio (P/C) | -| cash_per_share | float | Cash per share (Cash/sh) | -| price_to_free_cash_flow | float | Price-to-free cash flow ratio (P/FCF) | -| debt_to_equity | float | Debt-to-equity ratio (Debt/Eq) | -| long_term_debt_to_equity | float | Long-term debt-to-equity ratio (LT Debt/Eq) | -| quick_ratio | float | Quick ratio | -| current_ratio | float | Current ratio | -| gross_margin | float | Gross margin, as a normalized percent. | -| profit_margin | float | Profit margin, as a normalized percent. | -| operating_margin | float | Operating margin, as a normalized percent. | -| return_on_assets | float | Return on assets (ROA), as a normalized percent. | -| return_on_investment | float | Return on investment (ROI), as a normalized percent. | -| return_on_equity | float | Return on equity (ROE), as a normalized percent. | -| payout_ratio | float | Payout ratio, as a normalized percent. | -| dividend_yield | float | Dividend yield, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| market_cap | float | Market capitalization | -| pe_ratio | float | Price-to-earnings ratio (P/E ratio) | -| date | date | The date of the data. | -| period | str | Period of the data. | -| calendar_year | int | Calendar year. | -| revenue_per_share | float | Revenue per share | -| net_income_per_share | float | Net income per share | -| operating_cash_flow_per_share | float | Operating cash flow per share | -| free_cash_flow_per_share | float | Free cash flow per share | -| cash_per_share | float | Cash per share | -| book_value_per_share | float | Book value per share | -| tangible_book_value_per_share | float | Tangible book value per share | -| shareholders_equity_per_share | float | Shareholders equity per share | -| interest_debt_per_share | float | Interest debt per share | -| enterprise_value | float | Enterprise value | -| price_to_sales_ratio | float | Price-to-sales ratio | -| pocf_ratio | float | Price-to-operating cash flow ratio | -| pfcf_ratio | float | Price-to-free cash flow ratio | -| pb_ratio | float | Price-to-book ratio | -| ptb_ratio | float | Price-to-tangible book ratio | -| ev_to_sales | float | Enterprise value-to-sales ratio | -| enterprise_value_over_ebitda | float | Enterprise value-to-EBITDA ratio | -| ev_to_operating_cash_flow | float | Enterprise value-to-operating cash flow ratio | -| ev_to_free_cash_flow | float | Enterprise value-to-free cash flow ratio | -| earnings_yield | float | Earnings yield | -| free_cash_flow_yield | float | Free cash flow yield | -| debt_to_equity | float | Debt-to-equity ratio | -| debt_to_assets | float | Debt-to-assets ratio | -| net_debt_to_ebitda | float | Net debt-to-EBITDA ratio | -| current_ratio | float | Current ratio | -| interest_coverage | float | Interest coverage | -| income_quality | float | Income quality | -| dividend_yield | float | Dividend yield, as a normalized percent. | -| payout_ratio | float | Payout ratio | -| sales_general_and_administrative_to_revenue | float | Sales general and administrative expenses-to-revenue ratio | -| research_and_development_to_revenue | float | Research and development expenses-to-revenue ratio | -| intangibles_to_total_assets | float | Intangibles-to-total assets ratio | -| capex_to_operating_cash_flow | float | Capital expenditures-to-operating cash flow ratio | -| capex_to_revenue | float | Capital expenditures-to-revenue ratio | -| capex_to_depreciation | float | Capital expenditures-to-depreciation ratio | -| stock_based_compensation_to_revenue | float | Stock-based compensation-to-revenue ratio | -| graham_number | float | Graham number | -| roic | float | Return on invested capital | -| return_on_tangible_assets | float | Return on tangible assets | -| graham_net_net | float | Graham net-net working capital | -| working_capital | float | Working capital | -| tangible_asset_value | float | Tangible asset value | -| net_current_asset_value | float | Net current asset value | -| invested_capital | float | Invested capital | -| average_receivables | float | Average receivables | -| average_payables | float | Average payables | -| average_inventory | float | Average inventory | -| days_sales_outstanding | float | Days sales outstanding | -| days_payables_outstanding | float | Days payables outstanding | -| days_of_inventory_on_hand | float | Days of inventory on hand | -| receivables_turnover | float | Receivables turnover | -| payables_turnover | float | Payables turnover | -| inventory_turnover | float | Inventory turnover | -| roe | float | Return on equity | -| capex_per_share | float | Capital expenditures per share | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| market_cap | float | Market capitalization | -| pe_ratio | float | Price-to-earnings ratio (P/E ratio) | -| price_to_book | float | Price to book ratio. | -| price_to_tangible_book | float | Price to tangible book ratio. | -| price_to_revenue | float | Price to revenue ratio. | -| quick_ratio | float | Quick ratio. | -| gross_margin | float | Gross margin, as a normalized percent. | -| ebit_margin | float | EBIT margin, as a normalized percent. | -| profit_margin | float | Profit margin, as a normalized percent. | -| eps | float | Basic earnings per share. | -| eps_growth | float | EPS growth, as a normalized percent. | -| revenue_growth | float | Revenue growth, as a normalized percent. | -| ebitda_growth | float | EBITDA growth, as a normalized percent. | -| ebit_growth | float | EBIT growth, as a normalized percent. | -| net_income_growth | float | Net income growth, as a normalized percent. | -| free_cash_flow_to_firm_growth | float | Free cash flow to firm growth, as a normalized percent. | -| invested_capital_growth | float | Invested capital growth, as a normalized percent. | -| return_on_assets | float | Return on assets, as a normalized percent. | -| return_on_equity | float | Return on equity, as a normalized percent. | -| return_on_invested_capital | float | Return on invested capital, as a normalized percent. | -| ebitda | int | Earnings before interest, taxes, depreciation, and amortization. | -| ebit | int | Earnings before interest and taxes. | -| long_term_debt | int | Long-term debt. | -| total_debt | int | Total debt. | -| total_capital | int | The sum of long-term debt and total shareholder equity. | -| enterprise_value | int | Enterprise value. | -| free_cash_flow_to_firm | int | Free cash flow to firm. | -| altman_z_score | float | Altman Z-score. | -| beta | float | Beta relative to the broad market (rolling three-year). | -| dividend_yield | float | Dividend yield, as a normalized percent. | -| earnings_yield | float | Earnings yield, as a normalized percent. | -| last_price | float | Last price of the stock. | -| year_high | float | 52 week high | -| year_low | float | 52 week low | -| volume_avg | int | Average daily volume. | -| short_interest | int | Number of shares reported as sold short. | -| shares_outstanding | int | Weighted average shares outstanding (TTM). | -| days_to_cover | float | Days to cover short interest, based on average daily volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| market_cap | float | Market capitalization | -| pe_ratio | float | Price-to-earnings ratio (P/E ratio) | -| forward_pe | float | Forward price-to-earnings ratio. | -| peg_ratio | float | PEG ratio (5-year expected). | -| peg_ratio_ttm | float | PEG ratio (TTM). | -| eps_ttm | float | Earnings per share (TTM). | -| eps_forward | float | Forward earnings per share. | -| enterprise_to_ebitda | float | Enterprise value to EBITDA ratio. | -| earnings_growth | float | Earnings growth (Year Over Year), as a normalized percent. | -| earnings_growth_quarterly | float | Quarterly earnings growth (Year Over Year), as a normalized percent. | -| revenue_per_share | float | Revenue per share (TTM). | -| revenue_growth | float | Revenue growth (Year Over Year), as a normalized percent. | -| enterprise_to_revenue | float | Enterprise value to revenue ratio. | -| cash_per_share | float | Cash per share. | -| quick_ratio | float | Quick ratio. | -| current_ratio | float | Current ratio. | -| debt_to_equity | float | Debt-to-equity ratio. | -| gross_margin | float | Gross margin, as a normalized percent. | -| operating_margin | float | Operating margin, as a normalized percent. | -| ebitda_margin | float | EBITDA margin, as a normalized percent. | -| profit_margin | float | Profit margin, as a normalized percent. | -| return_on_assets | float | Return on assets, as a normalized percent. | -| return_on_equity | float | Return on equity, as a normalized percent. | -| dividend_yield | float | Dividend yield, as a normalized percent. | -| dividend_yield_5y_avg | float | 5-year average dividend yield, as a normalized percent. | -| payout_ratio | float | Payout ratio. | -| book_value | float | Book value per share. | -| price_to_book | float | Price-to-book ratio. | -| enterprise_value | int | Enterprise value. | -| overall_risk | float | Overall risk score. | -| audit_risk | float | Audit risk score. | -| board_risk | float | Board risk score. | -| compensation_risk | float | Compensation risk score. | -| shareholder_rights_risk | float | Shareholder rights risk score. | -| beta | float | Beta relative to the broad market (5-year monthly). | -| price_return_1y | float | One-year price return, as a normalized percent. | -| currency | str | Currency in which the data is presented. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/multiples.md b/website/content/platform/reference/equity/fundamental/multiples.md deleted file mode 100644 index 58324fcfd605..000000000000 --- a/website/content/platform/reference/equity/fundamental/multiples.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -title: "multiples" -description: "Learn how to calculate equity valuation multiples for a stock ticker using the OBB Python function. Discover the available parameters and the data returned, including revenue per share, net income per share, market capitalization, price-to-earnings ratio, and more. Improve your investment analysis with this powerful tool." -keywords: -- equity valuation multiples -- stock ticker valuation -- python function -- parameters -- returns -- data -- revenue per share -- net income per share -- operating cash flow per share -- free cash flow per share -- cash per share -- book value per share -- tangible book value per share -- shareholders equity per share -- market capitalization -- price-to-earnings ratio -- price-to-sales ratio -- price-to-operating cash flow ratio -- price-to-free cash flow ratio -- price-to-book ratio -- price-to-tangible book ratio -- enterprise value-to-sales ratio -- enterprise value-to-EBITDA ratio -- earnings yield -- free cash flow yield -- debt-to-equity ratio -- debt-to-assets ratio -- net debt-to-EBITDA ratio -- current ratio -- interest coverage -- income quality -- dividend yield -- payout ratio -- sales general and administrative expenses-to-revenue ratio -- research and development expenses-to-revenue ratio -- intangibles-to-total assets ratio -- capital expenditures-to-operating cash flow ratio -- capital expenditures-to-revenue ratio -- capital expenditures-to-depreciation ratio -- stock-based compensation-to-revenue ratio -- graham number -- return on invested capital -- return on tangible assets -- graham net-net working capital -- working capital -- tangible asset value -- net current asset value -- invested capital -- average receivables -- average payables -- average inventory -- days sales outstanding -- days payables outstanding -- days of inventory on hand -- receivables turnover -- payables turnover -- inventory turnover -- return on equity -- capital expenditures per share ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get equity valuation multiples for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.multiples(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fmp. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): fmp. | | False | -| 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityValuationMultiples - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| revenue_per_share_ttm | float | Revenue per share calculated as trailing twelve months. | -| net_income_per_share_ttm | float | Net income per share calculated as trailing twelve months. | -| operating_cash_flow_per_share_ttm | float | Operating cash flow per share calculated as trailing twelve months. | -| free_cash_flow_per_share_ttm | float | Free cash flow per share calculated as trailing twelve months. | -| cash_per_share_ttm | float | Cash per share calculated as trailing twelve months. | -| book_value_per_share_ttm | float | Book value per share calculated as trailing twelve months. | -| tangible_book_value_per_share_ttm | float | Tangible book value per share calculated as trailing twelve months. | -| shareholders_equity_per_share_ttm | float | Shareholders equity per share calculated as trailing twelve months. | -| interest_debt_per_share_ttm | float | Interest debt per share calculated as trailing twelve months. | -| market_cap_ttm | float | Market capitalization calculated as trailing twelve months. | -| enterprise_value_ttm | float | Enterprise value calculated as trailing twelve months. | -| pe_ratio_ttm | float | Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months. | -| price_to_sales_ratio_ttm | float | Price-to-sales ratio calculated as trailing twelve months. | -| pocf_ratio_ttm | float | Price-to-operating cash flow ratio calculated as trailing twelve months. | -| pfcf_ratio_ttm | float | Price-to-free cash flow ratio calculated as trailing twelve months. | -| pb_ratio_ttm | float | Price-to-book ratio calculated as trailing twelve months. | -| ptb_ratio_ttm | float | Price-to-tangible book ratio calculated as trailing twelve months. | -| ev_to_sales_ttm | float | Enterprise value-to-sales ratio calculated as trailing twelve months. | -| enterprise_value_over_ebitda_ttm | float | Enterprise value-to-EBITDA ratio calculated as trailing twelve months. | -| ev_to_operating_cash_flow_ttm | float | Enterprise value-to-operating cash flow ratio calculated as trailing twelve months. | -| ev_to_free_cash_flow_ttm | float | Enterprise value-to-free cash flow ratio calculated as trailing twelve months. | -| earnings_yield_ttm | float | Earnings yield calculated as trailing twelve months. | -| free_cash_flow_yield_ttm | float | Free cash flow yield calculated as trailing twelve months. | -| debt_to_equity_ttm | float | Debt-to-equity ratio calculated as trailing twelve months. | -| debt_to_assets_ttm | float | Debt-to-assets ratio calculated as trailing twelve months. | -| net_debt_to_ebitda_ttm | float | Net debt-to-EBITDA ratio calculated as trailing twelve months. | -| current_ratio_ttm | float | Current ratio calculated as trailing twelve months. | -| interest_coverage_ttm | float | Interest coverage calculated as trailing twelve months. | -| income_quality_ttm | float | Income quality calculated as trailing twelve months. | -| dividend_yield_ttm | float | Dividend yield calculated as trailing twelve months. | -| dividend_yield_percentage_ttm | float | Dividend yield percentage calculated as trailing twelve months. | -| dividend_to_market_cap_ttm | float | Dividend to market capitalization ratio calculated as trailing twelve months. | -| dividend_per_share_ttm | float | Dividend per share calculated as trailing twelve months. | -| payout_ratio_ttm | float | Payout ratio calculated as trailing twelve months. | -| sales_general_and_administrative_to_revenue_ttm | float | Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months. | -| research_and_development_to_revenue_ttm | float | Research and development expenses-to-revenue ratio calculated as trailing twelve months. | -| intangibles_to_total_assets_ttm | float | Intangibles-to-total assets ratio calculated as trailing twelve months. | -| capex_to_operating_cash_flow_ttm | float | Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months. | -| capex_to_revenue_ttm | float | Capital expenditures-to-revenue ratio calculated as trailing twelve months. | -| capex_to_depreciation_ttm | float | Capital expenditures-to-depreciation ratio calculated as trailing twelve months. | -| stock_based_compensation_to_revenue_ttm | float | Stock-based compensation-to-revenue ratio calculated as trailing twelve months. | -| graham_number_ttm | float | Graham number calculated as trailing twelve months. | -| roic_ttm | float | Return on invested capital calculated as trailing twelve months. | -| return_on_tangible_assets_ttm | float | Return on tangible assets calculated as trailing twelve months. | -| graham_net_net_ttm | float | Graham net-net working capital calculated as trailing twelve months. | -| working_capital_ttm | float | Working capital calculated as trailing twelve months. | -| tangible_asset_value_ttm | float | Tangible asset value calculated as trailing twelve months. | -| net_current_asset_value_ttm | float | Net current asset value calculated as trailing twelve months. | -| invested_capital_ttm | float | Invested capital calculated as trailing twelve months. | -| average_receivables_ttm | float | Average receivables calculated as trailing twelve months. | -| average_payables_ttm | float | Average payables calculated as trailing twelve months. | -| average_inventory_ttm | float | Average inventory calculated as trailing twelve months. | -| days_sales_outstanding_ttm | float | Days sales outstanding calculated as trailing twelve months. | -| days_payables_outstanding_ttm | float | Days payables outstanding calculated as trailing twelve months. | -| days_of_inventory_on_hand_ttm | float | Days of inventory on hand calculated as trailing twelve months. | -| receivables_turnover_ttm | float | Receivables turnover calculated as trailing twelve months. | -| payables_turnover_ttm | float | Payables turnover calculated as trailing twelve months. | -| inventory_turnover_ttm | float | Inventory turnover calculated as trailing twelve months. | -| roe_ttm | float | Return on equity calculated as trailing twelve months. | -| capex_per_share_ttm | float | Capital expenditures per share calculated as trailing twelve months. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| revenue_per_share_ttm | float | Revenue per share calculated as trailing twelve months. | -| net_income_per_share_ttm | float | Net income per share calculated as trailing twelve months. | -| operating_cash_flow_per_share_ttm | float | Operating cash flow per share calculated as trailing twelve months. | -| free_cash_flow_per_share_ttm | float | Free cash flow per share calculated as trailing twelve months. | -| cash_per_share_ttm | float | Cash per share calculated as trailing twelve months. | -| book_value_per_share_ttm | float | Book value per share calculated as trailing twelve months. | -| tangible_book_value_per_share_ttm | float | Tangible book value per share calculated as trailing twelve months. | -| shareholders_equity_per_share_ttm | float | Shareholders equity per share calculated as trailing twelve months. | -| interest_debt_per_share_ttm | float | Interest debt per share calculated as trailing twelve months. | -| market_cap_ttm | float | Market capitalization calculated as trailing twelve months. | -| enterprise_value_ttm | float | Enterprise value calculated as trailing twelve months. | -| pe_ratio_ttm | float | Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months. | -| price_to_sales_ratio_ttm | float | Price-to-sales ratio calculated as trailing twelve months. | -| pocf_ratio_ttm | float | Price-to-operating cash flow ratio calculated as trailing twelve months. | -| pfcf_ratio_ttm | float | Price-to-free cash flow ratio calculated as trailing twelve months. | -| pb_ratio_ttm | float | Price-to-book ratio calculated as trailing twelve months. | -| ptb_ratio_ttm | float | Price-to-tangible book ratio calculated as trailing twelve months. | -| ev_to_sales_ttm | float | Enterprise value-to-sales ratio calculated as trailing twelve months. | -| enterprise_value_over_ebitda_ttm | float | Enterprise value-to-EBITDA ratio calculated as trailing twelve months. | -| ev_to_operating_cash_flow_ttm | float | Enterprise value-to-operating cash flow ratio calculated as trailing twelve months. | -| ev_to_free_cash_flow_ttm | float | Enterprise value-to-free cash flow ratio calculated as trailing twelve months. | -| earnings_yield_ttm | float | Earnings yield calculated as trailing twelve months. | -| free_cash_flow_yield_ttm | float | Free cash flow yield calculated as trailing twelve months. | -| debt_to_equity_ttm | float | Debt-to-equity ratio calculated as trailing twelve months. | -| debt_to_assets_ttm | float | Debt-to-assets ratio calculated as trailing twelve months. | -| net_debt_to_ebitda_ttm | float | Net debt-to-EBITDA ratio calculated as trailing twelve months. | -| current_ratio_ttm | float | Current ratio calculated as trailing twelve months. | -| interest_coverage_ttm | float | Interest coverage calculated as trailing twelve months. | -| income_quality_ttm | float | Income quality calculated as trailing twelve months. | -| dividend_yield_ttm | float | Dividend yield calculated as trailing twelve months. | -| dividend_yield_percentage_ttm | float | Dividend yield percentage calculated as trailing twelve months. | -| dividend_to_market_cap_ttm | float | Dividend to market capitalization ratio calculated as trailing twelve months. | -| dividend_per_share_ttm | float | Dividend per share calculated as trailing twelve months. | -| payout_ratio_ttm | float | Payout ratio calculated as trailing twelve months. | -| sales_general_and_administrative_to_revenue_ttm | float | Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months. | -| research_and_development_to_revenue_ttm | float | Research and development expenses-to-revenue ratio calculated as trailing twelve months. | -| intangibles_to_total_assets_ttm | float | Intangibles-to-total assets ratio calculated as trailing twelve months. | -| capex_to_operating_cash_flow_ttm | float | Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months. | -| capex_to_revenue_ttm | float | Capital expenditures-to-revenue ratio calculated as trailing twelve months. | -| capex_to_depreciation_ttm | float | Capital expenditures-to-depreciation ratio calculated as trailing twelve months. | -| stock_based_compensation_to_revenue_ttm | float | Stock-based compensation-to-revenue ratio calculated as trailing twelve months. | -| graham_number_ttm | float | Graham number calculated as trailing twelve months. | -| roic_ttm | float | Return on invested capital calculated as trailing twelve months. | -| return_on_tangible_assets_ttm | float | Return on tangible assets calculated as trailing twelve months. | -| graham_net_net_ttm | float | Graham net-net working capital calculated as trailing twelve months. | -| working_capital_ttm | float | Working capital calculated as trailing twelve months. | -| tangible_asset_value_ttm | float | Tangible asset value calculated as trailing twelve months. | -| net_current_asset_value_ttm | float | Net current asset value calculated as trailing twelve months. | -| invested_capital_ttm | float | Invested capital calculated as trailing twelve months. | -| average_receivables_ttm | float | Average receivables calculated as trailing twelve months. | -| average_payables_ttm | float | Average payables calculated as trailing twelve months. | -| average_inventory_ttm | float | Average inventory calculated as trailing twelve months. | -| days_sales_outstanding_ttm | float | Days sales outstanding calculated as trailing twelve months. | -| days_payables_outstanding_ttm | float | Days payables outstanding calculated as trailing twelve months. | -| days_of_inventory_on_hand_ttm | float | Days of inventory on hand calculated as trailing twelve months. | -| receivables_turnover_ttm | float | Receivables turnover calculated as trailing twelve months. | -| payables_turnover_ttm | float | Payables turnover calculated as trailing twelve months. | -| inventory_turnover_ttm | float | Inventory turnover calculated as trailing twelve months. | -| roe_ttm | float | Return on equity calculated as trailing twelve months. | -| capex_per_share_ttm | float | Capital expenditures per share calculated as trailing twelve months. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/overview.md b/website/content/platform/reference/equity/fundamental/overview.md deleted file mode 100644 index 24f04c240527..000000000000 --- a/website/content/platform/reference/equity/fundamental/overview.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: "overview" -description: "Learn about the company overview and get essential information, including symbol, price, beta, volume average, market capitalization, last dividend, industry, website, CEO, sector, country, and more." -keywords: -- company overview -- overview symbol -- equity fundamental overview -- parameters -- returns -- data -- symbol -- price -- beta -- vol_avg -- mkt_cap -- last_div -- range -- changes -- company_name -- currency -- cik -- isin -- cusip -- exchange -- exchange_short_name -- industry -- website -- description -- ceo -- sector -- country -- full_time_employees -- phone -- address -- city -- state -- zip -- dcf_diff -- dcf -- image -- ipo_date -- default_image -- is_etf -- is_actively_trading -- is_adr -- is_fund ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -:::caution Deprecated -This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3. -::: - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get company general business and stock data for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.overview(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CompanyOverview - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| price | float | Price of the company. | -| beta | float | Beta of the company. | -| vol_avg | int | Volume average of the company. | -| mkt_cap | int | Market capitalization of the company. | -| last_div | float | Last dividend of the company. | -| range | str | Range of the company. | -| changes | float | Changes of the company. | -| company_name | str | Company name of the company. | -| currency | str | Currency of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| isin | str | ISIN of the company. | -| cusip | str | CUSIP of the company. | -| exchange | str | Exchange of the company. | -| exchange_short_name | str | Exchange short name of the company. | -| industry | str | Industry of the company. | -| website | str | Website of the company. | -| description | str | Description of the company. | -| ceo | str | CEO of the company. | -| sector | str | Sector of the company. | -| country | str | Country of the company. | -| full_time_employees | str | Full time employees of the company. | -| phone | str | Phone of the company. | -| address | str | Address of the company. | -| city | str | City of the company. | -| state | str | State of the company. | -| zip | str | Zip of the company. | -| dcf_diff | float | Discounted cash flow difference of the company. | -| dcf | float | Discounted cash flow of the company. | -| image | str | Image of the company. | -| ipo_date | date | IPO date of the company. | -| default_image | bool | If the image is the default image. | -| is_etf | bool | If the company is an ETF. | -| is_actively_trading | bool | If the company is actively trading. | -| is_adr | bool | If the company is an ADR. | -| is_fund | bool | If the company is a fund. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| price | float | Price of the company. | -| beta | float | Beta of the company. | -| vol_avg | int | Volume average of the company. | -| mkt_cap | int | Market capitalization of the company. | -| last_div | float | Last dividend of the company. | -| range | str | Range of the company. | -| changes | float | Changes of the company. | -| company_name | str | Company name of the company. | -| currency | str | Currency of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| isin | str | ISIN of the company. | -| cusip | str | CUSIP of the company. | -| exchange | str | Exchange of the company. | -| exchange_short_name | str | Exchange short name of the company. | -| industry | str | Industry of the company. | -| website | str | Website of the company. | -| description | str | Description of the company. | -| ceo | str | CEO of the company. | -| sector | str | Sector of the company. | -| country | str | Country of the company. | -| full_time_employees | str | Full time employees of the company. | -| phone | str | Phone of the company. | -| address | str | Address of the company. | -| city | str | City of the company. | -| state | str | State of the company. | -| zip | str | Zip of the company. | -| dcf_diff | float | Discounted cash flow difference of the company. | -| dcf | float | Discounted cash flow of the company. | -| image | str | Image of the company. | -| ipo_date | date | IPO date of the company. | -| default_image | bool | If the image is the default image. | -| is_etf | bool | If the company is an ETF. | -| is_actively_trading | bool | If the company is actively trading. | -| is_adr | bool | If the company is an ADR. | -| is_fund | bool | If the company is a fund. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/ratios.md b/website/content/platform/reference/equity/fundamental/ratios.md deleted file mode 100644 index 8e5344a4568e..000000000000 --- a/website/content/platform/reference/equity/fundamental/ratios.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -title: "ratios" -description: "Learn about financial ratios for a given company over time. Explore various equity ratios, such as current ratio, quick ratio, and cash conversion cycle. Understand key profitability metrics like return on equity and profit margin. Analyze debt ratios, inventory turnover, and operating and free cash flows. Evaluate the price to earnings ratio and dividend yield." -keywords: -- financial ratios -- company ratios -- ratios over time -- equity ratios -- current ratio -- quick ratio -- cash conversion cycle -- return on equity -- profit margin -- debt ratio -- inventory turnover -- operating cash flow -- free cash flow -- price to earnings ratio -- dividend yield ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get an extensive set of financial and accounting ratios for a given company over time. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.ratios(symbol='AAPL', provider='fmp') -obb.equity.fundamental.ratios(symbol='AAPL', period='annual', limit=12, provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 12 | True | -| provider | Literal['fmp', 'intrinio'] | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 12 | True | -| provider | Literal['fmp', 'intrinio'] | 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 | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| limit | int | The number of data entries to return. | 12 | True | -| provider | Literal['fmp', 'intrinio'] | 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 | -| fiscal_year | int | The specific fiscal year. Reports do not go beyond 2008. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : FinancialRatios - Serializable results. - provider : Literal['fmp', 'intrinio'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | str | The date of the data. | -| fiscal_period | str | Period of the financial ratios. | -| fiscal_year | int | Fiscal year. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | str | The date of the data. | -| fiscal_period | str | Period of the financial ratios. | -| fiscal_year | int | Fiscal year. | -| current_ratio | float | Current ratio. | -| quick_ratio | float | Quick ratio. | -| cash_ratio | float | Cash ratio. | -| days_of_sales_outstanding | float | Days of sales outstanding. | -| days_of_inventory_outstanding | float | Days of inventory outstanding. | -| operating_cycle | float | Operating cycle. | -| days_of_payables_outstanding | float | Days of payables outstanding. | -| cash_conversion_cycle | float | Cash conversion cycle. | -| gross_profit_margin | float | Gross profit margin. | -| operating_profit_margin | float | Operating profit margin. | -| pretax_profit_margin | float | Pretax profit margin. | -| net_profit_margin | float | Net profit margin. | -| effective_tax_rate | float | Effective tax rate. | -| return_on_assets | float | Return on assets. | -| return_on_equity | float | Return on equity. | -| return_on_capital_employed | float | Return on capital employed. | -| net_income_per_ebt | float | Net income per EBT. | -| ebt_per_ebit | float | EBT per EBIT. | -| ebit_per_revenue | float | EBIT per revenue. | -| debt_ratio | float | Debt ratio. | -| debt_equity_ratio | float | Debt equity ratio. | -| long_term_debt_to_capitalization | float | Long term debt to capitalization. | -| total_debt_to_capitalization | float | Total debt to capitalization. | -| interest_coverage | float | Interest coverage. | -| cash_flow_to_debt_ratio | float | Cash flow to debt ratio. | -| company_equity_multiplier | float | Company equity multiplier. | -| receivables_turnover | float | Receivables turnover. | -| payables_turnover | float | Payables turnover. | -| inventory_turnover | float | Inventory turnover. | -| fixed_asset_turnover | float | Fixed asset turnover. | -| asset_turnover | float | Asset turnover. | -| operating_cash_flow_per_share | float | Operating cash flow per share. | -| free_cash_flow_per_share | float | Free cash flow per share. | -| cash_per_share | float | Cash per share. | -| payout_ratio | float | Payout ratio. | -| operating_cash_flow_sales_ratio | float | Operating cash flow sales ratio. | -| free_cash_flow_operating_cash_flow_ratio | float | Free cash flow operating cash flow ratio. | -| cash_flow_coverage_ratios | float | Cash flow coverage ratios. | -| short_term_coverage_ratios | float | Short term coverage ratios. | -| capital_expenditure_coverage_ratio | float | Capital expenditure coverage ratio. | -| dividend_paid_and_capex_coverage_ratio | float | Dividend paid and capex coverage ratio. | -| dividend_payout_ratio | float | Dividend payout ratio. | -| price_book_value_ratio | float | Price book value ratio. | -| price_to_book_ratio | float | Price to book ratio. | -| price_to_sales_ratio | float | Price to sales ratio. | -| price_earnings_ratio | float | Price earnings ratio. | -| price_to_free_cash_flows_ratio | float | Price to free cash flows ratio. | -| price_to_operating_cash_flows_ratio | float | Price to operating cash flows ratio. | -| price_cash_flow_ratio | float | Price cash flow ratio. | -| price_earnings_to_growth_ratio | float | Price earnings to growth ratio. | -| price_sales_ratio | float | Price sales ratio. | -| dividend_yield | float | Dividend yield. | -| dividend_yield_percentage | float | Dividend yield percentage. | -| dividend_per_share | float | Dividend per share. | -| enterprise_value_multiple | float | Enterprise value multiple. | -| price_fair_value | float | Price fair value. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | str | The date of the data. | -| fiscal_period | str | Period of the financial ratios. | -| fiscal_year | int | Fiscal year. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/reported_financials.md b/website/content/platform/reference/equity/fundamental/reported_financials.md deleted file mode 100644 index 498984323dcc..000000000000 --- a/website/content/platform/reference/equity/fundamental/reported_financials.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: "reported_financials" -description: "Get financial statements as reported by the company" -keywords: -- equity -- fundamental -- reported_financials ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get financial statements as reported by the company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.reported_financials(symbol='AAPL', provider='intrinio') -# Get AAPL balance sheet with a limit of 10 items. -obb.equity.fundamental.reported_financials(symbol='AAPL', period='annual', statement_type='balance', limit=10, provider='intrinio') -# Get reported income statement -obb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income', provider='intrinio') -# Get reported cash flow statement -obb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash', provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| statement_type | str | The type of financial statement - i.e, balance, income, cash. | balance | True | -| limit | int | 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. | 100 | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | str | Time period of the data to return. | annual | True | -| statement_type | str | The type of financial statement - i.e, balance, income, cash. | balance | True | -| limit | int | 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. | 100 | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | -| fiscal_year | int | The specific fiscal year. Reports do not go beyond 2008. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : ReportedFinancials - Serializable results. - provider : Literal['intrinio'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The ending date of the reporting period. | -| fiscal_period | str | The fiscal period of the report (e.g. FY, Q1, etc.). | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The ending date of the reporting period. | -| fiscal_period | str | The fiscal period of the report (e.g. FY, Q1, etc.). | -| fiscal_year | int | The fiscal year of the fiscal period. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/revenue_per_geography.md b/website/content/platform/reference/equity/fundamental/revenue_per_geography.md deleted file mode 100644 index 2cb029f66add..000000000000 --- a/website/content/platform/reference/equity/fundamental/revenue_per_geography.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: "revenue_per_geography" -description: "Learn about the revenue per geography data with the geographic revenue data Python function in this documentation page. Understand the symbol, period, structure, and provider parameters. Explore the returns, results, metadata, and the data structure including the date, geographic segment, and revenue by region (Americas, Europe, Greater China, Japan, Rest of Asia Pacific)." -keywords: -- geographic revenue data -- revenue per geography -- Python function -- documentation page -- symbol parameter -- period parameter -- structure parameter -- provider parameter -- returns -- results -- metadata -- data -- date -- geographic segment -- Americas -- Europe -- Greater China -- Japan -- Rest of Asia Pacific ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the revenue geographic breakdown for a given company over time. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.revenue_per_geography(symbol='AAPL', provider='fmp') -obb.equity.fundamental.revenue_per_geography(symbol='AAPL', period='annual', structure='flat', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | Literal['quarter', 'annual'] | Time period of the data to return. | annual | True | -| structure | Literal['hierarchical', 'flat'] | Structure of the returned data. | flat | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | Literal['quarter', 'annual'] | Time period of the data to return. | annual | True | -| structure | Literal['hierarchical', 'flat'] | Structure of the returned data. | flat | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : RevenueGeographic - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the reporting period. | -| fiscal_year | int | The fiscal year of the reporting period. | -| filing_date | date | The filing date of the report. | -| geographic_segment | int | Dictionary of the revenue by geographic segment. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the reporting period. | -| fiscal_year | int | The fiscal year of the reporting period. | -| filing_date | date | The filing date of the report. | -| geographic_segment | int | Dictionary of the revenue by geographic segment. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/revenue_per_segment.md b/website/content/platform/reference/equity/fundamental/revenue_per_segment.md deleted file mode 100644 index 06af5c465e88..000000000000 --- a/website/content/platform/reference/equity/fundamental/revenue_per_segment.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: "revenue_per_segment" -description: "Learn how to get revenue data for a specific business line using the equity fundamental revenue per segment function." -keywords: -- Revenue Business Line -- business line revenue data -- equity fundamental revenue per segment -- symbol -- period -- structure -- provider -- results -- RevenueBusinessLine -- chart -- metadata -- data -- date -- business line ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the revenue breakdown by business segment for a given company over time. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.revenue_per_segment(symbol='AAPL', provider='fmp') -obb.equity.fundamental.revenue_per_segment(symbol='AAPL', period='annual', structure='flat', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | Literal['quarter', 'annual'] | Time period of the data to return. | annual | True | -| structure | Literal['hierarchical', 'flat'] | Structure of the returned data. | flat | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| period | Literal['quarter', 'annual'] | Time period of the data to return. | annual | True | -| structure | Literal['hierarchical', 'flat'] | Structure of the returned data. | flat | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : RevenueBusinessLine - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the reporting period. | -| fiscal_year | int | The fiscal year of the reporting period. | -| filing_date | date | The filing date of the report. | -| business_line | int | Dictionary containing the revenue of the business line. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end date of the reporting period. | -| fiscal_period | str | The fiscal period of the reporting period. | -| fiscal_year | int | The fiscal year of the reporting period. | -| filing_date | date | The filing date of the report. | -| business_line | int | Dictionary containing the revenue of the business line. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/search_attributes.md b/website/content/platform/reference/equity/fundamental/search_attributes.md deleted file mode 100644 index adc543f10b0e..000000000000 --- a/website/content/platform/reference/equity/fundamental/search_attributes.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "search_attributes" -description: "Search Intrinio data tags to search in latest or historical attributes" -keywords: -- equity -- fundamental -- search_attributes ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Search Intrinio data tags to search in latest or historical attributes. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.search_attributes(query='ebitda', provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Query to search for. | | False | -| limit | int | The number of data entries to return. | 1000 | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Query to search for. | | False | -| limit | int | The number of data entries to return. | 1000 | True | -| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | intrinio | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : SearchAttributes - Serializable results. - provider : Literal['intrinio'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| id | str | ID of the financial attribute. | -| name | str | Name of the financial attribute. | -| tag | str | Tag of the financial attribute. | -| statement_code | str | Code of the financial statement. | -| statement_type | str | Type of the financial statement. | -| parent_name | str | Parent's name of the financial attribute. | -| sequence | int | Sequence of the financial statement. | -| factor | str | Unit of the financial attribute. | -| transaction | str | Transaction type (credit/debit) of the financial attribute. | -| type | str | Type of the financial attribute. | -| unit | str | Unit of the financial attribute. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| id | str | ID of the financial attribute. | -| name | str | Name of the financial attribute. | -| tag | str | Tag of the financial attribute. | -| statement_code | str | Code of the financial statement. | -| statement_type | str | Type of the financial statement. | -| parent_name | str | Parent's name of the financial attribute. | -| sequence | int | Sequence of the financial statement. | -| factor | str | Unit of the financial attribute. | -| transaction | str | Transaction type (credit/debit) of the financial attribute. | -| type | str | Type of the financial attribute. | -| unit | str | Unit of the financial attribute. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/trailing_dividend_yield.md b/website/content/platform/reference/equity/fundamental/trailing_dividend_yield.md deleted file mode 100644 index 1e0fc98cb632..000000000000 --- a/website/content/platform/reference/equity/fundamental/trailing_dividend_yield.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: "trailing_dividend_yield" -description: "Trailing 1yr dividend yield" -keywords: -- equity -- fundamental -- trailing_dividend_yield ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the 1 year trailing dividend yield for a given company over time. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', provider='tiingo') -obb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', limit=252, provider='tiingo') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. Default is 252, the number of trading days in a year. | 252 | True | -| provider | Literal['tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default. | tiingo | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. Default is 252, the number of trading days in a year. | 252 | True | -| provider | Literal['tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tiingo' if there is no default. | tiingo | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : TrailingDividendYield - Serializable results. - provider : Literal['tiingo'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| trailing_dividend_yield | float | Trailing dividend yield. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| trailing_dividend_yield | float | Trailing dividend yield. | - - - - diff --git a/website/content/platform/reference/equity/fundamental/transcript.md b/website/content/platform/reference/equity/fundamental/transcript.md deleted file mode 100644 index 548180930fe0..000000000000 --- a/website/content/platform/reference/equity/fundamental/transcript.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: "transcript" -description: "Learn how to retrieve earnings call transcripts for a given company using Python obb.equity.fundamental.transcript. Understand the data parameters, returns, symbol, year, quarter, and metadata associated with the transcripts." -keywords: -- earnings call transcript -- python obb.equity.fundamental.transcript -- data parameters -- returns -- symbols -- year -- quar -- content -- metadata -- provider ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get earnings call transcripts for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.fundamental.transcript(symbol='AAPL', year=2020, provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| year | int | Year of the earnings call transcript. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| year | int | Year of the earnings call transcript. | | False | -| 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EarningsCallTranscript - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| quarter | int | Quarter of the earnings call transcript. | -| year | int | Year of the earnings call transcript. | -| date | datetime | The date of the data. | -| content | str | Content of the earnings call transcript. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| quarter | int | Quarter of the earnings call transcript. | -| year | int | Year of the earnings call transcript. | -| date | datetime | The date of the data. | -| content | str | Content of the earnings call transcript. | - - - - diff --git a/website/content/platform/reference/equity/index.mdx b/website/content/platform/reference/equity/index.mdx deleted file mode 100644 index ceb97a05bd58..000000000000 --- a/website/content/platform/reference/equity/index.mdx +++ /dev/null @@ -1,25 +0,0 @@ -# Equity - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Menus -
    - - - - - - - - - -
- -### Commands -
    - - - - -
- diff --git a/website/content/platform/reference/equity/market_snapshots.md b/website/content/platform/reference/equity/market_snapshots.md deleted file mode 100644 index 2fdcafd2b62e..000000000000 --- a/website/content/platform/reference/equity/market_snapshots.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -title: "market_snapshots" -description: "Get a current, complete market snapshot with the obb.equity.market_snapshots Python method. Retrieve equity data such as stock information, financial data, market analysis, and trading volume. Explore details like stock performance, price change, moving averages, 52-week high and low, market cap, earnings per share, price to earnings ratio, and stock exchange." -keywords: -- market snapshot -- equity data -- market data -- stock information -- financial data -- market analysis -- trading volume -- stock performance -- price change -- moving averages -- 52-week high -- 52-week low -- market cap -- earnings per share -- price to earnings ratio -- stock exchange ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get an updated equity market snapshot. This includes price data for thousands of stocks. - - -Examples --------- - -```python -from openbb import obb -obb.equity.market_snapshots(provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'polygon'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'polygon'] | 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 | -| market | Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra'] | The market to fetch data for. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['fmp', 'polygon'] | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : MarketSnapshots - Serializable results. - provider : Literal['fmp', 'polygon'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | The change in price from the previous close. | -| change_percent | float | The change in price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | The change in price from the previous close. | -| change_percent | float | The change in price from the previous close, as a normalized percent. | -| last_price | float | The last price of the stock. | -| last_price_timestamp | Union[date, datetime] | The timestamp of the last price. | -| ma50 | float | The 50-day moving average. | -| ma200 | float | The 200-day moving average. | -| year_high | float | The 52-week high. | -| year_low | float | The 52-week low. | -| volume_avg | int | Average daily trading volume. | -| market_cap | int | Market cap of the stock. | -| eps | float | Earnings per share. | -| pe | float | Price to earnings ratio. | -| shares_outstanding | int | Number of shares outstanding. | -| name | str | The company name associated with the symbol. | -| exchange | str | The exchange of the stock. | -| earnings_date | Union[date, datetime] | The upcoming earnings announcement date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | The change in price from the previous close. | -| change_percent | float | The change in price from the previous close, as a normalized percent. | -| vwap | float | The volume weighted average price of the stock on the current trading day. | -| prev_open | float | The previous trading session opening price. | -| prev_high | float | The previous trading session high price. | -| prev_low | float | The previous trading session low price. | -| prev_volume | float | The previous trading session volume. | -| prev_vwap | float | The previous trading session VWAP. | -| last_updated | datetime | The last time the data was updated. | -| bid | float | The current bid price. | -| bid_size | int | The current bid size. | -| ask_size | int | The current ask size. | -| ask | float | The current ask price. | -| quote_timestamp | datetime | The timestamp of the last quote. | -| last_trade_price | float | The last trade price. | -| last_trade_size | int | The last trade size. | -| last_trade_conditions | List[int] | The last trade condition codes. | -| last_trade_exchange | int | The last trade exchange ID code. | -| last_trade_timestamp | datetime | The last trade timestamp. | - - - - diff --git a/website/content/platform/reference/equity/ownership/_category_.json b/website/content/platform/reference/equity/ownership/_category_.json deleted file mode 100644 index dfd02598845f..000000000000 --- a/website/content/platform/reference/equity/ownership/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Ownership", - "position": 5 -} \ No newline at end of file diff --git a/website/content/platform/reference/equity/ownership/form_13f.md b/website/content/platform/reference/equity/ownership/form_13f.md deleted file mode 100644 index 2f8141cffd18..000000000000 --- a/website/content/platform/reference/equity/ownership/form_13f.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: "form_13f" -description: "The Securities and Exchange Commission's (SEC) Form 13F is a quarterly report -that is required to be filed by all institutional investment managers with at least -$100 million in assets under management" -keywords: -- equity -- ownership -- form_13f ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -The Securities and Exchange Commission's (SEC) Form 13F is a quarterly report -that is required to be filed by all institutional investment managers with at least -$100 million in assets under management. -Managers are required to file Form 13F within 45 days after the last day of the calendar quarter. -Most funds wait until the end of this period in order to conceal -their investment strategy from competitors and the public. - - -Examples --------- - -```python -from openbb import obb -obb.equity.ownership.form_13f(symbol='NVDA', provider='sec') -# Enter a date (calendar quarter ending) for a specific report. -obb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec') -# Example finding Michael Burry's filings. -cik = obb.regulators.sec.institutions_search("Scion Asset Management").results[0].cik -# Use the `limit` parameter to return N number of reports from the most recent. -obb.equity.ownership.form_13f(cik, limit=2).to_df() -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. A CIK or Symbol can be used. | | False | -| date | Union[date, str] | 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. | None | True | -| limit | int | The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter. | 1 | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. A CIK or Symbol can be used. | | False | -| date | Union[date, str] | 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. | None | True | -| limit | int | The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter. | 1 | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : Form13FHR - Serializable results. - provider : Literal['sec'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end-of-quarter date of the filing. | -| issuer | str | The name of the issuer. | -| cusip | str | The CUSIP of the security. | -| asset_class | str | The title of the asset class for the security. | -| security_type | Literal['SH', 'PRN'] | The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'. | -| option_type | Literal['call', 'put'] | Defined when the holdings being reported are put or call options. Only long positions are reported. | -| voting_authority_sole | int | The number of shares for which the Manager exercises sole voting authority (none). | -| voting_authority_shared | int | The number of shares for which the Manager exercises a defined shared voting authority (none). | -| voting_authority_other | int | The number of shares for which the Manager exercises other shared voting authority (none). | -| principal_amount | int | The total number of shares of the class of security or the principal amount of such class. Only long positions are reported | -| value | int | The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| period_ending | date | The end-of-quarter date of the filing. | -| issuer | str | The name of the issuer. | -| cusip | str | The CUSIP of the security. | -| asset_class | str | The title of the asset class for the security. | -| security_type | Literal['SH', 'PRN'] | The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'. | -| option_type | Literal['call', 'put'] | Defined when the holdings being reported are put or call options. Only long positions are reported. | -| voting_authority_sole | int | The number of shares for which the Manager exercises sole voting authority (none). | -| voting_authority_shared | int | The number of shares for which the Manager exercises a defined shared voting authority (none). | -| voting_authority_other | int | The number of shares for which the Manager exercises other shared voting authority (none). | -| principal_amount | int | The total number of shares of the class of security or the principal amount of such class. Only long positions are reported | -| value | int | The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter. | -| weight | float | The weight of the security relative to the market value of all securities in the filing , as a normalized percent. | - - - - diff --git a/website/content/platform/reference/equity/ownership/index.mdx b/website/content/platform/reference/equity/ownership/index.mdx deleted file mode 100644 index 0870fbe0d15c..000000000000 --- a/website/content/platform/reference/equity/ownership/index.mdx +++ /dev/null @@ -1,15 +0,0 @@ -# Ownership - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - - -
- diff --git a/website/content/platform/reference/equity/ownership/insider_trading.md b/website/content/platform/reference/equity/ownership/insider_trading.md deleted file mode 100644 index e6cc20e6a2cb..000000000000 --- a/website/content/platform/reference/equity/ownership/insider_trading.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -title: "insider_trading" -description: "Learn how to use the stock insider trading Python function to get information about insider trading, including parameter details, return types, and data descriptions." -keywords: -- stock insider trading -- equity ownership -- Python function -- parameter details -- data description -- symbol -- transaction type -- limit -- provider -- returns -- results -- chart -- metadata -- data -- filing date -- transaction date -- reporting CIK -- securities owned -- company CIK -- reporting name -- type of owner -- acquisition or disposition -- form type -- securities transacted -- price -- security name -- link ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get data about trading by a company's management team and board of directors. - - -Examples --------- - -```python -from openbb import obb -obb.equity.ownership.insider_trading(symbol='AAPL', provider='fmp') -obb.equity.ownership.insider_trading(symbol='AAPL', limit=500, provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 500 | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 500 | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| transaction_type | Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust'] | Type of the transaction. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 500 | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | | False | -| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | | False | -| ownership_type | Literal['D', 'I'] | Type of ownership. | None | True | -| sort_by | Literal['filing_date', 'updated_on'] | Field to sort by. | updated_on | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| limit | int | The number of data entries to return. | 500 | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| summary | bool | Return a summary of the insider activity instead of the individuals. | False | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : InsiderTrading - Serializable results. - provider : Literal['fmp', 'intrinio', 'tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| company_cik | Union[int, str] | CIK number of the company. | -| filing_date | Union[date, datetime] | Filing date of the trade. | -| transaction_date | date | Date of the transaction. | -| owner_cik | Union[int, str] | Reporting individual's CIK. | -| owner_name | str | Name of the reporting individual. | -| owner_title | str | The title held by the reporting individual. | -| transaction_type | str | Type of transaction being reported. | -| acquisition_or_disposition | str | Acquisition or disposition of the shares. | -| security_type | str | The type of security transacted. | -| securities_owned | float | Number of securities owned by the reporting individual. | -| securities_transacted | float | Number of securities transacted by the reporting individual. | -| transaction_price | float | The price of the transaction. | -| filing_url | str | Link to the filing. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| company_cik | Union[int, str] | CIK number of the company. | -| filing_date | Union[date, datetime] | Filing date of the trade. | -| transaction_date | date | Date of the transaction. | -| owner_cik | Union[int, str] | Reporting individual's CIK. | -| owner_name | str | Name of the reporting individual. | -| owner_title | str | The title held by the reporting individual. | -| transaction_type | str | Type of transaction being reported. | -| acquisition_or_disposition | str | Acquisition or disposition of the shares. | -| security_type | str | The type of security transacted. | -| securities_owned | float | Number of securities owned by the reporting individual. | -| securities_transacted | float | Number of securities transacted by the reporting individual. | -| transaction_price | float | The price of the transaction. | -| filing_url | str | Link to the filing. | -| form_type | str | Form type of the insider trading. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| company_cik | Union[int, str] | CIK number of the company. | -| filing_date | Union[date, datetime] | Filing date of the trade. | -| transaction_date | date | Date of the transaction. | -| owner_cik | Union[int, str] | Reporting individual's CIK. | -| owner_name | str | Name of the reporting individual. | -| owner_title | str | The title held by the reporting individual. | -| transaction_type | str | Type of transaction being reported. | -| acquisition_or_disposition | str | Acquisition or disposition of the shares. | -| security_type | str | The type of security transacted. | -| securities_owned | float | Number of securities owned by the reporting individual. | -| securities_transacted | float | Number of securities transacted by the reporting individual. | -| transaction_price | float | The price of the transaction. | -| filing_url | str | Link to the filing. | -| company_name | str | Name of the company. | -| conversion_exercise_price | float | Conversion/Exercise price of the shares. | -| deemed_execution_date | date | Deemed execution date of the trade. | -| exercise_date | date | Exercise date of the trade. | -| expiration_date | date | Expiration date of the derivative. | -| underlying_security_title | str | Name of the underlying non-derivative security related to this derivative transaction. | -| underlying_shares | Union[int, float] | Number of underlying shares related to this derivative transaction. | -| nature_of_ownership | str | Nature of ownership of the insider trading. | -| director | bool | Whether the owner is a director. | -| officer | bool | Whether the owner is an officer. | -| ten_percent_owner | bool | Whether the owner is a 10% owner. | -| other_relation | bool | Whether the owner is having another relation. | -| derivative_transaction | bool | Whether the owner is having a derivative transaction. | -| report_line_number | int | Report line number of the insider trading. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| company_cik | Union[int, str] | CIK number of the company. | -| filing_date | Union[date, datetime] | Filing date of the trade. | -| transaction_date | date | Date of the transaction. | -| owner_cik | Union[int, str] | Reporting individual's CIK. | -| owner_name | str | Name of the reporting individual. | -| owner_title | str | The title held by the reporting individual. | -| transaction_type | str | Type of transaction being reported. | -| acquisition_or_disposition | str | Acquisition or disposition of the shares. | -| security_type | str | The type of security transacted. | -| securities_owned | float | Number of securities owned by the reporting individual. | -| securities_transacted | float | Number of securities transacted by the reporting individual. | -| transaction_price | float | The price of the transaction. | -| filing_url | str | Link to the filing. | -| period | str | The period of the activity. Bucketed by three, six, and twelve months. | -| acquisition_or_deposition | str | Whether the insider bought or sold the shares. | -| number_of_trades | int | The number of shares traded over the period. | -| trade_value | float | The value of the shares traded by the insider. | -| securities_bought | int | The total number of shares bought by all insiders over the period. | -| securities_sold | int | The total number of shares sold by all insiders over the period. | -| net_activity | int | The total net activity by all insiders over the period. | - - - - diff --git a/website/content/platform/reference/equity/ownership/institutional.md b/website/content/platform/reference/equity/ownership/institutional.md deleted file mode 100644 index f5b3745619b3..000000000000 --- a/website/content/platform/reference/equity/ownership/institutional.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -title: "institutional" -description: "Learn about institutional ownership data, and how to use the OBB.equity.ownership.institutional function in Python to access the data. Explore the symbol, include_current_quarter, date, and provider parameters. Understand the meaning and usage of the results, provider, warnings, chart, and metadata properties. Additionally, get detailed descriptions of the various data fields such as symbol, cik, date, investors_holding, number_of_13f_shares, total_invested, ownership_percent, new_positions, closed_positions, total_calls, total_puts, and put_call_ratio." -keywords: -- institutional ownership data -- python OBB.equity.ownership.institutional function -- symbol parameter -- include_current_quarter parameter -- date parameter -- provider parameter -- results property -- provider property -- warnings property -- chart property -- metadata property -- data description -- symbol data -- cik data -- date data -- investors_holding data -- last_investors_holding data -- investors_holding_change data -- number_of_13f_shares data -- last_number_of_13f_shares data -- number_of_13f_shares_change data -- total_invested data -- last_total_invested data -- total_invested_change data -- ownership_percent data -- last_ownership_percent data -- ownership_percent_change data -- new_positions data -- last_new_positions data -- new_positions_change data -- increased_positions data -- last_increased_positions data -- increased_positions_change data -- closed_positions data -- last_closed_positions data -- closed_positions_change data -- reduced_positions data -- last_reduced_positions data -- reduced_positions_change data -- total_calls data -- last_total_calls data -- total_calls_change data -- total_puts data -- last_total_puts data -- total_puts_change data -- put_call_ratio data -- last_put_call_ratio data -- put_call_ratio_change data ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get data about institutional ownership for a given company over time. - - -Examples --------- - -```python -from openbb import obb -obb.equity.ownership.institutional(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| 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 | -| include_current_quarter | bool | Include current quarter data. | False | True | -| date | Union[date, str] | A specific date to get data for. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : InstitutionalOwnership - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| date | date | The date of the data. | -| investors_holding | int | Number of investors holding the stock. | -| last_investors_holding | int | Number of investors holding the stock in the last quarter. | -| investors_holding_change | int | Change in the number of investors holding the stock. | -| number_of_13f_shares | int | Number of 13F shares. | -| last_number_of_13f_shares | int | Number of 13F shares in the last quarter. | -| number_of_13f_shares_change | int | Change in the number of 13F shares. | -| total_invested | float | Total amount invested. | -| last_total_invested | float | Total amount invested in the last quarter. | -| total_invested_change | float | Change in the total amount invested. | -| ownership_percent | float | Ownership percent. | -| last_ownership_percent | float | Ownership percent in the last quarter. | -| ownership_percent_change | float | Change in the ownership percent. | -| new_positions | int | Number of new positions. | -| last_new_positions | int | Number of new positions in the last quarter. | -| new_positions_change | int | Change in the number of new positions. | -| increased_positions | int | Number of increased positions. | -| last_increased_positions | int | Number of increased positions in the last quarter. | -| increased_positions_change | int | Change in the number of increased positions. | -| closed_positions | int | Number of closed positions. | -| last_closed_positions | int | Number of closed positions in the last quarter. | -| closed_positions_change | int | Change in the number of closed positions. | -| reduced_positions | int | Number of reduced positions. | -| last_reduced_positions | int | Number of reduced positions in the last quarter. | -| reduced_positions_change | int | Change in the number of reduced positions. | -| total_calls | int | Total number of call options contracts traded for Apple Inc. on the specified date. | -| last_total_calls | int | Total number of call options contracts traded for Apple Inc. on the previous reporting date. | -| total_calls_change | int | Change in the total number of call options contracts traded between the current and previous reporting dates. | -| total_puts | int | Total number of put options contracts traded for Apple Inc. on the specified date. | -| last_total_puts | int | Total number of put options contracts traded for Apple Inc. on the previous reporting date. | -| total_puts_change | int | Change in the total number of put options contracts traded between the current and previous reporting dates. | -| put_call_ratio | float | Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date. | -| last_put_call_ratio | float | Put-call ratio on the previous reporting date. | -| put_call_ratio_change | float | Change in the put-call ratio between the current and previous reporting dates. | - - - - diff --git a/website/content/platform/reference/equity/ownership/major_holders.md b/website/content/platform/reference/equity/ownership/major_holders.md deleted file mode 100644 index df50a5a23e75..000000000000 --- a/website/content/platform/reference/equity/ownership/major_holders.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -title: "major_holders" -description: "Get detailed information about equity ownership and stock ownership, including investment data, security data, market value data, shares data, performance data, and ownership data. Use the equity ownership API to retrieve equity ownership details, and explore various stock ownership parameters and returns. Access company ownership data, investor data, filing data, industry data, and more." -keywords: -- equity ownership -- company ownership -- equity ownership API -- equity ownership data -- equity ownership parameters -- equity ownership returns -- equity ownership data fields -- stock ownership -- stock ownership data -- stock ownership API -- stock ownership parameters -- stock ownership returns -- stock ownership data fields -- investment data -- security data -- market value data -- shares data -- performance data -- ownership data -- equity ownership details -- stock ownership details -- equity ownership information -- stock ownership information -- company ownership data -- investor data -- filing data -- industry data ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get data about major holders for a given company over time. - - -Examples --------- - -```python -from openbb import obb -obb.equity.ownership.major_holders(symbol='AAPL', provider='fmp') -obb.equity.ownership.major_holders(symbol='AAPL', page=0, provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| date | Union[date, str] | A specific date to get data for. | None | True | -| page | int | Page number of the data to fetch. | 0 | 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| date | Union[date, str] | A specific date to get data for. | None | True | -| page | int | Page number of the data to fetch. | 0 | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityOwnership - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| cik | int | Central Index Key (CIK) for the requested entity. | -| filing_date | date | Filing date of the stock ownership. | -| investor_name | str | Investor name of the stock ownership. | -| symbol | str | Symbol representing the entity requested in the data. | -| security_name | str | Security name of the stock ownership. | -| type_of_security | str | Type of security of the stock ownership. | -| security_cusip | str | Security cusip of the stock ownership. | -| shares_type | str | Shares type of the stock ownership. | -| put_call_share | str | Put call share of the stock ownership. | -| investment_discretion | str | Investment discretion of the stock ownership. | -| industry_title | str | Industry title of the stock ownership. | -| weight | float | Weight of the stock ownership. | -| last_weight | float | Last weight of the stock ownership. | -| change_in_weight | float | Change in weight of the stock ownership. | -| change_in_weight_percentage | float | Change in weight percentage of the stock ownership. | -| market_value | int | Market value of the stock ownership. | -| last_market_value | int | Last market value of the stock ownership. | -| change_in_market_value | int | Change in market value of the stock ownership. | -| change_in_market_value_percentage | float | Change in market value percentage of the stock ownership. | -| shares_number | int | Shares number of the stock ownership. | -| last_shares_number | int | Last shares number of the stock ownership. | -| change_in_shares_number | float | Change in shares number of the stock ownership. | -| change_in_shares_number_percentage | float | Change in shares number percentage of the stock ownership. | -| quarter_end_price | float | Quarter end price of the stock ownership. | -| avg_price_paid | float | Average price paid of the stock ownership. | -| is_new | bool | Is the stock ownership new. | -| is_sold_out | bool | Is the stock ownership sold out. | -| ownership | float | How much is the ownership. | -| last_ownership | float | Last ownership amount. | -| change_in_ownership | float | Change in ownership amount. | -| change_in_ownership_percentage | float | Change in ownership percentage. | -| holding_period | int | Holding period of the stock ownership. | -| first_added | date | First added date of the stock ownership. | -| performance | float | Performance of the stock ownership. | -| performance_percentage | float | Performance percentage of the stock ownership. | -| last_performance | float | Last performance of the stock ownership. | -| change_in_performance | float | Change in performance of the stock ownership. | -| is_counted_for_performance | bool | Is the stock ownership counted for performance. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| cik | int | Central Index Key (CIK) for the requested entity. | -| filing_date | date | Filing date of the stock ownership. | -| investor_name | str | Investor name of the stock ownership. | -| symbol | str | Symbol representing the entity requested in the data. | -| security_name | str | Security name of the stock ownership. | -| type_of_security | str | Type of security of the stock ownership. | -| security_cusip | str | Security cusip of the stock ownership. | -| shares_type | str | Shares type of the stock ownership. | -| put_call_share | str | Put call share of the stock ownership. | -| investment_discretion | str | Investment discretion of the stock ownership. | -| industry_title | str | Industry title of the stock ownership. | -| weight | float | Weight of the stock ownership. | -| last_weight | float | Last weight of the stock ownership. | -| change_in_weight | float | Change in weight of the stock ownership. | -| change_in_weight_percentage | float | Change in weight percentage of the stock ownership. | -| market_value | int | Market value of the stock ownership. | -| last_market_value | int | Last market value of the stock ownership. | -| change_in_market_value | int | Change in market value of the stock ownership. | -| change_in_market_value_percentage | float | Change in market value percentage of the stock ownership. | -| shares_number | int | Shares number of the stock ownership. | -| last_shares_number | int | Last shares number of the stock ownership. | -| change_in_shares_number | float | Change in shares number of the stock ownership. | -| change_in_shares_number_percentage | float | Change in shares number percentage of the stock ownership. | -| quarter_end_price | float | Quarter end price of the stock ownership. | -| avg_price_paid | float | Average price paid of the stock ownership. | -| is_new | bool | Is the stock ownership new. | -| is_sold_out | bool | Is the stock ownership sold out. | -| ownership | float | How much is the ownership. | -| last_ownership | float | Last ownership amount. | -| change_in_ownership | float | Change in ownership amount. | -| change_in_ownership_percentage | float | Change in ownership percentage. | -| holding_period | int | Holding period of the stock ownership. | -| first_added | date | First added date of the stock ownership. | -| performance | float | Performance of the stock ownership. | -| performance_percentage | float | Performance percentage of the stock ownership. | -| last_performance | float | Last performance of the stock ownership. | -| change_in_performance | float | Change in performance of the stock ownership. | -| is_counted_for_performance | bool | Is the stock ownership counted for performance. | - - - - diff --git a/website/content/platform/reference/equity/ownership/share_statistics.md b/website/content/platform/reference/equity/ownership/share_statistics.md deleted file mode 100644 index 1fecbd732f7f..000000000000 --- a/website/content/platform/reference/equity/ownership/share_statistics.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -title: "share_statistics" -description: "Learn how to retrieve and analyze share statistics for a given company using the obb.equity.ownership.share_statistics API endpoint. This documentation provides details on the parameters, return values, and data structure." -keywords: -- share statistics -- company statistics -- equity ownership -- symbol -- provider -- data -- free float -- float shares -- outstanding shares -- source ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get data about share float for a given company. - - -Examples --------- - -```python -from openbb import obb -obb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): yfinance. | | False | -| provider | Literal['fmp', 'intrinio', '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. Multiple items allowed for provider(s): yfinance. | | False | -| provider | Literal['fmp', 'intrinio', '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. Multiple items allowed for provider(s): yfinance. | | False | -| provider | Literal['fmp', 'intrinio', '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. Multiple items allowed for provider(s): yfinance. | | False | -| provider | Literal['fmp', 'intrinio', '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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : ShareStatistics - Serializable results. - provider : Literal['fmp', 'intrinio', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| free_float | float | Percentage of unrestricted shares of a publicly-traded company. | -| float_shares | float | Number of shares available for trading by the general public. | -| outstanding_shares | float | Total number of shares of a publicly-traded company. | -| source | str | Source of the received data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| free_float | float | Percentage of unrestricted shares of a publicly-traded company. | -| float_shares | float | Number of shares available for trading by the general public. | -| outstanding_shares | float | Total number of shares of a publicly-traded company. | -| source | str | Source of the received data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| free_float | float | Percentage of unrestricted shares of a publicly-traded company. | -| float_shares | float | Number of shares available for trading by the general public. | -| outstanding_shares | float | Total number of shares of a publicly-traded company. | -| source | str | Source of the received data. | -| adjusted_outstanding_shares | float | Total number of shares of a publicly-traded company, adjusted for splits. | -| public_float | float | Aggregate market value of the shares of a publicly-traded company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| date | date | The date of the data. | -| free_float | float | Percentage of unrestricted shares of a publicly-traded company. | -| float_shares | float | Number of shares available for trading by the general public. | -| outstanding_shares | float | Total number of shares of a publicly-traded company. | -| source | str | Source of the received data. | -| implied_shares_outstanding | int | Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common. | -| short_interest | int | Number of shares that are reported short. | -| short_percent_of_float | float | Percentage of shares that are reported short, as a normalized percent. | -| days_to_cover | float | Number of days to repurchase the shares as a ratio of average daily volume | -| short_interest_prev_month | int | Number of shares that were reported short in the previous month. | -| short_interest_prev_date | date | Date of the previous month's report. | -| insider_ownership | float | Percentage of shares held by insiders, as a normalized percent. | -| institution_ownership | float | Percentage of shares held by institutions, as a normalized percent. | -| institution_float_ownership | float | Percentage of float held by institutions, as a normalized percent. | -| institutions_count | int | Number of institutions holding shares. | - - - - diff --git a/website/content/platform/reference/equity/price/_category_.json b/website/content/platform/reference/equity/price/_category_.json deleted file mode 100644 index f164afef9262..000000000000 --- a/website/content/platform/reference/equity/price/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Price", - "position": 6 -} \ No newline at end of file diff --git a/website/content/platform/reference/equity/price/historical.md b/website/content/platform/reference/equity/price/historical.md deleted file mode 100644 index 3d45fa34026a..000000000000 --- a/website/content/platform/reference/equity/price/historical.md +++ /dev/null @@ -1,380 +0,0 @@ ---- -title: "historical" -description: "Learn how to use the `obb.equity.price.historical` function to load historical price data for a specific stock ticker. Find out about the available parameters and providers, as well as the structure of the returned data and the columns it contains." -keywords: -- equity historical price -- load stock data -- specific ticker -- python function -- equity data parameters -- alpha vantage provider -- fmp provider -- intrinio provider -- polygon provider -- yfinance provider -- equity historical data returns -- equity data columns -- alpha vantage data columns -- cboe data columns -- fmp data columns -- intrinio data columns -- polygon data columns -- yfinance data columns ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get historical price data for a given stock. This includes open, high, low, close, and volume. - - -Examples --------- - -```python -from openbb import obb -obb.equity.price.historical(symbol='AAPL', provider='fmp') -obb.equity.price.historical(symbol='AAPL', interval='1d', provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'splits_and_dividends', 'unadjusted'] | The adjustment factor to apply. 'splits_only' is not supported for intraday data. | splits_only | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| adjusted | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| use_cache | bool | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| start_time | datetime.time | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. | None | True | -| end_time | datetime.time | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. | None | True | -| timezone | str | Timezone of the data, in the IANA format (Continent/City). | America/New_York | True | -| source | Literal['realtime', 'delayed', 'nasdaq_basic'] | The source of the data. | realtime | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'unadjusted'] | The adjustment factor to apply. Default is splits only. | splits_only | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'splits_and_dividends', 'unadjusted'] | The adjustment factor to apply. Only valid for daily data. | splits_only | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| include_actions | bool | Include dividends and stock splits in results. | True | True | -| adjustment | Literal['splits_only', 'splits_and_dividends'] | The adjustment factor to apply. Default is splits only. | splits_only | True | -| adjusted | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. | False | True | -| prepost | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead. | False | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityHistorical - Serializable results. - provider : Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_close | float, Gt(gt=0) | The adjusted close price. | -| dividend | float, Ge(ge=0) | Dividend amount, if a dividend was paid. | -| split_ratio | float, Ge(ge=0) | Split coefficient, if a split occurred. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| calls_volume | int | Number of calls traded during the most recent trading period. Only valid if interval is 1m. | -| puts_volume | int | Number of puts traded during the most recent trading period. Only valid if interval is 1m. | -| total_options_volume | int | Total number of options traded during the most recent trading period. Only valid if interval is 1m. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_close | float | The adjusted close price. | -| unadjusted_volume | float | Unadjusted volume of the symbol. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| average | float | Average trade price of an individual equity during the interval. | -| change | float | Change in the price of the symbol from the previous day. | -| change_percent | float | Percent change in the price of the symbol from the previous day. | -| adj_open | float | The adjusted open price. | -| adj_high | float | The adjusted high price. | -| adj_low | float | The adjusted low price. | -| adj_close | float | The adjusted close price. | -| adj_volume | float | The adjusted volume. | -| fifty_two_week_high | float | 52 week high price for the symbol. | -| fifty_two_week_low | float | 52 week low price for the symbol. | -| factor | float | factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount, if a dividend was paid. | -| close_time | datetime | The timestamp that represents the end of the interval span. | -| interval | str | The data time frequency. | -| intra_period | bool | 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 | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_open | float | The adjusted open price. | -| adj_high | float | The adjusted high price. | -| adj_low | float | The adjusted low price. | -| adj_close | float | The adjusted close price. | -| adj_volume | float | The adjusted volume. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount, if a dividend was paid. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| change | float | Change in price. | -| change_percent | float | Change in price, as a normalized percentage. | -| transactions | int | Total number of transactions recorded. | -| transactions_value | float | Nominal value of recorded transactions. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| last_price | float | The last price of the equity. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount (split-adjusted), if a dividend was paid. | - - - - diff --git a/website/content/platform/reference/equity/price/index.mdx b/website/content/platform/reference/equity/price/index.mdx deleted file mode 100644 index aacbe9ec6c81..000000000000 --- a/website/content/platform/reference/equity/price/index.mdx +++ /dev/null @@ -1,12 +0,0 @@ -# Price - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - -
- diff --git a/website/content/platform/reference/equity/price/nbbo.md b/website/content/platform/reference/equity/price/nbbo.md deleted file mode 100644 index 9f152992c00b..000000000000 --- a/website/content/platform/reference/equity/price/nbbo.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -title: "nbbo" -description: "Learn how to load the National Best Bid and Offer (NBBO) for a specific equity using the OBB.equity.price.nbbo API. Explore the parameters and data returned by the query, including ask price, bid price, ask size, bid size, exchange details, timestamps, and more." -keywords: -- Equity Quote -- National Best Bid and Offer -- specific equity -- symbol -- provider -- polygon -- query -- limit -- date -- timestamp -- OBBject -- results -- EquityNBBO -- warnings -- Chart -- Metadata -- ask_exchange -- ask -- ask_size -- bid_size -- bid -- bid_exchange -- tape -- conditions -- indicators -- sequence_num -- participant_timestamp -- sip_timestamp -- trf_timestamp -- data ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the National Best Bid and Offer for a given stock. - - -Examples --------- - -```python -from openbb import obb -obb.equity.price.nbbo(symbol='AAPL', provider='polygon') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['polygon'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default. | polygon | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['polygon'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'polygon' if there is no default. | polygon | True | -| limit | int | 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. | 50000 | True | -| date | Union[date, str] | A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges. | None | True | -| timestamp_lt | Union[datetime, str] | 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. | None | True | -| timestamp_gt | Union[datetime, str] | 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. | None | True | -| timestamp_lte | Union[datetime, str] | 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. | None | True | -| timestamp_gte | Union[datetime, str] | 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. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityNBBO - Serializable results. - provider : Literal['polygon'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ask_exchange | str | The exchange ID for the ask. | -| ask | float | The last ask price. | -| ask_size | int | The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. | -| bid_size | int | The bid size in round lots. | -| bid | float | The last bid price. | -| bid_exchange | str | The exchange ID for the bid. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| ask_exchange | str | The exchange ID for the ask. | -| ask | float | The last ask price. | -| ask_size | int | The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. | -| bid_size | int | The bid size in round lots. | -| bid | float | The last bid price. | -| bid_exchange | str | The exchange ID for the bid. | -| tape | str | The exchange tape. | -| conditions | Union[str, List[int], List[str]] | A list of condition codes. | -| indicators | List[int] | A list of indicator codes. | -| sequence_num | int | 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 | datetime | The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. | -| sip_timestamp | datetime | The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. | -| trf_timestamp | datetime | The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote. | - - - - diff --git a/website/content/platform/reference/equity/price/performance.md b/website/content/platform/reference/equity/price/performance.md deleted file mode 100644 index a7dcef9de7ee..000000000000 --- a/website/content/platform/reference/equity/price/performance.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: "performance" -description: "Learn how to calculate the price performance return for a symbol over different time periods using the OBB.equity.price.performance function. Retrieve data such as one-day return, week to date return, one-week return, month to date return, and more. Understand the parameters, returns, and data structure of the function." -keywords: -- price performance -- return -- symbol -- data -- provider -- chart -- metadata -- one-day return -- week to date return -- one-week return -- month to date return -- one-month return -- quarter to date return -- three-month return -- six-month return -- year to date return -- one-year return -- three-year return -- five-year return -- ten-year return -- max return -- time series -- ticker symbol ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get price performance data for a given stock. This includes price changes for different time periods. - - -Examples --------- - -```python -from openbb import obb -obb.equity.price.performance(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| provider | Literal['finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| provider | Literal['finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| provider | Literal['finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : PricePerformance - Serializable results. - provider : Literal['finviz', 'fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | -| volatility_week | float | One-week realized volatility, as a normalized percent. | -| volatility_month | float | One-month realized volatility, as a normalized percent. | -| price | float | Last Price. | -| volume | float | Current volume. | -| average_volume | float | Average daily volume. | -| relative_volume | float | Relative volume as a ratio of current volume to average volume. | -| analyst_recommendation | float | The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. | -| symbol | str | The ticker symbol. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | -| symbol | str | The ticker symbol. | - - - - diff --git a/website/content/platform/reference/equity/price/quote.md b/website/content/platform/reference/equity/price/quote.md deleted file mode 100644 index 794f425eb380..000000000000 --- a/website/content/platform/reference/equity/price/quote.md +++ /dev/null @@ -1,535 +0,0 @@ ---- -title: "quote" -description: "Learn how to load stock data for a specific ticker with the Equity Quote function. Discover the various parameters and data returned, including day low, day high, date, symbol, name, price, volume, and more." -keywords: -- equity quote -- stock data -- ticker -- parameters -- symbol -- provider -- returns -- data -- day low -- day high -- date -- fmp -- intrinio -- source -- results -- warnings -- chart -- metadata -- price -- changes percentage -- change -- year high -- year low -- market cap -- price avg50 -- price avg200 -- volume -- avg volume -- exchange -- open -- previous close -- eps -- pe -- earnings announcement -- shares outstanding -- last price -- last time -- last size -- bid price -- bid size -- ask price -- ask size -- close price -- high price -- low price -- exchange volume -- market volume -- updated on -- listing venue -- sales conditions -- quote conditions -- market center code -- is darkpool -- messages -- security ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the latest quote for a given stock. Quote includes price, volume, and other data. - - -Examples --------- - -```python -from openbb import obb -obb.equity.price.quote(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| use_cache | bool | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| source | Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip'] | Source of the data. | iex | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): cboe, fmp, intrinio, tmx, tradier, yfinance. | | False | -| provider | Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', '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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityQuote - Serializable results. - provider : Literal['cboe', 'fmp', 'intrinio', 'tmx', 'tradier', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| iv30 | float | The 30-day implied volatility of the stock. | -| iv30_change | float | Change in 30-day implied volatility of the stock. | -| iv30_change_percent | float | Change in 30-day implied volatility of the stock as a normalized percentage value. | -| iv30_annual_high | float | The 1-year high of 30-day implied volatility. | -| hv30_annual_high | float | The 1-year high of 30-day realized volatility. | -| iv30_annual_low | float | The 1-year low of 30-day implied volatility. | -| hv30_annual_low | float | The 1-year low of 30-dayrealized volatility. | -| iv60_annual_high | float | The 1-year high of 60-day implied volatility. | -| hv60_annual_high | float | The 1-year high of 60-day realized volatility. | -| iv60_annual_low | float | The 1-year low of 60-day implied volatility. | -| hv60_annual_low | float | The 1-year low of 60-day realized volatility. | -| iv90_annual_high | float | The 1-year high of 90-day implied volatility. | -| hv90_annual_high | float | The 1-year high of 90-day realized volatility. | -| iv90_annual_low | float | The 1-year low of 90-day implied volatility. | -| hv90_annual_low | float | The 1-year low of 90-day realized volatility. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| price_avg50 | float | 50 day moving average price. | -| price_avg200 | float | 200 day moving average price. | -| avg_volume | int | Average volume over the last 10 trading days. | -| market_cap | float | Market cap of the company. | -| shares_outstanding | int | Number of shares outstanding. | -| eps | float | Earnings per share. | -| pe | float | Price earnings ratio. | -| earnings_announcement | Union[datetime, str] | Upcoming earnings announcement date. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| is_darkpool | bool | Whether or not the current trade is from a darkpool. | -| source | str | Source of the Intrinio data. | -| updated_on | datetime | Date and Time when the data was last updated. | -| security | openbb_intrinio.utils.references.IntrinioSecurity | Security details related to the quote. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| security_type | str | The issuance type of the asset. | -| sector | str | The sector of the asset. | -| industry_category | str | The industry category of the asset. | -| industry_group | str | The industry group of the asset. | -| vwap | float | Volume Weighted Average Price over the period. | -| ma_21 | float | Twenty-one day moving average. | -| ma_50 | float | Fifty day moving average. | -| ma_200 | float | Two-hundred day moving average. | -| volume_avg_10d | int | Ten day average volume. | -| volume_avg_30d | int | Thirty day average volume. | -| volume_avg_50d | int | Fifty day average volume. | -| market_cap | int | Market capitalization. | -| market_cap_all_classes | int | Market capitalization of all share classes. | -| div_amount | float | The most recent dividend amount. | -| div_currency | str | The currency the dividend is paid in. | -| div_yield | float | The dividend yield as a normalized percentage. | -| div_freq | str | The frequency of dividend payments. | -| div_ex_date | date | The ex-dividend date. | -| div_pay_date | date | The next dividend ayment date. | -| div_growth_3y | Union[str, float] | The three year dividend growth as a normalized percentage. | -| div_growth_5y | Union[str, float] | The five year dividend growth as a normalized percentage. | -| pe | Union[str, float] | The price to earnings ratio. | -| eps | Union[str, float] | The earnings per share. | -| debt_to_equity | Union[str, float] | The debt to equity ratio. | -| price_to_book | Union[str, float] | The price to book ratio. | -| price_to_cf | Union[str, float] | The price to cash flow ratio. | -| return_on_equity | Union[str, float] | The return on equity, as a normalized percentage. | -| return_on_assets | Union[str, float] | The return on assets, as a normalized percentage. | -| beta | Union[str, float] | The beta relative to the TSX Composite. | -| alpha | Union[str, float] | The alpha relative to the TSX Composite. | -| shares_outstanding | int | The number of listed shares outstanding. | -| shares_escrow | int | The number of shares held in escrow. | -| shares_total | int | The total number of shares outstanding from all classes. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| last_volume | int | The last trade volume. | -| volume_avg | int | The average daily trading volume. | -| bid_timestamp | datetime | Timestamp of the bid price. | -| ask_timestamp | datetime | Timestamp of the ask price. | -| greeks_timestamp | datetime | Timestamp of the greeks data. | -| underlying | str | The underlying symbol for the option. | -| root_symbol | str | The root symbol for the option. | -| option_type | Literal['call', 'put'] | Type of option - call or put. | -| contract_size | int | The number of shares in a standard contract. | -| expiration_type | str | The expiration type of the option - i.e, standard, weekly, etc. | -| expiration_date | date | The expiration date of the option. | -| strike | float | The strike price of the option. | -| open_interest | int | The number of open contracts for the option. | -| bid_iv | float | Implied volatility of the bid price. | -| ask_iv | float | Implied volatility of the ask price. | -| mid_iv | float | Mid-point implied volatility of the option. | -| orats_final_iv | float | ORATS final implied volatility of the option. | -| delta | float | Delta of the option. | -| gamma | float | Gamma of the option. | -| theta | float | Theta of the option. | -| vega | float | Vega of the option. | -| rho | float | Rho of the option. | -| phi | float | Phi of the option. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| asset_type | str | Type of asset - i.e, stock, ETF, etc. | -| name | str | Name of the company or asset. | -| exchange | str | The name or symbol of the venue where the data is from. | -| bid | float | Price of the top bid order. | -| bid_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| bid_exchange | str | The specific trading venue where the purchase order was placed. | -| ask | float | Price of the top ask order. | -| ask_size | int | This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price. | -| ask_exchange | str | The specific trading venue where the sale order was placed. | -| quote_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the quote. | -| quote_indicators | Union[str, int, List[str], List[int]] | Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO. | -| sales_conditions | Union[str, int, List[str], List[int]] | Conditions or condition codes applicable to the sale. | -| sequence_number | int | 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). | -| market_center | str | The ID of the UTP participant that originated the message. | -| participant_timestamp | datetime | Timestamp for when the quote was generated by the exchange. | -| trf_timestamp | datetime | Timestamp for when the TRF (Trade Reporting Facility) received the message. | -| sip_timestamp | datetime | Timestamp for when the SIP (Security Information Processor) received the message from the exchange. | -| last_price | float | Price of the last trade. | -| last_tick | str | Whether the last sale was an up or down tick. | -| last_size | int | Size of the last trade. | -| last_timestamp | datetime | Date and Time when the last price was recorded. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[int, float] | The trading volume. | -| exchange_volume | Union[int, float] | Volume of shares exchanged during the trading day on the specific exchange. | -| prev_close | float | The previous close price. | -| change | float | Change in price from previous close. | -| change_percent | float | Change in price as a normalized percentage. | -| year_high | float | The one year high (52W High). | -| year_low | float | The one year low (52W Low). | -| ma_50d | float | 50-day moving average price. | -| ma_200d | float | 200-day moving average price. | -| volume_average | float | Average daily trading volume. | -| volume_average_10d | float | Average daily trading volume in the last 10 days. | -| currency | str | Currency of the price. | - - - - diff --git a/website/content/platform/reference/equity/profile.md b/website/content/platform/reference/equity/profile.md deleted file mode 100644 index 0eb7cbd3fa3c..000000000000 --- a/website/content/platform/reference/equity/profile.md +++ /dev/null @@ -1,454 +0,0 @@ ---- -title: "profile" -description: "Get general price and performance metrics of a stock with the Equity Information API. Retrieve data such as the symbol, name, price, open price, high price, low price, close price, change in price, change percent, previous close, type, exchange ID, bid, ask, volume, implied volatility, realized volatility, last trade timestamp, annual high, and annual low." -keywords: -- equity info -- price and performance metrics -- stock data -- equity profile -- symbol -- provider -- data -- parameters -- returns -- cboe -- EquityInfo -- warnings -- chart -- metadata -- Data -- name -- price -- open price -- high price -- low price -- close price -- change percent -- previous close -- type -- exchange ID -- bid -- ask -- volume -- implied volatility -- realized volatility -- last trade timestamp -- annual high -- annual low -- iv30 -- hv30 -- iv60 -- hv60 -- iv90 -- hv90 ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get general information about a company. This includes company name, industry, sector and price data. - - -Examples --------- - -```python -from openbb import obb -obb.equity.profile(symbol='AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityInfo - Serializable results. - provider : Literal['finviz', 'fmp', 'intrinio', 'tmx', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | -| index | str | Included in indices - i.e., Dow, Nasdaq, or S&P. | -| optionable | str | Whether options trade against the ticker. | -| shortable | str | If the asset is shortable. | -| shares_outstanding | str | The number of shares outstanding, as an abbreviated string. | -| shares_float | str | The number of shares in the public float, as an abbreviated string. | -| short_interest | str | The last reported number of shares sold short, as an abbreviated string. | -| institutional_ownership | float | The institutional ownership of the stock, as a normalized percent. | -| market_cap | str | The market capitalization of the stock, as an abbreviated string. | -| dividend_yield | float | The dividend yield of the stock, as a normalized percent. | -| earnings_date | str | The last, or next confirmed, earnings date and announcement time, as a string. The format is Nov 02 AMC - for after market close. | -| beta | float | The beta of the stock relative to the broad market. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | -| is_etf | bool | If the symbol is an ETF. | -| is_actively_trading | bool | If the company is actively trading. | -| is_adr | bool | If the stock is an ADR. | -| is_fund | bool | If the company is a fund. | -| image | str | Image of the company. | -| currency | str | Currency in which the stock is traded. | -| market_cap | int | Market capitalization of the company. | -| last_price | float | The last traded price. | -| year_high | float | The one-year high of the price. | -| year_low | float | The one-year low of the price. | -| volume_avg | int | Average daily trading volume. | -| annualized_dividend_amount | float | The annualized dividend payment based on the most recent regular dividend payment. | -| beta | float | Beta of the stock relative to the market. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | -| id | str | Intrinio ID for the company. | -| thea_enabled | bool | Whether the company has been enabled for Thea. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | -| email | str | The email of the company. | -| issue_type | str | The issuance type of the asset. | -| shares_outstanding | int | The number of listed shares outstanding. | -| shares_escrow | int | The number of shares held in escrow. | -| shares_total | int | The total number of shares outstanding from all classes. | -| dividend_frequency | str | The dividend frequency. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Common name of the company. | -| cik | str | Central Index Key (CIK) for the requested entity. | -| cusip | str | CUSIP identifier for the company. | -| isin | str | International Securities Identification Number. | -| lei | str | Legal Entity Identifier assigned to the company. | -| legal_name | str | Official legal name of the company. | -| stock_exchange | str | Stock exchange where the company is traded. | -| sic | int | Standard Industrial Classification code for the company. | -| short_description | str | Short description of the company. | -| long_description | str | Long description of the company. | -| ceo | str | Chief Executive Officer of the company. | -| company_url | str | URL of the company's website. | -| business_address | str | Address of the company's headquarters. | -| mailing_address | str | Mailing address of the company. | -| business_phone_no | str | Phone number of the company's headquarters. | -| hq_address1 | str | Address of the company's headquarters. | -| hq_address2 | str | Address of the company's headquarters. | -| hq_address_city | str | City of the company's headquarters. | -| hq_address_postal_code | str | Zip code of the company's headquarters. | -| hq_state | str | State of the company's headquarters. | -| hq_country | str | Country of the company's headquarters. | -| inc_state | str | State in which the company is incorporated. | -| inc_country | str | Country in which the company is incorporated. | -| employees | int | Number of employees working for the company. | -| entity_legal_form | str | Legal form of the company. | -| entity_status | str | Status of the company. | -| latest_filing_date | date | Date of the company's latest filing. | -| irs_number | str | IRS number assigned to the company. | -| sector | str | Sector in which the company operates. | -| industry_category | str | Category of industry in which the company operates. | -| industry_group | str | Group of industry in which the company operates. | -| template | str | Template used to standardize the company's financial statements. | -| standardized_active | bool | Whether the company is active or not. | -| first_fundamental_date | date | Date of the company's first fundamental. | -| last_fundamental_date | date | Date of the company's last fundamental. | -| first_stock_price_date | date | Date of the company's first stock price. | -| last_stock_price_date | date | Date of the company's last stock price. | -| exchange_timezone | str | The timezone of the exchange. | -| issue_type | str | The issuance type of the asset. | -| currency | str | The currency in which the asset is traded. | -| market_cap | int | The market capitalization of the asset. | -| shares_outstanding | int | The number of listed shares outstanding. | -| shares_float | int | The number of shares in the public float. | -| shares_implied_outstanding | int | Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common. | -| shares_short | int | The reported number of shares short. | -| dividend_yield | float | The dividend yield of the asset, as a normalized percent. | -| beta | float | The beta of the asset relative to the broad market. | - - - - diff --git a/website/content/platform/reference/equity/screener.md b/website/content/platform/reference/equity/screener.md deleted file mode 100644 index 1e7f4395ba1c..000000000000 --- a/website/content/platform/reference/equity/screener.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: "screener" -description: "Equity Screen" -keywords: -- equity -- screener ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Screen for companies meeting various criteria. These criteria include -market cap, price, beta, volume, and dividend yield. - - -Examples --------- - -```python -from openbb import obb -obb.equity.screener(provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | -| mktcap_min | int | Filter by market cap greater than this value. | None | True | -| mktcap_max | int | Filter by market cap less than this value. | None | True | -| price_min | float | Filter by price greater than this value. | None | True | -| price_max | float | Filter by price less than this value. | None | True | -| beta_min | float | Filter by a beta greater than this value. | None | True | -| beta_max | float | Filter by a beta less than this value. | None | True | -| volume_min | int | Filter by volume greater than this value. | None | True | -| volume_max | int | Filter by volume less than this value. | None | True | -| dividend_min | float | Filter by dividend amount greater than this value. | None | True | -| dividend_max | float | Filter by dividend amount less than this value. | None | True | -| is_etf | bool | If true, returns only ETFs. | False | True | -| is_active | bool | If false, returns only inactive tickers. | True | True | -| sector | Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates'] | Filter by sector. | None | True | -| industry | str | Filter by industry. | None | True | -| country | str | Filter by country, as a two-letter country code. | None | True | -| exchange | Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra'] | Filter by exchange. | None | True | -| limit | int | Limit the number of results to return. | 50000 | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityScreener - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| market_cap | int | The market cap of ticker. | -| sector | str | The sector the ticker belongs to. | -| industry | str | The industry ticker belongs to. | -| beta | float | The beta of the ETF. | -| price | float | The current price. | -| last_annual_dividend | float | The last annual amount dividend paid. | -| volume | int | The current trading volume. | -| exchange | str | The exchange code the asset trades on. | -| exchange_name | str | The full name of the primary exchange. | -| country | str | The two-letter country abbreviation where the head office is located. | -| is_etf | Literal[True, False] | Whether the ticker is an ETF. | -| actively_trading | Literal[True, False] | Whether the ETF is actively trading. | - - - - diff --git a/website/content/platform/reference/equity/search.md b/website/content/platform/reference/equity/search.md deleted file mode 100644 index 42998590f2a2..000000000000 --- a/website/content/platform/reference/equity/search.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -title: "search" -description: "Learn how to perform an equity search to find a company or stock ticker. Understand the query parameters, such as search by ticker symbol and search provider. Explore the various filters available, including market cap, price, beta, volume, dividend, ETF, sector, industry, country, and exchange. Limit and structure the results accordingly. Get access to the returned data, provider information, warnings, chart, and metadata." -keywords: -- equity search -- company search -- stock ticker search -- query parameter -- search by ticker symbol -- search provider -- market cap filter -- price filter -- beta filter -- volume filter -- dividend filter -- ETF filter -- sector filter -- industry filter -- country filter -- exchange filter -- limit results -- data structure -- results -- provider -- warnings -- chart -- metadata -- symbol -- name -- dpm_name -- post_station -- market cap -- sector -- industry -- beta -- price -- last annual dividend -- volume -- exchange -- exchange_name -- country -- is_etf -- actively trading -- cik ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Search for stock symbol, CIK, LEI, or company name. - - -Examples --------- - -```python -from openbb import obb -obb.equity.search(provider='intrinio') -obb.equity.search(query='AAPL', is_symbol=False, use_cache=True, provider='nasdaq') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| active | bool | 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. | True | True | -| limit | int | The number of data entries to return. | 10000 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| is_etf | bool | If True, returns ETFs. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| is_fund | bool | Whether to direct the search to the list of mutual funds and ETFs. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquitySearch - Serializable results. - provider : Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| dpm_name | str | Name of the primary market maker. | -| post_station | str | Post and station location on the CBOE trading floor. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| cik | str | | -| lei | str | The Legal Entity Identifier (LEI) of the company. | -| intrinio_id | str | The Intrinio ID of the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| nasdaq_traded | str | Is Nasdaq traded? | -| exchange | str | Primary Exchange | -| market_category | str | Market Category | -| etf | str | Is ETF? | -| round_lot_size | float | Round Lot Size | -| test_issue | str | Is test Issue? | -| financial_status | str | Financial Status | -| cqs_symbol | str | CQS Symbol | -| nasdaq_symbol | str | NASDAQ Symbol | -| next_shares | str | Is NextShares? | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| cik | str | Central Index Key | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| exchange | str | Exchange where the security is listed. | -| security_type | Literal['stock', 'option', 'etf', 'index', 'mutual_fund'] | Type of security. | - - - - diff --git a/website/content/platform/reference/equity/shorts/_category_.json b/website/content/platform/reference/equity/shorts/_category_.json deleted file mode 100644 index c464edf3aa83..000000000000 --- a/website/content/platform/reference/equity/shorts/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Shorts", - "position": 8 -} \ No newline at end of file diff --git a/website/content/platform/reference/equity/shorts/fails_to_deliver.md b/website/content/platform/reference/equity/shorts/fails_to_deliver.md deleted file mode 100644 index 8bd7fc7fb051..000000000000 --- a/website/content/platform/reference/equity/shorts/fails_to_deliver.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: "fails_to_deliver" -description: "Learn how to retrieve reported Fail-to-deliver (FTD) data using the OBB.equity.shorts.fails_to_deliver function in Python. Explore the available parameters for symbol selection and provider options. Understand the data returned, including settlement date, symbol, quantity of fails, and more." -keywords: -- Fail-to-deliver data -- Fail-to-deliver reporting -- Equity FTD -- Symbol data -- Provider selection -- Limiting number of reports -- Skipping reports -- Settlement date -- CUSIP -- Quantity of fails -- Previous closing price ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get reported Fail-to-deliver (FTD) data. - - -Examples --------- - -```python -from openbb import obb -obb.equity.shorts.fails_to_deliver(symbol='AAPL', provider='sec') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | -| limit | int | Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009. | 24 | True | -| skip_reports | int | Skip N number of reports from current. A value of 1 will skip the most recent report. | 0 | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityFTD - Serializable results. - provider : Literal['sec'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| settlement_date | date | The settlement date of the fail. | -| symbol | str | Symbol representing the entity requested in the data. | -| cusip | str | CUSIP of the Security. | -| quantity | int | The number of fails on that settlement date. | -| price | float | The price at the previous closing price from the settlement date. | -| description | str | The description of the Security. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| settlement_date | date | The settlement date of the fail. | -| symbol | str | Symbol representing the entity requested in the data. | -| cusip | str | CUSIP of the Security. | -| quantity | int | The number of fails on that settlement date. | -| price | float | The price at the previous closing price from the settlement date. | -| description | str | The description of the Security. | - - - - diff --git a/website/content/platform/reference/equity/shorts/index.mdx b/website/content/platform/reference/equity/shorts/index.mdx deleted file mode 100644 index 583b9a4cc76c..000000000000 --- a/website/content/platform/reference/equity/shorts/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ -# Shorts - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - -
- diff --git a/website/content/platform/reference/equity/shorts/short_interest.md b/website/content/platform/reference/equity/shorts/short_interest.md deleted file mode 100644 index 9a5c79d25807..000000000000 --- a/website/content/platform/reference/equity/shorts/short_interest.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "short_interest" -description: "Learn how to get reported Short Volume and Days to Cover data using the OBB.equity.shorts.short_interest function in Python. This page provides information on the parameters, returns, and available data fields such as settlement date, symbol, issue name, market class, current short position, previous short position, average daily volume, days to cover, change, and change percentage." -keywords: -- Get reported Short Volume and Days to Cover data -- OBB.equity.shorts.short_interest -- symbol -- provider -- Short Volume -- Days to Cover -- data -- parameters -- returns -- data -- settlement_date -- symbol -- issue_name -- market_class -- current_short_position -- previous_short_position -- avg_daily_volume -- days_to_cover -- change -- change_pct ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get reported short volume and days to cover data. - - -Examples --------- - -```python -from openbb import obb -obb.equity.shorts.short_interest(symbol='AAPL', provider='finra') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['finra'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default. | finra | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['finra'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finra' if there is no default. | finra | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EquityShortInterest - Serializable results. - provider : Literal['finra'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| settlement_date | date | The mid-month short interest report is based on short positions held by members on the settlement date of the 15th of each month. If the 15th falls on a weekend or another non-settlement date, the designated settlement date will be the previous business day on which transactions settled. The end-of-month short interest report is based on short positions held on the last business day of the month on which transactions settle. Once the short position reports are received, the short interest data is compiled for each equity security and provided for publication on the 7th business day after the reporting settlement date. | -| symbol | str | Symbol representing the entity requested in the data. | -| issue_name | str | Unique identifier of the issue. | -| market_class | str | Primary listing market. | -| current_short_position | float | The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the current cycle’s designated settlement date. | -| previous_short_position | float | The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the previous cycle’s designated settlement date. | -| avg_daily_volume | float | Total Volume or Adjusted Volume in case of splits / Total trade days between (previous settlement date + 1) to (current settlement date). The NULL values are translated as zero. | -| days_to_cover | float | The number of days of average share volume it would require to buy all of the shares that were sold short during the reporting cycle. Formula: Short Interest / Average Daily Share Volume, Rounded to Hundredths. 1.00 will be displayed for any values equal or less than 1 (i.e., Average Daily Share is equal to or greater than Short Interest). N/A will be displayed If the days to cover is Zero (i.e., Average Daily Share Volume is Zero). | -| change | float | Change in Shares Short from Previous Cycle: Difference in short interest between the current cycle and the previous cycle. | -| change_pct | float | Change in Shares Short from Previous Cycle as a percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| settlement_date | date | The mid-month short interest report is based on short positions held by members on the settlement date of the 15th of each month. If the 15th falls on a weekend or another non-settlement date, the designated settlement date will be the previous business day on which transactions settled. The end-of-month short interest report is based on short positions held on the last business day of the month on which transactions settle. Once the short position reports are received, the short interest data is compiled for each equity security and provided for publication on the 7th business day after the reporting settlement date. | -| symbol | str | Symbol representing the entity requested in the data. | -| issue_name | str | Unique identifier of the issue. | -| market_class | str | Primary listing market. | -| current_short_position | float | The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the current cycle’s designated settlement date. | -| previous_short_position | float | The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the previous cycle’s designated settlement date. | -| avg_daily_volume | float | Total Volume or Adjusted Volume in case of splits / Total trade days between (previous settlement date + 1) to (current settlement date). The NULL values are translated as zero. | -| days_to_cover | float | The number of days of average share volume it would require to buy all of the shares that were sold short during the reporting cycle. Formula: Short Interest / Average Daily Share Volume, Rounded to Hundredths. 1.00 will be displayed for any values equal or less than 1 (i.e., Average Daily Share is equal to or greater than Short Interest). N/A will be displayed If the days to cover is Zero (i.e., Average Daily Share Volume is Zero). | -| change | float | Change in Shares Short from Previous Cycle: Difference in short interest between the current cycle and the previous cycle. | -| change_pct | float | Change in Shares Short from Previous Cycle as a percent. | - - - - diff --git a/website/content/platform/reference/equity/shorts/short_volume.md b/website/content/platform/reference/equity/shorts/short_volume.md deleted file mode 100644 index 168f19be04d3..000000000000 --- a/website/content/platform/reference/equity/shorts/short_volume.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: "short_volume" -description: "This documentation page provides information and usage instructions on retrieving Fail-to-deliver (FTD) data using the Python library. Learn how to use the `obb.equity.shorts.short_volume` function to fetch FTD data, including parameters, return values, and data details such as date, market, volume, and more. The page also covers the stockgrid provider, chart object, and metadata information about the command execution." -keywords: -- Fail-to-deliver data -- FTD data -- Python library -- equity shorts -- short volume -- stockgrid provider -- data parameters -- data returns -- chart object -- metadata -- data -- date -- market -- short volume -- short exempt volume -- total volume -- close price -- short volume percentage ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get reported Fail-to-deliver (FTD) data. - - -Examples --------- - -```python -from openbb import obb -obb.equity.shorts.short_volume(symbol='AAPL', provider='stockgrid') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['stockgrid'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'stockgrid' if there is no default. | stockgrid | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['stockgrid'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'stockgrid' if there is no default. | stockgrid | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : ShortVolume - Serializable results. - provider : Literal['stockgrid'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| market | str | Reporting Facility ID. N=NYSE TRF, Q=NASDAQ TRF Carteret, B=NASDAQ TRY Chicago, D=FINRA ADF | -| short_volume | int | Aggregate reported share volume of executed short sale and short sale exempt trades during regular trading hours | -| short_exempt_volume | int | Aggregate reported share volume of executed short sale exempt trades during regular trading hours | -| total_volume | int | Aggregate reported share volume of executed trades during regular trading hours | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| market | str | Reporting Facility ID. N=NYSE TRF, Q=NASDAQ TRF Carteret, B=NASDAQ TRY Chicago, D=FINRA ADF | -| short_volume | int | Aggregate reported share volume of executed short sale and short sale exempt trades during regular trading hours | -| short_exempt_volume | int | Aggregate reported share volume of executed short sale exempt trades during regular trading hours | -| total_volume | int | Aggregate reported share volume of executed trades during regular trading hours | -| close | float | Closing price of the stock on the date. | -| short_volume_percent | float | Percentage of the total volume that was short volume. | - - - - diff --git a/website/content/platform/reference/etf/_category_.json b/website/content/platform/reference/etf/_category_.json deleted file mode 100644 index 22e300b671ee..000000000000 --- a/website/content/platform/reference/etf/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Etf", - "position": 11 -} \ No newline at end of file diff --git a/website/content/platform/reference/etf/countries.md b/website/content/platform/reference/etf/countries.md deleted file mode 100644 index 20c730f6303b..000000000000 --- a/website/content/platform/reference/etf/countries.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: "countries" -description: "Learn about ETF country weighting and how to retrieve country exposure data using obb.etf.countries API endpoint." -keywords: -- ETF country weighting -- obb.etf.countries -- symbol -- provider -- etf -- data -- results -- chart -- metadata -- country exposure ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -ETF Country weighting. - - -Examples --------- - -```python -from openbb import obb -obb.etf.countries(symbol='VT', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, tmx. | | False | -| provider | Literal['fmp', 'tmx'] | 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. (ETF) Multiple items allowed for provider(s): fmp, tmx. | | False | -| provider | Literal['fmp', 'tmx'] | 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. (ETF) Multiple items allowed for provider(s): fmp, tmx. | | False | -| provider | Literal['fmp', 'tmx'] | 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 | -| use_cache | bool | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. | True | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EtfCountries - Serializable results. - provider : Literal['fmp', 'tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| country | str | The country of the exposure. Corresponding values are normalized percentage points. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| country | str | The country of the exposure. Corresponding values are normalized percentage points. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| country | str | The country of the exposure. Corresponding values are normalized percentage points. | - - - - diff --git a/website/content/platform/reference/etf/discovery/_category_.json b/website/content/platform/reference/etf/discovery/_category_.json deleted file mode 100644 index e9fd866ea48c..000000000000 --- a/website/content/platform/reference/etf/discovery/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Discovery", - "position": 1 -} \ No newline at end of file diff --git a/website/content/platform/reference/etf/discovery/active.md b/website/content/platform/reference/etf/discovery/active.md deleted file mode 100644 index aadf7d90baaf..000000000000 --- a/website/content/platform/reference/etf/discovery/active.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -title: "active" -description: "Learn how to get the most active ETFs using the ETF discovery API. This page provides documentation for the parameters, returns, and data associated with the API endpoint. Understand how to use the sorting, limiting, and provider parameters and explore the returned results, chart object, and metadata. Find details about the data fields including symbol, name, last price, percent change, net change, volume, date, country, mantissa, type, and formatted values. Retrieve the source url for additional information." -keywords: -- ETFs -- most active ETFs -- ETF discovery -- sort order -- limit parameter -- provider parameter -- results -- chart object -- metadata -- symbol -- name -- last price -- percent change -- net change -- volume -- date -- country -- mantissa -- type -- formatted price -- formatted volume -- formatted price change -- formatted percent change -- url ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the most active ETFs. - - -Examples --------- - -```python -from openbb import obb -# Get the most active ETFs. -obb.etf.discovery.active(provider='wsj') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : ETFActive - Serializable results. - provider : Literal['wsj'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | -| country | str | Country of the entity. | -| mantissa | int | Mantissa. | -| type | str | Type of the entity. | -| formatted_price | str | Formatted price. | -| formatted_volume | str | Formatted volume. | -| formatted_price_change | str | Formatted price change. | -| formatted_percent_change | str | Formatted percent change. | -| url | str | The source url. | - - - - diff --git a/website/content/platform/reference/etf/discovery/gainers.md b/website/content/platform/reference/etf/discovery/gainers.md deleted file mode 100644 index f8e35ffd0cd7..000000000000 --- a/website/content/platform/reference/etf/discovery/gainers.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -title: "gainers" -description: "Learn how to get the top ETF gainers using Python code. This documentation includes details about the parameters, return values, and data format." -keywords: -- ETF gainers -- ETFGainers -- Python code -- parameters -- sort order -- limit -- provider -- returns -- results -- warnings -- chart -- metadata -- data -- symbol -- name -- last price -- percent change -- net change -- trading volume -- date -- bluegrass channel -- country -- mantissa -- type -- formatted price -- formatted volume -- formatted price change -- formatted percent change -- url ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the top ETF gainers. - - -Examples --------- - -```python -from openbb import obb -# Get the top ETF gainers. -obb.etf.discovery.gainers(provider='wsj') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : ETFGainers - Serializable results. - provider : Literal['wsj'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | -| bluegrass_channel | str | Bluegrass channel. | -| country | str | Country of the entity. | -| mantissa | int | Mantissa. | -| type | str | Type of the entity. | -| formatted_price | str | Formatted price. | -| formatted_volume | str | Formatted volume. | -| formatted_price_change | str | Formatted price change. | -| formatted_percent_change | str | Formatted percent change. | -| url | str | The source url. | - - - - diff --git a/website/content/platform/reference/etf/discovery/index.mdx b/website/content/platform/reference/etf/discovery/index.mdx deleted file mode 100644 index f013b12edc69..000000000000 --- a/website/content/platform/reference/etf/discovery/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ -# Discovery - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - -
- diff --git a/website/content/platform/reference/etf/discovery/losers.md b/website/content/platform/reference/etf/discovery/losers.md deleted file mode 100644 index 44ec1fd0d55a..000000000000 --- a/website/content/platform/reference/etf/discovery/losers.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -title: "losers" -description: "Learn how to get the top ETF losers using the OBB ETF Discovery API endpoint. Explore the available parameters and the returned data, including symbols, names, prices, percentage changes, and trading volumes." -keywords: -- ETF losers -- top ETF losers -- ETFLosers -- sort order -- data entries -- provider -- warnings -- chart -- metadata -- symbol -- name -- last price -- percent change -- net change -- trading volume -- date -- bluegrass channel -- country -- mantissa -- type -- formatted price -- formatted volume -- formatted price change -- formatted percent change -- source url ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the top ETF losers. - - -Examples --------- - -```python -from openbb import obb -# Get the top ETF losers. -obb.etf.discovery.losers(provider='wsj') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True | -| limit | int | The number of data entries to return. | 10 | True | -| provider | Literal['wsj'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. | wsj | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : ETFLosers - Serializable results. - provider : Literal['wsj'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the entity. | -| last_price | float | Last price. | -| percent_change | float | Percent change. | -| net_change | float | Net change. | -| volume | float | The trading volume. | -| date | date | The date of the data. | -| bluegrass_channel | str | Bluegrass channel. | -| country | str | Country of the entity. | -| mantissa | int | Mantissa. | -| type | str | Type of the entity. | -| formatted_price | str | Formatted price. | -| formatted_volume | str | Formatted volume. | -| formatted_price_change | str | Formatted price change. | -| formatted_percent_change | str | Formatted percent change. | -| url | str | The source url. | - - - - diff --git a/website/content/platform/reference/etf/equity_exposure.md b/website/content/platform/reference/etf/equity_exposure.md deleted file mode 100644 index 3efae33b519d..000000000000 --- a/website/content/platform/reference/etf/equity_exposure.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: "equity_exposure" -description: "Get the exposure to ETFs for a specific stock" -keywords: -- etf -- equity_exposure ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the exposure to ETFs for a specific stock. - - -Examples --------- - -```python -from openbb import obb -obb.etf.equity_exposure(symbol='MSFT', provider='fmp') -# This function accepts multiple tickers. -obb.etf.equity_exposure(symbol='MSFT,AAPL', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp. | | False | -| 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EtfEquityExposure - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| equity_symbol | str | The symbol of the equity requested. | -| etf_symbol | str | The symbol of the ETF with exposure to the requested equity. | -| shares | int | The number of shares held in the ETF. | -| weight | float | The weight of the equity in the ETF, as a normalized percent. | -| market_value | Union[int, float] | The market value of the equity position in the ETF. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| equity_symbol | str | The symbol of the equity requested. | -| etf_symbol | str | The symbol of the ETF with exposure to the requested equity. | -| shares | int | The number of shares held in the ETF. | -| weight | float | The weight of the equity in the ETF, as a normalized percent. | -| market_value | Union[int, float] | The market value of the equity position in the ETF. | - - - - diff --git a/website/content/platform/reference/etf/historical.md b/website/content/platform/reference/etf/historical.md deleted file mode 100644 index bb839a1d8bd6..000000000000 --- a/website/content/platform/reference/etf/historical.md +++ /dev/null @@ -1,380 +0,0 @@ ---- -title: "historical" -description: "Learn how to access historical market price data for ETFs with the OBB.etf.historical() method. This method allows you to retrieve data such as the opening, high, low, and closing prices, as well as the trading volume and adjusted closing price for a specific ETF symbol during a given time period." -keywords: -- ETF Historical Market Price -- ETF historical data -- ETF symbol -- start date -- end date -- provider -- query results -- chart object -- metadata -- data -- open price -- high price -- low price -- close price -- volume -- adjusted close price ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -ETF Historical Market Price. - - -Examples --------- - -```python -from openbb import obb -obb.etf.historical(symbol='SPY', provider='fmp') -obb.etf.historical(symbol='SPY', provider='yfinance') -# This function accepts multiple tickers. -obb.etf.historical(symbol='SPY,IWM,QQQ,DJIA', provider='yfinance') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'splits_and_dividends', 'unadjusted'] | The adjustment factor to apply. 'splits_only' is not supported for intraday data. | splits_only | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| adjusted | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| use_cache | bool | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| start_time | datetime.time | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. | None | True | -| end_time | datetime.time | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. | None | True | -| timezone | str | Timezone of the data, in the IANA format (Continent/City). | America/New_York | True | -| source | Literal['realtime', 'delayed', 'nasdaq_basic'] | The source of the data. | realtime | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'unadjusted'] | The adjustment factor to apply. Default is splits only. | splits_only | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| adjustment | Literal['splits_only', 'splits_and_dividends', 'unadjusted'] | The adjustment factor to apply. Only valid for daily data. | splits_only | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): alpha_vantage, cboe, fmp, polygon, tiingo, tmx, tradier, yfinance. | | False | -| interval | str | Time interval of the data to return. | 1d | True | -| 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['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'alpha_vantage' if there is no default. | alpha_vantage | True | -| extended_hours | bool | Include Pre and Post market data. | False | True | -| include_actions | bool | Include dividends and stock splits in results. | True | True | -| adjustment | Literal['splits_only', 'splits_and_dividends'] | The adjustment factor to apply. Default is splits only. | splits_only | True | -| adjusted | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead. | False | True | -| prepost | bool | This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead. | False | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EtfHistorical - Serializable results. - provider : Literal['alpha_vantage', 'cboe', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'tradier', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_close | float, Gt(gt=0) | The adjusted close price. | -| dividend | float, Ge(ge=0) | Dividend amount, if a dividend was paid. | -| split_ratio | float, Ge(ge=0) | Split coefficient, if a split occurred. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| calls_volume | int | Number of calls traded during the most recent trading period. Only valid if interval is 1m. | -| puts_volume | int | Number of puts traded during the most recent trading period. Only valid if interval is 1m. | -| total_options_volume | int | Total number of options traded during the most recent trading period. Only valid if interval is 1m. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_close | float | The adjusted close price. | -| unadjusted_volume | float | Unadjusted volume of the symbol. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| average | float | Average trade price of an individual equity during the interval. | -| change | float | Change in the price of the symbol from the previous day. | -| change_percent | float | Percent change in the price of the symbol from the previous day. | -| adj_open | float | The adjusted open price. | -| adj_high | float | The adjusted high price. | -| adj_low | float | The adjusted low price. | -| adj_close | float | The adjusted close price. | -| adj_volume | float | The adjusted volume. | -| fifty_two_week_high | float | 52 week high price for the symbol. | -| fifty_two_week_low | float | 52 week low price for the symbol. | -| factor | float | factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount, if a dividend was paid. | -| close_time | datetime | The timestamp that represents the end of the interval span. | -| interval | str | The data time frequency. | -| intra_period | bool | 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 | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| adj_open | float | The adjusted open price. | -| adj_high | float | The adjusted high price. | -| adj_low | float | The adjusted low price. | -| adj_close | float | The adjusted close price. | -| adj_volume | float | The adjusted volume. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount, if a dividend was paid. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| change | float | Change in price. | -| change_percent | float | Change in price, as a normalized percentage. | -| transactions | int | Total number of transactions recorded. | -| transactions_value | float | Nominal value of recorded transactions. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| last_price | float | The last price of the equity. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | Union[float, int] | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| split_ratio | float | Ratio of the equity split, if a split occurred. | -| dividend | float | Dividend amount (split-adjusted), if a dividend was paid. | - - - - diff --git a/website/content/platform/reference/etf/holdings.md b/website/content/platform/reference/etf/holdings.md deleted file mode 100644 index 59defdb2e1af..000000000000 --- a/website/content/platform/reference/etf/holdings.md +++ /dev/null @@ -1,271 +0,0 @@ ---- -title: "holdings" -description: "Learn how to get the holdings data for an individual ETF using the `obb.etf.holdings` method. Understand the parameters like symbol, provider, date, and CIK. Explore the returns, results, warnings, chart, and metadata. Dive into the data fields like symbol, name, LEI, title, CUSIP, ISIN, balance, units, currency, value, weight, payoff profile, asset category, issuer category, country, and more." -keywords: -- ETF holdings -- individual ETF holdings -- holdings data for ETF -- symbol -- provider -- date -- CIK -- returns -- results -- warnings -- chart -- metadata -- data -- name -- LEI -- title -- CUSIP -- ISIN -- balance -- units -- currency -- value -- weight -- payoff profile -- asset category -- issuer category -- country -- is restricted -- fair value level -- is cash collateral -- is non-cash collateral -- is loan by fund -- acceptance datetime ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the holdings for an individual ETF. - - -Examples --------- - -```python -from openbb import obb -obb.etf.holdings(symbol='XLK', provider='fmp') -# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings. -obb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp') -# The same data can be returned from the SEC directly. -obb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'sec', 'tmx'] | 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 | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'sec', 'tmx'] | 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 | -| date | Union[Union[str, date], str] | 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. | None | True | -| cik | str | The CIK of the filing entity. Overrides symbol. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'sec', 'tmx'] | 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 | -| date | Union[Union[str, date], str] | A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. | None | True | -| use_cache | bool | Whether or not to use cache for the request. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'sec', 'tmx'] | 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 | -| use_cache | bool | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. | True | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EtfHoldings - Serializable results. - provider : Literal['fmp', 'sec', 'tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF holding. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF holding. | -| lei | str | The LEI of the holding. | -| title | str | The title of the holding. | -| cusip | str | The CUSIP of the holding. | -| isin | str | The ISIN of the holding. | -| balance | int | The balance of the holding, in shares or units. | -| units | Union[str, float] | The type of units. | -| currency | str | The currency of the holding. | -| value | float | The value of the holding, in dollars. | -| weight | float | The weight of the holding, as a normalized percent. | -| payoff_profile | str | The payoff profile of the holding. | -| asset_category | str | The asset category of the holding. | -| issuer_category | str | The issuer category of the holding. | -| country | str | The country of the holding. | -| is_restricted | str | Whether the holding is restricted. | -| fair_value_level | int | The fair value level of the holding. | -| is_cash_collateral | str | Whether the holding is cash collateral. | -| is_non_cash_collateral | str | Whether the holding is non-cash collateral. | -| is_loan_by_fund | str | Whether the holding is loan by fund. | -| cik | str | The CIK of the filing. | -| acceptance_datetime | str | The acceptance datetime of the filing. | -| updated | Union[date, datetime] | The date the data was updated. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF holding. | -| lei | str | The LEI of the holding. | -| cusip | str | The CUSIP of the holding. | -| isin | str | The ISIN of the holding. | -| other_id | str | Internal identifier for the holding. | -| balance | float | The balance of the holding. | -| weight | float | The weight of the holding in ETF in %. | -| value | float | The value of the holding in USD. | -| payoff_profile | str | The payoff profile of the holding. | -| units | Union[str, float] | The units of the holding. | -| currency | str | The currency of the holding. | -| asset_category | str | The asset category of the holding. | -| issuer_category | str | The issuer category of the holding. | -| country | str | The country of the holding. | -| is_restricted | str | Whether the holding is restricted. | -| fair_value_level | int | The fair value level of the holding. | -| is_cash_collateral | str | Whether the holding is cash collateral. | -| is_non_cash_collateral | str | Whether the holding is non-cash collateral. | -| is_loan_by_fund | str | Whether the holding is loan by fund. | -| loan_value | float | The loan value of the holding. | -| issuer_conditional | str | The issuer conditions of the holding. | -| asset_conditional | str | The asset conditions of the holding. | -| maturity_date | date | The maturity date of the debt security. | -| coupon_kind | str | The type of coupon for the debt security. | -| rate_type | str | The type of rate for the debt security, floating or fixed. | -| annualized_return | float | The annualized return on the debt security. | -| is_default | str | If the debt security is defaulted. | -| in_arrears | str | If the debt security is in arrears. | -| is_paid_kind | str | If the debt security payments are paid in kind. | -| derivative_category | str | The derivative category of the holding. | -| counterparty | str | The counterparty of the derivative. | -| underlying_name | str | The name of the underlying asset associated with the derivative. | -| option_type | str | The type of option. | -| derivative_payoff | str | The payoff profile of the derivative. | -| expiry_date | date | The expiry or termination date of the derivative. | -| exercise_price | float | The exercise price of the option. | -| exercise_currency | str | The currency of the option exercise price. | -| shares_per_contract | float | The number of shares per contract. | -| delta | Union[str, float] | The delta of the option. | -| rate_type_rec | str | The type of rate for reveivable portion of the swap. | -| receive_currency | str | The receive currency of the swap. | -| upfront_receive | float | The upfront amount received of the swap. | -| floating_rate_index_rec | str | The floating rate index for reveivable portion of the swap. | -| floating_rate_spread_rec | float | The floating rate spread for reveivable portion of the swap. | -| rate_tenor_rec | str | The rate tenor for reveivable portion of the swap. | -| rate_tenor_unit_rec | Union[int, str] | The rate tenor unit for reveivable portion of the swap. | -| reset_date_rec | str | The reset date for reveivable portion of the swap. | -| reset_date_unit_rec | Union[int, str] | The reset date unit for reveivable portion of the swap. | -| rate_type_pmnt | str | The type of rate for payment portion of the swap. | -| payment_currency | str | The payment currency of the swap. | -| upfront_payment | float | The upfront amount received of the swap. | -| floating_rate_index_pmnt | str | The floating rate index for payment portion of the swap. | -| floating_rate_spread_pmnt | float | The floating rate spread for payment portion of the swap. | -| rate_tenor_pmnt | str | The rate tenor for payment portion of the swap. | -| rate_tenor_unit_pmnt | Union[int, str] | The rate tenor unit for payment portion of the swap. | -| reset_date_pmnt | str | The reset date for payment portion of the swap. | -| reset_date_unit_pmnt | Union[int, str] | The reset date unit for payment portion of the swap. | -| repo_type | str | The type of repo. | -| is_cleared | str | If the repo is cleared. | -| is_tri_party | str | If the repo is tri party. | -| principal_amount | float | The principal amount of the repo. | -| principal_currency | str | The currency of the principal amount. | -| collateral_type | str | The collateral type of the repo. | -| collateral_amount | float | The collateral amount of the repo. | -| collateral_currency | str | The currency of the collateral amount. | -| exchange_currency | str | The currency of the exchange rate. | -| exchange_rate | float | The exchange rate. | -| currency_sold | str | The currency sold in a Forward Derivative. | -| currency_amount_sold | float | The amount of currency sold in a Forward Derivative. | -| currency_bought | str | The currency bought in a Forward Derivative. | -| currency_amount_bought | float | The amount of currency bought in a Forward Derivative. | -| notional_amount | float | The notional amount of the derivative. | -| notional_currency | str | The currency of the derivative's notional amount. | -| unrealized_gain | float | The unrealized gain or loss on the derivative. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF holding. | -| weight | float | The weight of the asset in the portfolio, as a normalized percentage. | -| shares | Union[int, str] | The value of the assets under management. | -| market_value | Union[str, float] | The market value of the holding. | -| currency | str | The currency of the holding. | -| share_percentage | float | The share percentage of the holding, as a normalized percentage. | -| share_change | Union[str, float] | The change in shares of the holding. | -| country | str | The country of the holding. | -| exchange | str | The exchange code of the holding. | -| type_id | str | The holding type ID of the asset. | -| fund_id | str | The fund ID of the asset. | - - - - diff --git a/website/content/platform/reference/etf/holdings_date.md b/website/content/platform/reference/etf/holdings_date.md deleted file mode 100644 index 89521e9d7530..000000000000 --- a/website/content/platform/reference/etf/holdings_date.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: "holdings_date" -description: "Learn how to retrieve the holdings filing date for an individual ETF using the OBB.etf.holdings_date API. Explore the available parameters, such as symbol and provider, and understand the returned results like results list, chart object, and metadata info." -keywords: -- ETF holdings filing date -- get ETF holdings filing date -- ETF holdings date API -- symbol parameter -- provider parameter -- fmp provider -- cik parameter -- returns -- results -- warnings -- chart object -- metadata info -- data parameter -- date field ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Use this function to get the holdings dates, if available. - - -Examples --------- - -```python -from openbb import obb -obb.etf.holdings_date(symbol='XLK', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| 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 | -| cik | str | The CIK of the filing entity. Overrides symbol. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EtfHoldingsDate - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - diff --git a/website/content/platform/reference/etf/holdings_performance.md b/website/content/platform/reference/etf/holdings_performance.md deleted file mode 100644 index 2c14e8e55190..000000000000 --- a/website/content/platform/reference/etf/holdings_performance.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: "holdings_performance" -description: "Get the ETF holdings performance using the `obb.etf.holdings_performance` function in Python. This function returns a variety of performance metrics for ETF holdings, including one-day return, week-to-date return, one-week return, month-to-date return, and more. Analyze and chart the performance of ETF holdings with this comprehensive function." -keywords: -- ETF holdings performance -- etf holdings performance python -- etf holdings performance function -- etf performance data -- etf returns -- etf performance metrics -- etf performance analysis -- etf performance statistics -- etf performance calculation -- etf performance chart ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the recent price performance of each ticker held in the ETF. - - -Examples --------- - -```python -from openbb import obb -obb.etf.holdings_performance(symbol='XLK', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| 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 | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EtfHoldingsPerformance - Serializable results. - provider : Literal['fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | -| symbol | str | The ticker symbol. | - - - - diff --git a/website/content/platform/reference/etf/index.mdx b/website/content/platform/reference/etf/index.mdx deleted file mode 100644 index db6462504240..000000000000 --- a/website/content/platform/reference/etf/index.mdx +++ /dev/null @@ -1,23 +0,0 @@ -# Etf - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Menus -
    - -
- -### Commands -
    - - - - - - - - - - -
- diff --git a/website/content/platform/reference/etf/info.md b/website/content/platform/reference/etf/info.md deleted file mode 100644 index cf94282e00d9..000000000000 --- a/website/content/platform/reference/etf/info.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -title: "info" -description: "Get an overview of ETF information using the `obb.etf.info` function. Learn about the available parameters, returns, and data fields like name, inception date, asset class, assets under management, average trading volume, CUSIP, description, domicile, expense ratio, ISIN, net asset value, website link, and holdings count." -keywords: -- ETF Information Overview -- obb.etf.info -- parameters -- symbol -- provider -- returns -- data -- name -- inception date -- asset class -- assets under management -- average trading volume -- CUSIP -- description -- domicile -- expense ratio -- ISIN -- net asset value -- website link -- holdings count ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -ETF Information Overview. - - -Examples --------- - -```python -from openbb import obb -obb.etf.info(symbol='SPY', provider='fmp') -# This function accepts multiple tickers. -obb.etf.info(symbol='SPY,IWM,QQQ,DJIA', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['fmp', 'intrinio', 'tmx', '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. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['fmp', 'intrinio', 'tmx', '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. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['fmp', 'intrinio', 'tmx', '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. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['fmp', 'intrinio', 'tmx', '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 | -| use_cache | bool | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance. | | False | -| provider | Literal['fmp', 'intrinio', 'tmx', '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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EtfInfo - Serializable results. - provider : Literal['fmp', 'intrinio', 'tmx', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF. | -| description | str | Description of the fund. | -| inception_date | str | Inception date of the ETF. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF. | -| description | str | Description of the fund. | -| inception_date | str | Inception date of the ETF. | -| issuer | str | Company of the ETF. | -| cusip | str | CUSIP of the ETF. | -| isin | str | ISIN of the ETF. | -| domicile | str | Domicile of the ETF. | -| asset_class | str | Asset class of the ETF. | -| aum | float | Assets under management. | -| nav | float | Net asset value of the ETF. | -| nav_currency | str | Currency of the ETF's net asset value. | -| expense_ratio | float | The expense ratio, as a normalized percent. | -| holdings_count | int | Number of holdings. | -| avg_volume | float | Average daily trading volume. | -| website | str | Website of the issuer. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF. | -| description | str | Description of the fund. | -| inception_date | str | Inception date of the ETF. | -| fund_listing_date | date | The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange. | -| data_change_date | date | The last date on which there was a change in a classifications data field for this ETF. | -| etn_maturity_date | date | If the product is an ETN, this field identifies the maturity date for the ETN. | -| is_listed | bool | If true, the ETF is still listed on an exchange. | -| close_date | date | The date on which the ETF was de-listed if it is no longer listed. | -| exchange | str | The exchange Market Identifier Code (MIC). | -| isin | str | International Securities Identification Number (ISIN). | -| ric | str | Reuters Instrument Code (RIC). | -| sedol | str | Stock Exchange Daily Official List (SEDOL). | -| figi_symbol | str | Financial Instrument Global Identifier (FIGI) symbol. | -| share_class_figi | str | Financial Instrument Global Identifier (FIGI). | -| firstbridge_id | str | The FirstBridge unique identifier for the Exchange Traded Fund (ETF). | -| firstbridge_parent_id | str | The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable. | -| intrinio_id | str | Intrinio unique identifier for the security. | -| intraday_nav_symbol | str | Intraday Net Asset Value (NAV) symbol. | -| primary_symbol | str | The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes. | -| etp_structure_type | str | Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure. | -| legal_structure | str | Legal structure of the fund. | -| issuer | str | Issuer of the ETF. | -| etn_issuing_bank | str | If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank. | -| fund_family | str | This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor. | -| investment_style | str | Investment style of the ETF. | -| derivatives_based | str | This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio. | -| income_category | str | Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income | -| asset_class | str | Captures the underlying nature of the securities in the Exchanged Traded Product (ETP). | -| other_asset_types | str | If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets. | -| single_category_designation | str | This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market. | -| beta_type | str | This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately. | -| beta_details | str | This field provides further detail within the traditional and smart beta categories. | -| market_cap_range | str | Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.) | -| market_cap_weighting_type | str | For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type. | -| index_weighting_scheme | str | For ETFs that track an underlying index, this field provides detail on the index weighting type. | -| index_linked | str | This field identifies whether an ETF is index linked or active. | -| index_name | str | This field identifies the name of the underlying index tracked by the ETF, if applicable. | -| index_symbol | str | This field identifies the OpenFIGI ticker for the Index underlying the ETF. | -| parent_index | str | This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable. | -| index_family | str | This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider. | -| broader_index_family | str | This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider. | -| index_provider | str | This field identifies the Index provider for the index underlying the ETF, if applicable. | -| index_provider_code | str | This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable. | -| replication_structure | str | The replication structure of the Exchange Traded Product (ETP). | -| growth_value_tilt | str | Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'. | -| growth_type | str | For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores. | -| value_type | str | For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores. | -| sector | str | For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to. | -| industry | str | For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to. | -| industry_group | str | For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to. | -| cross_sector_theme | str | For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.) | -| natural_resources_type | str | For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure. | -| us_or_excludes_us | str | Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US. | -| developed_emerging | str | This field identifies the stage of development of the markets that the ETF provides exposure to. | -| specialized_region | str | This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.) | -| continent | str | This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent. | -| latin_america_sub_group | str | For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure. | -| europe_sub_group | str | For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure. | -| asia_sub_group | str | For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure. | -| specific_country | str | This field is populated if the ETF provides targeted exposure to a specific country. | -| china_listing_location | str | For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities. | -| us_state | str | Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies. | -| real_estate | str | For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market. | -| fundamental_weighting_type | str | For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology. | -| dividend_weighting_type | str | For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology. | -| bond_type | str | For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF. | -| government_bond_types | str | For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure. | -| municipal_bond_region | str | For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure. | -| municipal_vrdo | bool | For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations. | -| mortgage_bond_types | str | For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities. | -| bond_tax_status | str | For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities. | -| credit_quality | str | For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range. | -| average_maturity | str | For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range. | -| specific_maturity_year | int | For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year. | -| commodity_types | str | For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF. | -| energy_type | str | For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF. | -| agricultural_type | str | For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF. | -| livestock_type | str | For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF. | -| metal_type | str | For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF. | -| inverse_leveraged | str | This field is populated if the ETF provides inverse or leveraged exposure. | -| target_date_multi_asset_type | str | For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF. | -| currency_pair | str | This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure. | -| social_environmental_type | str | This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme. | -| clean_energy_type | str | This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field. | -| dividend_type | str | This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus. | -| regular_dividend_payor_type | str | This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field. | -| quant_strategies_type | str | This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy. | -| other_quant_models | str | For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF. | -| hedge_fund_type | str | For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy. | -| excludes_financials | bool | For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective. | -| excludes_technology | bool | For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective. | -| holds_only_nyse_stocks | bool | If true, the ETF is an equity ETF and holds only stocks listed on NYSE. | -| holds_only_nasdaq_stocks | bool | If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq. | -| holds_mlp | bool | If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy. | -| holds_preferred_stock | bool | If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy. | -| holds_closed_end_funds | bool | If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy. | -| holds_adr | bool | If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy. | -| laddered | bool | For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure. | -| zero_coupon | bool | For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills. | -| floating_rate | bool | For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds. | -| build_america_bonds | bool | For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds. | -| dynamic_futures_roll | bool | If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs. | -| currency_hedged | bool | This field is populated if the ETF's strategy involves hedging currency exposure. | -| includes_short_exposure | bool | This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF. | -| ucits | bool | If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant | -| registered_countries | str | The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe. | -| issuer_country | str | 2 letter ISO country code for the country where the issuer is located. | -| domicile | str | 2 letter ISO country code for the country where the ETP is domiciled. | -| listing_country | str | 2 letter ISO country code for the country of the primary listing. | -| listing_region | str | Geographic region in the country of the primary listing falls. | -| bond_currency_denomination | str | For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities. | -| base_currency | str | Base currency in which NAV is reported. | -| listing_currency | str | Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code. | -| number_of_holdings | int | The number of holdings in the ETF. | -| month_end_assets | float | Net assets in millions of dollars as of the most recent month end. | -| net_expense_ratio | float | Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer. | -| etf_portfolio_turnover | float | The percentage of positions turned over in the last 12 months. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF. | -| description | str | Description of the fund. | -| inception_date | str | Inception date of the ETF. | -| issuer | str | The issuer of the ETF. | -| investment_style | str | The investment style of the ETF. | -| esg | bool | Whether the ETF qualifies as an ESG fund. | -| currency | str | The currency of the ETF. | -| unit_price | float | The unit price of the ETF. | -| close | float | The closing price of the ETF. | -| prev_close | float | The previous closing price of the ETF. | -| return_1m | float | The one-month return of the ETF, as a normalized percent | -| return_3m | float | The three-month return of the ETF, as a normalized percent. | -| return_6m | float | The six-month return of the ETF, as a normalized percent. | -| return_ytd | float | The year-to-date return of the ETF, as a normalized percent. | -| return_1y | float | The one-year return of the ETF, as a normalized percent. | -| return_3y | float | The three-year return of the ETF, as a normalized percent. | -| return_5y | float | The five-year return of the ETF, as a normalized percent. | -| return_10y | float | The ten-year return of the ETF, as a normalized percent. | -| return_from_inception | float | The return from inception of the ETF, as a normalized percent. | -| avg_volume | int | The average daily volume of the ETF. | -| avg_volume_30d | int | The 30-day average volume of the ETF. | -| aum | float | The AUM of the ETF. | -| pe_ratio | float | The price-to-earnings ratio of the ETF. | -| pb_ratio | float | The price-to-book ratio of the ETF. | -| management_fee | float | The management fee of the ETF, as a normalized percent. | -| mer | float | The management expense ratio of the ETF, as a normalized percent. | -| distribution_yield | float | The distribution yield of the ETF, as a normalized percent. | -| dividend_frequency | str | The dividend payment frequency of the ETF. | -| website | str | The website of the ETF. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. (ETF) | -| name | str | Name of the ETF. | -| description | str | Description of the fund. | -| inception_date | str | Inception date of the ETF. | -| fund_type | str | The legal type of fund. | -| fund_family | str | The fund family. | -| category | str | The fund category. | -| exchange | str | The exchange the fund is listed on. | -| exchange_timezone | str | The timezone of the exchange. | -| currency | str | The currency in which the fund is listed. | -| nav_price | float | The net asset value per unit of the fund. | -| total_assets | int | The total value of assets held by the fund. | -| trailing_pe | float | The trailing twelve month P/E ratio of the fund's assets. | -| dividend_yield | float | The dividend yield of the fund, as a normalized percent. | -| dividend_rate_ttm | float | The trailing twelve month annual dividend rate of the fund, in currency units. | -| dividend_yield_ttm | float | The trailing twelve month annual dividend yield of the fund, as a normalized percent. | -| year_high | float | The fifty-two week high price. | -| year_low | float | The fifty-two week low price. | -| ma_50d | float | 50-day moving average price. | -| ma_200d | float | 200-day moving average price. | -| return_ytd | float | The year-to-date return of the fund, as a normalized percent. | -| return_3y_avg | float | The three year average return of the fund, as a normalized percent. | -| return_5y_avg | float | The five year average return of the fund, as a normalized percent. | -| beta_3y_avg | float | The three year average beta of the fund. | -| volume_avg | float | The average daily trading volume of the fund. | -| volume_avg_10d | float | The average daily trading volume of the fund over the past ten days. | -| bid | float | The current bid price. | -| bid_size | float | The current bid size. | -| ask | float | The current ask price. | -| ask_size | float | The current ask size. | -| open | float | The open price of the most recent trading session. | -| high | float | The highest price of the most recent trading session. | -| low | float | The lowest price of the most recent trading session. | -| volume | int | The trading volume of the most recent trading session. | -| prev_close | float | The previous closing price. | - - - - diff --git a/website/content/platform/reference/etf/price_performance.md b/website/content/platform/reference/etf/price_performance.md deleted file mode 100644 index caca1bd6300a..000000000000 --- a/website/content/platform/reference/etf/price_performance.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -title: "price_performance" -description: "Learn about price performance returns over different periods and how to retrieve data for a given symbol. Find out how to analyze the time series data, view the provider information, and access additional metadata and warnings." -keywords: -- price performance -- return -- periods -- symbol -- data -- time series -- chart -- provider -- metadata -- warnings -- one-day return -- week to date return -- one-week return -- month to date return -- one-month return -- quarter to date return -- three-month return -- six-month return -- year to date return -- one-year return -- three-year return -- five-year return -- ten-year return -- max return -- ticker symbol ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Price performance as a return, over different periods. This is a proxy for `equity.price.performance`. - - -Examples --------- - -```python -from openbb import obb -obb.etf.price_performance(symbol='QQQ', provider='fmp') -obb.etf.price_performance(symbol='SPY,QQQ,IWM,DJIA', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| provider | Literal['finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| provider | Literal['finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp. | | False | -| provider | Literal['finviz', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default. | finviz | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : PricePerformance - Serializable results. - provider : Literal['finviz', 'fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | -| volatility_week | float | One-week realized volatility, as a normalized percent. | -| volatility_month | float | One-month realized volatility, as a normalized percent. | -| price | float | Last Price. | -| volume | float | Current volume. | -| average_volume | float | Average daily volume. | -| relative_volume | float | Relative volume as a ratio of current volume to average volume. | -| analyst_recommendation | float | The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. | -| symbol | str | The ticker symbol. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| one_day | float | One-day return. | -| wtd | float | Week to date return. | -| one_week | float | One-week return. | -| mtd | float | Month to date return. | -| one_month | float | One-month return. | -| qtd | float | Quarter to date return. | -| three_month | float | Three-month return. | -| six_month | float | Six-month return. | -| ytd | float | Year to date return. | -| one_year | float | One-year return. | -| three_year | float | Three-year return. | -| five_year | float | Five-year return. | -| ten_year | float | Ten-year return. | -| max | float | Return from the beginning of the time series. | -| symbol | str | The ticker symbol. | - - - - diff --git a/website/content/platform/reference/etf/search.md b/website/content/platform/reference/etf/search.md deleted file mode 100644 index 968ad103ecad..000000000000 --- a/website/content/platform/reference/etf/search.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -title: "search" -description: "Learn how to search for ETFs with parameters like query, provider, exchange code, and more. Retrieve key details about ETFs, including market cap, industry, sector, beta, current price, annual dividend, trading volume, exchange, and country. Find actively trading ETFs and their symbol representation." -keywords: -- search for ETFs -- ETF search query -- ETF provider -- ETF exchange code -- ETF trading volume -- ETF market cap -- ETF sector -- ETF industry -- ETF beta -- ETF current price -- ETF annual dividend -- ETF exchange -- ETF country -- actively trading ETF ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Search for ETFs. - -An empty query returns the full list of ETFs from the provider. - - -Examples --------- - -```python -from openbb import obb -# An empty query returns the full list of ETFs from the provider. -obb.etf.search(provider='fmp') -# The query will return results from text-based fields containing the term. -obb.etf.search(query='commercial real estate', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| exchange | Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT'] | The exchange code the ETF trades on. | None | True | -| is_active | Literal[True, False] | Whether the ETF is actively trading. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| exchange | Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist'] | Target a specific exchange by providing the MIC code. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| provider | Literal['fmp', 'intrinio', 'tmx'] | 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 | -| div_freq | Literal['monthly', 'annually', 'quarterly'] | The dividend payment frequency. | None | True | -| sort_by | Literal['nav', 'return_1m', 'return_3m', 'return_6m', 'return_1y', 'return_3y', 'return_ytd', 'beta_1y', 'volume_avg_daily', 'management_fee', 'distribution_yield', 'pb_ratio', 'pe_ratio'] | The column to sort by. | None | True | -| use_cache | bool | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. | True | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EtfSearch - Serializable results. - provider : Literal['fmp', 'intrinio', 'tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data.(ETF) | -| name | str | Name of the ETF. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data.(ETF) | -| name | str | Name of the ETF. | -| market_cap | float | The market cap of the ETF. | -| sector | str | The sector of the ETF. | -| industry | str | The industry of the ETF. | -| beta | float | The beta of the ETF. | -| price | float | The current price of the ETF. | -| last_annual_dividend | float | The last annual dividend paid. | -| volume | float | The current trading volume of the ETF. | -| exchange | str | The exchange code the ETF trades on. | -| exchange_name | str | The full name of the exchange the ETF trades on. | -| country | str | The country the ETF is registered in. | -| actively_trading | Literal[True, False] | Whether the ETF is actively trading. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data.(ETF) | -| name | str | Name of the ETF. | -| exchange | str | The exchange MIC code. | -| figi_ticker | str | The OpenFIGI ticker. | -| ric | str | The Reuters Instrument Code. | -| isin | str | The International Securities Identification Number. | -| sedol | str | The Stock Exchange Daily Official List. | -| intrinio_id | str | The unique Intrinio ID for the security. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data.(ETF) | -| name | str | Name of the ETF. | -| short_name | str | The short name of the ETF. | -| inception_date | str | The inception date of the ETF. | -| issuer | str | The issuer of the ETF. | -| investment_style | str | The investment style of the ETF. | -| esg | bool | Whether the ETF qualifies as an ESG fund. | -| currency | str | The currency of the ETF. | -| unit_price | float | The unit price of the ETF. | -| close | float | The closing price of the ETF. | -| prev_close | float | The previous closing price of the ETF. | -| return_1m | float | The one-month return of the ETF, as a normalized percent. | -| return_3m | float | The three-month return of the ETF, as a normalized percent. | -| return_6m | float | The six-month return of the ETF, as a normalized percent. | -| return_ytd | float | The year-to-date return of the ETF, as a normalized percent. | -| return_1y | float | The one-year return of the ETF, as a normalized percent. | -| beta_1y | float | The one-year beta of the ETF, as a normalized percent. | -| return_3y | float | The three-year return of the ETF, as a normalized percent. | -| beta_3y | float | The three-year beta of the ETF, as a normalized percent. | -| return_5y | float | The five-year return of the ETF, as a normalized percent. | -| beta_5y | float | The five-year beta of the ETF, as a normalized percent. | -| return_10y | float | The ten-year return of the ETF, as a normalized percent. | -| beta_10y | float | The ten-year beta of the ETF. | -| beta_15y | float | The fifteen-year beta of the ETF. | -| return_from_inception | float | The return from inception of the ETF, as a normalized percent. | -| avg_volume | int | The average daily volume of the ETF. | -| avg_volume_30d | int | The 30-day average volume of the ETF. | -| aum | float | The AUM of the ETF. | -| pe_ratio | float | The price-to-earnings ratio of the ETF. | -| pb_ratio | float | The price-to-book ratio of the ETF. | -| management_fee | float | The management fee of the ETF, as a normalized percent. | -| mer | float | The management expense ratio of the ETF, as a normalized percent. | -| distribution_yield | float | The distribution yield of the ETF, as a normalized percent. | -| dividend_frequency | str | The dividend payment frequency of the ETF. | - - - - diff --git a/website/content/platform/reference/etf/sectors.md b/website/content/platform/reference/etf/sectors.md deleted file mode 100644 index 50f67d030676..000000000000 --- a/website/content/platform/reference/etf/sectors.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "sectors" -description: "Learn about ETF sector weighting using OBB.etf.sectors API. Find information about the parameters, returns, and data, including sectors, weights, and exposure levels in normalized percentage points." -keywords: -- ETF Sector weighting -- OBB.etf.sectors -- parameters -- symbol -- provider -- returns -- results -- etf sectors -- warnings -- chart -- metadata -- data -- sector -- weight -- exposure -- normalized percentage points ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -ETF Sector weighting. - - -Examples --------- - -```python -from openbb import obb -obb.etf.sectors(symbol='SPY', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'tmx'] | 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 | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'tmx'] | 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 | str | Symbol to get data for. (ETF) | | False | -| provider | Literal['fmp', 'tmx'] | 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 | -| use_cache | bool | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. | True | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EtfSectors - Serializable results. - provider : Literal['fmp', 'tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sector | str | Sector of exposure. | -| weight | float | Exposure of the ETF to the sector in normalized percentage points. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sector | str | Sector of exposure. | -| weight | float | Exposure of the ETF to the sector in normalized percentage points. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sector | str | Sector of exposure. | -| weight | float | Exposure of the ETF to the sector in normalized percentage points. | - - - - diff --git a/website/content/platform/reference/fixedincome/_category_.json b/website/content/platform/reference/fixedincome/_category_.json deleted file mode 100644 index 59342c34a8a5..000000000000 --- a/website/content/platform/reference/fixedincome/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Fixedincome", - "position": 8 -} \ No newline at end of file diff --git a/website/content/platform/reference/fixedincome/corporate/_category_.json b/website/content/platform/reference/fixedincome/corporate/_category_.json deleted file mode 100644 index c52425a2923c..000000000000 --- a/website/content/platform/reference/fixedincome/corporate/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Corporate", - "position": 1 -} \ No newline at end of file diff --git a/website/content/platform/reference/fixedincome/corporate/bond_prices.md b/website/content/platform/reference/fixedincome/corporate/bond_prices.md deleted file mode 100644 index b7fc851ce43a..000000000000 --- a/website/content/platform/reference/fixedincome/corporate/bond_prices.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: "bond_prices" -description: "Corporate Bond Prices" -keywords: -- fixedincome -- corporate -- bond_prices ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Corporate Bond Prices. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.corporate.bond_prices(provider='tmx') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| country | str | The country to get data. Matches partial name. | None | True | -| issuer_name | str | Name of the issuer. Returns partial matches and is case insensitive. | None | True | -| isin | Union[List, str] | International Securities Identification Number(s) of the bond(s). | None | True | -| lei | str | Legal Entity Identifier of the issuing entity. | None | True | -| currency | Union[List, str] | Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD). | None | True | -| coupon_min | float | Minimum coupon rate of the bond. | None | True | -| coupon_max | float | Maximum coupon rate of the bond. | None | True | -| issued_amount_min | int | Minimum issued amount of the bond. | None | True | -| issued_amount_max | str | Maximum issued amount of the bond. | None | True | -| maturity_date_min | date | Minimum maturity date of the bond. | None | True | -| maturity_date_max | date | Maximum maturity date of the bond. | None | True | -| provider | Literal['tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| country | str | The country to get data. Matches partial name. | None | True | -| issuer_name | str | Name of the issuer. Returns partial matches and is case insensitive. | None | True | -| isin | Union[List, str] | International Securities Identification Number(s) of the bond(s). | None | True | -| lei | str | Legal Entity Identifier of the issuing entity. | None | True | -| currency | Union[List, str] | Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD). | None | True | -| coupon_min | float | Minimum coupon rate of the bond. | None | True | -| coupon_max | float | Maximum coupon rate of the bond. | None | True | -| issued_amount_min | int | Minimum issued amount of the bond. | None | True | -| issued_amount_max | str | Maximum issued amount of the bond. | None | True | -| maturity_date_min | date | Minimum maturity date of the bond. | None | True | -| maturity_date_max | date | Maximum maturity date of the bond. | None | True | -| provider | Literal['tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | -| issue_date_min | date | Filter by the minimum original issue date. | None | True | -| issue_date_max | date | Filter by the maximum original issue date. | None | True | -| last_traded_min | date | Filter by the minimum last trade date. | None | True | -| use_cache | bool | All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. | True | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : BondPrices - Serializable results. - provider : Literal['tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| isin | str | International Securities Identification Number of the bond. | -| lei | str | Legal Entity Identifier of the issuing entity. | -| figi | str | FIGI of the bond. | -| cusip | str | CUSIP of the bond. | -| coupon_rate | float | Coupon rate of the bond. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| isin | str | International Securities Identification Number of the bond. | -| lei | str | Legal Entity Identifier of the issuing entity. | -| figi | str | FIGI of the bond. | -| cusip | str | CUSIP of the bond. | -| coupon_rate | float | Coupon rate of the bond. | -| ytm | float | Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. Values are returned as a normalized percent. | -| price | float | The last price for the bond. | -| highest_price | float | The highest price for the bond on the last traded date. | -| lowest_price | float | The lowest price for the bond on the last traded date. | -| total_trades | int | Total number of trades on the last traded date. | -| last_traded_date | date | Last traded date of the bond. | -| maturity_date | date | Maturity date of the bond. | -| issue_date | date | Issue date of the bond. This is the date when the bond first accrues interest. | -| issuer_name | str | Name of the issuing entity. | - - - - diff --git a/website/content/platform/reference/fixedincome/corporate/commercial_paper.md b/website/content/platform/reference/fixedincome/corporate/commercial_paper.md deleted file mode 100644 index 8fc9dd34cafa..000000000000 --- a/website/content/platform/reference/fixedincome/corporate/commercial_paper.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: "commercial_paper" -description: "Learn about commercial paper, a form of short-term promissory notes issued primarily by corporations. Discover how it can help raise cash for current transactions and serve as a lower-cost alternative to bank loans. Explore the parameters and data returned by the commercial paper API endpoint." -keywords: -- commercial paper -- short-term promissory notes -- corporations -- raise cash -- lower-cost alternative -- start_date -- end_date -- maturity -- category -- grade -- provider -- results -- warnings -- chart -- metadata -- data -- date -- rate ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Commercial Paper. - -Commercial paper (CP) consists of short-term, promissory notes issued primarily by corporations. -Maturities range up to 270 days but average about 30 days. -Many companies use CP to raise cash needed for current transactions, -and many find it to be a lower-cost alternative to bank loans. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.corporate.commercial_paper(provider='fred') -obb.fixedincome.corporate.commercial_paper(maturity='15d', provider='fred') -``` - ---- - -## 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 | -| maturity | Literal['overnight', '7d', '15d', '30d', '60d', '90d'] | The maturity. | 30d | True | -| category | Literal['asset_backed', 'financial', 'nonfinancial'] | The category. | financial | True | -| grade | Literal['aa', 'a2_p2'] | The grade. | aa | 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 | -| maturity | Literal['overnight', '7d', '15d', '30d', '60d', '90d'] | The maturity. | 30d | True | -| category | Literal['asset_backed', 'financial', 'nonfinancial'] | The category. | financial | True | -| grade | Literal['aa', 'a2_p2'] | The grade. | aa | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CommercialPaper - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Commercial Paper Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Commercial Paper Rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/corporate/hqm.md b/website/content/platform/reference/fixedincome/corporate/hqm.md deleted file mode 100644 index 0332b3b96c5e..000000000000 --- a/website/content/platform/reference/fixedincome/corporate/hqm.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: "hqm" -description: "Learn about the HQM yield curve and the high quality corporate bond market. Get information on AAA, AA, and A bonds, market-weighted average quality, corporate bond rates, maturity, yield curve type, provider, and data." -keywords: -- HQM yield curve -- high quality corporate bond market -- AAA bonds -- AA bonds -- A bonds -- market-weighted average quality -- corporate bond rates -- maturity -- yield curve type -- provider -- fred -- data ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -High Quality Market Corporate Bond. - -The HQM yield curve represents the high quality corporate bond market, i.e., -corporate bonds rated AAA, AA, or A. The HQM curve contains two regression terms. -These terms are adjustment factors that blend AAA, AA, and A bonds into a single HQM yield curve -that is the market-weighted average (MWA) quality of high quality bonds. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.corporate.hqm(provider='fred') -obb.fixedincome.corporate.hqm(yield_curve='par', provider='fred') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. | None | True | -| yield_curve | Literal['spot', 'par'] | The yield curve type. | spot | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. | None | True | -| yield_curve | Literal['spot', 'par'] | The yield curve type. | spot | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : HighQualityMarketCorporateBond - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | HighQualityMarketCorporateBond Rate. | -| maturity | str | Maturity. | -| yield_curve | Literal['spot', 'par'] | The yield curve type. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | HighQualityMarketCorporateBond Rate. | -| maturity | str | Maturity. | -| yield_curve | Literal['spot', 'par'] | The yield curve type. | -| series_id | str | FRED series id. | - - - - diff --git a/website/content/platform/reference/fixedincome/corporate/ice_bofa.md b/website/content/platform/reference/fixedincome/corporate/ice_bofa.md deleted file mode 100644 index 24e38eefd5a5..000000000000 --- a/website/content/platform/reference/fixedincome/corporate/ice_bofa.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -title: "ice_bofa" -description: "Learn about ICE BofA US Corporate Bond Indices, including the ICE BofA US Corporate Index and parameters for the `obb.fixedincome.corporate.ice_bofa` function. Find out how to retrieve historical data and explore the available categories and areas." -keywords: -- ICE BofA US Corporate Bond Indices -- ICE BofA US Corporate Index -- US dollar denominated investment grade corporate debt -- Moody's -- S&P -- Fitch -- investment grade rating -- final maturity -- rebalance date -- fixed coupon schedule -- minimum amount outstanding -- US Corporate Master Index -- start date -- end date -- index type -- provider -- fred -- category -- area -- grade -- options -- returns -- results -- warnings -- chart -- metadata -- data -- rate ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -ICE BofA US Corporate Bond Indices. - -The ICE BofA US Corporate Index tracks the performance of US dollar denominated investment grade corporate debt -publicly issued in the US domestic market. Qualifying securities must have an investment grade rating (based on an -average of Moody’s, S&P and Fitch), at least 18 months to final maturity at the time of issuance, at least one year -remaining term to final maturity as of the rebalance date, a fixed coupon schedule and a minimum amount -outstanding of $250 million. The ICE BofA US Corporate Index is a component of the US Corporate Master Index. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.corporate.ice_bofa(provider='fred') -obb.fixedincome.corporate.ice_bofa(index_type='yield_to_worst', provider='fred') -``` - ---- - -## 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 | -| index_type | Literal['yield', 'yield_to_worst', 'total_return', 'spread'] | The type of series. | yield | 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 | -| index_type | Literal['yield', 'yield_to_worst', 'total_return', 'spread'] | The type of series. | yield | 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 | -| category | Literal['all', 'duration', 'eur', 'usd'] | The type of category. | all | True | -| area | Literal['asia', 'emea', 'eu', 'ex_g10', 'latin_america', 'us'] | The type of area. | us | True | -| grade | Literal['a', 'aa', 'aaa', 'b', 'bb', 'bbb', 'ccc', 'crossover', 'high_grade', 'high_yield', 'non_financial', 'non_sovereign', 'private_sector', 'public_sector'] | The type of grade. | non_sovereign | True | -| options | bool | Whether to include options in the results. | False | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : ICEBofA - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | ICE BofA US Corporate Bond Indices Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | ICE BofA US Corporate Bond Indices Rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/corporate/index.mdx b/website/content/platform/reference/fixedincome/corporate/index.mdx deleted file mode 100644 index 288548703962..000000000000 --- a/website/content/platform/reference/fixedincome/corporate/index.mdx +++ /dev/null @@ -1,14 +0,0 @@ -# Corporate - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - - - -
- diff --git a/website/content/platform/reference/fixedincome/corporate/moody.md b/website/content/platform/reference/fixedincome/corporate/moody.md deleted file mode 100644 index f7545ca871bd..000000000000 --- a/website/content/platform/reference/fixedincome/corporate/moody.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: "moody" -description: "Moody Corporate Bond Index" -keywords: -- fixedincome -- corporate -- moody ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Moody Corporate Bond Index. - -Moody's Aaa and Baa are investment bonds that acts as an index of -the performance of all bonds given an Aaa or Baa rating by Moody's Investors Service respectively. -These corporate bonds often are used in macroeconomics as an alternative to the federal ten-year -Treasury Bill as an indicator of the interest rate. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.corporate.moody(provider='fred') -obb.fixedincome.corporate.moody(index_type='baa', provider='fred') -``` - ---- - -## 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 | -| index_type | Literal['aaa', 'baa'] | The type of series. | aaa | 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 | -| index_type | Literal['aaa', 'baa'] | The type of series. | aaa | 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 | -| spread | Literal['treasury', 'fed_funds'] | The type of spread. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : MoodyCorporateBondIndex - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Moody Corporate Bond Index Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Moody Corporate Bond Index Rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/corporate/spot_rates.md b/website/content/platform/reference/fixedincome/corporate/spot_rates.md deleted file mode 100644 index ad17fab77a6b..000000000000 --- a/website/content/platform/reference/fixedincome/corporate/spot_rates.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: "spot_rates" -description: "Learn about spot rates and how they are used to calculate the yield on a bond. Understand the concept of discounting and its application in evaluating pension liabilities. Explore the parameters needed to query and retrieve spot rate data. Get the serializable results, provider information, warnings, chart, and metadata associated with the query. Access the spot rate data including the date and rate." -keywords: -- spot rates -- yield -- bond -- zero coupon bond -- interest rate -- discounting -- pension liability -- maturities -- query -- results -- provider -- warnings -- chart -- metadata -- data -- date -- rate ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Spot Rates. - -The spot rates for any maturity is the yield on a bond that provides a single payment at that maturity. -This is a zero coupon bond. -Because each spot rate pertains to a single cashflow, it is the relevant interest rate -concept for discounting a pension liability at the same maturity. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.corporate.spot_rates(provider='fred') -obb.fixedincome.corporate.spot_rates(maturity='10,20,30,50', provider='fred') -``` - ---- - -## 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 | -| maturity | Union[Union[float, str], List[Union[float, str]]] | Maturities in years. Multiple items allowed for provider(s): fred. | 10.0 | True | -| category | Union[str, List[str]] | Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred. | spot_rate | 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 | -| maturity | Union[Union[float, str], List[Union[float, str]]] | Maturities in years. Multiple items allowed for provider(s): fred. | 10.0 | True | -| category | Union[str, List[str]] | Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred. | spot_rate | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : SpotRate - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Spot Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Spot Rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/government/_category_.json b/website/content/platform/reference/fixedincome/government/_category_.json deleted file mode 100644 index a5b1131d3974..000000000000 --- a/website/content/platform/reference/fixedincome/government/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Government", - "position": 3 -} \ No newline at end of file diff --git a/website/content/platform/reference/fixedincome/government/eu_yield_curve.md b/website/content/platform/reference/fixedincome/government/eu_yield_curve.md deleted file mode 100644 index d9268fd17a9f..000000000000 --- a/website/content/platform/reference/fixedincome/government/eu_yield_curve.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: "eu_yield_curve" -description: "Learn about the Euro Area Yield Curve, its definition, and how to access ECB yield curve data. Understand the factors influencing yield curve shape and rate expectations. Explore parameters, types, and providers for yield curve data, as well as the returned results, chart object, and metadata." -keywords: -- Euro Area Yield Curve -- ECB yield curve data -- yield curve definition -- bond yield curve -- Treasury market -- credit quality -- yield curve shape -- rate expectations -- pure expectations hypothesis -- bond pricing -- debt market -- yield curve parameters -- yield curve types -- yield curve provider -- yield curve data -- yield curve ratings -- OBBject -- EUYieldCurve -- results -- chart -- metadata ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Euro Area Yield Curve. - -Gets euro area yield curve data from ECB. - -The graphic depiction of the relationship between the yield on bonds of the same credit quality but different -maturities is known as the yield curve. In the past, most market participants have constructed yield curves from -the observations of prices and yields in the Treasury market. Two reasons account for this tendency. First, -Treasury securities are viewed as free of default risk, and differences in creditworthiness do not affect yield -estimates. Second, as the most active bond market, the Treasury market offers the fewest problems of illiquidity -or infrequent trading. The key function of the Treasury yield curve is to serve as a benchmark for pricing bonds -and setting yields in other sectors of the debt market. - -It is clear that the market’s expectations of future rate changes are one important determinant of the -yield-curve shape. For example, a steeply upward-sloping curve may indicate market expectations of near-term Fed -tightening or of rising inflation. However, it may be too restrictive to assume that the yield differences across -bonds with different maturities only reflect the market’s rate expectations. The well-known pure expectations -hypothesis has such an extreme implication. The pure expectations hypothesis asserts that all government bonds -have the same near-term expected return (as the nominally riskless short-term bond) because the return-seeking -activity of risk-neutral traders removes all expected return differentials across bonds. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.government.eu_yield_curve(provider='ecb') -obb.fixedincome.government.eu_yield_curve(yield_curve_type=spot_rate, provider='ecb') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. | None | True | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. | None | True | -| provider | Literal['ecb'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'ecb' if there is no default. | ecb | True | -| rating | Literal['aaa', 'all_ratings'] | The rating type, either 'aaa' or 'all_ratings'. | aaa | True | -| yield_curve_type | Literal['spot_rate', 'instantaneous_forward', 'par_yield'] | The yield curve type. | spot_rate | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EUYieldCurve - Serializable results. - provider : Literal['ecb'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| maturity | float | Maturity, in years. | -| rate | float | Yield curve rate, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| maturity | float | Maturity, in years. | -| rate | float | Yield curve rate, as a normalized percent. | - - - - diff --git a/website/content/platform/reference/fixedincome/government/index.mdx b/website/content/platform/reference/fixedincome/government/index.mdx deleted file mode 100644 index 93507c3607e3..000000000000 --- a/website/content/platform/reference/fixedincome/government/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ -# Government - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - - -
- diff --git a/website/content/platform/reference/fixedincome/government/treasury_auctions.md b/website/content/platform/reference/fixedincome/government/treasury_auctions.md deleted file mode 100644 index a4e01cfde552..000000000000 --- a/website/content/platform/reference/fixedincome/government/treasury_auctions.md +++ /dev/null @@ -1,343 +0,0 @@ ---- -title: "treasury_auctions" -description: "Government Treasury Auctions" -keywords: -- fixedincome -- government -- treasury_auctions ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Government Treasury Auctions. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.government.treasury_auctions(provider='government_us') -obb.fixedincome.government.treasury_auctions(security_type='Bill', start_date='2022-01-01', end_date='2023-01-01', provider='government_us') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| security_type | Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN'] | Used to only return securities of a particular type. | None | True | -| cusip | str | Filter securities by CUSIP. | None | True | -| page_size | int | Maximum number of results to return; you must also include pagenum when using pagesize. | None | True | -| page_num | int | The first page number to display results for; used in combination with page size. | None | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. The default is 90 days ago. | None | True | -| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. The default is today. | None | True | -| provider | Literal['government_us'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default. | government_us | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| security_type | Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN'] | Used to only return securities of a particular type. | None | True | -| cusip | str | Filter securities by CUSIP. | None | True | -| page_size | int | Maximum number of results to return; you must also include pagenum when using pagesize. | None | True | -| page_num | int | The first page number to display results for; used in combination with page size. | None | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. The default is 90 days ago. | None | True | -| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. The default is today. | None | True | -| provider | Literal['government_us'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default. | government_us | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : TreasuryAuctions - Serializable results. - provider : Literal['government_us'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| cusip | str | CUSIP of the Security. | -| issue_date | date | The issue date of the security. | -| security_type | Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN'] | The type of security. | -| security_term | str | The term of the security. | -| maturity_date | date | The maturity date of the security. | -| interest_rate | float | The interest rate of the security. | -| cpi_on_issue_date | float | Reference CPI rate on the issue date of the security. | -| cpi_on_dated_date | float | Reference CPI rate on the dated date of the security. | -| announcement_date | date | The announcement date of the security. | -| auction_date | date | The auction date of the security. | -| auction_date_year | int | The auction date year of the security. | -| dated_date | date | The dated date of the security. | -| first_payment_date | date | The first payment date of the security. | -| accrued_interest_per_100 | float | Accrued interest per $100. | -| accrued_interest_per_1000 | float | Accrued interest per $1000. | -| adjusted_accrued_interest_per_100 | float | Adjusted accrued interest per $100. | -| adjusted_accrued_interest_per_1000 | float | Adjusted accrued interest per $1000. | -| adjusted_price | float | Adjusted price. | -| allocation_percentage | float | Allocation percentage, as normalized percentage points. | -| allocation_percentage_decimals | float | The number of decimals in the Allocation percentage. | -| announced_cusip | str | The announced CUSIP of the security. | -| auction_format | str | The auction format of the security. | -| avg_median_discount_rate | float | The average median discount rate of the security. | -| avg_median_investment_rate | float | The average median investment rate of the security. | -| avg_median_price | float | The average median price paid for the security. | -| avg_median_discount_margin | float | The average median discount margin of the security. | -| avg_median_yield | float | The average median yield of the security. | -| back_dated | Literal['Yes', 'No'] | Whether the security is back dated. | -| back_dated_date | date | The back dated date of the security. | -| bid_to_cover_ratio | float | The bid to cover ratio of the security. | -| call_date | date | The call date of the security. | -| callable | Literal['Yes', 'No'] | Whether the security is callable. | -| called_date | date | The called date of the security. | -| cash_management_bill | Literal['Yes', 'No'] | Whether the security is a cash management bill. | -| closing_time_competitive | str | The closing time for competitive bids on the security. | -| closing_time_non_competitive | str | The closing time for non-competitive bids on the security. | -| competitive_accepted | int | The accepted value for competitive bids on the security. | -| competitive_accepted_decimals | int | The number of decimals in the Competitive Accepted. | -| competitive_tendered | int | The tendered value for competitive bids on the security. | -| competitive_tenders_accepted | Literal['Yes', 'No'] | Whether competitive tenders are accepted on the security. | -| corp_us_cusip | str | The CUSIP of the security. | -| cpi_base_reference_period | str | The CPI base reference period of the security. | -| currently_outstanding | int | The currently outstanding value on the security. | -| direct_bidder_accepted | int | The accepted value from direct bidders on the security. | -| direct_bidder_tendered | int | The tendered value from direct bidders on the security. | -| est_amount_of_publicly_held_maturing_security | int | The estimated amount of publicly held maturing securities on the security. | -| fima_included | Literal['Yes', 'No'] | Whether the security is included in the FIMA (Foreign and International Money Authorities). | -| fima_non_competitive_accepted | int | The non-competitive accepted value on the security from FIMAs. | -| fima_non_competitive_tendered | int | The non-competitive tendered value on the security from FIMAs. | -| first_interest_period | str | The first interest period of the security. | -| first_interest_payment_date | date | The first interest payment date of the security. | -| floating_rate | Literal['Yes', 'No'] | Whether the security is a floating rate. | -| frn_index_determination_date | date | The FRN index determination date of the security. | -| frn_index_determination_rate | float | The FRN index determination rate of the security. | -| high_discount_rate | float | The high discount rate of the security. | -| high_investment_rate | float | The high investment rate of the security. | -| high_price | float | The high price of the security at auction. | -| high_discount_margin | float | The high discount margin of the security. | -| high_yield | float | The high yield of the security at auction. | -| index_ratio_on_issue_date | float | The index ratio on the issue date of the security. | -| indirect_bidder_accepted | int | The accepted value from indirect bidders on the security. | -| indirect_bidder_tendered | int | The tendered value from indirect bidders on the security. | -| interest_payment_frequency | str | The interest payment frequency of the security. | -| low_discount_rate | float | The low discount rate of the security. | -| low_investment_rate | float | The low investment rate of the security. | -| low_price | float | The low price of the security at auction. | -| low_discount_margin | float | The low discount margin of the security. | -| low_yield | float | The low yield of the security at auction. | -| maturing_date | date | The maturing date of the security. | -| max_competitive_award | int | The maximum competitive award at auction. | -| max_non_competitive_award | int | The maximum non-competitive award at auction. | -| max_single_bid | int | The maximum single bid at auction. | -| min_bid_amount | int | The minimum bid amount at auction. | -| min_strip_amount | int | The minimum strip amount at auction. | -| min_to_issue | int | The minimum to issue at auction. | -| multiples_to_bid | int | The multiples to bid at auction. | -| multiples_to_issue | int | The multiples to issue at auction. | -| nlp_exclusion_amount | int | The NLP exclusion amount at auction. | -| nlp_reporting_threshold | int | The NLP reporting threshold at auction. | -| non_competitive_accepted | int | The accepted value from non-competitive bidders on the security. | -| non_competitive_tenders_accepted | Literal['Yes', 'No'] | Whether or not the auction accepted non-competitive tenders. | -| offering_amount | int | The offering amount at auction. | -| original_cusip | str | The original CUSIP of the security. | -| original_dated_date | date | The original dated date of the security. | -| original_issue_date | date | The original issue date of the security. | -| original_security_term | str | The original term of the security. | -| pdf_announcement | str | The PDF filename for the announcement of the security. | -| pdf_competitive_results | str | The PDF filename for the competitive results of the security. | -| pdf_non_competitive_results | str | The PDF filename for the non-competitive results of the security. | -| pdf_special_announcement | str | The PDF filename for the special announcements. | -| price_per_100 | float | The price per 100 of the security. | -| primary_dealer_accepted | int | The primary dealer accepted value on the security. | -| primary_dealer_tendered | int | The primary dealer tendered value on the security. | -| reopening | Literal['Yes', 'No'] | Whether or not the auction was reopened. | -| security_term_day_month | str | The security term in days or months. | -| security_term_week_year | str | The security term in weeks or years. | -| series | str | The series name of the security. | -| soma_accepted | int | The SOMA accepted value on the security. | -| soma_holdings | int | The SOMA holdings on the security. | -| soma_included | Literal['Yes', 'No'] | Whether or not the SOMA (System Open Market Account) was included on the security. | -| soma_tendered | int | The SOMA tendered value on the security. | -| spread | float | The spread on the security. | -| standard_payment_per_1000 | float | The standard payment per 1000 of the security. | -| strippable | Literal['Yes', 'No'] | Whether or not the security is strippable. | -| term | str | The term of the security. | -| tiin_conversion_factor_per_1000 | float | The TIIN conversion factor per 1000 of the security. | -| tips | Literal['Yes', 'No'] | Whether or not the security is TIPS. | -| total_accepted | int | The total accepted value at auction. | -| total_tendered | int | The total tendered value at auction. | -| treasury_retail_accepted | int | The accepted value on the security from retail. | -| treasury_retail_tenders_accepted | Literal['Yes', 'No'] | Whether or not the tender offers from retail are accepted | -| type | str | The type of issuance. This might be different than the security type. | -| unadjusted_accrued_interest_per_1000 | float | The unadjusted accrued interest per 1000 of the security. | -| unadjusted_price | float | The unadjusted price of the security. | -| updated_timestamp | datetime | The updated timestamp of the security. | -| xml_announcement | str | The XML filename for the announcement of the security. | -| xml_competitive_results | str | The XML filename for the competitive results of the security. | -| xml_special_announcement | str | The XML filename for special announcements. | -| tint_cusip1 | str | Tint CUSIP 1. | -| tint_cusip2 | str | Tint CUSIP 2. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| cusip | str | CUSIP of the Security. | -| issue_date | date | The issue date of the security. | -| security_type | Literal['Bill', 'Note', 'Bond', 'CMB', 'TIPS', 'FRN'] | The type of security. | -| security_term | str | The term of the security. | -| maturity_date | date | The maturity date of the security. | -| interest_rate | float | The interest rate of the security. | -| cpi_on_issue_date | float | Reference CPI rate on the issue date of the security. | -| cpi_on_dated_date | float | Reference CPI rate on the dated date of the security. | -| announcement_date | date | The announcement date of the security. | -| auction_date | date | The auction date of the security. | -| auction_date_year | int | The auction date year of the security. | -| dated_date | date | The dated date of the security. | -| first_payment_date | date | The first payment date of the security. | -| accrued_interest_per_100 | float | Accrued interest per $100. | -| accrued_interest_per_1000 | float | Accrued interest per $1000. | -| adjusted_accrued_interest_per_100 | float | Adjusted accrued interest per $100. | -| adjusted_accrued_interest_per_1000 | float | Adjusted accrued interest per $1000. | -| adjusted_price | float | Adjusted price. | -| allocation_percentage | float | Allocation percentage, as normalized percentage points. | -| allocation_percentage_decimals | float | The number of decimals in the Allocation percentage. | -| announced_cusip | str | The announced CUSIP of the security. | -| auction_format | str | The auction format of the security. | -| avg_median_discount_rate | float | The average median discount rate of the security. | -| avg_median_investment_rate | float | The average median investment rate of the security. | -| avg_median_price | float | The average median price paid for the security. | -| avg_median_discount_margin | float | The average median discount margin of the security. | -| avg_median_yield | float | The average median yield of the security. | -| back_dated | Literal['Yes', 'No'] | Whether the security is back dated. | -| back_dated_date | date | The back dated date of the security. | -| bid_to_cover_ratio | float | The bid to cover ratio of the security. | -| call_date | date | The call date of the security. | -| callable | Literal['Yes', 'No'] | Whether the security is callable. | -| called_date | date | The called date of the security. | -| cash_management_bill | Literal['Yes', 'No'] | Whether the security is a cash management bill. | -| closing_time_competitive | str | The closing time for competitive bids on the security. | -| closing_time_non_competitive | str | The closing time for non-competitive bids on the security. | -| competitive_accepted | int | The accepted value for competitive bids on the security. | -| competitive_accepted_decimals | int | The number of decimals in the Competitive Accepted. | -| competitive_tendered | int | The tendered value for competitive bids on the security. | -| competitive_tenders_accepted | Literal['Yes', 'No'] | Whether competitive tenders are accepted on the security. | -| corp_us_cusip | str | The CUSIP of the security. | -| cpi_base_reference_period | str | The CPI base reference period of the security. | -| currently_outstanding | int | The currently outstanding value on the security. | -| direct_bidder_accepted | int | The accepted value from direct bidders on the security. | -| direct_bidder_tendered | int | The tendered value from direct bidders on the security. | -| est_amount_of_publicly_held_maturing_security | int | The estimated amount of publicly held maturing securities on the security. | -| fima_included | Literal['Yes', 'No'] | Whether the security is included in the FIMA (Foreign and International Money Authorities). | -| fima_non_competitive_accepted | int | The non-competitive accepted value on the security from FIMAs. | -| fima_non_competitive_tendered | int | The non-competitive tendered value on the security from FIMAs. | -| first_interest_period | str | The first interest period of the security. | -| first_interest_payment_date | date | The first interest payment date of the security. | -| floating_rate | Literal['Yes', 'No'] | Whether the security is a floating rate. | -| frn_index_determination_date | date | The FRN index determination date of the security. | -| frn_index_determination_rate | float | The FRN index determination rate of the security. | -| high_discount_rate | float | The high discount rate of the security. | -| high_investment_rate | float | The high investment rate of the security. | -| high_price | float | The high price of the security at auction. | -| high_discount_margin | float | The high discount margin of the security. | -| high_yield | float | The high yield of the security at auction. | -| index_ratio_on_issue_date | float | The index ratio on the issue date of the security. | -| indirect_bidder_accepted | int | The accepted value from indirect bidders on the security. | -| indirect_bidder_tendered | int | The tendered value from indirect bidders on the security. | -| interest_payment_frequency | str | The interest payment frequency of the security. | -| low_discount_rate | float | The low discount rate of the security. | -| low_investment_rate | float | The low investment rate of the security. | -| low_price | float | The low price of the security at auction. | -| low_discount_margin | float | The low discount margin of the security. | -| low_yield | float | The low yield of the security at auction. | -| maturing_date | date | The maturing date of the security. | -| max_competitive_award | int | The maximum competitive award at auction. | -| max_non_competitive_award | int | The maximum non-competitive award at auction. | -| max_single_bid | int | The maximum single bid at auction. | -| min_bid_amount | int | The minimum bid amount at auction. | -| min_strip_amount | int | The minimum strip amount at auction. | -| min_to_issue | int | The minimum to issue at auction. | -| multiples_to_bid | int | The multiples to bid at auction. | -| multiples_to_issue | int | The multiples to issue at auction. | -| nlp_exclusion_amount | int | The NLP exclusion amount at auction. | -| nlp_reporting_threshold | int | The NLP reporting threshold at auction. | -| non_competitive_accepted | int | The accepted value from non-competitive bidders on the security. | -| non_competitive_tenders_accepted | Literal['Yes', 'No'] | Whether or not the auction accepted non-competitive tenders. | -| offering_amount | int | The offering amount at auction. | -| original_cusip | str | The original CUSIP of the security. | -| original_dated_date | date | The original dated date of the security. | -| original_issue_date | date | The original issue date of the security. | -| original_security_term | str | The original term of the security. | -| pdf_announcement | str | The PDF filename for the announcement of the security. | -| pdf_competitive_results | str | The PDF filename for the competitive results of the security. | -| pdf_non_competitive_results | str | The PDF filename for the non-competitive results of the security. | -| pdf_special_announcement | str | The PDF filename for the special announcements. | -| price_per_100 | float | The price per 100 of the security. | -| primary_dealer_accepted | int | The primary dealer accepted value on the security. | -| primary_dealer_tendered | int | The primary dealer tendered value on the security. | -| reopening | Literal['Yes', 'No'] | Whether or not the auction was reopened. | -| security_term_day_month | str | The security term in days or months. | -| security_term_week_year | str | The security term in weeks or years. | -| series | str | The series name of the security. | -| soma_accepted | int | The SOMA accepted value on the security. | -| soma_holdings | int | The SOMA holdings on the security. | -| soma_included | Literal['Yes', 'No'] | Whether or not the SOMA (System Open Market Account) was included on the security. | -| soma_tendered | int | The SOMA tendered value on the security. | -| spread | float | The spread on the security. | -| standard_payment_per_1000 | float | The standard payment per 1000 of the security. | -| strippable | Literal['Yes', 'No'] | Whether or not the security is strippable. | -| term | str | The term of the security. | -| tiin_conversion_factor_per_1000 | float | The TIIN conversion factor per 1000 of the security. | -| tips | Literal['Yes', 'No'] | Whether or not the security is TIPS. | -| total_accepted | int | The total accepted value at auction. | -| total_tendered | int | The total tendered value at auction. | -| treasury_retail_accepted | int | The accepted value on the security from retail. | -| treasury_retail_tenders_accepted | Literal['Yes', 'No'] | Whether or not the tender offers from retail are accepted | -| type | str | The type of issuance. This might be different than the security type. | -| unadjusted_accrued_interest_per_1000 | float | The unadjusted accrued interest per 1000 of the security. | -| unadjusted_price | float | The unadjusted price of the security. | -| updated_timestamp | datetime | The updated timestamp of the security. | -| xml_announcement | str | The XML filename for the announcement of the security. | -| xml_competitive_results | str | The XML filename for the competitive results of the security. | -| xml_special_announcement | str | The XML filename for special announcements. | -| tint_cusip1 | str | Tint CUSIP 1. | -| tint_cusip2 | str | Tint CUSIP 2. | - - - - diff --git a/website/content/platform/reference/fixedincome/government/treasury_prices.md b/website/content/platform/reference/fixedincome/government/treasury_prices.md deleted file mode 100644 index 89548cfebf0e..000000000000 --- a/website/content/platform/reference/fixedincome/government/treasury_prices.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -title: "treasury_prices" -description: "Government Treasury Prices by date" -keywords: -- fixedincome -- government -- treasury_prices ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Government Treasury Prices by date. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.government.treasury_prices(provider='government_us') -obb.fixedincome.government.treasury_prices(date='2019-02-05', provider='government_us') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. No date will return the current posted data. | None | True | -| provider | Literal['government_us', 'tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default. | government_us | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. No date will return the current posted data. | None | True | -| provider | Literal['government_us', 'tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default. | government_us | True | -| cusip | str | Filter by CUSIP. | None | True | -| security_type | Literal[None, 'bill', 'note', 'bond', 'tips', 'frn'] | Filter by security type. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. No date will return the current posted data. | None | True | -| provider | Literal['government_us', 'tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'government_us' if there is no default. | government_us | True | -| govt_type | Literal['federal', 'provincial', 'municipal'] | The level of government issuer. | federal | True | -| issue_date_min | date | Filter by the minimum original issue date. | None | True | -| issue_date_max | date | Filter by the maximum original issue date. | None | True | -| last_traded_min | date | Filter by the minimum last trade date. | None | True | -| maturity_date_min | date | Filter by the minimum maturity date. | None | True | -| maturity_date_max | date | Filter by the maximum maturity date. | None | True | -| use_cache | bool | All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False. | True | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : TreasuryPrices - Serializable results. - provider : Literal['government_us', 'tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| issuer_name | str | Name of the issuing entity. | -| cusip | str | CUSIP of the security. | -| isin | str | ISIN of the security. | -| security_type | str | The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN. | -| issue_date | date | The original issue date of the security. | -| maturity_date | date | The maturity date of the security. | -| call_date | date | The call date of the security. | -| bid | float | The bid price of the security. | -| offer | float | The offer price of the security. | -| eod_price | float | The end-of-day price of the security. | -| last_traded_date | date | The last trade date of the security. | -| total_trades | int | Total number of trades on the last traded date. | -| last_price | float | The last price of the security. | -| highest_price | float | The highest price for the bond on the last traded date. | -| lowest_price | float | The lowest price for the bond on the last traded date. | -| rate | float | The annualized interest rate or coupon of the security. | -| ytm | float | Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| issuer_name | str | Name of the issuing entity. | -| cusip | str | CUSIP of the security. | -| isin | str | ISIN of the security. | -| security_type | str | The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN. | -| issue_date | date | The original issue date of the security. | -| maturity_date | date | The maturity date of the security. | -| call_date | date | The call date of the security. | -| bid | float | The bid price of the security. | -| offer | float | The offer price of the security. | -| eod_price | float | The end-of-day price of the security. | -| last_traded_date | date | The last trade date of the security. | -| total_trades | int | Total number of trades on the last traded date. | -| last_price | float | The last price of the security. | -| highest_price | float | The highest price for the bond on the last traded date. | -| lowest_price | float | The lowest price for the bond on the last traded date. | -| rate | float | The annualized interest rate or coupon of the security. | -| ytm | float | Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| issuer_name | str | Name of the issuing entity. | -| cusip | str | CUSIP of the security. | -| isin | str | ISIN of the security. | -| security_type | str | The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN. | -| issue_date | date | The original issue date of the security. | -| maturity_date | date | The maturity date of the security. | -| call_date | date | The call date of the security. | -| bid | float | The bid price of the security. | -| offer | float | The offer price of the security. | -| eod_price | float | The end-of-day price of the security. | -| last_traded_date | date | The last trade date of the security. | -| total_trades | int | Total number of trades on the last traded date. | -| last_price | float | The last price of the security. | -| highest_price | float | The highest price for the bond on the last traded date. | -| lowest_price | float | The lowest price for the bond on the last traded date. | -| rate | float | The annualized interest rate or coupon of the security. | -| ytm | float | Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/government/treasury_rates.md b/website/content/platform/reference/fixedincome/government/treasury_rates.md deleted file mode 100644 index c1da0e93e309..000000000000 --- a/website/content/platform/reference/fixedincome/government/treasury_rates.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: "treasury_rates" -description: "Government Treasury Rates" -keywords: -- fixedincome -- government -- treasury_rates ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Government Treasury Rates. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.government.treasury_rates(provider='fmp') -``` - ---- - -## 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['federal_reserve', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | 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['federal_reserve', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | 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['federal_reserve', 'fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : TreasuryRates - Serializable results. - provider : Literal['federal_reserve', 'fmp'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| week_4 | float | 4 week Treasury bills rate (secondary market). | -| month_1 | float | 1 month Treasury rate. | -| month_2 | float | 2 month Treasury rate. | -| month_3 | float | 3 month Treasury rate. | -| month_6 | float | 6 month Treasury rate. | -| year_1 | float | 1 year Treasury rate. | -| year_2 | float | 2 year Treasury rate. | -| year_3 | float | 3 year Treasury rate. | -| year_5 | float | 5 year Treasury rate. | -| year_7 | float | 7 year Treasury rate. | -| year_10 | float | 10 year Treasury rate. | -| year_20 | float | 20 year Treasury rate. | -| year_30 | float | 30 year Treasury rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| week_4 | float | 4 week Treasury bills rate (secondary market). | -| month_1 | float | 1 month Treasury rate. | -| month_2 | float | 2 month Treasury rate. | -| month_3 | float | 3 month Treasury rate. | -| month_6 | float | 6 month Treasury rate. | -| year_1 | float | 1 year Treasury rate. | -| year_2 | float | 2 year Treasury rate. | -| year_3 | float | 3 year Treasury rate. | -| year_5 | float | 5 year Treasury rate. | -| year_7 | float | 7 year Treasury rate. | -| year_10 | float | 10 year Treasury rate. | -| year_20 | float | 20 year Treasury rate. | -| year_30 | float | 30 year Treasury rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| week_4 | float | 4 week Treasury bills rate (secondary market). | -| month_1 | float | 1 month Treasury rate. | -| month_2 | float | 2 month Treasury rate. | -| month_3 | float | 3 month Treasury rate. | -| month_6 | float | 6 month Treasury rate. | -| year_1 | float | 1 year Treasury rate. | -| year_2 | float | 2 year Treasury rate. | -| year_3 | float | 3 year Treasury rate. | -| year_5 | float | 5 year Treasury rate. | -| year_7 | float | 7 year Treasury rate. | -| year_10 | float | 10 year Treasury rate. | -| year_20 | float | 20 year Treasury rate. | -| year_30 | float | 30 year Treasury rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/government/us_yield_curve.md b/website/content/platform/reference/fixedincome/government/us_yield_curve.md deleted file mode 100644 index 52669eb06a3e..000000000000 --- a/website/content/platform/reference/fixedincome/government/us_yield_curve.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: "us_yield_curve" -description: "Learn about the US Yield Curve and how to retrieve United States yield curve data using the OBB.fixedincome.government.us_yield_curve function. Explore parameters like date, inflation adjustment, and provider. Understand the returned results, including the chart, metadata, and warnings. Discover the data structure, including maturity and rate." -keywords: -- US Yield Curve -- United States yield curve -- yield curve -- government bonds -- fixed income -- rates -- inflation adjusted -- FRED provider -- data -- maturity -- treasury rate -- rate ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -US Yield Curve. Get United States yield curve. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.government.us_yield_curve(provider='fred') -obb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. Defaults to the most recent FRED entry. | None | True | -| inflation_adjusted | bool | Get inflation adjusted rates. | False | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| date | Union[date, str] | A specific date to get data for. Defaults to the most recent FRED entry. | None | True | -| inflation_adjusted | bool | Get inflation adjusted rates. | False | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : USYieldCurve - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| maturity | float | Maturity of the treasury rate in years. | -| rate | float | Associated rate given in decimal form (0.05 is 5%) | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| maturity | float | Maturity of the treasury rate in years. | -| rate | float | Associated rate given in decimal form (0.05 is 5%) | - - - - diff --git a/website/content/platform/reference/fixedincome/index.mdx b/website/content/platform/reference/fixedincome/index.mdx deleted file mode 100644 index 0466ee432e59..000000000000 --- a/website/content/platform/reference/fixedincome/index.mdx +++ /dev/null @@ -1,17 +0,0 @@ -# Fixedincome - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Menus -
    - - - - -
- -### Commands -
    - -
- diff --git a/website/content/platform/reference/fixedincome/rate/_category_.json b/website/content/platform/reference/fixedincome/rate/_category_.json deleted file mode 100644 index 8e953baa04a7..000000000000 --- a/website/content/platform/reference/fixedincome/rate/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Rate", - "position": 2 -} \ No newline at end of file diff --git a/website/content/platform/reference/fixedincome/rate/ameribor.md b/website/content/platform/reference/fixedincome/rate/ameribor.md deleted file mode 100644 index 11bd3032ee05..000000000000 --- a/website/content/platform/reference/fixedincome/rate/ameribor.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: "ameribor" -description: "Ameribor" -keywords: -- fixedincome -- rate -- ameribor ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Ameribor. - -Ameribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of -short-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the -American Financial Exchange (AFX). - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.rate.ameribor(provider='fred') -obb.fixedincome.rate.ameribor(parameter=30_day_ma, provider='fred') -``` - ---- - -## 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : AMERIBOR - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | AMERIBOR rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | AMERIBOR rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/rate/dpcredit.md b/website/content/platform/reference/fixedincome/rate/dpcredit.md deleted file mode 100644 index 76f3ecb22e42..000000000000 --- a/website/content/platform/reference/fixedincome/rate/dpcredit.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: "dpcredit" -description: "Discount Window Primary Credit Rate" -keywords: -- fixedincome -- rate -- dpcredit ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Discount Window Primary Credit Rate. - -A bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money. -The rates central banks charge are set to stabilize the economy. -In the United States, the Federal Reserve System's Board of Governors set the bank rate, -also known as the discount rate. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.rate.dpcredit(provider='fred') -obb.fixedincome.rate.dpcredit(start_date='2023-02-01', end_date='2023-05-01', provider='fred') -``` - ---- - -## 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['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual'] | FRED series ID of DWPCR data. | daily_excl_weekend | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : DiscountWindowPrimaryCreditRate - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Discount Window Primary Credit Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Discount Window Primary Credit Rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/rate/ecb.md b/website/content/platform/reference/fixedincome/rate/ecb.md deleted file mode 100644 index 43eb8cc3192b..000000000000 --- a/website/content/platform/reference/fixedincome/rate/ecb.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: "ecb" -description: "Learn about the key interest rates set by the European Central Bank (ECB) for the Euro area. Explore the Python API for accessing European Central Bank interest rate data and understand the available parameters to customize your queries." -keywords: -- European Central Bank interest rates -- ECB key interest rates -- ECB refinancing operations -- deposit facility rate -- marginal lending facility rate -- Python OBB fixed income API -- start date parameter -- end date parameter -- interest rate type parameter -- provider parameter -- European Central Bank Interest Rates data -- European Central Bank Interest Rates API ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -European Central Bank Interest Rates. - -The Governing Council of the ECB sets the key interest rates for the euro area: - -- The interest rate on the main refinancing operations (MRO), which provide -the bulk of liquidity to the banking system. -- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem. -- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.rate.ecb(provider='fred') -obb.fixedincome.rate.ecb(interest_rate_type='refinancing', provider='fred') -``` - ---- - -## 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 | -| interest_rate_type | Literal['deposit', 'lending', 'refinancing'] | The type of interest rate. | lending | 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 | -| interest_rate_type | Literal['deposit', 'lending', 'refinancing'] | The type of interest rate. | lending | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : EuropeanCentralBankInterestRates - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | European Central Bank Interest Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | European Central Bank Interest Rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/rate/effr.md b/website/content/platform/reference/fixedincome/rate/effr.md deleted file mode 100644 index a9c7f60b40a6..000000000000 --- a/website/content/platform/reference/fixedincome/rate/effr.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: "effr" -description: "Fed Funds Rate" -keywords: -- fixedincome -- rate -- effr ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Fed Funds Rate. - -Get Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its -domestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the -United States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.rate.effr(provider='fred') -obb.fixedincome.rate.effr(parameter=daily, provider='fred') -``` - ---- - -## 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['federal_reserve', 'fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | 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['federal_reserve', 'fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | 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['federal_reserve', 'fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'federal_reserve' if there is no default. | federal_reserve | True | -| parameter | Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume'] | Period of FED rate. | weekly | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : FEDFUNDS - Serializable results. - provider : Literal['federal_reserve', 'fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | FED rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | FED rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | FED rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/rate/effr_forecast.md b/website/content/platform/reference/fixedincome/rate/effr_forecast.md deleted file mode 100644 index c559934a6a51..000000000000 --- a/website/content/platform/reference/fixedincome/rate/effr_forecast.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: "effr_forecast" -description: "Fed Funds Rate Projections" -keywords: -- fixedincome -- rate -- effr_forecast ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Fed Funds Rate Projections. - -The projections for the federal funds rate are the value of the midpoint of the -projected appropriate target range for the federal funds rate or the projected -appropriate target level for the federal funds rate at the end of the specified -calendar year or over the longer run. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.rate.effr_forecast(provider='fred') -obb.fixedincome.rate.effr_forecast(long_run=True, provider='fred') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | -| ---- | ---- | ----------- | ------- | -------- | -| 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 | -| long_run | bool | Flag to show long run projections | False | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : PROJECTIONS - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| range_high | float | High projection of rates. | -| central_tendency_high | float | Central tendency of high projection of rates. | -| median | float | Median projection of rates. | -| range_midpoint | float | Midpoint projection of rates. | -| central_tendency_midpoint | float | Central tendency of midpoint projection of rates. | -| range_low | float | Low projection of rates. | -| central_tendency_low | float | Central tendency of low projection of rates. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| range_high | float | High projection of rates. | -| central_tendency_high | float | Central tendency of high projection of rates. | -| median | float | Median projection of rates. | -| range_midpoint | float | Midpoint projection of rates. | -| central_tendency_midpoint | float | Central tendency of midpoint projection of rates. | -| range_low | float | Low projection of rates. | -| central_tendency_low | float | Central tendency of low projection of rates. | - - - - diff --git a/website/content/platform/reference/fixedincome/rate/estr.md b/website/content/platform/reference/fixedincome/rate/estr.md deleted file mode 100644 index 4a7003b0552f..000000000000 --- a/website/content/platform/reference/fixedincome/rate/estr.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: "estr" -description: "Euro Short-Term Rate" -keywords: -- fixedincome -- rate -- estr ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Euro Short-Term Rate. - -The euro short-term rate (€STR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in -the euro area. The €STR is published on each TARGET2 business day based on transactions conducted and settled on -the previous TARGET2 business day (the reporting date “T”) with a maturity date of T+1 which are deemed to have been -executed at arm’s length and thus reflect market rates in an unbiased way. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.rate.estr(provider='fred') -obb.fixedincome.rate.estr(parameter=number_of_active_banks, provider='fred') -``` - ---- - -## 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['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume'] | Period of ESTR rate. | volume_weighted_trimmed_mean_rate | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : ESTR - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | ESTR rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | ESTR rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/rate/index.mdx b/website/content/platform/reference/fixedincome/rate/index.mdx deleted file mode 100644 index 174289e427f1..000000000000 --- a/website/content/platform/reference/fixedincome/rate/index.mdx +++ /dev/null @@ -1,16 +0,0 @@ -# Rate - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - - - - - -
- diff --git a/website/content/platform/reference/fixedincome/rate/iorb.md b/website/content/platform/reference/fixedincome/rate/iorb.md deleted file mode 100644 index 13bd958d8873..000000000000 --- a/website/content/platform/reference/fixedincome/rate/iorb.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: "iorb" -description: "Interest on Reserve Balances" -keywords: -- fixedincome -- rate -- iorb ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Interest on Reserve Balances. - -Get Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its -domestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the -United States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.rate.iorb(provider='fred') -``` - ---- - -## 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : IORB - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | IORB rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | IORB rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/rate/sonia.md b/website/content/platform/reference/fixedincome/rate/sonia.md deleted file mode 100644 index 4807caa894f8..000000000000 --- a/website/content/platform/reference/fixedincome/rate/sonia.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: "sonia" -description: "Sterling Overnight Index Average" -keywords: -- fixedincome -- rate -- sonia ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Sterling Overnight Index Average. - -SONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual -transactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other -financial institutions and other institutional investors. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.rate.sonia(provider='fred') -obb.fixedincome.rate.sonia(parameter=total_nominal_value, provider='fred') -``` - ---- - -## 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['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value'] | Period of SONIA rate. | rate | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : SONIA - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SONIA rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SONIA rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/sofr.md b/website/content/platform/reference/fixedincome/sofr.md deleted file mode 100644 index 76bf45996954..000000000000 --- a/website/content/platform/reference/fixedincome/sofr.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: "sofr" -description: "Learn about the Secured Overnight Financing Rate (SOFR), a measure of the cost of borrowing cash overnight collateralized by Treasury securities. Explore the SOFR Python function parameters, data returns, and more." -keywords: -- Secured Overnight Financing Rate -- SOFR -- borrowing cash overnight -- collateralizing by Treasury securities -- SOFR python function -- SOFR parameters -- start_date -- end_date -- provider -- SOFR period -- returns -- results -- provider name -- warnings -- chart -- metadata -- data -- date -- rate ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Secured Overnight Financing Rate. - -The Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of -borrowing cash overnight collateralizing by Treasury securities. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.sofr(provider='fred') -obb.fixedincome.sofr(period=overnight, provider='fred') -``` - ---- - -## 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 | -| period | Literal['overnight', '30_day', '90_day', '180_day', 'index'] | Period of SOFR rate. | overnight | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : SOFR - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SOFR rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SOFR rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/spreads/_category_.json b/website/content/platform/reference/fixedincome/spreads/_category_.json deleted file mode 100644 index 2121466be057..000000000000 --- a/website/content/platform/reference/fixedincome/spreads/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Spreads", - "position": 4 -} \ No newline at end of file diff --git a/website/content/platform/reference/fixedincome/spreads/index.mdx b/website/content/platform/reference/fixedincome/spreads/index.mdx deleted file mode 100644 index 71acffe811e8..000000000000 --- a/website/content/platform/reference/fixedincome/spreads/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ -# Spreads - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - -
- diff --git a/website/content/platform/reference/fixedincome/spreads/tcm.md b/website/content/platform/reference/fixedincome/spreads/tcm.md deleted file mode 100644 index 7600a4ad733b..000000000000 --- a/website/content/platform/reference/fixedincome/spreads/tcm.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: "tcm" -description: "Treasury Constant Maturity" -keywords: -- fixedincome -- spreads -- tcm ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Treasury Constant Maturity. - -Get data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity. -Constant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S. -Treasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury -yield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.spreads.tcm(provider='fred') -obb.fixedincome.spreads.tcm(maturity='2y', provider='fred') -``` - ---- - -## 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 | -| maturity | Literal['3m', '2y'] | The maturity | 3m | 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 | -| maturity | Literal['3m', '2y'] | The maturity | 3m | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : TreasuryConstantMaturity - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | TreasuryConstantMaturity Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | TreasuryConstantMaturity Rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/spreads/tcm_effr.md b/website/content/platform/reference/fixedincome/spreads/tcm_effr.md deleted file mode 100644 index 86b907a4f36c..000000000000 --- a/website/content/platform/reference/fixedincome/spreads/tcm_effr.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: "tcm_effr" -description: "Select Treasury Constant Maturity" -keywords: -- fixedincome -- spreads -- tcm_effr ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Select Treasury Constant Maturity. - -Get data for Selected Treasury Constant Maturity Minus Federal Funds Rate -Constant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S. -Treasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury -yield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.spreads.tcm_effr(provider='fred') -obb.fixedincome.spreads.tcm_effr(maturity='10y', provider='fred') -``` - ---- - -## 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 | -| maturity | Literal['10y', '5y', '1y', '6m', '3m'] | The maturity | 10y | 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 | -| maturity | Literal['10y', '5y', '1y', '6m', '3m'] | The maturity | 10y | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : SelectedTreasuryConstantMaturity - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Selected Treasury Constant Maturity Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | Selected Treasury Constant Maturity Rate. | - - - - diff --git a/website/content/platform/reference/fixedincome/spreads/treasury_effr.md b/website/content/platform/reference/fixedincome/spreads/treasury_effr.md deleted file mode 100644 index 604879ddb1a0..000000000000 --- a/website/content/platform/reference/fixedincome/spreads/treasury_effr.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: "treasury_effr" -description: "This documentation page provides information about Treasury Bill data, including the selected Treasury Bill rate minus Federal Funds Rate. It explains the concept of constant maturity and the Treasury yield curve. The page also covers the parameters, returns, and data associated with the `obb.fixedincome.spreads.treasury_effr` function." -keywords: -- Treasury Bill -- Selected Treasury Bill -- Federal Funds Rate -- Constant Maturity -- Treasury yield curve -- bid-yields -- US Treasuries -- obb.fixedincome.spreads.treasury_effr -- start_date -- end_date -- maturity -- provider -- results -- warnings -- chart -- metadata -- rate -- data ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Select Treasury Bill. - -Get Selected Treasury Bill Minus Federal Funds Rate. -Constant maturity is the theoretical value of a U.S. Treasury that is based on recent values of -auctioned U.S. Treasuries. -The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury -yield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities. - - -Examples --------- - -```python -from openbb import obb -obb.fixedincome.spreads.treasury_effr(provider='fred') -obb.fixedincome.spreads.treasury_effr(maturity='6m', provider='fred') -``` - ---- - -## 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 | -| maturity | Literal['3m', '6m'] | The maturity | 3m | 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 | -| maturity | Literal['3m', '6m'] | The maturity | 3m | 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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : SelectedTreasuryBill - Serializable results. - provider : Literal['fred'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SelectedTreasuryBill Rate. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | -| rate | float | SelectedTreasuryBill Rate. | - - - - diff --git a/website/content/platform/reference/index.mdx b/website/content/platform/reference/index.mdx deleted file mode 100644 index 1aa1c94f3c5a..000000000000 --- a/website/content/platform/reference/index.mdx +++ /dev/null @@ -1,76 +0,0 @@ -# Reference - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -
    - - - - - - - - - - - - - - -
diff --git a/website/content/platform/reference/index/_category_.json b/website/content/platform/reference/index/_category_.json deleted file mode 100644 index a2b9ee64033d..000000000000 --- a/website/content/platform/reference/index/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Index", - "position": 10 -} \ No newline at end of file diff --git a/website/content/platform/reference/index/available.md b/website/content/platform/reference/index/available.md deleted file mode 100644 index 2b18fc3e736c..000000000000 --- a/website/content/platform/reference/index/available.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: "available" -description: "Available Indices" -keywords: -- index -- available ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -All indices available from a given provider. - - -Examples --------- - -```python -from openbb import obb -obb.index.available(provider='fmp') -obb.index.available(provider='yfinance') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['cboe', 'fmp', 'tmx', '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', 'tmx', '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 | -| use_cache | bool | When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['cboe', 'fmp', 'tmx', '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', 'tmx', '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 | -| use_cache | bool | Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['cboe', 'fmp', 'tmx', '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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : AvailableIndices - Serializable results. - provider : Literal['cboe', 'fmp', 'tmx', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## 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. | -| 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. | -| symbol | str | The ticker symbol of the index. | - - - - -| 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/reference/index/constituents.md b/website/content/platform/reference/index/constituents.md deleted file mode 100644 index b4a366412dea..000000000000 --- a/website/content/platform/reference/index/constituents.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -title: "constituents" -description: "Learn how to fetch constituents of an index using the OBB library in Python. Get detailed information such as symbol, name, sector, sub-sector, headquarters, date of first addition, CIK, and founding year of the constituent companies in the index." -keywords: -- index constituents -- fetch constituents -- index constituents parameters -- index constituents returns -- index constituents data -- index constituents symbol -- index constituents name -- index constituents sector -- index constituents sub-sector -- index constituents headquarters -- index constituents date first added -- index constituents cik -- index constituents founding year ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Index Constituents. - - -Examples --------- - -```python -from openbb import obb -obb.index.constituents(symbol='dowjones', provider='fmp') -# Providers other than FMP will use the ticker symbol. -obb.index.constituents(symbol='BEP50P', provider='cboe') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'fmp', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'fmp', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'fmp', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['cboe', 'fmp', 'tmx'] | 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 | -| use_cache | bool | Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. | True | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : IndexConstituents - Serializable results. - provider : Literal['cboe', 'fmp', 'tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the constituent company in the index. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the constituent company in the index. | -| security_type | str | The type of security represented. | -| last_price | float | Last price for the symbol. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | Change in price. | -| change_percent | float | Change in price as a normalized percentage. | -| tick | str | Whether the last sale was an up or down tick. | -| last_trade_time | datetime | Last trade timestamp for the symbol. | -| asset_type | str | Type of asset. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the constituent company in the index. | -| sector | str | Sector the constituent company in the index belongs to. | -| sub_sector | str | Sub-sector the constituent company in the index belongs to. | -| headquarter | str | Location of the headquarter of the constituent company in the index. | -| date_first_added | Union[str, date] | Date the constituent company was added to the index. | -| cik | int | Central Index Key (CIK) for the requested entity. | -| founded | Union[str, date] | Founding year of the constituent company in the index. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the constituent company in the index. | -| market_value | float | The quoted market value of the asset. | - - - - diff --git a/website/content/platform/reference/index/index.mdx b/website/content/platform/reference/index/index.mdx deleted file mode 100644 index f3a49a117120..000000000000 --- a/website/content/platform/reference/index/index.mdx +++ /dev/null @@ -1,20 +0,0 @@ -# Index - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Menus -
    - -
- -### Commands -
    - - - - - - - -
- diff --git a/website/content/platform/reference/index/market.md b/website/content/platform/reference/index/market.md deleted file mode 100644 index d8760b87488a..000000000000 --- a/website/content/platform/reference/index/market.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -title: "market" -description: "Learn how to retrieve historical market indices data using various data providers and query parameters. Understand the available parameters and return values, such as symbol, start date, end date, provider, interval, timeseries, timespan, sort order, limit, adjusted, multiplier, chart, metadata, date, open price, high price, low price, close price, volume, calls volume, puts volume, options volume, adjusted close price, unadjusted volume, change, change percent, label, change over time, and transactions." -keywords: -- Historical Market Indices -- market data -- symbol -- start date -- end date -- data provider -- query -- interval -- timeseries -- timespan -- sort order -- limit -- adjusted -- multiplier -- chart -- metadata -- date -- open price -- high price -- low price -- close price -- volume -- calls volume -- puts volume -- options volume -- adjusted close price -- unadjusted volume -- change -- change percent -- label -- change over time -- transactions ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -:::caution Deprecated -This endpoint is deprecated; use `/index/price/historical` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3. -::: - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Historical Market Indices. - - -Examples --------- - -```python -from openbb import obb -obb.index.market(symbol='^IBEX', provider='fmp') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| use_cache | bool | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| limit | int | The number of data entries to return. | 10000 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : MarketIndices - Serializable results. - provider : Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| calls_volume | float | Number of calls traded during the most recent trading period. Only valid if interval is 1m. | -| puts_volume | float | Number of puts traded during the most recent trading period. Only valid if interval is 1m. | -| total_options_volume | float | Total number of options traded during the most recent trading period. Only valid if interval is 1m. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - diff --git a/website/content/platform/reference/index/price/_category_.json b/website/content/platform/reference/index/price/_category_.json deleted file mode 100644 index 73fbd46944d2..000000000000 --- a/website/content/platform/reference/index/price/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Price", - "position": 1 -} \ No newline at end of file diff --git a/website/content/platform/reference/index/price/historical.md b/website/content/platform/reference/index/price/historical.md deleted file mode 100644 index 79bd56ff11c5..000000000000 --- a/website/content/platform/reference/index/price/historical.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -title: "historical" -description: "Historical Index Levels" -keywords: -- index -- price -- historical ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Historical Index Levels. - - -Examples --------- - -```python -from openbb import obb -obb.index.price.historical(symbol='^GSPC', provider='fmp') -# Not all providers have the same symbols. -obb.index.price.historical(symbol='SPX', provider='intrinio') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| use_cache | bool | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. | True | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| limit | int | The number of data entries to return. | 10000 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | -| sort | Literal['asc', 'desc'] | 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. | asc | True | -| limit | int | The number of data entries to return. | 49999 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, polygon, yfinance. | | False | -| 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 | -| interval | str | Time interval of the data to return. | 1d | True | -| provider | Literal['cboe', 'fmp', 'intrinio', 'polygon', '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 | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : IndexHistorical - Serializable results. - provider : Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| calls_volume | float | Number of calls traded during the most recent trading period. Only valid if interval is 1m. | -| puts_volume | float | Number of puts traded during the most recent trading period. Only valid if interval is 1m. | -| total_options_volume | float | Total number of options traded during the most recent trading period. Only valid if interval is 1m. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| vwap | float | Volume Weighted Average Price over the period. | -| change | float | Change in the price from the previous close. | -| change_percent | float | Change in the price from the previous close, as a normalized percent. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | -| transactions | int, Gt(gt=0) | Number of transactions for the symbol in the time period. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | Union[date, datetime] | The date of the data. | -| open | float, Strict(strict=True) | The open price. | -| high | float, Strict(strict=True) | The high price. | -| low | float, Strict(strict=True) | The low price. | -| close | float, Strict(strict=True) | The close price. | -| volume | int | The trading volume. | - - - - diff --git a/website/content/platform/reference/index/price/index.mdx b/website/content/platform/reference/index/price/index.mdx deleted file mode 100644 index 35f2a248dfd0..000000000000 --- a/website/content/platform/reference/index/price/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ -# Price - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - -
- diff --git a/website/content/platform/reference/index/search.md b/website/content/platform/reference/index/search.md deleted file mode 100644 index 461bff747790..000000000000 --- a/website/content/platform/reference/index/search.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: "search" -description: "Learn how to perform index search and retrieve index data using this Python API. Understand the different parameters and their defaults, and get detailed information about index symbols, names, and additional attributes such as ISIN code, region, description, currency, and trading times." -keywords: -- index search -- search indices -- Python search query -- index data -- index symbol -- index name -- European indices -- US indices ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Filters indices for rows containing the query. - - -Examples --------- - -```python -from openbb import obb -obb.index.search(provider='cboe') -obb.index.search(query='SPX', provider='cboe') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| provider | Literal['cboe'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| provider | Literal['cboe'] | 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 | -| use_cache | bool | When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass. | True | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : IndexSearch - Serializable results. - provider : Literal['cboe'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the index. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the index. | -| description | str | Description for the index. | -| data_delay | int | Data delay for the index. Valid only for US indices. | -| currency | str | Currency for the index. | -| time_zone | str | Time zone 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. | -| tick_days | str | The trading days for the index. Valid only for US indices. | -| tick_frequency | str | Tick frequency for the index. Valid only for US indices. | -| tick_period | str | Tick period for the index. Valid only for US indices. | - - - - diff --git a/website/content/platform/reference/index/sectors.md b/website/content/platform/reference/index/sectors.md deleted file mode 100644 index 1855dfec583c..000000000000 --- a/website/content/platform/reference/index/sectors.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: "sectors" -description: "Index Sectors" -keywords: -- index -- sectors ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Index Sectors. Sector weighting of an index. - - -Examples --------- - -```python -from openbb import obb -obb.index.sectors(symbol='^TX60', provider='tmx') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['tmx'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'tmx' if there is no default. | tmx | True | -| use_cache | bool | Whether to use a cached request. All Index data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 1 day. | True | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : IndexSectors - Serializable results. - provider : Literal['tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sector | str | The sector name. | -| weight | float | The weight of the sector in the index. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sector | str | The sector name. | -| weight | float | The weight of the sector in the index. | - - - - diff --git a/website/content/platform/reference/index/snapshots.md b/website/content/platform/reference/index/snapshots.md deleted file mode 100644 index 38ad751d19ce..000000000000 --- a/website/content/platform/reference/index/snapshots.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -title: "snapshots" -description: "Index Snapshots documentation page with information on current levels for all indices from a specific provider, and details on parameters, query, returns, and data." -keywords: -- index snapshots -- current levels -- provider -- parameters -- region -- query -- returns -- data -- symbol -- name -- currency -- price -- open -- high -- low -- close -- prev close -- change -- change percent -- isin code -- last trade timestamp ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Index Snapshots. Current levels for all indices from a provider, grouped by `region`. - - -Examples --------- - -```python -from openbb import obb -obb.index.snapshots(provider='tmx') -obb.index.snapshots(region='us', provider='cboe') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| region | str | The region of focus for the data - i.e., us, eu. | us | True | -| provider | Literal['cboe', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| region | str | The region of focus for the data - i.e., us, eu. | us | True | -| provider | Literal['cboe', 'tmx'] | 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 | -| ---- | ---- | ----------- | ------- | -------- | -| region | str | The region of focus for the data - i.e., us, eu. | us | True | -| provider | Literal['cboe', 'tmx'] | 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 | -| use_cache | bool | Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False. | True | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : IndexSnapshots - Serializable results. - provider : Literal['cboe', 'tmx'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the index. | -| currency | str | Currency of the index. | -| price | float | Current price of the index. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | Change in value of the index. | -| change_percent | float | Change, in normalized percentage points, of the index. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the index. | -| currency | str | Currency of the index. | -| price | float | Current price of the index. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | Change in value of the index. | -| change_percent | float | Change, in normalized percentage points, of the index. | -| bid | float | Current bid price. | -| ask | float | Current ask price. | -| last_trade_time | datetime | Last trade timestamp for the symbol. | -| status | str | Status of the market, open or closed. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the index. | -| currency | str | Currency of the index. | -| price | float | Current price of the index. | -| open | float | The open price. | -| high | float | The high price. | -| low | float | The low price. | -| close | float | The close price. | -| volume | int | The trading volume. | -| prev_close | float | The previous close price. | -| change | float | Change in value of the index. | -| change_percent | float | Change, in normalized percentage points, of the index. | -| year_high | float | The 52-week high of the index. | -| year_low | float | The 52-week low of the index. | -| return_mtd | float | The month-to-date return of the index, as a normalized percent. | -| return_qtd | float | The quarter-to-date return of the index, as a normalized percent. | -| return_ytd | float | The year-to-date return of the index, as a normalized percent. | -| total_market_value | float | The total quoted market value of the index. | -| number_of_constituents | int | The number of constituents in the index. | -| constituent_average_market_value | float | The average quoted market value of the index constituents. | -| constituent_median_market_value | float | The median quoted market value of the index constituents. | -| constituent_top10_market_value | float | The sum of the top 10 quoted market values of the index constituents. | -| constituent_largest_market_value | float | The largest quoted market value of the index constituents. | -| constituent_largest_weight | float | The largest weight of the index constituents, as a normalized percent. | -| constituent_smallest_market_value | float | The smallest quoted market value of the index constituents. | -| constituent_smallest_weight | float | The smallest weight of the index constituents, as a normalized percent. | - - - - diff --git a/website/content/platform/reference/index/sp500_multiples.md b/website/content/platform/reference/index/sp500_multiples.md deleted file mode 100644 index 208bc73ed698..000000000000 --- a/website/content/platform/reference/index/sp500_multiples.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: "sp500_multiples" -description: "Learn about S&P 500 multiples and Shiller PE ratios. Use the `index.sp500_multiples` query to retrieve historical data on various financial metrics such as PE Ratio, Dividend, Earnings, Inflation Adjusted Price, Sales, Price to Sales Ratio, and Book Value per Share. Specify query parameters such as start date, end date, and provider. Collapse the frequency or transform the time series. Get results, charts, metadata, and more." -keywords: -- S&P 500 multiples -- Shiller PE ratios -- SP500Multiples -- index.sp500_multiples -- historical data -- PE Ratio -- Dividend -- Earnings -- Inflation Adjusted Price -- Sales -- Price to Sales Ratio -- Book Value per Share -- query parameters -- start date -- end date -- provider -- collapse -- transform -- results -- chart -- metadata -- data -- date ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Historical S&P 500 multiples and Shiller PE ratios. - - -Examples --------- - -```python -from openbb import obb -obb.index.sp500_multiples(provider='nasdaq') -obb.index.sp500_multiples(series_name='shiller_pe_year', provider='nasdaq') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| series_name | Literal['shiller_pe_month', 'shiller_pe_year', 'pe_year', 'pe_month', 'dividend_year', 'dividend_month', 'dividend_growth_quarter', 'dividend_growth_year', 'dividend_yield_year', 'dividend_yield_month', 'earnings_year', 'earnings_month', 'earnings_growth_year', 'earnings_growth_quarter', 'real_earnings_growth_year', 'real_earnings_growth_quarter', 'earnings_yield_year', 'earnings_yield_month', 'real_price_year', 'real_price_month', 'inflation_adjusted_price_year', 'inflation_adjusted_price_month', 'sales_year', 'sales_quarter', 'sales_growth_year', 'sales_growth_quarter', 'real_sales_year', 'real_sales_quarter', 'real_sales_growth_year', 'real_sales_growth_quarter', 'price_to_sales_year', 'price_to_sales_quarter', 'price_to_book_value_year', 'price_to_book_value_quarter', 'book_value_year', 'book_value_quarter'] | The name of the series. Defaults to 'pe_month'. | pe_month | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| series_name | Literal['shiller_pe_month', 'shiller_pe_year', 'pe_year', 'pe_month', 'dividend_year', 'dividend_month', 'dividend_growth_quarter', 'dividend_growth_year', 'dividend_yield_year', 'dividend_yield_month', 'earnings_year', 'earnings_month', 'earnings_growth_year', 'earnings_growth_quarter', 'real_earnings_growth_year', 'real_earnings_growth_quarter', 'earnings_yield_year', 'earnings_yield_month', 'real_price_year', 'real_price_month', 'inflation_adjusted_price_year', 'inflation_adjusted_price_month', 'sales_year', 'sales_quarter', 'sales_growth_year', 'sales_growth_quarter', 'real_sales_year', 'real_sales_quarter', 'real_sales_growth_year', 'real_sales_growth_quarter', 'price_to_sales_year', 'price_to_sales_quarter', 'price_to_book_value_year', 'price_to_book_value_quarter', 'book_value_year', 'book_value_quarter'] | The name of the series. Defaults to 'pe_month'. | pe_month | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : SP500Multiples - Serializable results. - provider : Literal['nasdaq'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - diff --git a/website/content/platform/reference/news/_category_.json b/website/content/platform/reference/news/_category_.json deleted file mode 100644 index 4a6ef757c022..000000000000 --- a/website/content/platform/reference/news/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "News", - "position": 7 -} \ No newline at end of file diff --git a/website/content/platform/reference/news/company.md b/website/content/platform/reference/news/company.md deleted file mode 100644 index 73ff5f7385c8..000000000000 --- a/website/content/platform/reference/news/company.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -title: "company" -description: "Get company news for one or more companies using various providers. This API allows you to retrieve news articles along with metadata such as date, title, image, text, and URL. The available providers include Benzinga, FMP, Intrinio, Polygon, Ultima, and Yfinance." -keywords: -- company news -- news for companies -- news API -- API parameters -- benzinga provider -- fmp provider -- polygon provider -- intrinio provider -- ultima provider -- yfinance provider -- data entries -- metadata -- company news results -- company news warnings -- company news chart -- data date -- data title -- data image -- data text -- data URL -- benzinga data -- fmp data -- intrinio data -- polygon data -- ultima data -- yfinance data ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Company News. Get news for one or more companies. - - -Examples --------- - -```python -from openbb import obb -obb.news.company(provider='benzinga') -obb.news.company(limit=100, provider='benzinga') -# Get news on the specified dates. -obb.news.company(symbol='AAPL', start_date='2024-02-01', end_date='2024-02-07', provider='intrinio') -# Display the headlines of the news. -obb.news.company(symbol='AAPL', display=headline, provider='benzinga') -# Get news for multiple symbols. -obb.news.company(symbol='aapl,tsla', provider='fmp') -# Get news company's ISIN. -obb.news.company(symbol='NVDA', isin=US0378331005, provider='benzinga') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| date | Union[date, str] | A specific date to get data for. | None | True | -| display | Literal['headline', 'abstract', 'full'] | Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). | full | True | -| updated_since | int | Number of seconds since the news was updated. | None | True | -| published_since | int | Number of seconds since the news was published. | None | True | -| sort | Literal['id', 'created', 'updated'] | Key to sort the news by. | created | True | -| order | Literal['asc', 'desc'] | Order to sort the news by. | desc | True | -| isin | str | The company's ISIN. | None | True | -| cusip | str | The company's CUSIP. | None | True | -| channels | str | Channels of the news to retrieve. | None | True | -| topics | str | Topics of the news to retrieve. | None | True | -| authors | str | Authors of the news to retrieve. | None | True | -| content_types | str | Content types of the news to retrieve. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| page | int | Page number of the results. Use in combination with limit. | 0 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| order | Literal['asc', 'desc'] | Sort order of the articles. | desc | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| offset | int | Page offset, used in conjunction with limit. | 0 | True | -| source | str | A comma-separated list of the domains requested. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| page | int | The page number to start from. Use with limit. | 1 | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | Union[str, List[str]] | Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, tmx, yfinance. | None | True | -| 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 | -| limit | int, Ge(ge=0) | The number of data entries to return. | 2500 | True | -| provider | Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CompanyNews - Serializable results. - provider : Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'tmx', 'yfinance'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| id | str | Article ID. | -| author | str | Author of the article. | -| teaser | str | Teaser of the news. | -| channels | str | Channels associated with the news. | -| stocks | str | Stocks associated with the news. | -| tags | str | Tags associated with the news. | -| updated | datetime | Updated date of the news. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| source | str | Name of the news source. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| id | str | Article ID. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| source | str | Source of the article. | -| tags | str | Keywords/tags in the article | -| id | str | Article ID. | -| amp_url | str | AMP URL. | -| publisher | openbb_polygon.models.company_news.PolygonPublisher | Publisher of the article. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| tags | str | Tags associated with the news article. | -| article_id | int | Unique ID of the news article. | -| source | str | News source. | -| crawl_date | datetime | Date the news article was crawled. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| source | str | Source of the news. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. Here it is the published date of the article. | -| title | str | Title of the article. | -| text | str | Text/body of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| url | str | URL to the article. | -| symbols | str | Symbols associated with the article. | -| source | str | Source of the news article | - - - - diff --git a/website/content/platform/reference/news/index.mdx b/website/content/platform/reference/news/index.mdx deleted file mode 100644 index daeec32679a7..000000000000 --- a/website/content/platform/reference/news/index.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# News - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - -
- diff --git a/website/content/platform/reference/news/world.md b/website/content/platform/reference/news/world.md deleted file mode 100644 index 85895d7f00d7..000000000000 --- a/website/content/platform/reference/news/world.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -title: "world" -description: "Learn how to retrieve global news data using the obb.news.world API. This documentation covers the parameters, returns, and data structures used in the API, including details on how to set the limit and provider, and how to filter the news by date, author, channels, and more. Explore the different data fields such as date, title, images, text, and URL, and understand the structure of the returned results, warnings, chart, and metadata." -keywords: -- Global News -- global news data -- obb.news.world -- parameters -- limit -- provider -- default -- benzinga -- biztoc -- fmp -- intrinio -- display -- date -- start_date -- end_date -- updated_since -- published_since -- sort -- order -- isin -- cusip -- channels -- topics -- authors -- content_types -- returns -- results -- provider -- warnings -- chart -- metadata -- data -- date -- title -- images -- text -- url -- id -- author -- teaser -- stocks -- tags -- updated -- favicon -- score -- site -- company -- datetime -- list -- dict ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -World News. Global news data. - - -Examples --------- - -```python -from openbb import obb -obb.news.world(provider='fmp') -obb.news.world(limit=100, provider='intrinio') -# Get news on the specified dates. -obb.news.world(start_date='2024-02-01', end_date='2024-02-07', provider='intrinio') -# Display the headlines of the news. -obb.news.world(display=headline, provider='benzinga') -# Get news by topics. -obb.news.world(topics=finance, provider='benzinga') -# Get news by source using 'tingo' as provider. -obb.news.world(provider='tiingo', source=bloomberg) -# Filter aticles by term using 'biztoc' as provider. -obb.news.world(provider='biztoc', term=apple) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| date | Union[date, str] | A specific date to get data for. | None | True | -| display | Literal['headline', 'abstract', 'full'] | Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). | full | True | -| updated_since | int | Number of seconds since the news was updated. | None | True | -| published_since | int | Number of seconds since the news was published. | None | True | -| sort | Literal['id', 'created', 'updated'] | Key to sort the news by. | created | True | -| order | Literal['asc', 'desc'] | Order to sort the news by. | desc | True | -| isin | str | The ISIN of the news to retrieve. | None | True | -| cusip | str | The CUSIP of the news to retrieve. | None | True | -| channels | str | Channels of the news to retrieve. | None | True | -| topics | str | Topics of the news to retrieve. | None | True | -| authors | str | Authors of the news to retrieve. | None | True | -| content_types | str | Content types of the news to retrieve. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| filter | Literal['crypto', 'hot', 'latest', 'main', 'media', 'source', 'tag'] | Filter by type of news. | latest | True | -| source | str | Filter by a specific publisher. Only valid when filter is set to source. | bloomberg | True | -| tag | str | Tag, topic, to filter articles by. Only valid when filter is set to tag. | None | True | -| term | str | Search term to filter articles by. This overrides all other filters. | None | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| limit | int | The number of data entries to return. The number of articles to return. | 2500 | True | -| 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['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'benzinga' if there is no default. | benzinga | True | -| offset | int | Page offset, used in conjunction with limit. | 0 | True | -| source | str | A comma-separated list of the domains requested. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : WorldNews - Serializable results. - provider : Literal['benzinga', 'biztoc', 'fmp', 'intrinio', 'tiingo'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | -| id | str | Article ID. | -| author | str | Author of the news. | -| teaser | str | Teaser of the news. | -| channels | str | Channels associated with the news. | -| stocks | str | Stocks associated with the news. | -| tags | str | Tags associated with the news. | -| updated | datetime | Updated date of the news. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | -| favicon | str | Icon image for the source of the article. | -| tags | List[str] | Tags for the article. | -| id | str | Unique Article ID. | -| score | float | Search relevance score for the article. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | -| site | str | News source. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | -| id | str | Article ID. | -| company | Dict[str, Any] | Company details related to the news article. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | datetime | The date of the data. The published date of the article. | -| title | str | Title of the article. | -| images | List[Dict[str, str]] | Images associated with the article. | -| text | str | Text/body of the article. | -| url | str | URL to the article. | -| symbols | str | Ticker tagged in the fetched news. | -| article_id | int | Unique ID of the news article. | -| site | str | News source. | -| tags | str | Tags associated with the news article. | -| crawl_date | datetime | Date the news article was crawled. | - - - - diff --git a/website/content/platform/reference/quantitative/_category_.json b/website/content/platform/reference/quantitative/_category_.json deleted file mode 100644 index 2b6455d3a896..000000000000 --- a/website/content/platform/reference/quantitative/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Quantitative", - "position": 1 -} \ No newline at end of file diff --git a/website/content/platform/reference/quantitative/capm.md b/website/content/platform/reference/quantitative/capm.md deleted file mode 100644 index 9a1c27e59c6a..000000000000 --- a/website/content/platform/reference/quantitative/capm.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "capm" -description: "Learn about the Capital Asset Pricing Model (CAPM), a widely-used finance theory for determining an investment's expected return based on its risk. Understand how CAPM can be used as an investment strategy to evaluate and select securities." -keywords: -- capital asset pricing model -- CAPM -- finance -- investment strategy ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get Capital Asset Pricing Model (CAPM). - - CAPM offers a streamlined way to assess the expected return on an investment while accounting for its risk relative - to the market. It's a cornerstone of modern financial theory that helps investors understand the trade-off between - risk and return, guiding more informed investment choices. - - -Examples --------- - -```python -from openbb import obb -# Get Capital Asset Pricing Model (CAPM). -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.quantitative.capm(data=stock_data, target='close') -obb.quantitative.capm(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Time series data. | | False | -| target | str | Target column name. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CAPMModel - CAPM model summary. -``` - diff --git a/website/content/platform/reference/quantitative/index.mdx b/website/content/platform/reference/quantitative/index.mdx deleted file mode 100644 index 33154b1d7ab1..000000000000 --- a/website/content/platform/reference/quantitative/index.mdx +++ /dev/null @@ -1,19 +0,0 @@ -# Quantitative - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Menus -
    - - - -
- -### Commands -
    - - - - -
- diff --git a/website/content/platform/reference/quantitative/normality.md b/website/content/platform/reference/quantitative/normality.md deleted file mode 100644 index ce17d1c49c38..000000000000 --- a/website/content/platform/reference/quantitative/normality.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "normality" -description: "Learn about normality statistics and their significance in data analysis. Discover different techniques such as kurtosis, skewness, Jarque-Bera, Shapiro-Wilk, and Kolmogorov-Smirnov for evaluating normality in time series data. Explore how these tests can help determine if a data sample follows a normal distribution." -keywords: -- normality statistics -- kurtosis -- skewness -- Jarque-Bera -- Shapiro-Wilk -- Kolmogorov-Smirnov -- time series data -- target column -- normality tests ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get Normality Statistics. - - - **Kurtosis**: whether the kurtosis of a sample differs from the normal distribution. - - **Skewness**: whether the skewness of a sample differs from the normal distribution. - - **Jarque-Bera**: whether the sample data has the skewness and kurtosis matching a normal distribution. - - **Shapiro-Wilk**: whether a random sample comes from a normal distribution. - - **Kolmogorov-Smirnov**: whether two underlying one-dimensional probability distributions differ. - - -Examples --------- - -```python -from openbb import obb -# Get Normality Statistics. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.quantitative.normality(data=stock_data, target='close') -obb.quantitative.normality(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Time series data. | | False | -| target | str | Target column name. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : NormalityModel - Normality tests summary. See qa_models.NormalityModel for details. -``` - diff --git a/website/content/platform/reference/quantitative/performance/_category_.json b/website/content/platform/reference/quantitative/performance/_category_.json deleted file mode 100644 index 908e2f7b7ae0..000000000000 --- a/website/content/platform/reference/quantitative/performance/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Performance", - "position": 2 -} \ No newline at end of file diff --git a/website/content/platform/reference/quantitative/performance/index.mdx b/website/content/platform/reference/quantitative/performance/index.mdx deleted file mode 100644 index 0c4c07fc4e75..000000000000 --- a/website/content/platform/reference/quantitative/performance/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ -# Performance - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - -
- diff --git a/website/content/platform/reference/quantitative/performance/omega_ratio.md b/website/content/platform/reference/quantitative/performance/omega_ratio.md deleted file mode 100644 index 28598f4ac4ff..000000000000 --- a/website/content/platform/reference/quantitative/performance/omega_ratio.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "omega_ratio" -description: "Calculate the Omega Ratio" -keywords: -- quantitative -- performance -- omega_ratio ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Omega Ratio. - - The Omega Ratio is a sophisticated metric that goes beyond traditional performance measures by considering the - probability of achieving returns above a given threshold. It offers a more nuanced view of risk and reward, - focusing on the likelihood of success rather than just average outcomes. - - -Examples --------- - -```python -from openbb import obb -# Get Omega Ratio. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.performance.omega_ratio(data=returns, target="close") -obb.quantitative.performance.omega_ratio(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Time series data. | | False | -| target | str | Target column name. | | False | -| threshold_start | float, optional | Start threshold, by default 0.0 | | False | -| threshold_end | float, optional | End threshold, by default 1.5 | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[OmegaModel] - Omega ratios. -``` - diff --git a/website/content/platform/reference/quantitative/performance/sharpe_ratio.md b/website/content/platform/reference/quantitative/performance/sharpe_ratio.md deleted file mode 100644 index 3bf6a986bb5d..000000000000 --- a/website/content/platform/reference/quantitative/performance/sharpe_ratio.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "sharpe_ratio" -description: "Get Rolling Sharpe Ratio" -keywords: -- quantitative -- performance -- sharpe_ratio ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get Rolling Sharpe Ratio. - - This function calculates the Sharpe Ratio, a metric used to assess the return of an investment compared to its risk. - By factoring in the risk-free rate, it helps you understand how much extra return you're getting for the extra - volatility that you endure by holding a riskier asset. The Sharpe Ratio is essential for investors looking to - compare the efficiency of different investments, providing a clear picture of potential rewards in relation to their - risks over a specified period. Ideal for gauging the effectiveness of investment strategies, it offers insights into - optimizing your portfolio for maximum return on risk. - - -Examples --------- - -```python -from openbb import obb -# Get Rolling Sharpe Ratio. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.performance.sharpe_ratio(data=returns, target="close") -obb.quantitative.performance.sharpe_ratio(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Time series data. | | False | -| target | str | Target column name. | | False | -| rfr | float, optional | Risk-free rate, by default 0.0 | | False | -| window | PositiveInt, optional | Window size, by default 252 | | False | -| index | str, optional | Returns | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - Sharpe ratio. -``` - diff --git a/website/content/platform/reference/quantitative/performance/sortino_ratio.md b/website/content/platform/reference/quantitative/performance/sortino_ratio.md deleted file mode 100644 index 4f5970df108e..000000000000 --- a/website/content/platform/reference/quantitative/performance/sortino_ratio.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "sortino_ratio" -description: "Get rolling Sortino Ratio" -keywords: -- quantitative -- performance -- sortino_ratio ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get rolling Sortino Ratio. - - The Sortino Ratio enhances the evaluation of investment returns by distinguishing harmful volatility - from total volatility. Unlike other metrics that treat all volatility as risk, this command specifically assesses - the volatility of negative returns relative to a target or desired return. - It's particularly useful for investors who are more concerned with downside risk than with overall volatility. - By calculating the Sortino Ratio, investors can better understand the risk-adjusted return of their investments, - focusing on the likelihood and impact of negative returns. - This approach offers a more nuanced tool for portfolio optimization, especially in strategies aiming - to minimize the downside. - - For method & terminology see: - http://www.redrockcapital.com/Sortino__A__Sharper__Ratio_Red_Rock_Capital.pdf - - -Examples --------- - -```python -from openbb import obb -# Get Rolling Sortino Ratio. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.performance.sortino_ratio(data=stock_data, target="close") -obb.quantitative.performance.sortino_ratio(data=stock_data, target="close", target_return=0.01, window=126, adjusted=True) -obb.quantitative.performance.sortino_ratio(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| http | //www.redrockcapital.com/Sortino__A__Sharper__Ratio_Red_Rock_Capital.pdf | Parameters | | False | -| data | List[Data] | Time series data. | | False | -| target | str | Target column name. | | False | -| target_return | float, optional | Target return, by default 0.0 | | False | -| window | PositiveInt, optional | Window size, by default 252 | | False | -| adjusted | bool, optional | Adjust sortino ratio to compare it to sharpe ratio, by default False | | False | -| index | str | Index column for input data | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - Sortino ratio. -``` - diff --git a/website/content/platform/reference/quantitative/rolling/_category_.json b/website/content/platform/reference/quantitative/rolling/_category_.json deleted file mode 100644 index 6095332ec70b..000000000000 --- a/website/content/platform/reference/quantitative/rolling/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Rolling", - "position": 1 -} \ No newline at end of file diff --git a/website/content/platform/reference/quantitative/rolling/index.mdx b/website/content/platform/reference/quantitative/rolling/index.mdx deleted file mode 100644 index 7ff046ca6e74..000000000000 --- a/website/content/platform/reference/quantitative/rolling/index.mdx +++ /dev/null @@ -1,14 +0,0 @@ -# Rolling - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - - - -
- diff --git a/website/content/platform/reference/quantitative/rolling/kurtosis.md b/website/content/platform/reference/quantitative/rolling/kurtosis.md deleted file mode 100644 index 93cdd5f52b23..000000000000 --- a/website/content/platform/reference/quantitative/rolling/kurtosis.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "kurtosis" -description: "Calculate the rolling kurtosis of a target column within a given window size" -keywords: -- quantitative -- rolling -- kurtosis ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the rolling kurtosis of a target column within a given window size. - - Kurtosis measures the "tailedness" of the probability distribution of a real-valued random variable. - High kurtosis indicates a distribution with heavy tails (outliers), suggesting a higher risk of extreme outcomes. - Low kurtosis indicates a distribution with lighter tails (less outliers), suggesting less risk of extreme outcomes. - This function helps in assessing the risk of outliers in financial returns or other time series data over a specified - rolling window. - - -Examples --------- - -```python -from openbb import obb -# Get Rolling Kurtosis. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.rolling.kurtosis(data=returns, target="close", window=252) -obb.quantitative.rolling.kurtosis(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The time series data as a list of data points. | | False | -| target | str | The name of the column for which to calculate kurtosis. | | False | -| window | PositiveInt | The number of observations used for calculating the rolling measure. | | False | -| index | str, optional | The name of the index column, default is "date". | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - An object containing the rolling kurtosis values. -``` - diff --git a/website/content/platform/reference/quantitative/rolling/mean.md b/website/content/platform/reference/quantitative/rolling/mean.md deleted file mode 100644 index 472658dc8162..000000000000 --- a/website/content/platform/reference/quantitative/rolling/mean.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "mean" -description: "Calculate the rolling mean (average) of a target column within a given window size" -keywords: -- quantitative -- rolling -- mean ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the rolling mean (average) of a target column within a given window size. - - The rolling mean is a simple moving average that calculates the average of a target variable over a specified window. - This function is widely used in financial analysis to smooth short-term fluctuations and highlight longer-term trends - or cycles in time series data. - - -Examples --------- - -```python -from openbb import obb -# Get Rolling Mean. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.rolling.mean(data=returns, target="close", window=252) -obb.quantitative.rolling.mean(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The time series data as a list of data points. | | False | -| target | str | The name of the column for which to calculate the mean. | | False | -| window | PositiveInt | The number of observations used for calculating the rolling measure. | | False | -| index | str, optional | The name of the index column, default is "date". | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - An object containing the rolling mean values. -``` - diff --git a/website/content/platform/reference/quantitative/rolling/quantile.md b/website/content/platform/reference/quantitative/rolling/quantile.md deleted file mode 100644 index dc35ec91905f..000000000000 --- a/website/content/platform/reference/quantitative/rolling/quantile.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "quantile" -description: "Calculate the rolling quantile of a target column within a given window size at a specified quantile percentage" -keywords: -- quantitative -- rolling -- quantile ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the rolling quantile of a target column within a given window size at a specified quantile percentage. - - Quantiles are points dividing the range of a probability distribution into intervals with equal probabilities, - or dividing the sample in the same way. This function is useful for understanding the distribution of data - within a specified window, allowing for analysis of trends, identification of outliers, and assessment of risk. - - -Examples --------- - -```python -from openbb import obb -# Get Rolling Quantile. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.rolling.quantile(data=returns, target="close", window=252, quantile_pct=0.25) -obb.quantitative.rolling.quantile(data=returns, target="close", window=252, quantile_pct=0.75) -obb.quantitative.rolling.quantile(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The time series data as a list of data points. | | False | -| target | str | The name of the column for which to calculate the quantile. | | False | -| window | PositiveInt | The number of observations used for calculating the rolling measure. | | False | -| quantile_pct | NonNegativeFloat, optional | The quantile percentage to calculate (e.g., 0.5 for median), default is 0.5. | | False | -| index | str, optional | The name of the index column, default is "date". | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - An object containing the rolling quantile values with the median. -``` - diff --git a/website/content/platform/reference/quantitative/rolling/skew.md b/website/content/platform/reference/quantitative/rolling/skew.md deleted file mode 100644 index 1209041c2322..000000000000 --- a/website/content/platform/reference/quantitative/rolling/skew.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "skew" -description: "Get Rolling Skew" -keywords: -- quantitative -- rolling -- skew ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get Rolling Skew. - - Skew is a statistical measure that reveals the degree of asymmetry of a distribution around its mean. - Positive skewness indicates a distribution with an extended tail to the right, while negative skewness shows a tail - that stretches left. Understanding skewness can provide insights into potential biases in data and help anticipate - the nature of future data points. It's particularly useful for identifying the likelihood of extreme outcomes in - financial returns, enabling more informed decision-making based on the distribution's shape over a specified period. - - -Examples --------- - -```python -from openbb import obb -# Get Rolling Mean. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.rolling.skew(data=returns, target="close") -obb.quantitative.rolling.skew(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Time series data. | | False | -| target | str | Target column name. | | False | -| window | PositiveInt | Window size. | | False | -| index | str, optional | Index column name, by default "date" | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - Rolling skew. -``` - diff --git a/website/content/platform/reference/quantitative/rolling/stdev.md b/website/content/platform/reference/quantitative/rolling/stdev.md deleted file mode 100644 index e3cd46d683a6..000000000000 --- a/website/content/platform/reference/quantitative/rolling/stdev.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "stdev" -description: "Calculate the rolling standard deviation of a target column within a given window size" -keywords: -- quantitative -- rolling -- stdev ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the rolling standard deviation of a target column within a given window size. - - Standard deviation is a measure of the amount of variation or dispersion of a set of values. - It is widely used to assess the risk and volatility of financial returns or other time series data - over a specified rolling window. It is the square root of the variance. - - -Examples --------- - -```python -from openbb import obb -# Get Rolling Standard Deviation. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.rolling.stdev(data=returns, target="close", window=252) -obb.quantitative.rolling.stdev(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The time series data as a list of data points. | | False | -| target | str | The name of the column for which to calculate standard deviation. | | False | -| window | PositiveInt | The number of observations used for calculating the rolling measure. | | False | -| index | str, optional | The name of the index column, default is "date". | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - An object containing the rolling standard deviation values. -``` - diff --git a/website/content/platform/reference/quantitative/rolling/variance.md b/website/content/platform/reference/quantitative/rolling/variance.md deleted file mode 100644 index b3cf63a115eb..000000000000 --- a/website/content/platform/reference/quantitative/rolling/variance.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "variance" -description: "Calculate the rolling variance of a target column within a given window size" -keywords: -- quantitative -- rolling -- variance ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the rolling variance of a target column within a given window size. - - Variance measures the dispersion of a set of data points around their mean. It is a key metric for - assessing the volatility and stability of financial returns or other time series data over a specified rolling window. - - -Examples --------- - -```python -from openbb import obb -# Get Rolling Variance. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.rolling.variance(data=returns, target="close", window=252) -obb.quantitative.rolling.variance(target='close', window=2, data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The time series data as a list of data points. | | False | -| target | str | The name of the column for which to calculate variance. | | False | -| window | PositiveInt | The number of observations used for calculating the rolling measure. | | False | -| index | str, optional | The name of the index column, default is "date". | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - An object containing the rolling variance values. -``` - diff --git a/website/content/platform/reference/quantitative/stats/_category_.json b/website/content/platform/reference/quantitative/stats/_category_.json deleted file mode 100644 index ee60edacadbd..000000000000 --- a/website/content/platform/reference/quantitative/stats/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Stats", - "position": 3 -} \ No newline at end of file diff --git a/website/content/platform/reference/quantitative/stats/index.mdx b/website/content/platform/reference/quantitative/stats/index.mdx deleted file mode 100644 index 5bcc16543017..000000000000 --- a/website/content/platform/reference/quantitative/stats/index.mdx +++ /dev/null @@ -1,14 +0,0 @@ -# Stats - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - - - -
- diff --git a/website/content/platform/reference/quantitative/stats/kurtosis.md b/website/content/platform/reference/quantitative/stats/kurtosis.md deleted file mode 100644 index 59a44561c647..000000000000 --- a/website/content/platform/reference/quantitative/stats/kurtosis.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "kurtosis" -description: "Calculate the rolling kurtosis of a target column" -keywords: -- quantitative -- stats -- kurtosis ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the rolling kurtosis of a target column. - - Kurtosis measures the "tailedness" of the probability distribution of a real-valued random variable. - High kurtosis indicates a distribution with heavy tails (outliers), suggesting a higher risk of extreme outcomes. - Low kurtosis indicates a distribution with lighter tails (less outliers), suggesting less risk of extreme outcomes. - This function helps in assessing the risk of outliers in financial returns or other time series data. - - -Examples --------- - -```python -from openbb import obb -# Get Kurtosis. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.stats.kurtosis(data=returns, target="close") -obb.quantitative.stats.kurtosis(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The time series data as a list of data points. | | False | -| target | str | The name of the column for which to calculate kurtosis. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - An object containing the kurtosis value -``` - diff --git a/website/content/platform/reference/quantitative/stats/mean.md b/website/content/platform/reference/quantitative/stats/mean.md deleted file mode 100644 index 4260d09d5bbb..000000000000 --- a/website/content/platform/reference/quantitative/stats/mean.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "mean" -description: "Calculate the mean (average) of a target column" -keywords: -- quantitative -- stats -- mean ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the mean (average) of a target column. - - The rolling mean is a simple moving average that calculates the average of a target variable. - This function is widely used in financial analysis to smooth short-term fluctuations and highlight longer-term trends - or cycles in time series data. - - -Examples --------- - -```python -from openbb import obb -# Get Mean. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.stats.mean(data=returns, target="close") -obb.quantitative.stats.mean(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The time series data as a list of data points. | | False | -| target | str | The name of the column for which to calculate the mean. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - An object containing the mean value. -``` - diff --git a/website/content/platform/reference/quantitative/stats/quantile.md b/website/content/platform/reference/quantitative/stats/quantile.md deleted file mode 100644 index d92d63d7d3ef..000000000000 --- a/website/content/platform/reference/quantitative/stats/quantile.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "quantile" -description: "Calculate the quantile of a target column at a specified quantile percentage" -keywords: -- quantitative -- stats -- quantile ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the quantile of a target column at a specified quantile percentage. - - Quantiles are points dividing the range of a probability distribution into intervals with equal probabilities, - or dividing the sample in the same way. - - -Examples --------- - -```python -from openbb import obb -# Get Quantile. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.stats.quantile(data=returns, target="close", quantile_pct=0.75) -obb.quantitative.stats.quantile(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The time series data as a list of data points. | | False | -| target | str | The name of the column for which to calculate the quantile. | | False | -| quantile_pct | NonNegativeFloat, optional | The quantile percentage to calculate (e.g., 0.5 for median), default is 0.5. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - An object containing the rolling quantile values with the median. -``` - diff --git a/website/content/platform/reference/quantitative/stats/skew.md b/website/content/platform/reference/quantitative/stats/skew.md deleted file mode 100644 index 039fcb2f31fc..000000000000 --- a/website/content/platform/reference/quantitative/stats/skew.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "skew" -description: "Get the skew of the data set" -keywords: -- quantitative -- stats -- skew ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get the skew of the data set. - - Skew is a statistical measure that reveals the degree of asymmetry of a distribution around its mean. - Positive skewness indicates a distribution with an extended tail to the right, while negative skewness shows a tail - that stretches left. Understanding skewness can provide insights into potential biases in data and help anticipate - the nature of future data points. It's particularly useful for identifying the likelihood of extreme outcomes in - financial returns, enabling more informed decision-making based on the distribution's shape over a specified period. - - -Examples --------- - -```python -from openbb import obb -# Get Skewness. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.stats.skew(data=returns, target="close") -obb.quantitative.stats.skew(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Time series data. | | False | -| target | str | Target column name. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - Rolling skew. -``` - diff --git a/website/content/platform/reference/quantitative/stats/stdev.md b/website/content/platform/reference/quantitative/stats/stdev.md deleted file mode 100644 index a78546bc0b23..000000000000 --- a/website/content/platform/reference/quantitative/stats/stdev.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "stdev" -description: "Calculate the rolling standard deviation of a target column" -keywords: -- quantitative -- stats -- stdev ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the rolling standard deviation of a target column. - - Standard deviation is a measure of the amount of variation or dispersion of a set of values. - It is widely used to assess the risk and volatility of financial returns or other time series data - It is the square root of the variance. - - -Examples --------- - -```python -from openbb import obb -# Get Standard Deviation. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.stats.stdev(data=returns, target="close") -obb.quantitative.stats.stdev(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The time series data as a list of data points. | | False | -| target | str | The name of the column for which to calculate standard deviation. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - An object containing the rolling standard deviation values. -``` - diff --git a/website/content/platform/reference/quantitative/stats/variance.md b/website/content/platform/reference/quantitative/stats/variance.md deleted file mode 100644 index 4eb177c2304e..000000000000 --- a/website/content/platform/reference/quantitative/stats/variance.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "variance" -description: "Calculate the variance of a target column" -keywords: -- quantitative -- stats -- variance ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the variance of a target column. - - Variance measures the dispersion of a set of data points around their mean. It is a key metric for - assessing the volatility and stability of financial returns or other time series data. - - -Examples --------- - -```python -from openbb import obb -# Get Variance. -stock_data = obb.equity.price.historical(symbol="TSLA", start_date="2023-01-01", provider="fmp").to_df() -returns = stock_data["close"].pct_change().dropna() -obb.quantitative.stats.variance(data=returns, target="close") -obb.quantitative.stats.variance(target='close', data=[{'date': '2023-01-02', 'close': 0.05}, {'date': '2023-01-03', 'close': 0.08}, {'date': '2023-01-04', 'close': 0.07}, {'date': '2023-01-05', 'close': 0.06}, {'date': '2023-01-06', 'close': 0.06}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The time series data as a list of data points. | | False | -| target | str | The name of the column for which to calculate variance. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - An object containing the rolling variance values. -``` - diff --git a/website/content/platform/reference/quantitative/summary.md b/website/content/platform/reference/quantitative/summary.md deleted file mode 100644 index b6338c116d1a..000000000000 --- a/website/content/platform/reference/quantitative/summary.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "summary" -description: "Learn how to get summary statistics on time series data using Python. This documentation page provides information on the parameters and return value of the function." -keywords: -- summary statistics -- get summary statistics -- summary table -- python -- time series data -- target column ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get Summary Statistics. - - The summary that offers a snapshot of its central tendencies, variability, and distribution. - This command calculates essential statistics, including mean, standard deviation, variance, - and specific percentiles, to provide a detailed profile of your target column. B - y examining these metrics, you gain insights into the data's overall behavior, helping to identify patterns, - outliers, or anomalies. The summary table is an invaluable tool for initial data exploration, - ensuring you have a solid foundation for further analysis or reporting. - - -Examples --------- - -```python -from openbb import obb -# Get Summary Statistics. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.quantitative.summary(data=stock_data, target='close') -obb.quantitative.summary(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Time series data. | | False | -| target | str | Target column name. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : SummaryModel - Summary table. -``` - diff --git a/website/content/platform/reference/quantitative/unitroot_test.md b/website/content/platform/reference/quantitative/unitroot_test.md deleted file mode 100644 index ca1d6d68b9c8..000000000000 --- a/website/content/platform/reference/quantitative/unitroot_test.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "unitroot_test" -description: "Learn about the Unit Root Test function in Python, including the Augmented Dickey-Fuller test and the Kwiatkowski-Phillips-Schmidt-Shin test. Explore the parameters, such as data, target, fuller_reg, and kpss_reg, and understand how to interpret the unit root tests summary." -keywords: -- Unit Root Test -- Augmented Dickey-Fuller test -- Kwiatkowski-Phillips-Schmidt-Shin test -- data -- target -- fuller_reg -- kpss_reg -- Time series data -- unit root tests -- unit root tests summary ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Get Unit Root Test. - - This function applies two renowned tests to assess whether your data series is stationary or if it contains a unit - root, indicating it may be influenced by time-based trends or seasonality. The Augmented Dickey-Fuller (ADF) test - helps identify the presence of a unit root, suggesting that the series could be non-stationary and potentially - unpredictable over time. On the other hand, the Kwiatkowski-Phillips-Schmidt-Shin (KPSS) test checks for the - stationarity of the series, where failing to reject the null hypothesis indicates a stable, stationary series. - Together, these tests provide a comprehensive view of your data's time series properties, essential for - accurate modeling and forecasting. - - -Examples --------- - -```python -from openbb import obb -# Get Unit Root Test. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df() -obb.quantitative.unitroot_test(data=stock_data, target='close') -obb.quantitative.unitroot_test(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | Time series data. | | False | -| target | str | Target column name. | | False | -| fuller_reg | Literal["c", "ct", "ctt", "nc", "c"] | Regression type for ADF test. | | False | -| kpss_reg | Literal["c", "ct"] | Regression type for KPSS test. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : UnitRootModel - Unit root tests summary. -``` - diff --git a/website/content/platform/reference/regulators/_category_.json b/website/content/platform/reference/regulators/_category_.json deleted file mode 100644 index e4c27103a273..000000000000 --- a/website/content/platform/reference/regulators/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Regulators", - "position": 13 -} \ No newline at end of file diff --git a/website/content/platform/reference/regulators/cftc/_category_.json b/website/content/platform/reference/regulators/cftc/_category_.json deleted file mode 100644 index 78a857e1e2d5..000000000000 --- a/website/content/platform/reference/regulators/cftc/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Cftc", - "position": 2 -} \ No newline at end of file diff --git a/website/content/platform/reference/regulators/cftc/cot.md b/website/content/platform/reference/regulators/cftc/cot.md deleted file mode 100644 index 01cecbae2ff3..000000000000 --- a/website/content/platform/reference/regulators/cftc/cot.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "cot" -description: "Learn how to lookup Commitment of Traders Reports by series ID and view the results, metadata, warnings, and charts associated with the reports. Understand the available parameters such as default report, provider, data type, legacy format, report type, measure, start date, end date, and transform." -keywords: -- Commitment of Traders Reports -- lookup -- series ID -- CFTC -- regulators -- default report -- provider -- data type -- legacy format -- report type -- measure -- start date -- end date -- transform -- results -- metadata -- warnings -- chart -- traders -- date ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Commitment of Traders Reports. - - -Examples --------- - -```python -from openbb import obb -obb.regulators.cftc.cot(provider='nasdaq') -# Get the Commitment of Traders Report for Gold. -obb.regulators.cftc.cot(id='GC=F', provider='nasdaq') -# Enter the report ID by the Nasdaq Data Link Code. -obb.regulators.cftc.cot(id='088691', provider='nasdaq') -# Get the report for futures only. -obb.regulators.cftc.cot(id='088691', data_type=F, provider='nasdaq') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| id | str | The series ID string for the report. Default report is Two-Year Treasury Note Futures. | 042601 | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| id | str | The series ID string for the report. Default report is Two-Year Treasury Note Futures. | 042601 | True | -| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| end_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True | -| transform | Literal['diff', 'rdiff', 'cumul', 'normalize'] | Transform the data as difference, percent change, cumulative, or normalize. | None | True | -| collapse | Literal['daily', 'weekly', 'monthly', 'quarterly', 'annual'] | Collapse the frequency of the time series. | None | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | -| data_type | Literal['F', 'FO', 'CITS'] | The type of data to reuturn. Default is 'FO'. F = Futures only FO = Futures and Options CITS = Commodity Index Trader Supplemental. Only valid for commodities. | FO | True | -| legacy_format | bool | Returns the legacy format of report. Default is False. | False | True | -| report_type | Literal['ALL', 'CHG', 'OLD', 'OTR'] | The type of report to return. Default is 'ALL'. ALL = All CHG = Change in Positions OLD = Old Crop Years OTR = Other Crop Years | ALL | True | -| measure | Literal['CR', 'NT', 'OI', 'CHG'] | The measure to return. Default is None. CR = Concentration Ratios NT = Number of Traders OI = Percent of Open Interest CHG = Change in Positions. Only valid when data_type is 'CITS'. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : COT - Serializable results. - provider : Literal['nasdaq'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| date | date | The date of the data. | - - - - diff --git a/website/content/platform/reference/regulators/cftc/cot_search.md b/website/content/platform/reference/regulators/cftc/cot_search.md deleted file mode 100644 index 33f7fafc2c5b..000000000000 --- a/website/content/platform/reference/regulators/cftc/cot_search.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: "cot_search" -description: "Learn about curated Commitment of Traders Reports series information and how to perform a search for specific data. Find details on the parameters, data returned, and available CFTC codes." -keywords: -- Commitment of Traders Reports -- curated COT Reports series -- CFTC Code -- underlying asset -- search query -- provider -- results -- warnings -- chart object -- metadata info -- CFTC ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Curated Commitment of Traders Reports. - -Search a list of curated Commitment of Traders Reports series information. - - -Examples --------- - -```python -from openbb import obb -obb.regulators.cftc.cot_search(provider='nasdaq') -obb.regulators.cftc.cot_search(query='gold', provider='nasdaq') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : COTSearch - Serializable results. - provider : Literal['nasdaq'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| code | str | CFTC Code of the report. | -| name | str | Name of the underlying asset. | -| category | str | Category of the underlying asset. | -| subcategory | str | Subcategory of the underlying asset. | -| units | str | The units for one contract. | -| symbol | str | Symbol representing the entity requested in the data. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| code | str | CFTC Code of the report. | -| name | str | Name of the underlying asset. | -| category | str | Category of the underlying asset. | -| subcategory | str | Subcategory of the underlying asset. | -| units | str | The units for one contract. | -| symbol | str | Symbol representing the entity requested in the data. | - - - - diff --git a/website/content/platform/reference/regulators/cftc/index.mdx b/website/content/platform/reference/regulators/cftc/index.mdx deleted file mode 100644 index f8182d88bc17..000000000000 --- a/website/content/platform/reference/regulators/cftc/index.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Cftc - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - -
- diff --git a/website/content/platform/reference/regulators/index.mdx b/website/content/platform/reference/regulators/index.mdx deleted file mode 100644 index bf5d1cd7f15c..000000000000 --- a/website/content/platform/reference/regulators/index.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Regulators - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Menus -
    - - -
- diff --git a/website/content/platform/reference/regulators/sec/_category_.json b/website/content/platform/reference/regulators/sec/_category_.json deleted file mode 100644 index 81faa30a6ce2..000000000000 --- a/website/content/platform/reference/regulators/sec/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Sec", - "position": 1 -} \ No newline at end of file diff --git a/website/content/platform/reference/regulators/sec/cik_map.md b/website/content/platform/reference/regulators/sec/cik_map.md deleted file mode 100644 index 4cdcd20e7319..000000000000 --- a/website/content/platform/reference/regulators/sec/cik_map.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: "cik_map" -description: "Learn how to retrieve the CIK number corresponding to a ticker symbol using the python obb.regulators.sec.cik_map function. Understand the available parameters, return values, and data structure." -keywords: -- CIK number -- ticker symbol -- python obb.regulators.sec.cik_map function -- get data for symbol -- provider parameter -- returns -- results -- warnings -- chart object -- metadata info -- data -- central index key ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Map a ticker symbol to a CIK number. - - -Examples --------- - -```python -from openbb import obb -obb.regulators.sec.cik_map(symbol='MSFT', provider='sec') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| symbol | str | Symbol to get data for. | | False | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : CikMap - Serializable results. - provider : Literal['sec'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| cik | Union[int, str] | Central Index Key (CIK) for the requested entity. | - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| cik | Union[int, str] | Central Index Key (CIK) for the requested entity. | - - - - diff --git a/website/content/platform/reference/regulators/sec/index.mdx b/website/content/platform/reference/regulators/sec/index.mdx deleted file mode 100644 index 30ba5b4cef1f..000000000000 --- a/website/content/platform/reference/regulators/sec/index.mdx +++ /dev/null @@ -1,14 +0,0 @@ -# Sec - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - - - -
- diff --git a/website/content/platform/reference/regulators/sec/institutions_search.md b/website/content/platform/reference/regulators/sec/institutions_search.md deleted file mode 100644 index 2615da656826..000000000000 --- a/website/content/platform/reference/regulators/sec/institutions_search.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: "institutions_search" -description: "Learn how to use the OBB.regulators.sec.institutions_search() method to look up institutions regulated by the SEC. This method allows you to search for institutions based on various parameters such as the query and provider. It returns a list of search results and provides additional attributes like warnings, chart, and metadata. Explore the attributes like name and cik for more details on the institution." -keywords: -- institutions regulated by the SEC -- SEC regulated institutions lookup -- SEC regulated institutions search -- SEC institutions search query -- OBB regulator -- InstitutionsSearch class -- provider parameter -- query parameter -- use_cache parameter -- results attribute -- warnings attribute -- chart attribute -- metadata attribute -- name attribute -- cik attribute ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Search SEC-regulated institutions by name and return a list of results with CIK numbers. - - -Examples --------- - -```python -from openbb import obb -obb.regulators.sec.institutions_search(provider='sec') -obb.regulators.sec.institutions_search(query='blackstone real estate', provider='sec') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : InstitutionsSearch - Serializable results. - provider : Literal['sec'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| name | str | The name of the institution. | -| cik | Union[int, str] | Central Index Key (CIK) | - - - - diff --git a/website/content/platform/reference/regulators/sec/rss_litigation.md b/website/content/platform/reference/regulators/sec/rss_litigation.md deleted file mode 100644 index 208d936555cb..000000000000 --- a/website/content/platform/reference/regulators/sec/rss_litigation.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: "rss_litigation" -description: "Learn how to use the RSS feed to access litigation releases, including civil lawsuits brought by the Commission in federal court. This documentation provides details about the 'obb.regulators.sec.rss_litigation' python function, its parameters and return values, as well as the data structure used for the releases." -keywords: -- RSS feed -- litigation releases -- civil lawsuits -- Commission -- federal court -- python -- obb.regulators.sec.rss_litigation -- provider -- parameters -- returns -- data -- published -- title -- summary -- id -- link ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -The RSS feed provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court. - - -Examples --------- - -```python -from openbb import obb -obb.regulators.sec.rss_litigation(provider='sec') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : RssLitigation - Serializable results. - provider : Literal['sec'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| published | datetime | The date of publication. | -| title | str | The title of the release. | -| summary | str | Short summary of the release. | -| id | str | The identifier associated with the release. | -| link | str | URL to the release. | - - - - diff --git a/website/content/platform/reference/regulators/sec/schema_files.md b/website/content/platform/reference/regulators/sec/schema_files.md deleted file mode 100644 index aebc67ab78a6..000000000000 --- a/website/content/platform/reference/regulators/sec/schema_files.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: "schema_files" -description: "Get lists of SEC XML schema files by year with the OBBect function. Returns serializable results, provider name, warnings list, chart object, metadata info, and data including a list of URLs to SEC Schema Files." -keywords: -- SEC XML schema files -- SEC XML schema files by year -- get SEC XML schema files -- OBBect -- Serializable results -- provider name -- warnings list -- chart object -- metadata info -- fetch URL path -- data -- list of URLs to SEC Schema Files ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -A tool for navigating the directory of SEC XML schema files by year. - - -Examples --------- - -```python -from openbb import obb -obb.regulators.sec.schema_files(provider='sec') -# Get a list of schema files. -data = obb.regulators.sec.schema_files().results -data.files[0] -'https://xbrl.fasb.org/us-gaap/' -# The directory structure can be navigated by constructing a URL from the 'results' list. -url = data.files[0]+data.files[-1] -# The URL base will always be the 0 position in the list, feed the URL back in as a parameter. -obb.regulators.sec.schema_files(url=url).results.files -['https://xbrl.fasb.org/us-gaap/2024/' -'USGAAP2024FileList.xml' -'dis/' -'dqcrules/' -'ebp/' -'elts/' -'entire/' -'meta/' -'stm/' -'us-gaap-2024.zip'] -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | -| url | str | Enter an optional URL path to fetch the next level. | None | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : SchemaFiles - Serializable results. - provider : Literal['sec'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| files | List[str] | Dictionary of URLs to SEC Schema Files | - - - - diff --git a/website/content/platform/reference/regulators/sec/sic_search.md b/website/content/platform/reference/regulators/sec/sic_search.md deleted file mode 100644 index 69087528e08a..000000000000 --- a/website/content/platform/reference/regulators/sec/sic_search.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: "sic_search" -description: "Learn how to perform a search for industry titles, reporting office, and SIC codes using Python. Explore the parameters, returns, and data associated with the `obb.regulators.sec.sic_search` function." -keywords: -- search -- industry titles -- reporting office -- SIC codes -- Python -- search query -- provider -- cache -- results -- warnings -- chart -- metadata -- data -- sector industrial code -- industry title -- reporting office -- Corporate Finance Office ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Search for Industry Titles, Reporting Office, and SIC Codes. An empty query string returns all results. - - -Examples --------- - -```python -from openbb import obb -obb.regulators.sec.sic_search(provider='sec') -obb.regulators.sec.sic_search(query='real estate investment trusts', provider='sec') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : SicSearch - Serializable results. - provider : Literal['sec'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| sic | int | Sector Industrial Code (SIC) | -| industry | str | Industry title. | -| office | str | Reporting office within the Corporate Finance Office | - - - - diff --git a/website/content/platform/reference/regulators/sec/symbol_map.md b/website/content/platform/reference/regulators/sec/symbol_map.md deleted file mode 100644 index 235ccc7e86ba..000000000000 --- a/website/content/platform/reference/regulators/sec/symbol_map.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: "symbol_map" -description: "Retrieve the ticker symbol corresponding to a company CIK using the OBB API endpoint. This function allows you to perform a search query and get the results along with additional metadata, warnings, and optional chart data." -keywords: -- ticker symbol -- CIK -- company -- ticker mapping -- search query -- provider -- results -- warnings -- chart -- metadata -- data -- symbol -- entity ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Map a CIK number to a ticker symbol, leading 0s can be omitted or included. - - -Examples --------- - -```python -from openbb import obb -obb.regulators.sec.symbol_map(query='0000789019', provider='sec') -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | False | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | False | -| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True | -| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : SymbolMap - Serializable results. - provider : Literal['sec'] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. - -``` - ---- - -## Data - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | - - - - - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | - - - - diff --git a/website/content/platform/reference/technical/_category_.json b/website/content/platform/reference/technical/_category_.json deleted file mode 100644 index a24ed7eff3dd..000000000000 --- a/website/content/platform/reference/technical/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Technical", - "position": 14 -} \ No newline at end of file diff --git a/website/content/platform/reference/technical/ad.md b/website/content/platform/reference/technical/ad.md deleted file mode 100644 index e7ebf31e09e5..000000000000 --- a/website/content/platform/reference/technical/ad.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "ad" -description: "Learn about the Accumulation/Distribution Line and how it is interpreted to detect trends in price movement. Explore its parameters, usage, and see code examples." -keywords: -- Accumulation/Distribution Line -- On Balance Volume -- CLV -- divergence -- price -- trending upward -- flat -- flattening of the price -- Parameters -- data -- index -- offset -- Returns -- Examples ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Accumulation/Distribution Line. - - Similar to the On Balance Volume (OBV). - Sums the volume times +1/-1 based on whether the close is higher than the previous - close. The Accumulation/Distribution indicator, however multiplies the volume by the - close location value (CLV). The CLV is based on the movement of the issue within a - single bar and can be +1, -1 or zero. - - - The Accumulation/Distribution Line is interpreted by looking for a divergence in - the direction of the indicator relative to price. If the Accumulation/Distribution - Line is trending upward it indicates that the price may follow. Also, if the - Accumulation/Distribution Line becomes flat while the price is still rising (or falling) - then it signals an impending flattening of the price. - - -Examples --------- - -```python -from openbb import obb -# Get the Accumulation/Distribution Line. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -ad_data = obb.technical.ad(data=stock_data.results, offset=0) -obb.technical.ad(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| offset | int, optional | Offset of the AD, by default 0. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/adosc.md b/website/content/platform/reference/technical/adosc.md deleted file mode 100644 index bf08a3ae79aa..000000000000 --- a/website/content/platform/reference/technical/adosc.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "adosc" -description: "Learn about the Accumulation/Distribution Oscillator, also known as the Chaikin Oscillator. This momentum indicator examines the strength of price moves and underlying buying and selling pressure. Discover how divergence between the indicator and price signals market turning points. Explore the parameters, data, and examples for using this oscillator in your analysis." -keywords: -- Accumulation/Distribution Oscillator -- Chaikin Oscillator -- momentum indicator -- Accumulation-Distribution line -- buying pressure -- selling pressure -- divergence -- market turning points -- parameters -- data -- fast calculation -- slow calculation -- offset -- returns -- examples ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Accumulation/Distribution Oscillator. - - Also known as the Chaikin Oscillator. - - Essentially a momentum indicator, but of the Accumulation-Distribution line - rather than merely price. It looks at both the strength of price moves and the - underlying buying and selling pressure during a given time period. The oscillator - reading above zero indicates net buying pressure, while one below zero registers - net selling pressure. Divergence between the indicator and pure price moves are - the most common signals from the indicator, and often flag market turning points. - - -Examples --------- - -```python -from openbb import obb -# Get the Accumulation/Distribution Oscillator. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -adosc_data = obb.technical.adosc(data=stock_data.results, fast=3, slow=10, offset=0) -obb.technical.adosc(fast=2, slow=4, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| fast | PositiveInt, optional | Number of periods to be used for the fast calculation, by default 3. | | False | -| slow | PositiveInt, optional | Number of periods to be used for the slow calculation, by default 10. | | False | -| offset | int, optional | Offset to be used for the calculation, by default 0. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/adx.md b/website/content/platform/reference/technical/adx.md deleted file mode 100644 index 8283f88d8cc8..000000000000 --- a/website/content/platform/reference/technical/adx.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "adx" -description: "Learn about ADX, a Welles Wilder style moving average of the Directional Movement Index. Understand its calculation, interpretation, and usage with stock data. Explore examples for implementation." -keywords: -- ADX -- Welles Wilder -- moving average -- Directional Movement Index -- trend -- calculation -- data -- index column -- length -- scalar value -- drift -- interpretation -- stock data -- historical data -- examples ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Average Directional Index (ADX). - - The ADX is a Welles Wilder style moving average of the Directional Movement Index (DX). - The values range from 0 to 100, but rarely get above 60. To interpret the ADX, consider - a high number to be a strong trend, and a low number, a weak trend. - - -Examples --------- - -```python -from openbb import obb -# Get the Average Directional Index (ADX). -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -adx_data = obb.technical.adx(data=stock_data.results, length=50, scalar=100.0, drift=1) -obb.technical.adx(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| length | int, optional | Number of periods for the ADX, by default 50. | | False | -| scalar | float, optional | Scalar value for the ADX, by default 100.0. | | False | -| drift | int, optional | Drift value for the ADX, by default 1. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/aroon.md b/website/content/platform/reference/technical/aroon.md deleted file mode 100644 index 673da1a76b03..000000000000 --- a/website/content/platform/reference/technical/aroon.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "aroon" -description: "Learn about the Aroon Indicator, a trend indicator in technical analysis. Understand how the Aroon Up and Down lines can help identify upward and downward trends, and how to calculate and use the Aroon Indicator. Includes examples and parameters." -keywords: -- Aroon Indicator -- Aroon Up and Down -- Aroon Indicator explanation -- trend indicator -- technical analysis -- Aroon Indicator usage -- Aroon Indicator examples -- Aroon Indicator parameters -- Aroon Indicator calculation ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Aroon Indicator. - - The word aroon is Sanskrit for "dawn's early light." The Aroon - indicator attempts to show when a new trend is dawning. The indicator consists - of two lines (Up and Down) that measure how long it has been since the highest - high/lowest low has occurred within an n period range. - - When the Aroon Up is staying between 70 and 100 then it indicates an upward trend. - When the Aroon Down is staying between 70 and 100 then it indicates an downward trend. - A strong upward trend is indicated when the Aroon Up is above 70 while the Aroon Down is below 30. - Likewise, a strong downward trend is indicated when the Aroon Down is above 70 while - the Aroon Up is below 30. Also look for crossovers. When the Aroon Down crosses above - the Aroon Up, it indicates a weakening of the upward trend (and vice versa). - - -Examples --------- - -```python -from openbb import obb -# Get the Chande Momentum Oscillator. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -aaron_data = obb.technical.aroon(data=stock_data.results, length=25, scalar=100) -obb.technical.aroon(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| length | int, optional | Number of periods to be used for the calculation, by default 25. | | False | -| scalar | int, optional | Scalar to be used for the calculation, by default 100. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/atr.md b/website/content/platform/reference/technical/atr.md deleted file mode 100644 index 359eadd7a5e6..000000000000 --- a/website/content/platform/reference/technical/atr.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "atr" -description: "Learn about the Average True Range indicator used to measure volatility in financial data and how to apply it with examples." -keywords: -- Average True Range -- volatility measurement -- gaps -- limit moves -- data -- index column -- length -- moving average mode -- difference period -- offset -- OBBject -- List -- examples ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Average True Range. - - Used to measure volatility, especially volatility caused by gaps or limit moves. - The ATR metric helps understand how much the values in your data change on average, - giving insights into the stability or unpredictability during a certain period. - It's particularly useful for spotting trends of increase or decrease in variations, - without getting into technical trading details. - The method considers not just the day-to-day changes but also accounts for any - sudden jumps or drops, ensuring you get a comprehensive view of movement. - - -Examples --------- - -```python -from openbb import obb -# Get the Average True Range. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -atr_data = obb.technical.atr(data=stock_data.results) -obb.technical.atr(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to apply the indicator to. | | False | -| index | str, optional | Index column name, by default "date" | | False | -| length | PositiveInt, optional | It's period, by default 14 | | False | -| mamode | Literal["rma", "ema", "sma", "wma"], optional | Moving average mode, by default "rma" | | False | -| drift | NonNegativeInt, optional | The difference period, by default 1 | | False | -| offset | int, optional | How many periods to offset the result, by default 0 | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - List of data with the indicator applied. -``` - diff --git a/website/content/platform/reference/technical/bbands.md b/website/content/platform/reference/technical/bbands.md deleted file mode 100644 index 5a2aae59c700..000000000000 --- a/website/content/platform/reference/technical/bbands.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "bbands" -description: "Learn about Bollinger Bands, a popular trading indicator used to identify volatility, overbought or oversold conditions, support and resistance levels, and price targets. Understand how they work, their parameters, and how to use them effectively in your trading strategy." -keywords: -- Bollinger Bands -- trading indicator -- volatility -- buy or sell signals -- overbought or oversold conditions -- support or resistance level -- price targets -- moving average -- standard deviation ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Bollinger Bands. - - Consist of three lines. The middle band is a simple moving average (generally 20 - periods) of the typical price (TP). The upper and lower bands are F standard - deviations (generally 2) above and below the middle band. - The bands widen and narrow when the volatility of the price is higher or lower, - respectively. - - Bollinger Bands do not, in themselves, generate buy or sell signals; - they are an indicator of overbought or oversold conditions. When the price is near the - upper or lower band it indicates that a reversal may be imminent. The middle band - becomes a support or resistance level. The upper and lower bands can also be - interpreted as price targets. When the price bounces off of the lower band and crosses - the middle band, then the upper band becomes the price target. - - -Examples --------- - -```python -from openbb import obb -# Get the Chande Momentum Oscillator. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -bbands_data = obb.technical.bbands(data=stock_data.results, target='close', length=50, std=2, mamode='sma') -obb.technical.bbands(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| target | str | Target column name. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| length | int, optional | Number of periods to be used for the calculation, by default 50. | | False | -| std | NonNegativeFloat, optional | Standard deviation to be used for the calculation, by default 2. | | False | -| mamode | Literal["sma", "ema", "wma", "rma"], optional | Moving average mode to be used for the calculation, by default "sma". | | False | -| offset | int, optional | Offset to be used for the calculation, by default 0. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/cci.md b/website/content/platform/reference/technical/cci.md deleted file mode 100644 index ada7c0788880..000000000000 --- a/website/content/platform/reference/technical/cci.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "cci" -description: "Learn about the Commodity Channel Index (CCI) and how it can be used to detect market trends, overbought or oversold conditions, and price divergence. This documentation provides an overview of the CCI, its parameters, and its calculation, along with an explanation of the CCI data it returns." -keywords: -- Commodity Channel Index -- CCI -- market trends -- trading range -- overbought -- oversold -- price divergence -- price correction -- data -- index column -- length -- scalar -- CCI calculation -- CCI data ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Commodity Channel Index (CCI). - - The CCI is designed to detect beginning and ending market trends. - The range of 100 to -100 is the normal trading range. CCI values outside of this - range indicate overbought or oversold conditions. You can also look for price - divergence in the CCI. If the price is making new highs, and the CCI is not, - then a price correction is likely. - - -Examples --------- - -```python -from openbb import obb -# Get the Commodity Channel Index (CCI). -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -cci_data = obb.technical.cci(data=stock_data.results, length=14, scalar=0.015) -obb.technical.cci(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The data to use for the CCI calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| length | PositiveInt, optional | The length of the CCI, by default 14. | | False | -| scalar | PositiveFloat, optional | The scalar of the CCI, by default 0.015. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The CCI data. -``` - diff --git a/website/content/platform/reference/technical/cg.md b/website/content/platform/reference/technical/cg.md deleted file mode 100644 index dc6526b1dee1..000000000000 --- a/website/content/platform/reference/technical/cg.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "cg" -description: "Learn about the Center of Gravity (COG) indicator, how it predicts price movements and reversals, and its use in range-bound markets. Explore the parameters, examples, and how to calculate COG data with OpenBB for technical analysis." -keywords: -- center of gravity -- COG indicator -- price movements -- price reversals -- oscillators -- range-bound markets -- upcoming price change -- asset trading -- data -- COG calculation -- index column -- length -- COG data -- openbb -- equity price historical -- stock data -- symbol -- start date -- provider -- technical analysis -- TSLA ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Center of Gravity. - - The Center of Gravity indicator, in short, is used to anticipate future price movements - and to trade on price reversals as soon as they happen. However, just like other oscillators, - the COG indicator returns the best results in range-bound markets and should be avoided when - the price is trending. Traders who use it will be able to closely speculate the upcoming - price change of the asset. - - -Examples --------- - -```python -from openbb import obb -# Get the Center of Gravity (CG). -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -cg_data = obb.technical.cg(data=stock_data.results, length=14) -obb.technical.cg(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The data to use for the COG calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date" | | False | -| length | PositiveInt, optional | The length of the COG, by default 14 | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The COG data. -``` - diff --git a/website/content/platform/reference/technical/clenow.md b/website/content/platform/reference/technical/clenow.md deleted file mode 100644 index e78c6ac00d3c..000000000000 --- a/website/content/platform/reference/technical/clenow.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "clenow" -description: "Learn about Clenow Volatility Adjusted Momentum and how to calculate it using Python code with openbb library. Explore the parameters, examples, and returns of this technical analysis function." -keywords: -- Clenow Volatility Adjusted Momentum -- Clenow -- momentum -- data -- index column -- target column -- period -- calculation -- examples -- Python code -- openbb -- equity -- price -- historical -- symbol -- start date -- provider -- technical analysis -- stock data ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Clenow Volatility Adjusted Momentum. - - The Clenow Volatility Adjusted Momentum is a sophisticated approach to understanding market momentum with a twist. - It adjusts for volatility, offering a clearer picture of true momentum by considering how price movements are - influenced by their volatility over a set period. It helps in identifying stronger, more reliable trends. - - -Examples --------- - -```python -from openbb import obb -# Get the Clenow Volatility Adjusted Momentum. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -clenow_data = obb.technical.clenow(data=stock_data.results, period=90) -obb.technical.clenow(period=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| target | str, optional | Target column name, by default "close". | | False | -| period | PositiveInt, optional | Number of periods for the momentum, by default 90. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/cones.md b/website/content/platform/reference/technical/cones.md deleted file mode 100644 index 0cba23282295..000000000000 --- a/website/content/platform/reference/technical/cones.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "cones" -description: "Calculate realized volatility quantiles over rolling windows of time using different volatility models. Understand the parameters and their effects, such as index, quantile values, and is_crypto. Examples and code snippets provided." -keywords: -- realized volatility quantiles -- rolling windows of time -- calculate volatility -- parameter data -- quantile value -- volatility models -- standard deviation -- Parkinson volatility -- Garman-Klass volatility -- Hodges-Tompkins volatility -- Rogers-Satchell volatility -- Yang-Zhang volatility -- is_crypto -- cones data -- code example ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the realized volatility quantiles over rolling windows of time. - - The cones indicator is designed to map out the ebb and flow of price movements through a detailed analysis of - volatility quantiles. By examining the range of volatility within specific time frames, it offers a nuanced view of - market behavior, highlighting periods of stability and turbulence. - - The model for calculating volatility is selectable and can be one of the following: - - Standard deviation - - Parkinson - - Garman-Klass - - Hodges-Tompkins - - Rogers-Satchell - - Yang-Zhang - - Read more about it in the model parameter description. - - -Examples --------- - -```python -from openbb import obb -# Get the cones indicator. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -cones_data = obb.technical.cones(data=stock_data.results, lower_q=0.25, upper_q=0.75, model='STD') -obb.technical.cones(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The data to use for the calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date" | | False | -| lower_q | float, optional | The lower quantile value for calculations | | False | -| upper_q | float, optional | The upper quantile value for calculations | | False | -| model | Literal["STD", "Parkinson", "Garman-Klass", "Hodges-Tompkins", "Rogers-Satchell", "Yang-Zhang"], optional | The model used to calculate realized volatility | | False | -| is_crypto | bool, optional | Whether the data is crypto or not. If True, volatility is calculated for 365 days instead of 252 | | False | -| trading_periods | Optional[int] [default: 252] | Number of trading periods in a year. | | True | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The cones data. -``` - diff --git a/website/content/platform/reference/technical/demark.md b/website/content/platform/reference/technical/demark.md deleted file mode 100644 index c13a31b19a6a..000000000000 --- a/website/content/platform/reference/technical/demark.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "demark" -description: "Learn how to use the Demark sequential indicator function in the OBBject library to analyze stock market data and calculate specific values. See examples of its implementation with the OpenBB package." -keywords: -- Demark sequential indicator -- data -- index -- target -- show_all -- asint -- offset -- OBBject -- List[Data] -- calculated data -- examples -- openbb -- equity -- price -- historical -- symbol -- start_date -- provider -- fmp -- technical -- demark ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Demark sequential indicator. - - This indicator offers a strategic way to spot potential reversals in market trends. - It's designed to highlight moments when the current trend may be running out of steam, - suggesting a possible shift in direction. By focusing on specific patterns in price movements, it provides - valuable insights for making informed decisions on future changes and identifies trend exhaustion points - with precision. - - -Examples --------- - -```python -from openbb import obb -# Get the Demark Sequential Indicator. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -demark_data = obb.technical.demark(data=stock_data.results, offset=0) -obb.technical.demark(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| target | str, optional | Target column name, by default "close". | | False | -| show_all | bool, optional | Show 1 - 13. If set to False, show 6 - 9 | | False | -| asint | bool, optional | If True, fill NAs with 0 and change type to int, by default True. | | False | -| offset | int, optional | How many periods to offset the result | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/donchian.md b/website/content/platform/reference/technical/donchian.md deleted file mode 100644 index 154c8a63463b..000000000000 --- a/website/content/platform/reference/technical/donchian.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "donchian" -description: "Learn about Donchian Channels, an indicator formed by upper and lower bands around a midrange or median band. Explore the parameters, returns, and examples." -keywords: -- Donchian Channels -- indicator -- upper band -- lower band -- moving average -- security -- N periods -- Donchian Channel -- parameters -- data -- index column -- lower length -- upper length -- offset -- returns -- examples ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Donchian Channels. - - Three lines generated by moving average calculations that comprise an indicator - formed by upper and lower bands around a midrange or median band. The upper band - marks the highest price of a security over N periods while the lower band - marks the lowest price of a security over N periods. The area - between the upper and lower bands represents the Donchian Channel. - - -Examples --------- - -```python -from openbb import obb -# Get the Donchian Channels. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -donchian_data = obb.technical.donchian(data=stock_data.results, lower_length=20, upper_length=20, offset=0) -obb.technical.donchian(lower_length=1, upper_length=3, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| lower_length | PositiveInt, optional | Number of periods for the lower band, by default 20. | | False | -| upper_length | PositiveInt, optional | Number of periods for the upper band, by default 20. | | False | -| offset | int, optional | Offset of the Donchian Channel, by default 0. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/ema.md b/website/content/platform/reference/technical/ema.md deleted file mode 100644 index 018d438487ad..000000000000 --- a/website/content/platform/reference/technical/ema.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "ema" -description: "Learn how to calculate the Exponential Moving Average (EMA) in Python using the openbb library. Understand its benefits as a cumulative calculation and how it maintains data responsiveness. Find details on parameters like data, target column, index column, length, and offset. Get code examples to implement EMA calculations in your projects." -keywords: -- Exponential Moving Average -- EMA -- cumulative calculation -- moving average -- data responsiveness -- parameters -- target column -- index column -- length -- offset -- calculated data -- examples ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Exponential Moving Average (EMA). - - EMA is a cumulative calculation, including all data. Past values have - a diminishing contribution to the average, while more recent values have a greater - contribution. This method allows the moving average to be more responsive to changes - in the data. - - -Examples --------- - -```python -from openbb import obb -# Get the Exponential Moving Average (EMA). -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -ema_data = obb.technical.ema(data=stock_data.results, target='close', length=50, offset=0) -obb.technical.ema(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The data to use for the calculation. | | False | -| target | str | Target column name. | | False | -| index | str, optional | Index column name to use with `data`, by default "date" | | False | -| length | int, optional | The length of the calculation, by default 50. | | False | -| offset | int, optional | The offset of the calculation, by default 0. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/fib.md b/website/content/platform/reference/technical/fib.md deleted file mode 100644 index a45427c50dfd..000000000000 --- a/website/content/platform/reference/technical/fib.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "fib" -description: "Learn how to create Fibonacci Retracement Levels using the openbb Python library for technical analysis. Apply the Fibonacci indicator to stock data and visualize the results." -keywords: -- Fibonacci Retracement Levels -- Fibonacci indicator -- technical analysis -- stock data -- Python -- data visualization -- open source library ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Create Fibonacci Retracement Levels. - - This method draws from a classic technique to pinpoint significant price levels - that often indicate where the market might find support or resistance. - It's a tool used to gauge potential turning points in the data by applying a - mathematical approach rooted in nature's patterns. Is used to get insights into - where prices could head next, based on historical movements. - - -Examples --------- - -```python -from openbb import obb -# Get the Bollinger Band Width. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -fib_data = obb.technical.fib(data=stock_data.results, period=120) -obb.technical.fib(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to apply the indicator to. | | False | -| index | str, optional | Index column name, by default "date" | | False | -| period | PositiveInt, optional | Period to calculate the indicator, by default 120 | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - List of data with the indicator applied. -``` - diff --git a/website/content/platform/reference/technical/fisher.md b/website/content/platform/reference/technical/fisher.md deleted file mode 100644 index 40c8c97834da..000000000000 --- a/website/content/platform/reference/technical/fisher.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "fisher" -description: "Learn about the Fisher Transform, a technical indicator created by John F. Ehlers that converts prices into a Gaussian normal distribution. This indicator can help identify extreme prices and turning points in asset prices. Discover how to use the Fisher Transform with examples and parameter explanations." -keywords: -- Fisher Transform -- John F. Ehlers -- technical indicator -- Gaussian normal distribution -- extreme prices -- turning points -- price waves -- trend isolation -- indicator parameters -- data -- index column -- Fisher period -- Fisher Signal period -- indicator application -- OBBject -- example -- stock data -- equity -- historical price -- symbol -- start date -- data provider ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform the Fisher Transform. - - A technical indicator created by John F. Ehlers that converts prices into a Gaussian - normal distribution. The indicator highlights when prices have moved to an extreme, - based on recent prices. - This may help in spotting turning points in the price of an asset. It also helps - show the trend and isolate the price waves within a trend. - - -Examples --------- - -```python -from openbb import obb -# Perform the Fisher Transform. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -fisher_data = obb.technical.fisher(data=stock_data.results, length=14, signal=1) -obb.technical.fisher(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to apply the indicator to. | | False | -| index | str, optional | Index column name, by default "date" | | False | -| length | PositiveInt, optional | Fisher period, by default 14 | | False | -| signal | PositiveInt, optional | Fisher Signal period, by default 1 | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - List of data with the indicator applied. -``` - diff --git a/website/content/platform/reference/technical/hma.md b/website/content/platform/reference/technical/hma.md deleted file mode 100644 index 6634b9922241..000000000000 --- a/website/content/platform/reference/technical/hma.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "hma" -description: "Learn about the Hull Moving Average (HMA), a responsive and smooth moving average indicator. Understand how to use the HMA, its parameters, and see examples using the OBBject library." -keywords: -- Hull Moving Average -- moving average -- lag -- smoothing -- data -- target column -- index column -- length -- offset -- OBBject -- examples -- openbb -- equity -- price -- historical -- symbol -- start date -- provider ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Hull Moving Average (HMA). - - Solves the age old dilemma of making a moving average more responsive to current - price activity whilst maintaining curve smoothness. - In fact the HMA almost eliminates lag altogether and manages to improve smoothing - at the same time. - - -Examples --------- - -```python -from openbb import obb -# Calculate HMA with historical stock data. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -hma_data = obb.technical.hma(data=stock_data.results, target='close', length=50, offset=0) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| target | str | Target column name. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| length | int, optional | Number of periods for the HMA, by default 50. | | False | -| offset | int, optional | Offset of the HMA, by default 0. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/ichimoku.md b/website/content/platform/reference/technical/ichimoku.md deleted file mode 100644 index 948cc2a71b0b..000000000000 --- a/website/content/platform/reference/technical/ichimoku.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "ichimoku" -description: "Learn about Ichimoku Cloud, a versatile indicator that defines support and resistance, identifies trend direction, gauges momentum, and provides trading signals. Explore its parameters and usage in Python." -keywords: -- Ichimoku Cloud -- Ichimoku Kinko Hyo -- versatile indicator -- support and resistance -- trend direction -- momentum -- trading signals -- conversion line -- base line -- lagging span -- Chikou Span Column -- data leak ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Ichimoku Cloud. - - Also known as Ichimoku Kinko Hyo, is a versatile indicator that defines support and - resistance, identifies trend direction, gauges momentum and provides trading - signals. Ichimoku Kinko Hyo translates into "one look equilibrium chart". With - one look, chartists can identify the trend and look for potential signals within - that trend. - - -Examples --------- - -```python -from openbb import obb -# Get the Ichimoku Cloud. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -ichimoku_data = obb.technical.ichimoku(data=stock_data.results, conversion=9, base=26, lookahead=False) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| conversion | PositiveInt, optional | Number of periods for the conversion line, by default 9. | | False | -| base | PositiveInt, optional | Number of periods for the base line, by default 26. | | False | -| lagging | PositiveInt, optional | Number of periods for the lagging span, by default 52. | | False | -| offset | PositiveInt, optional | Number of periods for the offset, by default 26. | | False | -| lookahead | bool, optional | drops the Chikou Span Column to prevent potential data leak | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/index.mdx b/website/content/platform/reference/technical/index.mdx deleted file mode 100644 index a2af0125b453..000000000000 --- a/website/content/platform/reference/technical/index.mdx +++ /dev/null @@ -1,34 +0,0 @@ -# Technical - -import ReferenceCard from '@site/src/components/General/NewReferenceCard'; - -### Commands -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
- diff --git a/website/content/platform/reference/technical/kc.md b/website/content/platform/reference/technical/kc.md deleted file mode 100644 index 958ca2440877..000000000000 --- a/website/content/platform/reference/technical/kc.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "kc" -description: "Learn how to use Keltner Channels, volatility-based bands used to determine the direction of a trend. This documentation covers the Keltner Channels calculation, breakout signals, and parameters like the moving average mode, length, scalar value, and offset." -keywords: -- Keltner Channels -- volatility-based bands -- direction of a trend -- average true range -- ATR -- breakout signals -- Keltner Channels calculation -- moving average mode -- length of Keltner Channels -- scalar value for Keltner Channels -- offset for Keltner Channels -- Keltner Channels data ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Keltner Channels. - - Keltner Channels are volatility-based bands that are placed - on either side of an asset's price and can aid in determining - the direction of a trend.The Keltner channel uses the average - true range (ATR) or volatility, with breaks above or below the top - and bottom barriers signaling a continuation. - - -Examples --------- - -```python -from openbb import obb -# Get the Keltner Channels. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -kc_data = obb.technical.kc(data=stock_data.results, length=20, scalar=20, mamode='ema', offset=0) -obb.technical.kc(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The data to use for the Keltner Channels calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date" | | False | -| length | PositiveInt, optional | The length of the Keltner Channels, by default 20 | | False | -| scalar | PositiveFloat, optional | The scalar to use for the Keltner Channels, by default 20 | | False | -| mamode | Literal["ema", "sma", "wma", "hma", "zlma"], optional | The moving average mode to use for the Keltner Channels, by default "ema" | | False | -| offset | NonNegativeInt, optional | The offset to use for the Keltner Channels, by default 0 | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The Keltner Channels data. -``` - diff --git a/website/content/platform/reference/technical/macd.md b/website/content/platform/reference/technical/macd.md deleted file mode 100644 index 0a14d875c3e0..000000000000 --- a/website/content/platform/reference/technical/macd.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "macd" -description: "Learn about the Moving Average Convergence Divergence (MACD), a powerful technical indicator used in financial analysis. Understand how the MACD signals trend changes, identifies overbought and oversold conditions, and generates buy/sell signals. Explore the parameters and see examples of how to use this indicator in Python." -keywords: -- Moving Average Convergence Divergence -- MACD -- Exponential Moving Averages -- Signal line -- trend changes -- overbought conditions -- oversold conditions -- divergence with price -- buy signal -- sell signal -- zero line -- parameters -- data -- target column -- fast EMA -- slow EMA -- signal EMA -- calculated data -- examples ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Moving Average Convergence Divergence (MACD). - - Difference between two Exponential Moving Averages. The Signal line is an - Exponential Moving Average of the MACD. - - The MACD signals trend changes and indicates the start of new trend direction. - High values indicate overbought conditions, low values indicate oversold conditions. - Divergence with the price indicates an end to the current trend, especially if the - MACD is at extreme high or low values. When the MACD line crosses above the - signal line a buy signal is generated. When the MACD crosses below the signal line a - sell signal is generated. To confirm the signal, the MACD should be above zero for a buy, - and below zero for a sell. - - -Examples --------- - -```python -from openbb import obb -# Get the Moving Average Convergence Divergence (MACD). -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -macd_data = obb.technical.macd(data=stock_data.results, target='close', fast=12, slow=26, signal=9) -# Example with mock data. -obb.technical.macd(fast=2, slow=3, signal=1, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| target | str | Target column name. | | False | -| fast | int, optional | Number of periods for the fast EMA, by default 12. | | False | -| slow | int, optional | Number of periods for the slow EMA, by default 26. | | False | -| signal | int, optional | Number of periods for the signal EMA, by default 9. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/obv.md b/website/content/platform/reference/technical/obv.md deleted file mode 100644 index aa80ff39f9be..000000000000 --- a/website/content/platform/reference/technical/obv.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "obv" -description: "Learn about On Balance Volume (OBV), a cumulative volume indicator that helps to interpret price moves, identify trends, and determine market trends. This documentation page provides an explanation of how OBV works, its parameters, and a Python example." -keywords: -- On Balance Volume -- OBV -- cumulative volume -- up and down volume -- running total -- price moves -- non-confirmed move -- rising peaks -- falling troughs -- strong trend -- flat OBV -- interpret OBV -- how to use OBV -- Python example ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the On Balance Volume (OBV). - - Is a cumulative total of the up and down volume. When the close is higher than the - previous close, the volume is added to the running total, and when the close is - lower than the previous close, the volume is subtracted from the running total. - - To interpret the OBV, look for the OBV to move with the price or precede price moves. - If the price moves before the OBV, then it is a non-confirmed move. A series of rising peaks, - or falling troughs, in the OBV indicates a strong trend. If the OBV is flat, then the market - is not trending. - - -Examples --------- - -```python -from openbb import obb -# Get the On Balance Volume (OBV). -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -obv_data = obb.technical.obv(data=stock_data.results, offset=0) -obb.technical.obv(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to apply the indicator to. | | False | -| index | str, optional | Index column name, by default "date" | | False | -| offset | int, optional | How many periods to offset the result, by default 0. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - List of data with the indicator applied. -``` - diff --git a/website/content/platform/reference/technical/rsi.md b/website/content/platform/reference/technical/rsi.md deleted file mode 100644 index 4966f2f7310d..000000000000 --- a/website/content/platform/reference/technical/rsi.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "rsi" -description: "Learn about Relative Strength Index (RSI) and how to calculate it. Understand its interpretation as an overbought/oversold indicator and its relevance in identifying price movements and reversals. Explore the various parameters involved in the RSI calculation with practical examples." -keywords: -- Relative Strength Index -- RSI -- oversold indicator -- overbought indicator -- divergence -- price movements -- reversal -- parameters -- data -- target -- index -- length -- scalar -- drift -- examples ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Relative Strength Index (RSI). - - RSI calculates a ratio of the recent upward price movements to the absolute price - movement. The RSI ranges from 0 to 100. - The RSI is interpreted as an overbought/oversold indicator when - the value is over 70/below 30. You can also look for divergence with price. If - the price is making new highs/lows, and the RSI is not, it indicates a reversal. - - -Examples --------- - -```python -from openbb import obb -# Get the Relative Strength Index (RSI). -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -rsi_data = obb.technical.rsi(data=stock_data.results, target='close', length=14, scalar=100.0, drift=1) -obb.technical.rsi(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The data to use for the RSI calculation. | | False | -| target | str | Target column name. | | False | -| index | str, optional | Index column name to use with `data`, by default "date" | | False | -| length | int, optional | The length of the RSI, by default 14 | | False | -| scalar | float, optional | The scalar to use for the RSI, by default 100.0 | | False | -| drift | int, optional | The drift to use for the RSI, by default 1 | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The RSI data. -``` - diff --git a/website/content/platform/reference/technical/sma.md b/website/content/platform/reference/technical/sma.md deleted file mode 100644 index a08c46a33605..000000000000 --- a/website/content/platform/reference/technical/sma.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "sma" -description: "Learn about the Simple Moving Average and how it can be used to smooth data, eliminate noise, and identify trends. Gain insights into the simple form of moving averages, equal weighting, responsiveness to changes, and filtering data. Understand the parameters involved in the calculation, such as length and offset." -keywords: -- Simple Moving Average -- moving averages -- smoothing data -- identify trends -- noise elimination -- simplest form of moving average -- equal weight -- responsive to changes -- filtering data -- data calculation -- length parameter -- offset parameter ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Simple Moving Average (SMA). - - Moving Averages are used to smooth the data in an array to - help eliminate noise and identify trends. The Simple Moving Average is literally - the simplest form of a moving average. Each output value is the average of the - previous n values. In a Simple Moving Average, each value in the time period carries - equal weight, and values outside of the time period are not included in the average. - This makes it less responsive to recent changes in the data, which can be useful for - filtering out those changes. - - -Examples --------- - -```python -from openbb import obb -# Get the Chande Momentum Oscillator. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -sma_data = obb.technical.sma(data=stock_data.results, target='close', length=50, offset=0) -obb.technical.sma(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| target | str | Target column name. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| length | int, optional | Number of periods to be used for the calculation, by default 50. | | False | -| offset | int, optional | Offset from the current period, by default 0. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/stoch.md b/website/content/platform/reference/technical/stoch.md deleted file mode 100644 index e5600640a476..000000000000 --- a/website/content/platform/reference/technical/stoch.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "stoch" -description: "Learn about the Stochastic Oscillator and its calculation. Understand the parameters, returns, and see examples of how to use it with OpenBB. Improve your page's SEO with this well-researched content." -keywords: -- stochastic oscillator -- close -- trading range -- '%D values' -- overbought condition -- oversold condition -- buy signal -- sell signal -- raw %K -- crossover signals -- parameters -- data -- index -- fast %K period -- slow %D period -- slow %K period -- returns -- stochastic oscillator data -- examples -- openbb -- equity -- price -- historical -- symbol -- start date -- provider -- stock data -- stoch data -- well-researched -- improve page's SEO ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Stochastic Oscillator. - - The Stochastic Oscillator measures where the close is in relation - to the recent trading range. The values range from zero to 100. %D values over 75 - indicate an overbought condition; values under 25 indicate an oversold condition. - When the Fast %D crosses above the Slow %D, it is a buy signal; when it crosses - below, it is a sell signal. The Raw %K is generally considered too erratic to use - for crossover signals. - - -Examples --------- - -```python -from openbb import obb -# Get the Stochastic Oscillator. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -stoch_data = obb.technical.stoch(data=stock_data.results, fast_k_period=14, slow_d_period=3, slow_k_period=3) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The data to use for the Stochastic Oscillator calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| fast_k_period | NonNegativeInt, optional | The fast %K period, by default 14. | | False | -| slow_d_period | NonNegativeInt, optional | The slow %D period, by default 3. | | False | -| slow_k_period | NonNegativeInt, optional | The slow %K period, by default 3. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The Stochastic Oscillator data. -``` - diff --git a/website/content/platform/reference/technical/vwap.md b/website/content/platform/reference/technical/vwap.md deleted file mode 100644 index f247a0c949e5..000000000000 --- a/website/content/platform/reference/technical/vwap.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "vwap" -description: "Learn about the Volume Weighted Average Price (VWAP) and how it measures the average typical price by volume. Discover how it can be used with intraday charts to identify general direction. Explore Python examples using the OpenBB OBB package." -keywords: -- Volume Weighted Average Price -- average typical price by volume -- intraday charts -- general direction identification -- timeseries offset aliases -- python examples -- openbb obb package ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Volume Weighted Average Price (VWAP). - - Measures the average typical price by volume. - It is typically used with intraday charts to identify general direction. - It helps to understand the true average price factoring in the volume of transactions, - and serves as a benchmark for assessing the market's direction over short periods, such as a single trading day. - - -Examples --------- - -```python -from openbb import obb -# Get the Volume Weighted Average Price (VWAP). -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -vwap_data = obb.technical.vwap(data=stock_data.results, anchor='D', offset=0) -obb.technical.vwap(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| anchor | str, optional | Anchor period to use for the calculation, by default "D". | | False | -| https | //pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#timeseries-offset-aliases | offset : int, optional | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - diff --git a/website/content/platform/reference/technical/wma.md b/website/content/platform/reference/technical/wma.md deleted file mode 100644 index f0f7b18790d3..000000000000 --- a/website/content/platform/reference/technical/wma.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "wma" -description: "Learn about the Weighted Moving Average (WMA) and how it is used to give more weight to recent data. Understand its unique calculation and how it compares to the Simple Moving Average. Find out the parameters for the WMA function, such as the target and index column names, length, and offset. See an example of using the WMA function in Python with the OpenBB library to calculate WMA data for historical stock prices." -keywords: -- weighted moving average -- WMA -- moving average -- weighting factor -- price -- data -- calculation -- simple moving average -- parameters -- target column -- index column -- length -- offset -- returns -- examples -- python -- openbb -- equity -- price -- historical -- symbol -- start date -- provider -- wma data ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the Weighted Moving Average (WMA). - - A Weighted Moving Average puts more weight on recent data and less on past data. - This is done by multiplying each bar's price by a weighting factor. Because of its - unique calculation, WMA will follow prices more closely than a corresponding Simple - Moving Average. - - -Examples --------- - -```python -from openbb import obb -# Get the Average True Range (ATR). -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -wma_data = obb.technical.wma(data=stock_data.results, target='close', length=50, offset=0) -obb.technical.wma(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | The data to use for the calculation. | | False | -| target | str | Target column name. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| length | int, optional | The length of the WMA, by default 50. | | False | -| offset | int, optional | The offset of the WMA, by default 0. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The WMA data. -``` - diff --git a/website/content/platform/reference/technical/zlma.md b/website/content/platform/reference/technical/zlma.md deleted file mode 100644 index 305933ea9bd9..000000000000 --- a/website/content/platform/reference/technical/zlma.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "zlma" -description: "Learn about the zero lag exponential moving average (ZLEMA) and how it can be used to perform EMA calculations on de-lagged data. Explore the parameters and get examples of implementing ZLEMA in Python." -keywords: -- zero lag exponential moving average -- ZLEMA -- EMA calculation -- de-lagged data -- moving average -- lagged data -- cumulative effect -- parameters -- target column -- index column -- length -- offset -- calculation -- calculated data -- example ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - - - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Calculate the zero lag exponential moving average (ZLEMA). - - Created by John Ehlers and Ric Way. The idea is do a - regular exponential moving average (EMA) calculation but - on a de-lagged data instead of doing it on the regular data. - Data is de-lagged by removing the data from "lag" days ago - thus removing (or attempting to) the cumulative effect of - the moving average. - - -Examples --------- - -```python -from openbb import obb -# Get the Chande Momentum Oscillator. -stock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp') -zlma_data = obb.technical.zlma(data=stock_data.results, target='close', length=50, offset=0) -obb.technical.zlma(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}]) -``` - ---- - -## Parameters - - - - - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| data | List[Data] | List of data to be used for the calculation. | | False | -| target | str | Target column name. | | False | -| index | str, optional | Index column name to use with `data`, by default "date". | | False | -| length | int, optional | Number of periods to be used for the calculation, by default 50. | | False | -| offset | int, optional | Offset to be used for the calculation, by default 0. | | False | - - - - ---- - -## Returns - -```python wordwrap -OBBject - results : List[Data] - The calculated data. -``` - From 857b5bf64147fcc35081b8db2d8a602307b1d348 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Mon, 1 Apr 2024 17:12:01 +0100 Subject: [PATCH 2/2] add to gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index a3530870231d..6f9fb6bb5a13 100644 --- a/.gitignore +++ b/.gitignore @@ -88,3 +88,5 @@ openbb_platform/openbb/package/* # Reference files website/content/excel/reference/* website/content/excel/reference/*/* +website/content/platform/data_models/* +website/content/platform/reference/*