OpenBB/website/content/platform/data_models/index.mdx

# Data Models

import ReferenceCard from "@site/src/components/General/ReferenceCard";

<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
<ReferenceCard
    title="Cryptocurrency Historical Price"
    description="Cryptocurrency historical price data"
    url="/platform/data_models/CryptoHistorical"
    command="true"
/>
<ReferenceCard
    title="Cryptocurrency Search"
    description="Search available cryptocurrency pairs"
    url="/platform/data_models/CryptoSearch"
    command="true"
/>
<ReferenceCard
    title="Currency Historical Price"
    description="Currency historical data"
    url="/platform/data_models/CurrencyHistorical"
    command="true"
/>
<ReferenceCard
    title="Currency Search"
    description="Search available currency pairs"
    url="/platform/data_models/CurrencyPairs"
    command="true"
/>
<ReferenceCard
    title="Economic Calendar"
    description=""
    url="/platform/data_models/EconomicCalendar"
    command="true"
/>
<ReferenceCard
    title="Consumer Price Index (CPI) Data"
    description=""
    url="/platform/data_models/ConsumerPriceIndex"
    command="true"
/>
<ReferenceCard
    title="Forecasted GDP Data"
    description=""
    url="/platform/data_models/GdpForecast"
    command="true"
/>
<ReferenceCard
    title="Nominal GDP Data"
    description=""
    url="/platform/data_models/GdpNominal"
    command="true"
/>
<ReferenceCard
    title="Real GDP Data"
    description=""
    url="/platform/data_models/GdpReal"
    command="true"
/>
<ReferenceCard
    title="Historical Market Risk Premium"
    description=""
    url="/platform/data_models/RiskPremium"
    command="true"
/>
<ReferenceCard
    title="Upcoming and Historical Dividend Calendar"
    description=""
    url="/platform/data_models/CalendarDividend"
    command="true"
/>
<ReferenceCard
    title="Upcoming and Historical earnings calendar"
    description=""
    url="/platform/data_models/CalendarEarnings"
    command="true"
/>
<ReferenceCard
    title="Upcoming and Historical IPO Calendar"
    description=""
    url="/platform/data_models/CalendarIpo"
    command="true"
/>
<ReferenceCard
    title="Calendar Splits"
    description="Show Stock Split Calendar"
    url="/platform/data_models/CalendarSplits"
    command="true"
/>
<ReferenceCard
    title="Equity Peers"
    description="Company peers"
    url="/platform/data_models/EquityPeers"
    command="true"
/>
<ReferenceCard
    title="Weekly aggregate trade data for Over The Counter deals"
    description="ATS and non-ATS trading data for each ATS/firm with trade reporting obligations under FINRA rules"
    url="/platform/data_models/OTCAggregate"
    command="true"
/>
<ReferenceCard
    title="Get the most active Equities"
    description=""
    url="/platform/data_models/EquityActive"
    command="true"
/>
<ReferenceCard
    title="Get aggressive small cap Equities"
    description=""
    url="/platform/data_models/EquityAggressiveSmallCaps"
    command="true"
/>
<ReferenceCard
    title="Get the most-recent filings submitted to the SEC"
    description=""
    url="/platform/data_models/DiscoveryFilings"
    command="true"
/>
<ReferenceCard
    title="Get the top Equity gainers"
    description=""
    url="/platform/data_models/EquityGainers"
    command="true"
/>
<ReferenceCard
    title="Get growth tech Equities"
    description=""
    url="/platform/data_models/GrowthTechEquities"
    command="true"
/>
<ReferenceCard
    title="Get the top Equity losers"
    description=""
    url="/platform/data_models/EquityLosers"
    command="true"
/>
<ReferenceCard
    title="Tracks over $30B USD/day of individual investors trades"
    description="It gives a daily view into retail activity and sentiment for over 9,500 US traded stocks, ADRs, and ETPs"
    url="/platform/data_models/TopRetail"
    command="true"
/>
<ReferenceCard
    title="Get undervalued growth Equities"
    description=""
    url="/platform/data_models/EquityUndervaluedGrowth"
    command="true"
/>
<ReferenceCard
    title="Get undervalued large cap Equities"
    description=""
    url="/platform/data_models/EquityUndervaluedLargeCaps"
    command="true"
/>
<ReferenceCard
    title="Get upcoming release days"
    description=""
    url="/platform/data_models/UpcomingReleaseDays"
    command="true"
/>
<ReferenceCard
    title="Price Target Consensus"
    description="Price target consensus data"
    url="/platform/data_models/PriceTargetConsensus"
    command="true"
/>
<ReferenceCard
    title="Historical Analyst Estimates"
    description="Analyst stock recommendations"
    url="/platform/data_models/AnalystEstimates"
    command="true"
/>
<ReferenceCard
    title="Price Target"
    description="Price target data"
    url="/platform/data_models/PriceTarget"
    command="true"
/>
<ReferenceCard
    title="Balance Sheet"
    description="Balance sheet statement"
    url="/platform/data_models/BalanceSheet"
    command="true"
/>
<ReferenceCard
    title="Balance Sheet Statement Growth"
    description="Information about the growth of the company balance sheet"
    url="/platform/data_models/BalanceSheetGrowth"
    command="true"
/>
<ReferenceCard
    title="Cash Flow Statement"
    description="Information about the cash flow statement"
    url="/platform/data_models/CashFlowStatement"
    command="true"
/>
<ReferenceCard
    title="Cash Flow Statement Growth"
    description="Information about the growth of the company cash flow statement"
    url="/platform/data_models/CashFlowStatementGrowth"
    command="true"
/>
<ReferenceCard
    title="Historical Dividends"
    description="Historical dividends data for a given company"
    url="/platform/data_models/HistoricalDividends"
    command="true"
/>
<ReferenceCard
    title="Historical Earnings for a given company"
    description=""
    url="/platform/data_models/CalendarEarnings"
    command="true"
/>
<ReferenceCard
    title="Historical Employees"
    description="Historical number of employees"
    url="/platform/data_models/HistoricalEmployees"
    command="true"
/>
<ReferenceCard
    title="Company Filings"
    description="Company filings data"
    url="/platform/data_models/CompanyFilings"
    command="true"
/>
<ReferenceCard
    title="Historical Stock Splits"
    description="Historical stock splits data"
    url="/platform/data_models/HistoricalStockSplits"
    command="true"
/>
<ReferenceCard
    title="Income Statement"
    description="Report on a company's financial performance"
    url="/platform/data_models/IncomeStatement"
    command="true"
/>
<ReferenceCard
    title="Income Statement Growth"
    description="Information about the growth of the company income statement"
    url="/platform/data_models/IncomeStatementGrowth"
    command="true"
/>
<ReferenceCard
    title="Key Executives"
    description="Key executives for a given company"
    url="/platform/data_models/KeyExecutives"
    command="true"
/>
<ReferenceCard
    title="Get Executive Compensation"
    description="Information about the executive compensation for a given company"
    url="/platform/data_models/ExecutiveCompensation"
    command="true"
/>
<ReferenceCard
    title="Key Metrics"
    description="Key metrics for a given company"
    url="/platform/data_models/KeyMetrics"
    command="true"
/>
<ReferenceCard
    title="Equity Valuation Multiples"
    description="Valuation multiples for a stock ticker"
    url="/platform/data_models/EquityValuationMultiples"
    command="true"
/>
<ReferenceCard
    title="Company Overview"
    description="General information about a company"
    url="/platform/data_models/CompanyOverview"
    command="true"
/>
<ReferenceCard
    title="Extensive set of ratios over time"
    description="Financial ratios for a given company"
    url="/platform/data_models/FinancialRatios"
    command="true"
/>
<ReferenceCard
    title="Revenue Geographic"
    description="Geographic revenue data"
    url="/platform/data_models/RevenueGeographic"
    command="true"
/>
<ReferenceCard
    title="Revenue Business Line"
    description="Business line revenue data"
    url="/platform/data_models/RevenueBusinessLine"
    command="true"
/>
<ReferenceCard
    title="Earnings Call Transcript"
    description="Earnings call transcript for a given company"
    url="/platform/data_models/EarningsCallTranscript"
    command="true"
/>
<ReferenceCard
    title="Get a current, complete, market snapshot"
    description=""
    url="/platform/data_models/MarketSnapshots"
    command="true"
/>
<ReferenceCard
    title="Company News"
    description="Get news for one or more companies"
    url="/platform/data_models/CompanyNews"
    command="true"
/>
<ReferenceCard
    title="Get the complete options chain for a ticker"
    description=""
    url="/platform/data_models/OptionsChains"
    command="true"
/>
<ReferenceCard
    title="Get the complete options chain for a ticker"
    description=""
    url="/platform/data_models/OptionsUnusual"
    command="true"
/>
<ReferenceCard
    title="Stock Insider Trading"
    description="Information about insider trading"
    url="/platform/data_models/StockInsiderTrading"
    command="true"
/>
<ReferenceCard
    title="Institutional Ownership"
    description="Institutional ownership data"
    url="/platform/data_models/InstitutionalOwnership"
    command="true"
/>
<ReferenceCard
    title="Equity Ownership"
    description="Information about the company ownership"
    url="/platform/data_models/EquityOwnership"
    command="true"
/>
<ReferenceCard
    title="Share Statistics"
    description="Share statistics for a given company"
    url="/platform/data_models/ShareStatistics"
    command="true"
/>
<ReferenceCard
    title="Equity Historical price"
    description="Load stock data for a specific ticker"
    url="/platform/data_models/EquityHistorical"
    command="true"
/>
<ReferenceCard
    title="Equity Quote"
    description="Load National Best Bid and Offer for a specific equity"
    url="/platform/data_models/EquityNBBO"
    command="true"
/>
<ReferenceCard
    title="Price performance as a return, over different periods"
    description=""
    url="/platform/data_models/PricePerformance"
    command="true"
/>
<ReferenceCard
    title="Equity Quote"
    description="Load stock data for a specific ticker"
    url="/platform/data_models/EquityQuote"
    command="true"
/>
<ReferenceCard
    title="Equity Info"
    description="Get general price and performance metrics of a stock"
    url="/platform/data_models/EquityInfo"
    command="true"
/>
<ReferenceCard
    title="Equity Search"
    description="Search for a company or stock ticker"
    url="/platform/data_models/EquitySearch"
    command="true"
/>
<ReferenceCard
    title="Get reported Fail-to-deliver (FTD) data"
    description=""
    url="/platform/data_models/EquityFTD"
    command="true"
/>
<ReferenceCard
    title="Get reported Short Volume and Days to Cover data"
    description=""
    url="/platform/data_models/EquityShortInterest"
    command="true"
/>
<ReferenceCard
    title="Get reported Fail-to-deliver (FTD) data"
    description=""
    url="/platform/data_models/ShortVolume"
    command="true"
/>
<ReferenceCard
    title="ETF Country weighting"
    description=""
    url="/platform/data_models/EtfCountries"
    command="true"
/>
<ReferenceCard
    title="Get the most active ETFs"
    description=""
    url="/platform/data_models/ETFActive"
    command="true"
/>
<ReferenceCard
    title="Get the top ETF gainers"
    description=""
    url="/platform/data_models/ETFGainers"
    command="true"
/>
<ReferenceCard
    title="Get the top ETF losers"
    description=""
    url="/platform/data_models/ETFLosers"
    command="true"
/>
<ReferenceCard
    title="ETF Historical Market Price"
    description=""
    url="/platform/data_models/EtfHistorical"
    command="true"
/>
<ReferenceCard
    title="Get the holdings for an individual ETF"
    description=""
    url="/platform/data_models/EtfHoldings"
    command="true"
/>
<ReferenceCard
    title="Get the holdings filing date for an individual ETF"
    description=""
    url="/platform/data_models/EtfHoldingsDate"
    command="true"
/>
<ReferenceCard
    title="Get the ETF holdings performance"
    description=""
    url="/platform/data_models/EtfHoldingsPerformance"
    command="true"
/>
<ReferenceCard
    title="ETF Information Overview"
    description=""
    url="/platform/data_models/EtfInfo"
    command="true"
/>
<ReferenceCard
    title="Price performance as a return, over different periods"
    description=""
    url="/platform/data_models/PricePerformance"
    command="true"
/>
<ReferenceCard
    title="Search for ETFs"
    description="An empty query returns the full list of ETFs from the provider"
    url="/platform/data_models/EtfSearch"
    command="true"
/>
<ReferenceCard
    title="ETF Sector weighting"
    description=""
    url="/platform/data_models/EtfSectors"
    command="true"
/>
<ReferenceCard
    title="Commercial Paper"
    description="Commercial paper (CP) consists of short-term, promissory notes issued primarily by corporations. Maturities range..."
    url="/platform/data_models/CommercialPaper"
    command="true"
/>
<ReferenceCard
    title="High Quality Market Corporate Bond"
    description="The HQM yield curve represents the high quality corporate bond market, i.e., corporate bonds rated AAA, AA, or A...."
    url="/platform/data_models/HighQualityMarketCorporateBond"
    command="true"
/>
<ReferenceCard
    title="ICE BofA US Corporate Bond Indices"
    description="The ICE BofA US Corporate Index tracks the performance of US dollar denominated investment grade corporate debt..."
    url="/platform/data_models/ICEBofA"
    command="true"
/>
<ReferenceCard
    title="Moody Corporate Bond Index"
    description="Moody's Aaa and Baa are investment bonds that acts as an index of the performance of all bonds given an Aaa or..."
    url="/platform/data_models/MoodyCorporateBondIndex"
    command="true"
/>
<ReferenceCard
    title="Spot Rates"
    description="The spot rates for any maturity is the yield on a bond that provides a single payment at that maturity. This is a..."
    url="/platform/data_models/SpotRate"
    command="true"
/>
<ReferenceCard
    title="Euro Area Yield Curve"
    description="Gets euro area yield curve data from ECB. The graphic depiction of the relationship between the yield on bonds of..."
    url="/platform/data_models/EUYieldCurve"
    command="true"
/>
<ReferenceCard
    title="Treasury Rates"
    description="Treasury rates data"
    url="/platform/data_models/TreasuryRates"
    command="true"
/>
<ReferenceCard
    title="US Yield Curve"
    description="Get United States yield curve"
    url="/platform/data_models/USYieldCurve"
    command="true"
/>
<ReferenceCard
    title="Ameribor"
    description="Ameribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost..."
    url="/platform/data_models/AMERIBOR"
    command="true"
/>
<ReferenceCard
    title="Discount Window Primary Credit Rate"
    description="A bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money. The rates..."
    url="/platform/data_models/DiscountWindowPrimaryCreditRate"
    command="true"
/>
<ReferenceCard
    title="European Central Bank Interest Rates"
    description="The Governing Council of the ECB sets the key interest rates for the euro area: - The interest rate on the main..."
    url="/platform/data_models/EuropeanCentralBankInterestRates"
    command="true"
/>
<ReferenceCard
    title="Fed Funds Rate"
    description="Get Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its..."
    url="/platform/data_models/FEDFUNDS"
    command="true"
/>
<ReferenceCard
    title="Fed Funds Rate Projections"
    description="The projections for the federal funds rate are the value of the midpoint of the projected appropriate target..."
    url="/platform/data_models/PROJECTIONS"
    command="true"
/>
<ReferenceCard
    title="Euro Short-Term Rate"
    description="The euro short-term rate (€STR) reflects the wholesale euro unsecured overnight borrowing costs of banks located..."
    url="/platform/data_models/ESTR"
    command="true"
/>
<ReferenceCard
    title="Interest on Reserve Balances"
    description="Get Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to..."
    url="/platform/data_models/IORB"
    command="true"
/>
<ReferenceCard
    title="Sterling Overnight Index Average"
    description="SONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual..."
    url="/platform/data_models/SONIA"
    command="true"
/>
<ReferenceCard
    title="Secured Overnight Financing Rate"
    description="The Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of borrowing cash overnight..."
    url="/platform/data_models/SOFR"
    command="true"
/>
<ReferenceCard
    title="Treasury Constant Maturity"
    description="Get data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity. Constant maturity is..."
    url="/platform/data_models/TreasuryConstantMaturity"
    command="true"
/>
<ReferenceCard
    title="Select Treasury Constant Maturity"
    description="Get data for Selected Treasury Constant Maturity Minus Federal Funds Rate Constant maturity is the theoretical..."
    url="/platform/data_models/SelectedTreasuryConstantMaturity"
    command="true"
/>
<ReferenceCard
    title="Select Treasury Bill"
    description="Get Selected Treasury Bill Minus Federal Funds Rate. Constant maturity is the theoretical value of a U.S...."
    url="/platform/data_models/SelectedTreasuryBill"
    command="true"
/>
<ReferenceCard
    title="Futures Historical Price"
    description="Futures historical data"
    url="/platform/data_models/FuturesCurve"
    command="true"
/>
<ReferenceCard
    title="Futures Historical Price"
    description="Futures historical data"
    url="/platform/data_models/FuturesHistorical"
    command="true"
/>
<ReferenceCard
    title="Available Indices"
    description="Available indices for a given provider"
    url="/platform/data_models/AvailableIndices"
    command="true"
/>
<ReferenceCard
    title="Index Constituents"
    description="Constituents of an index"
    url="/platform/data_models/IndexConstituents"
    command="true"
/>
<ReferenceCard
    title="Historical European Indices"
    description=""
    url="/platform/data_models/EuropeanIndices"
    command="true"
/>
<ReferenceCard
    title="European Index Constituents"
    description="Constituents of select european indices"
    url="/platform/data_models/EuropeanIndexConstituents"
    command="true"
/>
<ReferenceCard
    title="Historical Fred Indices"
    description="Close values for selected Fred indices"
    url="/platform/data_models/FredIndices"
    command="true"
/>
<ReferenceCard
    title="Historical Market Indices"
    description=""
    url="/platform/data_models/MarketIndices"
    command="true"
/>
<ReferenceCard
    title="Index Search"
    description="Search for indices"
    url="/platform/data_models/IndexSearch"
    command="true"
/>
<ReferenceCard
    title="Index Snapshots"
    description="Current levels for all indices from a provider"
    url="/platform/data_models/IndexSnapshots"
    command="true"
/>
<ReferenceCard
    title="S&P 500 Multiples"
    description="Historical S&P 500 multiples and Shiller PE ratios"
    url="/platform/data_models/SP500Multiples"
    command="true"
/>
<ReferenceCard
    title="Company News"
    description="Get news for one or more companies"
    url="/platform/data_models/CompanyNews"
    command="true"
/>
<ReferenceCard
    title="Global News"
    description="Global news data"
    url="/platform/data_models/GlobalNews"
    command="true"
/>
<ReferenceCard
    title="Commitment of Traders Reports"
    description="Lookup Commitment of Traders Reports by series ID"
    url="/platform/data_models/COT"
    command="true"
/>
<ReferenceCard
    title="Curated Commitment of Traders Reports"
    description="Fuzzy search and list of curated Commitment of Traders Reports series information"
    url="/platform/data_models/COTSearch"
    command="true"
/>
<ReferenceCard
    title="Get the CIK number corresponding to a ticker symbol"
    description=""
    url="/platform/data_models/CikMap"
    command="true"
/>
<ReferenceCard
    title="Look up filings to the SEC by ticker symbol or CIK"
    description=""
    url="/platform/data_models/Filings"
    command="true"
/>
<ReferenceCard
    title="Look up institutions regulated by the SEC"
    description=""
    url="/platform/data_models/InstitutionsSearch"
    command="true"
/>
<ReferenceCard
    title="The RSS feed provides links to litigation releases concerning civil lawsuits brought
    by the Commission in federal court"
    description=""
    url="/platform/data_models/RssLitigation"
    command="true"
/>
<ReferenceCard
    title="Get lists of SEC XML schema files by year"
    description=""
    url="/platform/data_models/SchemaFiles"
    command="true"
/>
<ReferenceCard
    title="Fuzzy search for Industry Titles, Reporting Office, and SIC Codes"
    description=""
    url="/platform/data_models/SicSearch"
    command="true"
/>
<ReferenceCard
    title="Get the ticker symbol corresponding to a company's CIK"
    description="Enter the CIK as a string, e.g. '0001067983'. This function is not intended for funds"
    url="/platform/data_models/SymbolMap"
    command="true"
/>
</ul>