jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 12:40:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
16cffc5f81eceda7df66461fc0029223dafd9352
OpenBB/website/content/excel/reference/docs_map.json
montezdesousa 16cffc5f81 Docs/remove core refs (#5957) 
* remove references to core: PathHandler + ProviderInterface

* remove unused function

* add comment

* regenerate

* fix a few examples

* add comment

* rename file
2024-01-15 15:24:20 +00:00

8663 lines
297 KiB
JSON
Vendored
Raw Blame History

{
"/crypto/price/historical": {
"name": "historical",
"description": "Cryptocurrency Historical Price. Cryptocurrency historical price data.",
"signature": "=OBB.CRYPTO.PRICE.HISTORICAL(symbol;[start_date];[end_date];[provider];[timeseries];[interval];[multiplier];[timespan];[sort];[limit];[adjusted];[exchanges])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.",
"required": true
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, polygon, tiingo, defaults to fmp.",
"required": false
},
"timeseries": {
"type": "Number",
"description": "Number of days to look back. (provider: fmp)",
"required": false
},
"interval": {
"type": "Text",
"description": "Data granularity. (provider: fmp, tiingo)",
"required": false
},
"multiplier": {
"type": "Number",
"description": "Multiplier of the timespan. (provider: polygon)",
"required": false
},
"timespan": {
"type": "Text",
"description": "Timespan of the data. (provider: polygon)",
"required": false
},
"sort": {
"type": "Text",
"description": "Sort order of the data. (provider: polygon)",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return. (provider: polygon)",
"required": false
},
"adjusted": {
"type": "Boolean",
"description": "Whether the data is adjusted. (provider: polygon)",
"required": false
},
"exchanges": {
"type": "Any",
"description": "To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] (provider: tiingo)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"open": {
"description": "The open price. "
},
"high": {
"description": "The high price. "
},
"low": {
"description": "The low price. "
},
"close": {
"description": "The close price. "
},
"volume": {
"description": "The trading volume. "
},
"vwap": {
"description": "Volume Weighted Average Price over the period. "
},
"adj_close": {
"description": "The adjusted close price. (provider: fmp)"
},
"unadjusted_volume": {
"description": "Unadjusted volume of the symbol. (provider: fmp)"
},
"change": {
"description": "Change in the price of the symbol from the previous day. (provider: fmp)"
},
"change_percent": {
"description": "Change % in the price of the symbol. (provider: fmp)"
},
"label": {
"description": "Human readable format of the date. (provider: fmp)"
},
"change_over_time": {
"description": "Change % in the price of the symbol over a period of time. (provider: fmp)"
},
"transactions": {
"description": "Number of transactions for the symbol in the time period. (provider: polygon, tiingo)"
},
"volume_notional": {
"description": "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. (provider: tiingo)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.CRYPTO.PRICE.HISTORICAL(\"BTCUSD\")"
}
},
"/crypto/search": {
"name": "search",
"description": "Cryptocurrency Search. Search available cryptocurrency pairs.",
"signature": "=OBB.CRYPTO.SEARCH([query];[provider])",
"parameters": {
"query": {
"type": "Text",
"description": "Search query.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. (Crypto) "
},
"name": {
"description": "Name of the crypto. "
},
"currency": {
"description": "The currency the crypto trades for. (provider: fmp)"
},
"exchange": {
"description": "The exchange code the crypto trades on. (provider: fmp)"
},
"exchange_name": {
"description": "The short name of the exchange the crypto trades on. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.CRYPTO.SEARCH()"
}
},
"/currency/price/historical": {
"name": "historical",
"description": "Currency Historical Price. Currency historical data.",
"signature": "=OBB.CURRENCY.PRICE.HISTORICAL(symbol;[start_date];[end_date];[provider];[interval];[multiplier];[timespan];[sort];[limit];[adjusted])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.",
"required": true
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, polygon, tiingo, defaults to fmp.",
"required": false
},
"interval": {
"type": "Text",
"description": "Data granularity. (provider: fmp, tiingo)",
"required": false
},
"multiplier": {
"type": "Number",
"description": "Multiplier of the timespan. (provider: polygon)",
"required": false
},
"timespan": {
"type": "Text",
"description": "Timespan of the data. (provider: polygon)",
"required": false
},
"sort": {
"type": "Text",
"description": "Sort order of the data. (provider: polygon)",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return. (provider: polygon)",
"required": false
},
"adjusted": {
"type": "Boolean",
"description": "Whether the data is adjusted. (provider: polygon)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"open": {
"description": "The open price. "
},
"high": {
"description": "The high price. "
},
"low": {
"description": "The low price. "
},
"close": {
"description": "The close price. "
},
"volume": {
"description": "The trading volume. "
},
"vwap": {
"description": "Volume Weighted Average Price over the period. "
},
"adj_close": {
"description": "The adjusted close price. (provider: fmp)"
},
"unadjusted_volume": {
"description": "Unadjusted volume of the symbol. (provider: fmp)"
},
"change": {
"description": "Change in the price of the symbol from the previous day. (provider: fmp)"
},
"change_percent": {
"description": "Change % in the price of the symbol. (provider: fmp)"
},
"label": {
"description": "Human readable format of the date. (provider: fmp)"
},
"change_over_time": {
"description": "Change % in the price of the symbol over a period of time. (provider: fmp)"
},
"transactions": {
"description": "Number of transactions for the symbol in the time period. (provider: polygon)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.CURRENCY.PRICE.HISTORICAL(\"EURUSD\")"
}
},
"/currency/search": {
"name": "search",
"description": "Currency Search. Search available currency pairs.",
"signature": "=OBB.CURRENCY.SEARCH([provider];[symbol];[date];[search];[active];[order];[sort];[limit])",
"parameters": {
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, polygon, defaults to fmp.",
"required": false
},
"symbol": {
"type": "Text",
"description": "Symbol of the pair to search. (provider: polygon)",
"required": false
},
"date": {
"type": "Text",
"description": "A specific date to get data for. (provider: polygon)",
"required": false
},
"search": {
"type": "Text",
"description": "Search for terms within the ticker and/or company name. (provider: polygon)",
"required": false
},
"active": {
"type": "Boolean",
"description": "Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)",
"required": false
},
"order": {
"type": "Text",
"description": "Order data by ascending or descending. (provider: polygon)",
"required": false
},
"sort": {
"type": "Text",
"description": "Sort field used for ordering. (provider: polygon)",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return. (provider: polygon)",
"required": false
}
},
"data": {
"name": {
"description": "Name of the currency pair. "
},
"symbol": {
"description": "Symbol of the currency pair. (provider: fmp)"
},
"currency": {
"description": "Base currency of the currency pair. (provider: fmp)"
},
"stock_exchange": {
"description": "Stock exchange of the currency pair. (provider: fmp)"
},
"exchange_short_name": {
"description": "Short name of the stock exchange of the currency pair. (provider: fmp)"
},
"code": {
"description": "Code of the currency pair. (provider: intrinio)"
},
"base_currency": {
"description": "ISO 4217 currency code of the base currency. (provider: intrinio)"
},
"quote_currency": {
"description": "ISO 4217 currency code of the quote currency. (provider: intrinio)"
},
"market": {
"description": "Name of the trading market. Always 'fx'. (provider: polygon)"
},
"locale": {
"description": "Locale of the currency pair. (provider: polygon)"
},
"currency_symbol": {
"description": "The symbol of the quote currency. (provider: polygon)"
},
"currency_name": {
"description": "Name of the quote currency. (provider: polygon)"
},
"base_currency_symbol": {
"description": "The symbol of the base currency. (provider: polygon)"
},
"base_currency_name": {
"description": "Name of the base currency. (provider: polygon)"
},
"last_updated_utc": {
"description": "The last updated timestamp in UTC. (provider: polygon)"
},
"delisted_utc": {
"description": "The delisted timestamp in UTC. (provider: polygon)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.CURRENCY.SEARCH()"
}
},
"/derivatives/options/chains": {
"name": "chains",
"description": "Get the complete options chain for a ticker.",
"signature": "=OBB.DERIVATIVES.OPTIONS.CHAINS(symbol;[provider];[date])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: intrinio, defaults to intrinio.",
"required": false
},
"date": {
"type": "Text",
"description": "Date for which the options chains are returned. (provider: intrinio)",
"required": false
}
},
"data": {
"contract_symbol": {
"description": "Contract symbol for the option. "
},
"symbol": {
"description": "Symbol representing the entity requested in the data. Here its the underlying symbol for the option. "
},
"expiration": {
"description": "Expiration date of the contract. "
},
"strike": {
"description": "Strike price of the contract. "
},
"option_type": {
"description": "Call or Put. "
},
"eod_date": {
"description": "Date for which the options chains are returned. "
},
"close": {
"description": "The close price. "
},
"close_bid": {
"description": "The closing bid price for the option that day. "
},
"close_ask": {
"description": "The closing ask price for the option that day. "
},
"volume": {
"description": "The trading volume. "
},
"open": {
"description": "The open price. "
},
"open_bid": {
"description": "The opening bid price for the option that day. "
},
"open_ask": {
"description": "The opening ask price for the option that day. "
},
"open_interest": {
"description": "Open interest on the contract. "
},
"high": {
"description": "The high price. "
},
"low": {
"description": "The low price. "
},
"mark": {
"description": "The mid-price between the latest bid-ask spread. "
},
"ask_high": {
"description": "The highest ask price for the option that day. "
},
"ask_low": {
"description": "The lowest ask price for the option that day. "
},
"bid_high": {
"description": "The highest bid price for the option that day. "
},
"bid_low": {
"description": "The lowest bid price for the option that day. "
},
"implied_volatility": {
"description": "Implied volatility of the option. "
},
"delta": {
"description": "Delta of the option. "
},
"gamma": {
"description": "Gamma of the option. "
},
"theta": {
"description": "Theta of the option. "
},
"vega": {
"description": "Vega of the option. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.DERIVATIVES.OPTIONS.CHAINS(\"AAPL\")"
}
},
"/derivatives/options/unusual": {
"name": "unusual",
"description": "Get the complete options chain for a ticker.",
"signature": "=OBB.DERIVATIVES.OPTIONS.UNUSUAL([symbol];[provider];[source])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for. (the underlying symbol)",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: intrinio, defaults to intrinio.",
"required": false
},
"source": {
"type": "Text",
"description": "The source of the data. Either realtime or delayed. (provider: intrinio)",
"required": false
}
},
"data": {
"underlying_symbol": {
"description": "Symbol representing the entity requested in the data. (the underlying symbol) "
},
"contract_symbol": {
"description": "Contract symbol for the option. "
},
"trade_type": {
"description": "The type of unusual trade. (provider: intrinio)"
},
"sentiment": {
"description": "Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price. (provider: intrinio)"
},
"total_value": {
"description": "The aggregated value of all option contract premiums included in the trade. (provider: intrinio)"
},
"total_size": {
"description": "The total number of contracts involved in a single transaction. (provider: intrinio)"
},
"average_price": {
"description": "The average premium paid per option contract. (provider: intrinio)"
},
"ask_at_execution": {
"description": "Ask price at execution. (provider: intrinio)"
},
"bid_at_execution": {
"description": "Bid price at execution. (provider: intrinio)"
},
"underlying_price_at_execution": {
"description": "Price of the underlying security at execution of trade. (provider: intrinio)"
},
"timestamp": {
"description": "The UTC timestamp of order placement. (provider: intrinio)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.DERIVATIVES.OPTIONS.UNUSUAL()"
}
},
"/economy/calendar": {
"name": "calendar",
"description": "Economic Calendar.",
"signature": "=OBB.ECONOMY.CALENDAR([start_date];[end_date];[provider];[country];[importance];[group])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, tradingeconomics, defaults to fmp.",
"required": false
},
"country": {
"type": "Any",
"description": "Country of the event (provider: tradingeconomics)",
"required": false
},
"importance": {
"type": "Text",
"description": "Importance of the event. (provider: tradingeconomics)",
"required": false
},
"group": {
"type": "Text",
"description": "Grouping of events (provider: tradingeconomics)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"country": {
"description": "Country of event. "
},
"event": {
"description": "Event name. "
},
"reference": {
"description": "Abbreviated period for which released data refers to. "
},
"source": {
"description": "Source of the data. "
},
"sourceurl": {
"description": "Source URL. "
},
"actual": {
"description": "Latest released value. "
},
"previous": {
"description": "Value for the previous period after the revision (if revision is applicable). "
},
"consensus": {
"description": "Average forecast among a representative group of economists. "
},
"forecast": {
"description": "Trading Economics projections "
},
"url": {
"description": "Trading Economics URL "
},
"importance": {
"description": "Importance of the event. 1-Low, 2-Medium, 3-High "
},
"currency": {
"description": "Currency of the data. "
},
"unit": {
"description": "Unit of the data. "
},
"change": {
"description": "Value change since previous. (provider: fmp)"
},
"change_percent": {
"description": "Percentage change since previous. (provider: fmp)"
},
"updated_at": {
"description": "Last updated timestamp. (provider: fmp)"
},
"created_at": {
"description": "Created at timestamp. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ECONOMY.CALENDAR()"
}
},
"/economy/cpi": {
"name": "cpi",
"description": "Consumer Price Index (CPI). Returns either the rescaled index value, or a rate of change (inflation).",
"signature": "=OBB.ECONOMY.CPI(countries;[units];[frequency];[harmonized];[start_date];[end_date];[provider])",
"parameters": {
"countries": {
"type": "Any",
"description": "The country or countries to get data.",
"required": true
},
"units": {
"type": "Text",
"description": "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.",
"required": false
},
"frequency": {
"type": "Text",
"description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.",
"required": false
},
"harmonized": {
"type": "Boolean",
"description": "Whether you wish to obtain harmonized data.",
"required": false
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ECONOMY.CPI(\"united_states\")"
}
},
"/economy/fred_search": {
"name": "fred_search",
"description": "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()`.",
"signature": "=OBB.ECONOMY.FRED_SEARCH([query];[provider];[is_release];[release_id];[limit];[offset];[filter_variable];[filter_value];[tag_names];[exclude_tag_names])",
"parameters": {
"query": {
"type": "Text",
"description": "The search word(s).",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
},
"is_release": {
"type": "Boolean",
"description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True. (provider: fred)",
"required": false
},
"release_id": {
"type": "Any",
"description": "A specific release ID to target. (provider: fred)",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return. (1-1000) (provider: fred)",
"required": false
},
"offset": {
"type": "Number",
"description": "Offset the results in conjunction with limit. (provider: fred)",
"required": false
},
"filter_variable": {
"type": "Any",
"description": "Filter by an attribute. (provider: fred)",
"required": false
},
"filter_value": {
"type": "Text",
"description": "String value to filter the variable by. Used in conjunction with filter_variable. (provider: fred)",
"required": false
},
"tag_names": {
"type": "Text",
"description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' (provider: fred)",
"required": false
},
"exclude_tag_names": {
"type": "Text",
"description": "A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series. (provider: fred)",
"required": false
}
},
"data": {
"release_id": {
"description": "The release ID for queries. "
},
"series_id": {
"description": "The series ID for the item in the release. "
},
"name": {
"description": "The name of the release. "
},
"title": {
"description": "The title of the series. "
},
"observation_start": {
"description": "The date of the first observation in the series. "
},
"observation_end": {
"description": "The date of the last observation in the series. "
},
"frequency": {
"description": "The frequency of the data. "
},
"frequency_short": {
"description": "Short form of the data frequency. "
},
"units": {
"description": "The units of the data. "
},
"units_short": {
"description": "Short form of the data units. "
},
"seasonal_adjustment": {
"description": "The seasonal adjustment of the data. "
},
"seasonal_adjustment_short": {
"description": "Short form of the data seasonal adjustment. "
},
"last_updated": {
"description": "The datetime of the last update to the data. "
},
"notes": {
"description": "Description of the release. "
},
"press_release": {
"description": "If the release is a press release. "
},
"url": {
"description": "URL to the release. "
},
"popularity": {
"description": "Popularity of the series (provider: fred)"
},
"group_popularity": {
"description": "Group popularity of the release (provider: fred)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ECONOMY.FRED_SEARCH()"
}
},
"/economy/fred_series": {
"name": "fred_series",
"description": "Get data by series ID from FRED.",
"signature": "=OBB.ECONOMY.FRED_SERIES(symbol;[start_date];[end_date];[limit];[provider];[frequency];[aggregation_method];[transform];[all_pages];[sleep])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, intrinio, defaults to fred.",
"required": false
},
"frequency": {
"type": "Any",
"description": "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 (provider: fred)",
"required": false
},
"aggregation_method": {
"type": "Any",
"description": "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 (provider: fred)",
"required": false
},
"transform": {
"type": "Any",
"description": "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 (provider: fred)",
"required": false
},
"all_pages": {
"type": "Boolean",
"description": "Returns all pages of data from the API call at once. (provider: intrinio)",
"required": false
},
"sleep": {
"type": "Number",
"description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"value": {
"description": "Value of the index. (provider: intrinio)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ECONOMY.FRED_SERIES(\"GFDGDPA188S\")"
}
},
"/economy/gdp/forecast": {
"name": "forecast",
"description": "Forecasted GDP Data.",
"signature": "=OBB.ECONOMY.GDP.FORECAST([period];[start_date];[end_date];[type];[provider];[country])",
"parameters": {
"period": {
"type": "Text",
"description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.",
"required": false
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"type": {
"type": "Text",
"description": "Type of GDP to get forecast of. Either nominal or real.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: oecd, defaults to oecd.",
"required": false
},
"country": {
"type": "Text",
"description": "Country to get GDP for. (provider: oecd)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"value": {
"description": "Nominal GDP value on the date. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ECONOMY.GDP.FORECAST()"
}
},
"/economy/gdp/nominal": {
"name": "nominal",
"description": "Nominal GDP Data.",
"signature": "=OBB.ECONOMY.GDP.NOMINAL([units];[start_date];[end_date];[provider];[country])",
"parameters": {
"units": {
"type": "Text",
"description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita.",
"required": false
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: oecd, defaults to oecd.",
"required": false
},
"country": {
"type": "Text",
"description": "Country to get GDP for. (provider: oecd)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"value": {
"description": "Nominal GDP value on the date. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ECONOMY.GDP.NOMINAL()"
}
},
"/economy/gdp/real": {
"name": "real",
"description": "Real GDP Data.",
"signature": "=OBB.ECONOMY.GDP.REAL([units];[start_date];[end_date];[provider];[country])",
"parameters": {
"units": {
"type": "Text",
"description": "The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).)",
"required": false
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: oecd, defaults to oecd.",
"required": false
},
"country": {
"type": "Text",
"description": "Country to get GDP for. (provider: oecd)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"value": {
"description": "Nominal GDP value on the date. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ECONOMY.GDP.REAL()"
}
},
"/economy/money_measures": {
"name": "money_measures",
"description": "Money Measures.",
"signature": "=OBB.ECONOMY.MONEY_MEASURES([start_date];[end_date];[adjusted];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"adjusted": {
"type": "Boolean",
"description": "Whether to return seasonally adjusted data.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: federal_reserve, defaults to federal_reserve.",
"required": false
}
},
"data": {
"month": {
"description": "The date of the data. "
},
"M1": {
"description": "Value of the M1 money supply in billions. "
},
"M2": {
"description": "Value of the M2 money supply in billions. "
},
"currency": {
"description": "Value of currency in circulation in billions. "
},
"demand_deposits": {
"description": "Value of demand deposits in billions. "
},
"retail_money_market_funds": {
"description": "Value of retail money market funds in billions. "
},
"other_liquid_deposits": {
"description": "Value of other liquid deposits in billions. "
},
"small_denomination_time_deposits": {
"description": "Value of small denomination time deposits in billions. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ECONOMY.MONEY_MEASURES()"
}
},
"/economy/risk_premium": {
"name": "risk_premium",
"description": "Historical Market Risk Premium.",
"signature": "=OBB.ECONOMY.RISK_PREMIUM([provider])",
"parameters": {
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"country": {
"description": "Market country. "
},
"continent": {
"description": "Continent of the country. "
},
"total_equity_risk_premium": {
"description": "Total equity risk premium for the country. "
},
"country_risk_premium": {
"description": "Country-specific risk premium. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ECONOMY.RISK_PREMIUM()"
}
},
"/equity/calendar/dividend": {
"name": "dividend",
"description": "Upcoming and Historical Dividend Calendar.",
"signature": "=OBB.EQUITY.CALENDAR.DIVIDEND([start_date];[end_date];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. (Ex-Dividend) "
},
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"amount": {
"description": "Dividend amount, per-share. "
},
"name": {
"description": "Name of the entity. "
},
"record_date": {
"description": "The record date of ownership for eligibility. "
},
"payment_date": {
"description": "The payment date of the dividend. "
},
"declaration_date": {
"description": "Declaration date of the dividend. "
},
"adjusted_amount": {
"description": "The adjusted-dividend amount. (provider: fmp)"
},
"label": {
"description": "Ex-dividend date formatted for display. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.CALENDAR.DIVIDEND()"
}
},
"/equity/calendar/earnings": {
"name": "earnings",
"description": "Upcoming and Historical earnings calendar.",
"signature": "=OBB.EQUITY.CALENDAR.EARNINGS([start_date];[end_date];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"report_date": {
"description": "The date of the earnings report. "
},
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"name": {
"description": "Name of the entity. "
},
"eps_previous": {
"description": "The earnings-per-share from the same previously reported period. "
},
"eps_consensus": {
"description": "The analyst conesus earnings-per-share estimate. "
},
"eps_actual": {
"description": "The actual earnings per share announced. (provider: fmp)"
},
"revenue_actual": {
"description": "The actual reported revenue. (provider: fmp)"
},
"revenue_consensus": {
"description": "The revenue forecast consensus. (provider: fmp)"
},
"period_ending": {
"description": "The fiscal period end date. (provider: fmp)"
},
"reporting_time": {
"description": "The reporting time - e.g. after market close. (provider: fmp)"
},
"updated_date": {
"description": "The date the data was updated last. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.CALENDAR.EARNINGS()"
}
},
"/equity/calendar/ipo": {
"name": "ipo",
"description": "Upcoming and Historical IPO Calendar.",
"signature": "=OBB.EQUITY.CALENDAR.IPO([symbol];[start_date];[end_date];[limit];[provider];[status];[offer_amount_greater_than];[offer_amount_less_than])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": false
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: intrinio, defaults to intrinio.",
"required": false
},
"status": {
"type": "Text",
"description": "Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio)",
"required": false
},
"offer_amount_greater_than": {
"type": "Number",
"description": "Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio)",
"required": false
},
"offer_amount_less_than": {
"type": "Number",
"description": "Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"ipo_date": {
"description": "The date of the IPO, when the stock first trades on a major exchange. "
},
"status": {
"description": " 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 (provider: intrinio)"
},
"exchange": {
"description": " The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ. (provider: intrinio)"
},
"offer_amount": {
"description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count (provider: intrinio)"
},
"share_price": {
"description": "The price per share at which the IPO was offered. (provider: intrinio)"
},
"share_price_lowest": {
"description": " 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). (provider: intrinio)"
},
"share_price_highest": {
"description": " 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). (provider: intrinio)"
},
"share_count": {
"description": "The number of shares offered in the IPO. (provider: intrinio)"
},
"share_count_lowest": {
"description": " 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). (provider: intrinio)"
},
"share_count_highest": {
"description": " 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). (provider: intrinio)"
},
"announcement_url": {
"description": "The URL to the company's announcement of the IPO (provider: intrinio)"
},
"sec_report_url": {
"description": " 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. (provider: intrinio)"
},
"open_price": {
"description": "The opening price at the beginning of the first trading day (only available for priced IPOs). (provider: intrinio)"
},
"close_price": {
"description": "The closing price at the end of the first trading day (only available for priced IPOs). (provider: intrinio)"
},
"volume": {
"description": "The volume at the end of the first trading day (only available for priced IPOs). (provider: intrinio)"
},
"day_change": {
"description": " The percentage change between the open price and the close price on the first trading day (only available for priced IPOs). (provider: intrinio)"
},
"week_change": {
"description": " 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). (provider: intrinio)"
},
"month_change": {
"description": " 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). (provider: intrinio)"
},
"id": {
"description": "The Intrinio ID of the IPO. (provider: intrinio)"
},
"company": {
"description": "The company that is going public via the IPO. (provider: intrinio)"
},
"security": {
"description": "The primary Security for the Company that is going public via the IPO (provider: intrinio)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.CALENDAR.IPO()"
}
},
"/equity/calendar/splits": {
"name": "splits",
"description": "Calendar Splits. Show Stock Split Calendar.",
"signature": "=OBB.EQUITY.CALENDAR.SPLITS([start_date];[end_date];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"label": {
"description": "Label of the stock splits. "
},
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"numerator": {
"description": "Numerator of the stock splits. "
},
"denominator": {
"description": "Denominator of the stock splits. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.CALENDAR.SPLITS()"
}
},
"/equity/compare/peers": {
"name": "peers",
"description": "Equity Peers. Company peers.",
"signature": "=OBB.EQUITY.COMPARE.PEERS(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"peers_list": {
"description": "A list of equity peers based on sector, exchange and market cap. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.COMPARE.PEERS(\"AAPL\")"
}
},
"/equity/discovery/filings": {
"name": "filings",
"description": "Get the most-recent filings submitted to the SEC.",
"signature": "=OBB.EQUITY.DISCOVERY.FILINGS([start_date];[end_date];[form_type];[limit];[provider];[isDone])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"form_type": {
"type": "Text",
"description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
},
"isDone": {
"type": "Boolean",
"description": "Flag for whether or not the filing is done. (provider: fmp)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"cik": {
"description": "Central Index Key (CIK) for the requested entity. "
},
"title": {
"description": "Title of the filing. "
},
"date": {
"description": "The date of the data. "
},
"form_type": {
"description": "The form type of the filing "
},
"link": {
"description": "URL to the filing page on the SEC site. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.DISCOVERY.FILINGS()"
}
},
"/equity/estimates/consensus": {
"name": "consensus",
"description": "Price Target Consensus. Price target consensus data.",
"signature": "=OBB.EQUITY.ESTIMATES.CONSENSUS(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"target_high": {
"description": "High target of the price target consensus. "
},
"target_low": {
"description": "Low target of the price target consensus. "
},
"target_consensus": {
"description": "Consensus target of the price target consensus. "
},
"target_median": {
"description": "Median target of the price target consensus. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.ESTIMATES.CONSENSUS(\"AAPL\")"
}
},
"/equity/estimates/historical": {
"name": "historical",
"description": "Historical Analyst Estimates. Analyst stock recommendations.",
"signature": "=OBB.EQUITY.ESTIMATES.HISTORICAL(symbol;[period];[limit];[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"period": {
"type": "Text",
"description": "Time period of the data to return.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"date": {
"description": "The date of the data. "
},
"estimated_revenue_low": {
"description": "Estimated revenue low. "
},
"estimated_revenue_high": {
"description": "Estimated revenue high. "
},
"estimated_revenue_avg": {
"description": "Estimated revenue average. "
},
"estimated_ebitda_low": {
"description": "Estimated EBITDA low. "
},
"estimated_ebitda_high": {
"description": "Estimated EBITDA high. "
},
"estimated_ebitda_avg": {
"description": "Estimated EBITDA average. "
},
"estimated_ebit_low": {
"description": "Estimated EBIT low. "
},
"estimated_ebit_high": {
"description": "Estimated EBIT high. "
},
"estimated_ebit_avg": {
"description": "Estimated EBIT average. "
},
"estimated_net_income_low": {
"description": "Estimated net income low. "
},
"estimated_net_income_high": {
"description": "Estimated net income high. "
},
"estimated_net_income_avg": {
"description": "Estimated net income average. "
},
"estimated_sga_expense_low": {
"description": "Estimated SGA expense low. "
},
"estimated_sga_expense_high": {
"description": "Estimated SGA expense high. "
},
"estimated_sga_expense_avg": {
"description": "Estimated SGA expense average. "
},
"estimated_eps_avg": {
"description": "Estimated EPS average. "
},
"estimated_eps_high": {
"description": "Estimated EPS high. "
},
"estimated_eps_low": {
"description": "Estimated EPS low. "
},
"number_analyst_estimated_revenue": {
"description": "Number of analysts who estimated revenue. "
},
"number_analysts_estimated_eps": {
"description": "Number of analysts who estimated EPS. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.ESTIMATES.HISTORICAL(\"AAPL\")"
}
},
"/equity/estimates/price_target": {
"name": "price_target",
"description": "Price Target. Price target data.",
"signature": "=OBB.EQUITY.ESTIMATES.PRICE_TARGET(symbol;[provider];[with_grade])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
},
"with_grade": {
"type": "Boolean",
"description": "Include upgrades and downgrades in the response. (provider: fmp)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"published_date": {
"description": "Published date of the price target. "
},
"news_url": {
"description": "News URL of the price target. "
},
"news_title": {
"description": "News title of the price target. "
},
"analyst_name": {
"description": "Analyst name. "
},
"analyst_company": {
"description": "Analyst company. "
},
"price_target": {
"description": "Price target. "
},
"adj_price_target": {
"description": "Adjusted price target. "
},
"price_when_posted": {
"description": "Price when posted. "
},
"news_publisher": {
"description": "News publisher of the price target. "
},
"news_base_url": {
"description": "News base URL of the price target. "
},
"new_grade": {
"description": "New grade (provider: fmp)"
},
"previous_grade": {
"description": "Previous grade (provider: fmp)"
},
"grading_company": {
"description": "Grading company (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.ESTIMATES.PRICE_TARGET(\"AAPL\")"
}
},
"/equity/fundamental/balance": {
"name": "balance",
"description": "Balance Sheet. Balance sheet statement.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.BALANCE(symbol;[period];[limit];[provider];[fiscal_year];[filing_date];[filing_date_lt];[filing_date_lte];[filing_date_gt];[filing_date_gte];[period_of_report_date];[period_of_report_date_lt];[period_of_report_date_lte];[period_of_report_date_gt];[period_of_report_date_gte];[include_sources];[order];[sort])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"period": {
"type": "Text",
"description": "Time period of the data to return.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, polygon, defaults to fmp.",
"required": false
},
"fiscal_year": {
"type": "Number",
"description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)",
"required": false
},
"filing_date": {
"type": "Text",
"description": "Filing date of the financial statement. (provider: polygon)",
"required": false
},
"filing_date_lt": {
"type": "Text",
"description": "Filing date less than the given date. (provider: polygon)",
"required": false
},
"filing_date_lte": {
"type": "Text",
"description": "Filing date less than or equal to the given date. (provider: polygon)",
"required": false
},
"filing_date_gt": {
"type": "Text",
"description": "Filing date greater than the given date. (provider: polygon)",
"required": false
},
"filing_date_gte": {
"type": "Text",
"description": "Filing date greater than or equal to the given date. (provider: polygon)",
"required": false
},
"period_of_report_date": {
"type": "Text",
"description": "Period of report date of the financial statement. (provider: polygon)",
"required": false
},
"period_of_report_date_lt": {
"type": "Text",
"description": "Period of report date less than the given date. (provider: polygon)",
"required": false
},
"period_of_report_date_lte": {
"type": "Text",
"description": "Period of report date less than or equal to the given date. (provider: polygon)",
"required": false
},
"period_of_report_date_gt": {
"type": "Text",
"description": "Period of report date greater than the given date. (provider: polygon)",
"required": false
},
"period_of_report_date_gte": {
"type": "Text",
"description": "Period of report date greater than or equal to the given date. (provider: polygon)",
"required": false
},
"include_sources": {
"type": "Boolean",
"description": "Whether to include the sources of the financial statement. (provider: polygon)",
"required": false
},
"order": {
"type": "Text",
"description": "Order of the financial statement. (provider: polygon)",
"required": false
},
"sort": {
"type": "Text",
"description": "Sort of the financial statement. (provider: polygon)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"period_ending": {
"description": "The end date of the reporting period. "
},
"fiscal_period": {
"description": "The fiscal period of the report. "
},
"fiscal_year": {
"description": "The fiscal year of the fiscal period. "
},
"filing_date": {
"description": "The date when the filing was made. (provider: fmp)"
},
"accepted_date": {
"description": "The date and time when the filing was accepted. (provider: fmp)"
},
"reported_currency": {
"description": "The currency in which the balance sheet was reported. (provider: fmp, intrinio)"
},
"cash_and_cash_equivalents": {
"description": "Cash and cash equivalents. (provider: fmp, intrinio)"
},
"short_term_investments": {
"description": "Short term investments. (provider: fmp, intrinio)"
},
"cash_and_short_term_investments": {
"description": "Cash and short term investments. (provider: fmp)"
},
"net_receivables": {
"description": "Net receivables. (provider: fmp)"
},
"inventory": {
"description": "Inventory. (provider: fmp, polygon)"
},
"other_current_assets": {
"description": "Other current assets. (provider: fmp, intrinio, polygon)"
},
"total_current_assets": {
"description": "Total current assets. (provider: fmp, intrinio, polygon)"
},
"plant_property_equipment_net": {
"description": "Plant property equipment net. (provider: fmp, intrinio)"
},
"goodwill": {
"description": "Goodwill. (provider: fmp, intrinio)"
},
"intangible_assets": {
"description": "Intangible assets. (provider: fmp, intrinio, polygon)"
},
"goodwill_and_intangible_assets": {
"description": "Goodwill and intangible assets. (provider: fmp)"
},
"long_term_investments": {
"description": "Long term investments. (provider: fmp, intrinio)"
},
"tax_assets": {
"description": "Tax assets. (provider: fmp)"
},
"other_non_current_assets": {
"description": "Other non current assets. (provider: fmp, polygon)"
},
"non_current_assets": {
"description": "Total non current assets. (provider: fmp)"
},
"other_assets": {
"description": "Other assets. (provider: fmp, intrinio)"
},
"total_assets": {
"description": "Total assets. (provider: fmp, intrinio, polygon)"
},
"accounts_payable": {
"description": "Accounts payable. (provider: fmp, intrinio, polygon)"
},
"short_term_debt": {
"description": "Short term debt. (provider: fmp, intrinio)"
},
"tax_payables": {
"description": "Tax payables. (provider: fmp)"
},
"current_deferred_revenue": {
"description": "Current deferred revenue. (provider: fmp, intrinio)"
},
"other_current_liabilities": {
"description": "Other current liabilities. (provider: fmp, intrinio, polygon)"
},
"total_current_liabilities": {
"description": "Total current liabilities. (provider: fmp, intrinio, polygon)"
},
"long_term_debt": {
"description": "Long term debt. (provider: fmp, intrinio, polygon)"
},
"deferred_revenue_non_current": {
"description": "Non current deferred revenue. (provider: fmp)"
},
"deferred_tax_liabilities_non_current": {
"description": "Deferred tax liabilities non current. (provider: fmp)"
},
"other_non_current_liabilities": {
"description": "Other non current liabilities. (provider: fmp, polygon)"
},
"total_non_current_liabilities": {
"description": "Total non current liabilities. (provider: fmp, intrinio, polygon)"
},
"other_liabilities": {
"description": "Other liabilities. (provider: fmp)"
},
"capital_lease_obligations": {
"description": "Capital lease obligations. (provider: fmp, intrinio)"
},
"total_liabilities": {
"description": "Total liabilities. (provider: fmp, intrinio, polygon)"
},
"preferred_stock": {
"description": "Preferred stock. (provider: fmp, intrinio, polygon)"
},
"common_stock": {
"description": "Common stock. (provider: fmp, intrinio)"
},
"retained_earnings": {
"description": "Retained earnings. (provider: fmp, intrinio)"
},
"accumulated_other_comprehensive_income": {
"description": "Accumulated other comprehensive income (loss). (provider: fmp, intrinio)"
},
"other_shareholders_equity": {
"description": "Other shareholders equity. (provider: fmp)"
},
"other_total_shareholders_equity": {
"description": "Other total shareholders equity. (provider: fmp)"
},
"total_common_equity": {
"description": "Total common equity. (provider: fmp, intrinio)"
},
"total_equity_non_controlling_interests": {
"description": "Total equity non controlling interests. (provider: fmp, intrinio)"
},
"total_liabilities_and_shareholders_equity": {
"description": "Total liabilities and shareholders equity. (provider: fmp)"
},
"minority_interest": {
"description": "Minority interest. (provider: fmp, polygon)"
},
"total_liabilities_and_total_equity": {
"description": "Total liabilities and total equity. (provider: fmp)"
},
"total_investments": {
"description": "Total investments. (provider: fmp)"
},
"total_debt": {
"description": "Total debt. (provider: fmp)"
},
"net_debt": {
"description": "Net debt. (provider: fmp)"
},
"link": {
"description": "Link to the filing. (provider: fmp)"
},
"final_link": {
"description": "Link to the filing document. (provider: fmp)"
},
"cash_and_due_from_banks": {
"description": "Cash and due from banks. (provider: intrinio)"
},
"restricted_cash": {
"description": "Restricted cash. (provider: intrinio)"
},
"federal_funds_sold": {
"description": "Federal funds sold. (provider: intrinio)"
},
"accounts_receivable": {
"description": "Accounts receivable. (provider: intrinio, polygon)"
},
"note_and_lease_receivable": {
"description": "Note and lease receivable. (Vendor non-trade receivables) (provider: intrinio)"
},
"inventories": {
"description": "Net Inventories. (provider: intrinio)"
},
"customer_and_other_receivables": {
"description": "Customer and other receivables. (provider: intrinio)"
},
"interest_bearing_deposits_at_other_banks": {
"description": "Interest bearing deposits at other banks. (provider: intrinio)"
},
"time_deposits_placed_and_other_short_term_investments": {
"description": "Time deposits placed and other short term investments. (provider: intrinio)"
},
"trading_account_securities": {
"description": "Trading account securities. (provider: intrinio)"
},
"loans_and_leases": {
"description": "Loans and leases. (provider: intrinio)"
},
"allowance_for_loan_and_lease_losses": {
"description": "Allowance for loan and lease losses. (provider: intrinio)"
},
"current_deferred_refundable_income_taxes": {
"description": "Current deferred refundable income taxes. (provider: intrinio)"
},
"loans_and_leases_net_of_allowance": {
"description": "Loans and leases net of allowance. (provider: intrinio)"
},
"accrued_investment_income": {
"description": "Accrued investment income. (provider: intrinio)"
},
"other_current_non_operating_assets": {
"description": "Other current non-operating assets. (provider: intrinio)"
},
"loans_held_for_sale": {
"description": "Loans held for sale. (provider: intrinio)"
},
"prepaid_expenses": {
"description": "Prepaid expenses. (provider: intrinio, polygon)"
},
"plant_property_equipment_gross": {
"description": "Plant property equipment gross. (provider: intrinio)"
},
"accumulated_depreciation": {
"description": "Accumulated depreciation. (provider: intrinio)"
},
"premises_and_equipment_net": {
"description": "Net premises and equipment. (provider: intrinio)"
},
"mortgage_servicing_rights": {
"description": "Mortgage servicing rights. (provider: intrinio)"
},
"unearned_premiums_asset": {
"description": "Unearned premiums asset. (provider: intrinio)"
},
"non_current_note_lease_receivables": {
"description": "Non-current note lease receivables. (provider: intrinio)"
},
"deferred_acquisition_cost": {
"description": "Deferred acquisition cost. (provider: intrinio)"
},
"separate_account_business_assets": {
"description": "Separate account business assets. (provider: intrinio)"
},
"non_current_deferred_refundable_income_taxes": {
"description": "Noncurrent deferred refundable income taxes. (provider: intrinio)"
},
"employee_benefit_assets": {
"description": "Employee benefit assets. (provider: intrinio)"
},
"other_non_current_operating_assets": {
"description": "Other noncurrent operating assets. (provider: intrinio)"
},
"other_non_current_non_operating_assets": {
"description": "Other noncurrent non-operating assets. (provider: intrinio)"
},
"interest_bearing_deposits": {
"description": "Interest bearing deposits. (provider: intrinio)"
},
"total_non_current_assets": {
"description": "Total noncurrent assets. (provider: intrinio, polygon)"
},
"non_interest_bearing_deposits": {
"description": "Non interest bearing deposits. (provider: intrinio)"
},
"federal_funds_purchased_and_securities_sold": {
"description": "Federal funds purchased and securities sold. (provider: intrinio)"
},
"bankers_acceptance_outstanding": {
"description": "Bankers acceptance outstanding. (provider: intrinio)"
},
"current_deferred_payable_income_tax_liabilities": {
"description": "Current deferred payable income tax liabilities. (provider: intrinio)"
},
"accrued_interest_payable": {
"description": "Accrued interest payable. (provider: intrinio)"
},
"accrued_expenses": {
"description": "Accrued expenses. (provider: intrinio)"
},
"other_short_term_payables": {
"description": "Other short term payables. (provider: intrinio)"
},
"customer_deposits": {
"description": "Customer deposits. (provider: intrinio)"
},
"dividends_payable": {
"description": "Dividends payable. (provider: intrinio)"
},
"claims_and_claim_expense": {
"description": "Claims and claim expense. (provider: intrinio)"
},
"future_policy_benefits": {
"description": "Future policy benefits. (provider: intrinio)"
},
"current_employee_benefit_liabilities": {
"description": "Current employee benefit liabilities. (provider: intrinio)"
},
"unearned_premiums_liability": {
"description": "Unearned premiums liability. (provider: intrinio)"
},
"other_taxes_payable": {
"description": "Other taxes payable. (provider: intrinio)"
},
"policy_holder_funds": {
"description": "Policy holder funds. (provider: intrinio)"
},
"other_current_non_operating_liabilities": {
"description": "Other current non-operating liabilities. (provider: intrinio)"
},
"separate_account_business_liabilities": {
"description": "Separate account business liabilities. (provider: intrinio)"
},
"other_long_term_liabilities": {
"description": "Other long term liabilities. (provider: intrinio)"
},
"non_current_deferred_revenue": {
"description": "Non-current deferred revenue. (provider: intrinio)"
},
"non_current_deferred_payable_income_tax_liabilities": {
"description": "Non-current deferred payable income tax liabilities. (provider: intrinio)"
},
"non_current_employee_benefit_liabilities": {
"description": "Non-current employee benefit liabilities. (provider: intrinio)"
},
"other_non_current_operating_liabilities": {
"description": "Other non-current operating liabilities. (provider: intrinio)"
},
"other_non_current_non_operating_liabilities": {
"description": "Other non-current, non-operating liabilities. (provider: intrinio)"
},
"asset_retirement_reserve_litigation_obligation": {
"description": "Asset retirement reserve litigation obligation. (provider: intrinio)"
},
"commitments_contingencies": {
"description": "Commitments contingencies. (provider: intrinio)"
},
"redeemable_non_controlling_interest": {
"description": "Redeemable non-controlling interest. (provider: intrinio, polygon)"
},
"treasury_stock": {
"description": "Treasury stock. (provider: intrinio)"
},
"participating_policy_holder_equity": {
"description": "Participating policy holder equity. (provider: intrinio)"
},
"other_equity_adjustments": {
"description": "Other equity adjustments. (provider: intrinio)"
},
"total_preferred_common_equity": {
"description": "Total preferred common equity. (provider: intrinio)"
},
"non_controlling_interest": {
"description": "Non-controlling interest. (provider: intrinio)"
},
"total_liabilities_shareholders_equity": {
"description": "Total liabilities and shareholders equity. (provider: intrinio)"
},
"marketable_securities": {
"description": "Marketable securities (provider: polygon)"
},
"property_plant_equipment_net": {
"description": "Property plant and equipment net (provider: polygon)"
},
"employee_wages": {
"description": "Employee wages (provider: polygon)"
},
"temporary_equity_attributable_to_parent": {
"description": "Temporary equity attributable to parent (provider: polygon)"
},
"equity_attributable_to_parent": {
"description": "Equity attributable to parent (provider: polygon)"
},
"temporary_equity": {
"description": "Temporary equity (provider: polygon)"
},
"redeemable_non_controlling_interest_other": {
"description": "Redeemable non-controlling interest other (provider: polygon)"
},
"total_stock_holders_equity": {
"description": "Total stock holders equity (provider: polygon)"
},
"total_liabilities_and_stock_holders_equity": {
"description": "Total liabilities and stockholders equity (provider: polygon)"
},
"total_equity": {
"description": "Total equity (provider: polygon)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.BALANCE(\"AAPL\")"
}
},
"/equity/fundamental/balance_growth": {
"name": "balance_growth",
"description": "Balance Sheet Statement Growth. Information about the growth of the company balance sheet.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.BALANCE_GROWTH(symbol;[limit];[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"date": {
"description": "The date of the data. "
},
"period": {
"description": "Reporting period. "
},
"growth_cash_and_cash_equivalents": {
"description": "Growth rate of cash and cash equivalents. "
},
"growth_short_term_investments": {
"description": "Growth rate of short-term investments. "
},
"growth_cash_and_short_term_investments": {
"description": "Growth rate of cash and short-term investments. "
},
"growth_net_receivables": {
"description": "Growth rate of net receivables. "
},
"growth_inventory": {
"description": "Growth rate of inventory. "
},
"growth_other_current_assets": {
"description": "Growth rate of other current assets. "
},
"growth_total_current_assets": {
"description": "Growth rate of total current assets. "
},
"growth_property_plant_equipment_net": {
"description": "Growth rate of net property, plant, and equipment. "
},
"growth_goodwill": {
"description": "Growth rate of goodwill. "
},
"growth_intangible_assets": {
"description": "Growth rate of intangible assets. "
},
"growth_goodwill_and_intangible_assets": {
"description": "Growth rate of goodwill and intangible assets. "
},
"growth_long_term_investments": {
"description": "Growth rate of long-term investments. "
},
"growth_tax_assets": {
"description": "Growth rate of tax assets. "
},
"growth_other_non_current_assets": {
"description": "Growth rate of other non-current assets. "
},
"growth_total_non_current_assets": {
"description": "Growth rate of total non-current assets. "
},
"growth_other_assets": {
"description": "Growth rate of other assets. "
},
"growth_total_assets": {
"description": "Growth rate of total assets. "
},
"growth_account_payables": {
"description": "Growth rate of accounts payable. "
},
"growth_short_term_debt": {
"description": "Growth rate of short-term debt. "
},
"growth_tax_payables": {
"description": "Growth rate of tax payables. "
},
"growth_deferred_revenue": {
"description": "Growth rate of deferred revenue. "
},
"growth_other_current_liabilities": {
"description": "Growth rate of other current liabilities. "
},
"growth_total_current_liabilities": {
"description": "Growth rate of total current liabilities. "
},
"growth_long_term_debt": {
"description": "Growth rate of long-term debt. "
},
"growth_deferred_revenue_non_current": {
"description": "Growth rate of non-current deferred revenue. "
},
"growth_deferrred_tax_liabilities_non_current": {
"description": "Growth rate of non-current deferred tax liabilities. "
},
"growth_other_non_current_liabilities": {
"description": "Growth rate of other non-current liabilities. "
},
"growth_total_non_current_liabilities": {
"description": "Growth rate of total non-current liabilities. "
},
"growth_other_liabilities": {
"description": "Growth rate of other liabilities. "
},
"growth_total_liabilities": {
"description": "Growth rate of total liabilities. "
},
"growth_common_stock": {
"description": "Growth rate of common stock. "
},
"growth_retained_earnings": {
"description": "Growth rate of retained earnings. "
},
"growth_accumulated_other_comprehensive_income_loss": {
"description": "Growth rate of accumulated other comprehensive income/loss. "
},
"growth_othertotal_stockholders_equity": {
"description": "Growth rate of other total stockholders' equity. "
},
"growth_total_stockholders_equity": {
"description": "Growth rate of total stockholders' equity. "
},
"growth_total_liabilities_and_stockholders_equity": {
"description": "Growth rate of total liabilities and stockholders' equity. "
},
"growth_total_investments": {
"description": "Growth rate of total investments. "
},
"growth_total_debt": {
"description": "Growth rate of total debt. "
},
"growth_net_debt": {
"description": "Growth rate of net debt. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.BALANCE_GROWTH(\"AAPL\")"
}
},
"/equity/fundamental/cash": {
"name": "cash",
"description": "Cash Flow Statement. Information about the cash flow statement.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.CASH(symbol;[period];[limit];[provider];[fiscal_year];[filing_date];[filing_date_lt];[filing_date_lte];[filing_date_gt];[filing_date_gte];[period_of_report_date];[period_of_report_date_lt];[period_of_report_date_lte];[period_of_report_date_gt];[period_of_report_date_gte];[include_sources];[order];[sort])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"period": {
"type": "Text",
"description": "Time period of the data to return.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, polygon, defaults to fmp.",
"required": false
},
"fiscal_year": {
"type": "Number",
"description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)",
"required": false
},
"filing_date": {
"type": "Text",
"description": "Filing date of the financial statement. (provider: polygon)",
"required": false
},
"filing_date_lt": {
"type": "Text",
"description": "Filing date less than the given date. (provider: polygon)",
"required": false
},
"filing_date_lte": {
"type": "Text",
"description": "Filing date less than or equal to the given date. (provider: polygon)",
"required": false
},
"filing_date_gt": {
"type": "Text",
"description": "Filing date greater than the given date. (provider: polygon)",
"required": false
},
"filing_date_gte": {
"type": "Text",
"description": "Filing date greater than or equal to the given date. (provider: polygon)",
"required": false
},
"period_of_report_date": {
"type": "Text",
"description": "Period of report date of the financial statement. (provider: polygon)",
"required": false
},
"period_of_report_date_lt": {
"type": "Text",
"description": "Period of report date less than the given date. (provider: polygon)",
"required": false
},
"period_of_report_date_lte": {
"type": "Text",
"description": "Period of report date less than or equal to the given date. (provider: polygon)",
"required": false
},
"period_of_report_date_gt": {
"type": "Text",
"description": "Period of report date greater than the given date. (provider: polygon)",
"required": false
},
"period_of_report_date_gte": {
"type": "Text",
"description": "Period of report date greater than or equal to the given date. (provider: polygon)",
"required": false
},
"include_sources": {
"type": "Boolean",
"description": "Whether to include the sources of the financial statement. (provider: polygon)",
"required": false
},
"order": {
"type": "Any",
"description": "Order of the financial statement. (provider: polygon)",
"required": false
},
"sort": {
"type": "Any",
"description": "Sort of the financial statement. (provider: polygon)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"period_ending": {
"description": "The end date of the reporting period. "
},
"fiscal_period": {
"description": "The fiscal period of the report. "
},
"fiscal_year": {
"description": "The fiscal year of the fiscal period. "
},
"filing_date": {
"description": "The date of the filing. (provider: fmp)"
},
"accepted_date": {
"description": "The date the filing was accepted. (provider: fmp)"
},
"reported_currency": {
"description": "The currency in which the cash flow statement was reported. (provider: fmp); The currency in which the balance sheet is reported. (provider: intrinio)"
},
"net_income": {
"description": "Net income. (provider: fmp); Consolidated Net Income. (provider: intrinio)"
},
"depreciation_and_amortization": {
"description": "Depreciation and amortization. (provider: fmp)"
},
"deferred_income_tax": {
"description": "Deferred income tax. (provider: fmp)"
},
"stock_based_compensation": {
"description": "Stock-based compensation. (provider: fmp)"
},
"change_in_working_capital": {
"description": "Change in working capital. (provider: fmp)"
},
"change_in_account_receivables": {
"description": "Change in account receivables. (provider: fmp)"
},
"change_in_inventory": {
"description": "Change in inventory. (provider: fmp)"
},
"change_in_account_payable": {
"description": "Change in account payable. (provider: fmp)"
},
"change_in_other_working_capital": {
"description": "Change in other working capital. (provider: fmp)"
},
"change_in_other_non_cash_items": {
"description": "Change in other non-cash items. (provider: fmp)"
},
"net_cash_from_operating_activities": {
"description": "Net cash from operating activities. (provider: fmp, intrinio)"
},
"purchase_of_property_plant_and_equipment": {
"description": "Purchase of property, plant and equipment. (provider: fmp, intrinio)"
},
"acquisitions": {
"description": "Acquisitions. (provider: fmp, intrinio)"
},
"purchase_of_investment_securities": {
"description": "Purchase of investment securities. (provider: fmp, intrinio)"
},
"sale_and_maturity_of_investments": {
"description": "Sale and maturity of investments. (provider: fmp, intrinio)"
},
"other_investing_activities": {
"description": "Other investing activities. (provider: fmp, intrinio)"
},
"net_cash_from_investing_activities": {
"description": "Net cash from investing activities. (provider: fmp, intrinio)"
},
"repayment_of_debt": {
"description": "Repayment of debt. (provider: fmp, intrinio)"
},
"issuance_of_common_equity": {
"description": "Issuance of common equity. (provider: fmp, intrinio)"
},
"repurchase_of_common_equity": {
"description": "Repurchase of common equity. (provider: fmp, intrinio)"
},
"payment_of_dividends": {
"description": "Payment of dividends. (provider: fmp, intrinio)"
},
"other_financing_activities": {
"description": "Other financing activities. (provider: fmp, intrinio)"
},
"net_cash_from_financing_activities": {
"description": "Net cash from financing activities. (provider: fmp, intrinio)"
},
"effect_of_exchange_rate_changes_on_cash": {
"description": "Effect of exchange rate changes on cash. (provider: fmp)"
},
"net_change_in_cash_and_equivalents": {
"description": "Net change in cash and equivalents. (provider: fmp, intrinio)"
},
"cash_at_beginning_of_period": {
"description": "Cash at beginning of period. (provider: fmp)"
},
"cash_at_end_of_period": {
"description": "Cash at end of period. (provider: fmp)"
},
"operating_cash_flow": {
"description": "Operating cash flow. (provider: fmp)"
},
"capital_expenditure": {
"description": "Capital expenditure. (provider: fmp)"
},
"free_cash_flow": {
"description": "Free cash flow. (provider: fmp)"
},
"link": {
"description": "Link to the filing. (provider: fmp)"
},
"final_link": {
"description": "Link to the filing document. (provider: fmp)"
},
"provision_for_loan_losses": {
"description": "Provision for Loan Losses (provider: intrinio)"
},
"provision_for_credit_losses": {
"description": "Provision for credit losses (provider: intrinio)"
},
"depreciation_expense": {
"description": "Depreciation Expense. (provider: intrinio)"
},
"amortization_expense": {
"description": "Amortization Expense. (provider: intrinio)"
},
"share_based_compensation": {
"description": "Share-based compensation. (provider: intrinio)"
},
"non_cash_adjustments_to_reconcile_net_income": {
"description": "Non-Cash Adjustments to Reconcile Net Income. (provider: intrinio)"
},
"changes_in_operating_assets_and_liabilities": {
"description": "Changes in Operating Assets and Liabilities (Net) (provider: intrinio)"
},
"net_cash_from_continuing_operating_activities": {
"description": "Net Cash from Continuing Operating Activities (provider: intrinio)"
},
"net_cash_from_discontinued_operating_activities": {
"description": "Net Cash from Discontinued Operating Activities (provider: intrinio)"
},
"net_income_continuing_operations": {
"description": "Net Income (Continuing Operations) (provider: intrinio)"
},
"net_income_discontinued_operations": {
"description": "Net Income (Discontinued Operations) (provider: intrinio)"
},
"divestitures": {
"description": "Divestitures (provider: intrinio)"
},
"sale_of_property_plant_and_equipment": {
"description": "Sale of Property, Plant, and Equipment (provider: intrinio)"
},
"purchase_of_investments": {
"description": "Purchase of Investments (provider: intrinio)"
},
"loans_held_for_sale": {
"description": "Loans Held for Sale (Net) (provider: intrinio)"
},
"net_cash_from_continuing_investing_activities": {
"description": "Net Cash from Continuing Investing Activities (provider: intrinio)"
},
"net_cash_from_discontinued_investing_activities": {
"description": "Net Cash from Discontinued Investing Activities (provider: intrinio)"
},
"repurchase_of_preferred_equity": {
"description": "Repurchase of Preferred Equity (provider: intrinio)"
},
"issuance_of_preferred_equity": {
"description": "Issuance of Preferred Equity (provider: intrinio)"
},
"issuance_of_debt": {
"description": "Issuance of Debt (provider: intrinio)"
},
"cash_interest_received": {
"description": "Cash Interest Received (provider: intrinio)"
},
"net_change_in_deposits": {
"description": "Net Change in Deposits (provider: intrinio)"
},
"net_increase_in_fed_funds_sold": {
"description": "Net Increase in Fed Funds Sold (provider: intrinio)"
},
"net_cash_from_continuing_financing_activities": {
"description": "Net Cash from Continuing Financing Activities (provider: intrinio)"
},
"net_cash_from_discontinued_financing_activities": {
"description": "Net Cash from Discontinued Financing Activities (provider: intrinio)"
},
"effect_of_exchange_rate_changes": {
"description": "Effect of Exchange Rate Changes (provider: intrinio)"
},
"other_net_changes_in_cash": {
"description": "Other Net Changes in Cash (provider: intrinio)"
},
"cash_income_taxes_paid": {
"description": "Cash Income Taxes Paid (provider: intrinio)"
},
"cash_interest_paid": {
"description": "Cash Interest Paid (provider: intrinio)"
},
"net_cash_flow_from_operating_activities_continuing": {
"description": "Net cash flow from operating activities continuing. (provider: polygon)"
},
"net_cash_flow_from_operating_activities_discontinued": {
"description": "Net cash flow from operating activities discontinued. (provider: polygon)"
},
"net_cash_flow_from_operating_activities": {
"description": "Net cash flow from operating activities. (provider: polygon)"
},
"net_cash_flow_from_investing_activities_continuing": {
"description": "Net cash flow from investing activities continuing. (provider: polygon)"
},
"net_cash_flow_from_investing_activities_discontinued": {
"description": "Net cash flow from investing activities discontinued. (provider: polygon)"
},
"net_cash_flow_from_investing_activities": {
"description": "Net cash flow from investing activities. (provider: polygon)"
},
"net_cash_flow_from_financing_activities_continuing": {
"description": "Net cash flow from financing activities continuing. (provider: polygon)"
},
"net_cash_flow_from_financing_activities_discontinued": {
"description": "Net cash flow from financing activities discontinued. (provider: polygon)"
},
"net_cash_flow_from_financing_activities": {
"description": "Net cash flow from financing activities. (provider: polygon)"
},
"net_cash_flow_continuing": {
"description": "Net cash flow continuing. (provider: polygon)"
},
"net_cash_flow_discontinued": {
"description": "Net cash flow discontinued. (provider: polygon)"
},
"exchange_gains_losses": {
"description": "Exchange gains losses. (provider: polygon)"
},
"net_cash_flow": {
"description": "Net cash flow. (provider: polygon)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.CASH(\"AAPL\")"
}
},
"/equity/fundamental/cash_growth": {
"name": "cash_growth",
"description": "Cash Flow Statement Growth. Information about the growth of the company cash flow statement.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.CASH_GROWTH(symbol;[limit];[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"date": {
"description": "The date of the data. "
},
"period": {
"description": "Period the statement is returned for. "
},
"growth_net_income": {
"description": "Growth rate of net income. "
},
"growth_depreciation_and_amortization": {
"description": "Growth rate of depreciation and amortization. "
},
"growth_deferred_income_tax": {
"description": "Growth rate of deferred income tax. "
},
"growth_stock_based_compensation": {
"description": "Growth rate of stock-based compensation. "
},
"growth_change_in_working_capital": {
"description": "Growth rate of change in working capital. "
},
"growth_accounts_receivables": {
"description": "Growth rate of accounts receivables. "
},
"growth_inventory": {
"description": "Growth rate of inventory. "
},
"growth_accounts_payables": {
"description": "Growth rate of accounts payables. "
},
"growth_other_working_capital": {
"description": "Growth rate of other working capital. "
},
"growth_other_non_cash_items": {
"description": "Growth rate of other non-cash items. "
},
"growth_net_cash_provided_by_operating_activities": {
"description": "Growth rate of net cash provided by operating activities. "
},
"growth_investments_in_property_plant_and_equipment": {
"description": "Growth rate of investments in property, plant, and equipment. "
},
"growth_acquisitions_net": {
"description": "Growth rate of net acquisitions. "
},
"growth_purchases_of_investments": {
"description": "Growth rate of purchases of investments. "
},
"growth_sales_maturities_of_investments": {
"description": "Growth rate of sales maturities of investments. "
},
"growth_other_investing_activities": {
"description": "Growth rate of other investing activities. "
},
"growth_net_cash_used_for_investing_activities": {
"description": "Growth rate of net cash used for investing activities. "
},
"growth_debt_repayment": {
"description": "Growth rate of debt repayment. "
},
"growth_common_stock_issued": {
"description": "Growth rate of common stock issued. "
},
"growth_common_stock_repurchased": {
"description": "Growth rate of common stock repurchased. "
},
"growth_dividends_paid": {
"description": "Growth rate of dividends paid. "
},
"growth_other_financing_activities": {
"description": "Growth rate of other financing activities. "
},
"growth_net_cash_used_provided_by_financing_activities": {
"description": "Growth rate of net cash used/provided by financing activities. "
},
"growth_effect_of_forex_changes_on_cash": {
"description": "Growth rate of the effect of foreign exchange changes on cash. "
},
"growth_net_change_in_cash": {
"description": "Growth rate of net change in cash. "
},
"growth_cash_at_end_of_period": {
"description": "Growth rate of cash at the end of the period. "
},
"growth_cash_at_beginning_of_period": {
"description": "Growth rate of cash at the beginning of the period. "
},
"growth_operating_cash_flow": {
"description": "Growth rate of operating cash flow. "
},
"growth_capital_expenditure": {
"description": "Growth rate of capital expenditure. "
},
"growth_free_cash_flow": {
"description": "Growth rate of free cash flow. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.CASH_GROWTH(\"AAPL\")"
}
},
"/equity/fundamental/dividends": {
"name": "dividends",
"description": "Historical Dividends. Historical dividends data for a given company.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.DIVIDENDS(symbol;[provider];[page_size])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, defaults to fmp.",
"required": false
},
"page_size": {
"type": "Number",
"description": "The number of data entries to return. (provider: intrinio)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"dividend": {
"description": "Dividend of the historical dividends. "
},
"label": {
"description": "Label of the historical dividends. (provider: fmp)"
},
"adj_dividend": {
"description": "Adjusted dividend of the historical dividends. (provider: fmp)"
},
"record_date": {
"description": "Record date of the historical dividends. (provider: fmp)"
},
"payment_date": {
"description": "Payment date of the historical dividends. (provider: fmp)"
},
"declaration_date": {
"description": "Declaration date of the historical dividends. (provider: fmp)"
},
"factor": {
"description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices. (provider: intrinio)"
},
"dividend_currency": {
"description": "The currency of the dividend. (provider: intrinio)"
},
"split_ratio": {
"description": "The ratio of the stock split, if a stock split occurred. (provider: intrinio)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.DIVIDENDS(\"AAPL\")"
}
},
"/equity/fundamental/employee_count": {
"name": "employee_count",
"description": "Historical Employees. Historical number of employees.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"cik": {
"description": "Central Index Key (CIK) for the requested entity. "
},
"acceptance_time": {
"description": "Time of acceptance of the company employee. "
},
"period_of_report": {
"description": "Date of reporting of the company employee. "
},
"company_name": {
"description": "Registered name of the company to retrieve the historical employees of. "
},
"form_type": {
"description": "Form type of the company employee. "
},
"filing_date": {
"description": "Filing date of the company employee "
},
"employee_count": {
"description": "Count of employees of the company. "
},
"source": {
"description": "Source URL which retrieves this data for the company. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT(\"AAPL\")"
}
},
"/equity/fundamental/filings": {
"name": "filings",
"description": "Company Filings. Company filings data.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.FILINGS([symbol];[provider];[form_type];[limit];[start_date];[end_date];[thea_enabled];[cik];[use_cache])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, sec, defaults to fmp.",
"required": false
},
"form_type": {
"type": "Text",
"description": "Type of the SEC filing form. (provider: sec)",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format. (provider: intrinio)",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format. (provider: intrinio)",
"required": false
},
"thea_enabled": {
"type": "Boolean",
"description": "Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio)",
"required": false
},
"cik": {
"type": "Any",
"description": "Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec)",
"required": false
},
"use_cache": {
"type": "Boolean",
"description": "Whether or not to use cache. If True, cache will store for one day. (provider: sec)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"cik": {
"description": "Central Index Key (CIK) for the requested entity. "
},
"filing_date": {
"description": "Filing date of the SEC report. "
},
"accepted_date": {
"description": "Accepted date of the SEC report. "
},
"report_type": {
"description": "Type of the SEC report. "
},
"filing_url": {
"description": "URL to the filing page on the SEC site. "
},
"report_url": {
"description": "URL to the actual report on the SEC site. "
},
"id": {
"description": "Intrinio ID of the filing. (provider: intrinio)"
},
"period_end_date": {
"description": "Ending date of the fiscal period for the filing. (provider: intrinio)"
},
"sec_unique_id": {
"description": "SEC unique ID of the filing. (provider: intrinio)"
},
"instance_url": {
"description": "URL for the XBRL filing for the report. (provider: intrinio)"
},
"industry_group": {
"description": "Industry group of the company. (provider: intrinio)"
},
"industry_category": {
"description": "Industry category of the company. (provider: intrinio)"
},
"report_date": {
"description": "The date of the filing. (provider: sec)"
},
"act": {
"description": "The SEC Act number. (provider: sec)"
},
"items": {
"description": "The SEC Item numbers. (provider: sec)"
},
"primary_doc_description": {
"description": "The description of the primary document. (provider: sec)"
},
"primary_doc": {
"description": "The filename of the primary document. (provider: sec)"
},
"accession_number": {
"description": "The accession number. (provider: sec)"
},
"file_number": {
"description": "The file number. (provider: sec)"
},
"film_number": {
"description": "The film number. (provider: sec)"
},
"is_inline_xbrl": {
"description": "Whether the filing is an inline XBRL filing. (provider: sec)"
},
"is_xbrl": {
"description": "Whether the filing is an XBRL filing. (provider: sec)"
},
"size": {
"description": "The size of the filing. (provider: sec)"
},
"complete_submission_url": {
"description": "The URL to the complete filing submission. (provider: sec)"
},
"filing_detail_url": {
"description": "The URL to the filing details. (provider: sec)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.FILINGS()"
}
},
"/equity/fundamental/historical_attributes": {
"name": "historical_attributes",
"description": "Fetch the historical values of a data tag from Intrinio.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES(symbol;tag;[start_date];[end_date];[frequency];[limit];[type];[sort];[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"tag": {
"type": "Text",
"description": "Intrinio data tag ID or code.",
"required": true
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"frequency": {
"type": "Text",
"description": "The frequency of the data.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"type": {
"type": "Text",
"description": "Filter by type, when applicable.",
"required": false
},
"sort": {
"type": "Text",
"description": "Sort order.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: intrinio, defaults to intrinio.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"value": {
"description": "The value of the data. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES(\"AAPL\";\"ebitda\")"
}
},
"/equity/fundamental/historical_eps": {
"name": "historical_eps",
"description": "Historical earnings-per-share for a given company.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_EPS(symbol;[provider];[limit])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return. (provider: fmp)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"announce_time": {
"description": "Timing of the earnings announcement. "
},
"eps_actual": {
"description": "Actual EPS from the earnings date. "
},
"eps_estimated": {
"description": "Estimated EPS for the earnings date. "
},
"revenue_estimated": {
"description": "Estimated consensus revenue for the reporting period. (provider: fmp)"
},
"revenue_actual": {
"description": "The actual reported revenue. (provider: fmp)"
},
"reporting_time": {
"description": "The reporting time - e.g. after market close. (provider: fmp)"
},
"updated_at": {
"description": "The date when the data was last updated. (provider: fmp)"
},
"period_ending": {
"description": "The fiscal period end date. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_EPS(\"AAPL\")"
}
},
"/equity/fundamental/historical_splits": {
"name": "historical_splits",
"description": "Historical Splits. Historical splits data.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"label": {
"description": "Label of the historical stock splits. "
},
"numerator": {
"description": "Numerator of the historical stock splits. "
},
"denominator": {
"description": "Denominator of the historical stock splits. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS(\"AAPL\")"
}
},
"/equity/fundamental/income": {
"name": "income",
"description": "Income Statement. Report on a company's financial performance.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.INCOME(symbol;[period];[limit];[provider];[fiscal_year];[filing_date];[filing_date_lt];[filing_date_lte];[filing_date_gt];[filing_date_gte];[period_of_report_date];[period_of_report_date_lt];[period_of_report_date_lte];[period_of_report_date_gt];[period_of_report_date_gte];[include_sources];[order];[sort])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"period": {
"type": "Text",
"description": "Time period of the data to return.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, polygon, defaults to fmp.",
"required": false
},
"fiscal_year": {
"type": "Number",
"description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)",
"required": false
},
"filing_date": {
"type": "Text",
"description": "Filing date of the financial statement. (provider: polygon)",
"required": false
},
"filing_date_lt": {
"type": "Text",
"description": "Filing date less than the given date. (provider: polygon)",
"required": false
},
"filing_date_lte": {
"type": "Text",
"description": "Filing date less than or equal to the given date. (provider: polygon)",
"required": false
},
"filing_date_gt": {
"type": "Text",
"description": "Filing date greater than the given date. (provider: polygon)",
"required": false
},
"filing_date_gte": {
"type": "Text",
"description": "Filing date greater than or equal to the given date. (provider: polygon)",
"required": false
},
"period_of_report_date": {
"type": "Text",
"description": "Period of report date of the financial statement. (provider: polygon)",
"required": false
},
"period_of_report_date_lt": {
"type": "Text",
"description": "Period of report date less than the given date. (provider: polygon)",
"required": false
},
"period_of_report_date_lte": {
"type": "Text",
"description": "Period of report date less than or equal to the given date. (provider: polygon)",
"required": false
},
"period_of_report_date_gt": {
"type": "Text",
"description": "Period of report date greater than the given date. (provider: polygon)",
"required": false
},
"period_of_report_date_gte": {
"type": "Text",
"description": "Period of report date greater than or equal to the given date. (provider: polygon)",
"required": false
},
"include_sources": {
"type": "Boolean",
"description": "Whether to include the sources of the financial statement. (provider: polygon)",
"required": false
},
"order": {
"type": "Text",
"description": "Order of the financial statement. (provider: polygon)",
"required": false
},
"sort": {
"type": "Text",
"description": "Sort of the financial statement. (provider: polygon)",
"required": false
}
},
"data": {
"period_ending": {
"description": "The end date of the reporting period. "
},
"fiscal_period": {
"description": "The fiscal period of the report. "
},
"fiscal_year": {
"description": "The fiscal year of the fiscal period. "
},
"symbol": {
"description": "Symbol representing the entity requested in the data. (provider: fmp); Symbol of the company. (provider: intrinio)"
},
"filing_date": {
"description": "The date when the filing was made. (provider: fmp)"
},
"accepted_date": {
"description": "The date and time when the filing was accepted. (provider: fmp)"
},
"reported_currency": {
"description": "The currency in which the balance sheet was reported. (provider: fmp, intrinio)"
},
"revenue": {
"description": "Total revenue. (provider: fmp, intrinio, polygon)"
},
"cost_of_revenue": {
"description": "Cost of revenue. (provider: fmp, intrinio, polygon)"
},
"gross_profit": {
"description": "Gross profit. (provider: fmp, intrinio, polygon)"
},
"gross_profit_margin": {
"description": "Gross profit margin. (provider: fmp); Gross margin ratio. (provider: intrinio)"
},
"general_and_admin_expense": {
"description": "General and administrative expenses. (provider: fmp)"
},
"research_and_development_expense": {
"description": "Research and development expenses. (provider: fmp, intrinio)"
},
"selling_and_marketing_expense": {
"description": "Selling and marketing expenses. (provider: fmp)"
},
"selling_general_and_admin_expense": {
"description": "Selling, general and administrative expenses. (provider: fmp, intrinio)"
},
"other_expenses": {
"description": "Other expenses. (provider: fmp)"
},
"total_operating_expenses": {
"description": "Total operating expenses. (provider: fmp, intrinio)"
},
"cost_and_expenses": {
"description": "Cost and expenses. (provider: fmp)"
},
"interest_income": {
"description": "Interest income. (provider: fmp)"
},
"total_interest_expense": {
"description": "Total interest expenses. (provider: fmp, intrinio); Interest Expense (provider: polygon)"
},
"depreciation_and_amortization": {
"description": "Depreciation and amortization. (provider: fmp, polygon)"
},
"ebitda": {
"description": "EBITDA. (provider: fmp); Earnings Before Interest, Taxes, Depreciation and Amortization. (provider: intrinio)"
},
"ebitda_margin": {
"description": "EBITDA margin. (provider: fmp); Margin on Earnings Before Interest, Taxes, Depreciation and Amortization. (provider: intrinio)"
},
"total_operating_income": {
"description": "Total operating income. (provider: fmp, intrinio)"
},
"operating_income_margin": {
"description": "Operating income margin. (provider: fmp)"
},
"total_other_income_expenses": {
"description": "Total other income and expenses. (provider: fmp)"
},
"total_pre_tax_income": {
"description": "Total pre-tax income. (provider: fmp, intrinio); Income Before Tax (provider: polygon)"
},
"pre_tax_income_margin": {
"description": "Pre-tax income margin. (provider: fmp, intrinio)"
},
"income_tax_expense": {
"description": "Income tax expense. (provider: fmp, intrinio, polygon)"
},
"consolidated_net_income": {
"description": "Consolidated net income. (provider: fmp, intrinio); Net Income/Loss (provider: polygon)"
},
"net_income_margin": {
"description": "Net income margin. (provider: fmp)"
},
"basic_earnings_per_share": {
"description": "Basic earnings per share. (provider: fmp, intrinio); Earnings Per Share (provider: polygon)"
},
"diluted_earnings_per_share": {
"description": "Diluted earnings per share. (provider: fmp, intrinio, polygon)"
},
"weighted_average_basic_shares_outstanding": {
"description": "Weighted average basic shares outstanding. (provider: fmp, intrinio); Basic Average Shares (provider: polygon)"
},
"weighted_average_diluted_shares_outstanding": {
"description": "Weighted average diluted shares outstanding. (provider: fmp, intrinio); Diluted Average Shares (provider: polygon)"
},
"link": {
"description": "Link to the filing. (provider: fmp)"
},
"final_link": {
"description": "Link to the filing document. (provider: fmp)"
},
"operating_revenue": {
"description": "Total operating revenue (provider: intrinio)"
},
"operating_cost_of_revenue": {
"description": "Total operating cost of revenue (provider: intrinio)"
},
"provision_for_credit_losses": {
"description": "Provision for credit losses (provider: intrinio)"
},
"salaries_and_employee_benefits": {
"description": "Salaries and employee benefits (provider: intrinio)"
},
"marketing_expense": {
"description": "Marketing expense (provider: intrinio)"
},
"net_occupancy_and_equipment_expense": {
"description": "Net occupancy and equipment expense (provider: intrinio)"
},
"other_operating_expenses": {
"description": "Other operating expenses (provider: intrinio, polygon)"
},
"depreciation_expense": {
"description": "Depreciation expense (provider: intrinio)"
},
"amortization_expense": {
"description": "Amortization expense (provider: intrinio)"
},
"amortization_of_deferred_policy_acquisition_costs": {
"description": "Amortization of deferred policy acquisition costs (provider: intrinio)"
},
"exploration_expense": {
"description": "Exploration expense (provider: intrinio)"
},
"depletion_expense": {
"description": "Depletion expense (provider: intrinio)"
},
"deposits_and_money_market_investments_interest_income": {
"description": "Deposits and money market investments interest income (provider: intrinio)"
},
"federal_funds_sold_and_securities_borrowed_interest_income": {
"description": "Federal funds sold and securities borrowed interest income (provider: intrinio)"
},
"investment_securities_interest_income": {
"description": "Investment securities interest income (provider: intrinio)"
},
"loans_and_leases_interest_income": {
"description": "Loans and leases interest income (provider: intrinio)"
},
"trading_account_interest_income": {
"description": "Trading account interest income (provider: intrinio)"
},
"other_interest_income": {
"description": "Other interest income (provider: intrinio)"
},
"total_non_interest_income": {
"description": "Total non-interest income (provider: intrinio)"
},
"interest_and_investment_income": {
"description": "Interest and investment income (provider: intrinio)"
},
"short_term_borrowings_interest_expense": {
"description": "Short-term borrowings interest expense (provider: intrinio)"
},
"long_term_debt_interest_expense": {
"description": "Long-term debt interest expense (provider: intrinio)"
},
"capitalized_lease_obligations_interest_expense": {
"description": "Capitalized lease obligations interest expense (provider: intrinio)"
},
"deposits_interest_expense": {
"description": "Deposits interest expense (provider: intrinio)"
},
"federal_funds_purchased_and_securities_sold_interest_expense": {
"description": "Federal funds purchased and securities sold interest expense (provider: intrinio)"
},
"other_interest_expense": {
"description": "Other interest expense (provider: intrinio)"
},
"net_interest_income": {
"description": "Net interest income (provider: intrinio); Interest Income Net (provider: polygon)"
},
"other_non_interest_income": {
"description": "Other non-interest income (provider: intrinio)"
},
"investment_banking_income": {
"description": "Investment banking income (provider: intrinio)"
},
"trust_fees_by_commissions": {
"description": "Trust fees by commissions (provider: intrinio)"
},
"premiums_earned": {
"description": "Premiums earned (provider: intrinio)"
},
"insurance_policy_acquisition_costs": {
"description": "Insurance policy acquisition costs (provider: intrinio)"
},
"current_and_future_benefits": {
"description": "Current and future benefits (provider: intrinio)"
},
"property_and_liability_insurance_claims": {
"description": "Property and liability insurance claims (provider: intrinio)"
},
"total_non_interest_expense": {
"description": "Total non-interest expense (provider: intrinio)"
},
"net_realized_and_unrealized_capital_gains_on_investments": {
"description": "Net realized and unrealized capital gains on investments (provider: intrinio)"
},
"other_gains": {
"description": "Other gains (provider: intrinio)"
},
"non_operating_income": {
"description": "Non-operating income (provider: intrinio); Non Operating Income/Loss (provider: polygon)"
},
"other_income": {
"description": "Other income (provider: intrinio)"
},
"other_revenue": {
"description": "Other revenue (provider: intrinio)"
},
"extraordinary_income": {
"description": "Extraordinary income (provider: intrinio)"
},
"total_other_income": {
"description": "Total other income (provider: intrinio)"
},
"ebit": {
"description": "Earnings Before Interest and Taxes. (provider: intrinio)"
},
"impairment_charge": {
"description": "Impairment charge (provider: intrinio)"
},
"restructuring_charge": {
"description": "Restructuring charge (provider: intrinio)"
},
"service_charges_on_deposit_accounts": {
"description": "Service charges on deposit accounts (provider: intrinio)"
},
"other_service_charges": {
"description": "Other service charges (provider: intrinio)"
},
"other_special_charges": {
"description": "Other special charges (provider: intrinio)"
},
"other_cost_of_revenue": {
"description": "Other cost of revenue (provider: intrinio)"
},
"net_income_continuing_operations": {
"description": "Net income (continuing operations) (provider: intrinio)"
},
"net_income_discontinued_operations": {
"description": "Net income (discontinued operations) (provider: intrinio)"
},
"other_adjustments_to_consolidated_net_income": {
"description": "Other adjustments to consolidated net income (provider: intrinio)"
},
"other_adjustment_to_net_income_attributable_to_common_shareholders": {
"description": "Other adjustment to net income attributable to common shareholders (provider: intrinio)"
},
"net_income_attributable_to_noncontrolling_interest": {
"description": "Net income attributable to noncontrolling interest (provider: intrinio)"
},
"net_income_attributable_to_common_shareholders": {
"description": "Net income attributable to common shareholders (provider: intrinio); Net Income/Loss Available To Common Stockholders Basic (provider: polygon)"
},
"basic_and_diluted_earnings_per_share": {
"description": "Basic and diluted earnings per share (provider: intrinio)"
},
"cash_dividends_to_common_per_share": {
"description": "Cash dividends to common per share (provider: intrinio)"
},
"preferred_stock_dividends_declared": {
"description": "Preferred stock dividends declared (provider: intrinio)"
},
"weighted_average_basic_and_diluted_shares_outstanding": {
"description": "Weighted average basic and diluted shares outstanding (provider: intrinio)"
},
"cost_of_revenue_goods": {
"description": "Cost of Revenue - Goods (provider: polygon)"
},
"cost_of_revenue_services": {
"description": "Cost of Revenue - Services (provider: polygon)"
},
"provisions_for_loan_lease_and_other_losses": {
"description": "Provisions for loan lease and other losses (provider: polygon)"
},
"income_tax_expense_benefit_current": {
"description": "Income tax expense benefit current (provider: polygon)"
},
"deferred_tax_benefit": {
"description": "Deferred tax benefit (provider: polygon)"
},
"benefits_costs_expenses": {
"description": "Benefits, costs and expenses (provider: polygon)"
},
"selling_general_and_administrative_expense": {
"description": "Selling, general and administrative expense (provider: polygon)"
},
"research_and_development": {
"description": "Research and development (provider: polygon)"
},
"costs_and_expenses": {
"description": "Costs and expenses (provider: polygon)"
},
"operating_expenses": {
"description": "Operating expenses (provider: polygon)"
},
"operating_income": {
"description": "Operating Income/Loss (provider: polygon)"
},
"interest_and_dividend_income": {
"description": "Interest and Dividend Income (provider: polygon)"
},
"interest_and_debt_expense": {
"description": "Interest and Debt Expense (provider: polygon)"
},
"interest_income_after_provision_for_losses": {
"description": "Interest Income After Provision for Losses (provider: polygon)"
},
"non_interest_expense": {
"description": "Non-Interest Expense (provider: polygon)"
},
"non_interest_income": {
"description": "Non-Interest Income (provider: polygon)"
},
"income_from_discontinued_operations_net_of_tax_on_disposal": {
"description": "Income From Discontinued Operations Net of Tax on Disposal (provider: polygon)"
},
"income_from_discontinued_operations_net_of_tax": {
"description": "Income From Discontinued Operations Net of Tax (provider: polygon)"
},
"income_before_equity_method_investments": {
"description": "Income Before Equity Method Investments (provider: polygon)"
},
"income_from_equity_method_investments": {
"description": "Income From Equity Method Investments (provider: polygon)"
},
"income_after_tax": {
"description": "Income After Tax (provider: polygon)"
},
"net_income_attributable_noncontrolling_interest": {
"description": "Net income (loss) attributable to noncontrolling interest (provider: polygon)"
},
"net_income_attributable_to_parent": {
"description": "Net income (loss) attributable to parent (provider: polygon)"
},
"participating_securities_earnings": {
"description": "Participating Securities Distributed And Undistributed Earnings Loss Basic (provider: polygon)"
},
"undistributed_earnings_allocated_to_participating_securities": {
"description": "Undistributed Earnings Allocated To Participating Securities (provider: polygon)"
},
"common_stock_dividends": {
"description": "Common Stock Dividends (provider: polygon)"
},
"preferred_stock_dividends_and_other_adjustments": {
"description": "Preferred stock dividends and other adjustments (provider: polygon)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.INCOME(\"AAPL\")"
}
},
"/equity/fundamental/income_growth": {
"name": "income_growth",
"description": "Income Statement Growth. Information about the growth of the company income statement.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.INCOME_GROWTH(symbol;[limit];[period];[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"period": {
"type": "Text",
"description": "Time period of the data to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"date": {
"description": "The date of the data. "
},
"period": {
"description": "Period the statement is returned for. "
},
"growth_revenue": {
"description": "Growth rate of total revenue. "
},
"growth_cost_of_revenue": {
"description": "Growth rate of cost of goods sold. "
},
"growth_gross_profit": {
"description": "Growth rate of gross profit. "
},
"growth_gross_profit_ratio": {
"description": "Growth rate of gross profit as a percentage of revenue. "
},
"growth_research_and_development_expenses": {
"description": "Growth rate of expenses on research and development. "
},
"growth_general_and_administrative_expenses": {
"description": "Growth rate of general and administrative expenses. "
},
"growth_selling_and_marketing_expenses": {
"description": "Growth rate of expenses on selling and marketing activities. "
},
"growth_other_expenses": {
"description": "Growth rate of other operating expenses. "
},
"growth_operating_expenses": {
"description": "Growth rate of total operating expenses. "
},
"growth_cost_and_expenses": {
"description": "Growth rate of total costs and expenses. "
},
"growth_interest_expense": {
"description": "Growth rate of interest expenses. "
},
"growth_depreciation_and_amortization": {
"description": "Growth rate of depreciation and amortization expenses. "
},
"growth_ebitda": {
"description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization. "
},
"growth_ebitda_ratio": {
"description": "Growth rate of EBITDA as a percentage of revenue. "
},
"growth_operating_income": {
"description": "Growth rate of operating income. "
},
"growth_operating_income_ratio": {
"description": "Growth rate of operating income as a percentage of revenue. "
},
"growth_total_other_income_expenses_net": {
"description": "Growth rate of net total other income and expenses. "
},
"growth_income_before_tax": {
"description": "Growth rate of income before taxes. "
},
"growth_income_before_tax_ratio": {
"description": "Growth rate of income before taxes as a percentage of revenue. "
},
"growth_income_tax_expense": {
"description": "Growth rate of income tax expenses. "
},
"growth_net_income": {
"description": "Growth rate of net income. "
},
"growth_net_income_ratio": {
"description": "Growth rate of net income as a percentage of revenue. "
},
"growth_eps": {
"description": "Growth rate of Earnings Per Share (EPS). "
},
"growth_eps_diluted": {
"description": "Growth rate of diluted Earnings Per Share (EPS). "
},
"growth_weighted_average_shs_out": {
"description": "Growth rate of weighted average shares outstanding. "
},
"growth_weighted_average_shs_out_dil": {
"description": "Growth rate of diluted weighted average shares outstanding. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.INCOME_GROWTH(\"AAPL\")"
}
},
"/equity/fundamental/latest_attributes": {
"name": "latest_attributes",
"description": "Fetch the latest value of a data tag from Intrinio.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES(symbol;tag;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"tag": {
"type": "Text",
"description": "Intrinio data tag ID or code.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: intrinio, defaults to intrinio.",
"required": false
}
},
"data": {
"value": {
"description": "The value of the data. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES(\"AAPL\";\"ebitda\")"
}
},
"/equity/fundamental/management": {
"name": "management",
"description": "Key Executives. Key executives for a given company.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"title": {
"description": "Designation of the key executive. "
},
"name": {
"description": "Name of the key executive. "
},
"pay": {
"description": "Pay of the key executive. "
},
"currency_pay": {
"description": "Currency of the pay. "
},
"gender": {
"description": "Gender of the key executive. "
},
"year_born": {
"description": "Birth year of the key executive. "
},
"title_since": {
"description": "Date the tile was held since. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT(\"AAPL\")"
}
},
"/equity/fundamental/management_compensation": {
"name": "management_compensation",
"description": "Get Executive Compensation. Information about the executive compensation for a given company.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"cik": {
"description": "Central Index Key (CIK) for the requested entity. "
},
"filing_date": {
"description": "Date of the filing. "
},
"accepted_date": {
"description": "Date the filing was accepted. "
},
"name_and_position": {
"description": "Name and position of the executive. "
},
"year": {
"description": "Year of the compensation. "
},
"salary": {
"description": "Salary of the executive. "
},
"bonus": {
"description": "Bonus of the executive. "
},
"stock_award": {
"description": "Stock award of the executive. "
},
"incentive_plan_compensation": {
"description": "Incentive plan compensation of the executive. "
},
"all_other_compensation": {
"description": "All other compensation of the executive. "
},
"total": {
"description": "Total compensation of the executive. "
},
"url": {
"description": "URL of the filing data. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION(\"AAPL\")"
}
},
"/equity/fundamental/metrics": {
"name": "metrics",
"description": "Key Metrics. Key metrics for a given company.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.METRICS(symbol;[period];[limit];[provider];[with_ttm])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"period": {
"type": "Text",
"description": "Time period of the data to return.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, defaults to fmp.",
"required": false
},
"with_ttm": {
"type": "Boolean",
"description": "Include trailing twelve months (TTM) data. (provider: fmp)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"market_cap": {
"description": "Market capitalization "
},
"pe_ratio": {
"description": "Price-to-earnings ratio (P/E ratio) "
},
"date": {
"description": "The date of the data. (provider: fmp)"
},
"period": {
"description": "Period of the data. (provider: fmp)"
},
"calendar_year": {
"description": "Calendar year. (provider: fmp)"
},
"revenue_per_share": {
"description": "Revenue per share (provider: fmp)"
},
"net_income_per_share": {
"description": "Net income per share (provider: fmp)"
},
"operating_cash_flow_per_share": {
"description": "Operating cash flow per share (provider: fmp)"
},
"free_cash_flow_per_share": {
"description": "Free cash flow per share (provider: fmp)"
},
"cash_per_share": {
"description": "Cash per share (provider: fmp)"
},
"book_value_per_share": {
"description": "Book value per share (provider: fmp)"
},
"tangible_book_value_per_share": {
"description": "Tangible book value per share (provider: fmp)"
},
"shareholders_equity_per_share": {
"description": "Shareholders equity per share (provider: fmp)"
},
"interest_debt_per_share": {
"description": "Interest debt per share (provider: fmp)"
},
"enterprise_value": {
"description": "Enterprise value (provider: fmp)"
},
"price_to_sales_ratio": {
"description": "Price-to-sales ratio (provider: fmp)"
},
"pocf_ratio": {
"description": "Price-to-operating cash flow ratio (provider: fmp)"
},
"pfcf_ratio": {
"description": "Price-to-free cash flow ratio (provider: fmp)"
},
"pb_ratio": {
"description": "Price-to-book ratio (provider: fmp)"
},
"ptb_ratio": {
"description": "Price-to-tangible book ratio (provider: fmp)"
},
"ev_to_sales": {
"description": "Enterprise value-to-sales ratio (provider: fmp)"
},
"enterprise_value_over_ebitda": {
"description": "Enterprise value-to-EBITDA ratio (provider: fmp)"
},
"ev_to_operating_cash_flow": {
"description": "Enterprise value-to-operating cash flow ratio (provider: fmp)"
},
"ev_to_free_cash_flow": {
"description": "Enterprise value-to-free cash flow ratio (provider: fmp)"
},
"earnings_yield": {
"description": "Earnings yield (provider: fmp)"
},
"free_cash_flow_yield": {
"description": "Free cash flow yield (provider: fmp)"
},
"debt_to_equity": {
"description": "Debt-to-equity ratio (provider: fmp)"
},
"debt_to_assets": {
"description": "Debt-to-assets ratio (provider: fmp)"
},
"net_debt_to_ebitda": {
"description": "Net debt-to-EBITDA ratio (provider: fmp)"
},
"current_ratio": {
"description": "Current ratio (provider: fmp)"
},
"interest_coverage": {
"description": "Interest coverage (provider: fmp)"
},
"income_quality": {
"description": "Income quality (provider: fmp)"
},
"dividend_yield": {
"description": "Dividend yield (provider: fmp, intrinio)"
},
"payout_ratio": {
"description": "Payout ratio (provider: fmp)"
},
"sales_general_and_administrative_to_revenue": {
"description": "Sales general and administrative expenses-to-revenue ratio (provider: fmp)"
},
"research_and_development_to_revenue": {
"description": "Research and development expenses-to-revenue ratio (provider: fmp)"
},
"intangibles_to_total_assets": {
"description": "Intangibles-to-total assets ratio (provider: fmp)"
},
"capex_to_operating_cash_flow": {
"description": "Capital expenditures-to-operating cash flow ratio (provider: fmp)"
},
"capex_to_revenue": {
"description": "Capital expenditures-to-revenue ratio (provider: fmp)"
},
"capex_to_depreciation": {
"description": "Capital expenditures-to-depreciation ratio (provider: fmp)"
},
"stock_based_compensation_to_revenue": {
"description": "Stock-based compensation-to-revenue ratio (provider: fmp)"
},
"graham_number": {
"description": "Graham number (provider: fmp)"
},
"roic": {
"description": "Return on invested capital (provider: fmp)"
},
"return_on_tangible_assets": {
"description": "Return on tangible assets (provider: fmp)"
},
"graham_net_net": {
"description": "Graham net-net working capital (provider: fmp)"
},
"working_capital": {
"description": "Working capital (provider: fmp)"
},
"tangible_asset_value": {
"description": "Tangible asset value (provider: fmp)"
},
"net_current_asset_value": {
"description": "Net current asset value (provider: fmp)"
},
"invested_capital": {
"description": "Invested capital (provider: fmp)"
},
"average_receivables": {
"description": "Average receivables (provider: fmp)"
},
"average_payables": {
"description": "Average payables (provider: fmp)"
},
"average_inventory": {
"description": "Average inventory (provider: fmp)"
},
"days_sales_outstanding": {
"description": "Days sales outstanding (provider: fmp)"
},
"days_payables_outstanding": {
"description": "Days payables outstanding (provider: fmp)"
},
"days_of_inventory_on_hand": {
"description": "Days of inventory on hand (provider: fmp)"
},
"receivables_turnover": {
"description": "Receivables turnover (provider: fmp)"
},
"payables_turnover": {
"description": "Payables turnover (provider: fmp)"
},
"inventory_turnover": {
"description": "Inventory turnover (provider: fmp)"
},
"roe": {
"description": "Return on equity (provider: fmp)"
},
"capex_per_share": {
"description": "Capital expenditures per share (provider: fmp)"
},
"beta": {
"description": "Beta (provider: intrinio)"
},
"volume": {
"description": "Volume (provider: intrinio)"
},
"fifty_two_week_high": {
"description": "52 week high (provider: intrinio)"
},
"fifty_two_week_low": {
"description": "52 week low (provider: intrinio)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.METRICS(\"AAPL\")"
}
},
"/equity/fundamental/multiples": {
"name": "multiples",
"description": "Equity Valuation Multiples. Valuation multiples for a stock ticker.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.MULTIPLES(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"revenue_per_share_ttm": {
"description": "Revenue per share calculated as trailing twelve months. "
},
"net_income_per_share_ttm": {
"description": "Net income per share calculated as trailing twelve months. "
},
"operating_cash_flow_per_share_ttm": {
"description": "Operating cash flow per share calculated as trailing twelve months. "
},
"free_cash_flow_per_share_ttm": {
"description": "Free cash flow per share calculated as trailing twelve months. "
},
"cash_per_share_ttm": {
"description": "Cash per share calculated as trailing twelve months. "
},
"book_value_per_share_ttm": {
"description": "Book value per share calculated as trailing twelve months. "
},
"tangible_book_value_per_share_ttm": {
"description": "Tangible book value per share calculated as trailing twelve months. "
},
"shareholders_equity_per_share_ttm": {
"description": "Shareholders equity per share calculated as trailing twelve months. "
},
"interest_debt_per_share_ttm": {
"description": "Interest debt per share calculated as trailing twelve months. "
},
"market_cap_ttm": {
"description": "Market capitalization calculated as trailing twelve months. "
},
"enterprise_value_ttm": {
"description": "Enterprise value calculated as trailing twelve months. "
},
"pe_ratio_ttm": {
"description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months. "
},
"price_to_sales_ratio_ttm": {
"description": "Price-to-sales ratio calculated as trailing twelve months. "
},
"pocf_ratio_ttm": {
"description": "Price-to-operating cash flow ratio calculated as trailing twelve months. "
},
"pfcf_ratio_ttm": {
"description": "Price-to-free cash flow ratio calculated as trailing twelve months. "
},
"pb_ratio_ttm": {
"description": "Price-to-book ratio calculated as trailing twelve months. "
},
"ptb_ratio_ttm": {
"description": "Price-to-tangible book ratio calculated as trailing twelve months. "
},
"ev_to_sales_ttm": {
"description": "Enterprise value-to-sales ratio calculated as trailing twelve months. "
},
"enterprise_value_over_ebitda_ttm": {
"description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months. "
},
"ev_to_operating_cash_flow_ttm": {
"description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months. "
},
"ev_to_free_cash_flow_ttm": {
"description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months. "
},
"earnings_yield_ttm": {
"description": "Earnings yield calculated as trailing twelve months. "
},
"free_cash_flow_yield_ttm": {
"description": "Free cash flow yield calculated as trailing twelve months. "
},
"debt_to_equity_ttm": {
"description": "Debt-to-equity ratio calculated as trailing twelve months. "
},
"debt_to_assets_ttm": {
"description": "Debt-to-assets ratio calculated as trailing twelve months. "
},
"net_debt_to_ebitda_ttm": {
"description": "Net debt-to-EBITDA ratio calculated as trailing twelve months. "
},
"current_ratio_ttm": {
"description": "Current ratio calculated as trailing twelve months. "
},
"interest_coverage_ttm": {
"description": "Interest coverage calculated as trailing twelve months. "
},
"income_quality_ttm": {
"description": "Income quality calculated as trailing twelve months. "
},
"dividend_yield_ttm": {
"description": "Dividend yield calculated as trailing twelve months. "
},
"dividend_yield_percentage_ttm": {
"description": "Dividend yield percentage calculated as trailing twelve months. "
},
"dividend_to_market_cap_ttm": {
"description": "Dividend to market capitalization ratio calculated as trailing twelve months. "
},
"dividend_per_share_ttm": {
"description": "Dividend per share calculated as trailing twelve months. "
},
"payout_ratio_ttm": {
"description": "Payout ratio calculated as trailing twelve months. "
},
"sales_general_and_administrative_to_revenue_ttm": {
"description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months. "
},
"research_and_development_to_revenue_ttm": {
"description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months. "
},
"intangibles_to_total_assets_ttm": {
"description": "Intangibles-to-total assets ratio calculated as trailing twelve months. "
},
"capex_to_operating_cash_flow_ttm": {
"description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months. "
},
"capex_to_revenue_ttm": {
"description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months. "
},
"capex_to_depreciation_ttm": {
"description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months. "
},
"stock_based_compensation_to_revenue_ttm": {
"description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months. "
},
"graham_number_ttm": {
"description": "Graham number calculated as trailing twelve months. "
},
"roic_ttm": {
"description": "Return on invested capital calculated as trailing twelve months. "
},
"return_on_tangible_assets_ttm": {
"description": "Return on tangible assets calculated as trailing twelve months. "
},
"graham_net_net_ttm": {
"description": "Graham net-net working capital calculated as trailing twelve months. "
},
"working_capital_ttm": {
"description": "Working capital calculated as trailing twelve months. "
},
"tangible_asset_value_ttm": {
"description": "Tangible asset value calculated as trailing twelve months. "
},
"net_current_asset_value_ttm": {
"description": "Net current asset value calculated as trailing twelve months. "
},
"invested_capital_ttm": {
"description": "Invested capital calculated as trailing twelve months. "
},
"average_receivables_ttm": {
"description": "Average receivables calculated as trailing twelve months. "
},
"average_payables_ttm": {
"description": "Average payables calculated as trailing twelve months. "
},
"average_inventory_ttm": {
"description": "Average inventory calculated as trailing twelve months. "
},
"days_sales_outstanding_ttm": {
"description": "Days sales outstanding calculated as trailing twelve months. "
},
"days_payables_outstanding_ttm": {
"description": "Days payables outstanding calculated as trailing twelve months. "
},
"days_of_inventory_on_hand_ttm": {
"description": "Days of inventory on hand calculated as trailing twelve months. "
},
"receivables_turnover_ttm": {
"description": "Receivables turnover calculated as trailing twelve months. "
},
"payables_turnover_ttm": {
"description": "Payables turnover calculated as trailing twelve months. "
},
"inventory_turnover_ttm": {
"description": "Inventory turnover calculated as trailing twelve months. "
},
"roe_ttm": {
"description": "Return on equity calculated as trailing twelve months. "
},
"capex_per_share_ttm": {
"description": "Capital expenditures per share calculated as trailing twelve months. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.MULTIPLES(\"AAPL\")"
}
},
"/equity/fundamental/overview": {
"name": "overview",
"description": "Company Overview. General information about a company.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.OVERVIEW(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"price": {
"description": "Price of the company. "
},
"beta": {
"description": "Beta of the company. "
},
"vol_avg": {
"description": "Volume average of the company. "
},
"mkt_cap": {
"description": "Market capitalization of the company. "
},
"last_div": {
"description": "Last dividend of the company. "
},
"range": {
"description": "Range of the company. "
},
"changes": {
"description": "Changes of the company. "
},
"company_name": {
"description": "Company name of the company. "
},
"currency": {
"description": "Currency of the company. "
},
"cik": {
"description": "Central Index Key (CIK) for the requested entity. "
},
"isin": {
"description": "ISIN of the company. "
},
"cusip": {
"description": "CUSIP of the company. "
},
"exchange": {
"description": "Exchange of the company. "
},
"exchange_short_name": {
"description": "Exchange short name of the company. "
},
"industry": {
"description": "Industry of the company. "
},
"website": {
"description": "Website of the company. "
},
"description": {
"description": "Description of the company. "
},
"ceo": {
"description": "CEO of the company. "
},
"sector": {
"description": "Sector of the company. "
},
"country": {
"description": "Country of the company. "
},
"full_time_employees": {
"description": "Full time employees of the company. "
},
"phone": {
"description": "Phone of the company. "
},
"address": {
"description": "Address of the company. "
},
"city": {
"description": "City of the company. "
},
"state": {
"description": "State of the company. "
},
"zip": {
"description": "Zip of the company. "
},
"dcf_diff": {
"description": "Discounted cash flow difference of the company. "
},
"dcf": {
"description": "Discounted cash flow of the company. "
},
"image": {
"description": "Image of the company. "
},
"ipo_date": {
"description": "IPO date of the company. "
},
"default_image": {
"description": "If the image is the default image. "
},
"is_etf": {
"description": "If the company is an ETF. "
},
"is_actively_trading": {
"description": "If the company is actively trading. "
},
"is_adr": {
"description": "If the company is an ADR. "
},
"is_fund": {
"description": "If the company is a fund. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.OVERVIEW(\"AAPL\")"
}
},
"/equity/fundamental/ratios": {
"name": "ratios",
"description": "Extensive set of ratios over time. Financial ratios for a given company.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.RATIOS(symbol;[period];[limit];[provider];[with_ttm];[fiscal_year])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"period": {
"type": "Text",
"description": "Time period of the data to return.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, defaults to fmp.",
"required": false
},
"with_ttm": {
"type": "Boolean",
"description": "Include trailing twelve months (TTM) data. (provider: fmp, intrinio)",
"required": false
},
"fiscal_year": {
"type": "Number",
"description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)",
"required": false
}
},
"data": {
"period_ending": {
"description": "The date of the data. "
},
"fiscal_period": {
"description": "Period of the financial ratios. "
},
"fiscal_year": {
"description": "Fiscal year. "
},
"current_ratio": {
"description": "Current ratio. (provider: fmp)"
},
"quick_ratio": {
"description": "Quick ratio. (provider: fmp)"
},
"cash_ratio": {
"description": "Cash ratio. (provider: fmp)"
},
"days_of_sales_outstanding": {
"description": "Days of sales outstanding. (provider: fmp)"
},
"days_of_inventory_outstanding": {
"description": "Days of inventory outstanding. (provider: fmp)"
},
"operating_cycle": {
"description": "Operating cycle. (provider: fmp)"
},
"days_of_payables_outstanding": {
"description": "Days of payables outstanding. (provider: fmp)"
},
"cash_conversion_cycle": {
"description": "Cash conversion cycle. (provider: fmp)"
},
"gross_profit_margin": {
"description": "Gross profit margin. (provider: fmp)"
},
"operating_profit_margin": {
"description": "Operating profit margin. (provider: fmp)"
},
"pretax_profit_margin": {
"description": "Pretax profit margin. (provider: fmp)"
},
"net_profit_margin": {
"description": "Net profit margin. (provider: fmp)"
},
"effective_tax_rate": {
"description": "Effective tax rate. (provider: fmp)"
},
"return_on_assets": {
"description": "Return on assets. (provider: fmp)"
},
"return_on_equity": {
"description": "Return on equity. (provider: fmp)"
},
"return_on_capital_employed": {
"description": "Return on capital employed. (provider: fmp)"
},
"net_income_per_ebt": {
"description": "Net income per EBT. (provider: fmp)"
},
"ebt_per_ebit": {
"description": "EBT per EBIT. (provider: fmp)"
},
"ebit_per_revenue": {
"description": "EBIT per revenue. (provider: fmp)"
},
"debt_ratio": {
"description": "Debt ratio. (provider: fmp)"
},
"debt_equity_ratio": {
"description": "Debt equity ratio. (provider: fmp)"
},
"long_term_debt_to_capitalization": {
"description": "Long term debt to capitalization. (provider: fmp)"
},
"total_debt_to_capitalization": {
"description": "Total debt to capitalization. (provider: fmp)"
},
"interest_coverage": {
"description": "Interest coverage. (provider: fmp)"
},
"cash_flow_to_debt_ratio": {
"description": "Cash flow to debt ratio. (provider: fmp)"
},
"company_equity_multiplier": {
"description": "Company equity multiplier. (provider: fmp)"
},
"receivables_turnover": {
"description": "Receivables turnover. (provider: fmp)"
},
"payables_turnover": {
"description": "Payables turnover. (provider: fmp)"
},
"inventory_turnover": {
"description": "Inventory turnover. (provider: fmp)"
},
"fixed_asset_turnover": {
"description": "Fixed asset turnover. (provider: fmp)"
},
"asset_turnover": {
"description": "Asset turnover. (provider: fmp)"
},
"operating_cash_flow_per_share": {
"description": "Operating cash flow per share. (provider: fmp)"
},
"free_cash_flow_per_share": {
"description": "Free cash flow per share. (provider: fmp)"
},
"cash_per_share": {
"description": "Cash per share. (provider: fmp)"
},
"payout_ratio": {
"description": "Payout ratio. (provider: fmp)"
},
"operating_cash_flow_sales_ratio": {
"description": "Operating cash flow sales ratio. (provider: fmp)"
},
"free_cash_flow_operating_cash_flow_ratio": {
"description": "Free cash flow operating cash flow ratio. (provider: fmp)"
},
"cash_flow_coverage_ratios": {
"description": "Cash flow coverage ratios. (provider: fmp)"
},
"short_term_coverage_ratios": {
"description": "Short term coverage ratios. (provider: fmp)"
},
"capital_expenditure_coverage_ratio": {
"description": "Capital expenditure coverage ratio. (provider: fmp)"
},
"dividend_paid_and_capex_coverage_ratio": {
"description": "Dividend paid and capex coverage ratio. (provider: fmp)"
},
"dividend_payout_ratio": {
"description": "Dividend payout ratio. (provider: fmp)"
},
"price_book_value_ratio": {
"description": "Price book value ratio. (provider: fmp)"
},
"price_to_book_ratio": {
"description": "Price to book ratio. (provider: fmp)"
},
"price_to_sales_ratio": {
"description": "Price to sales ratio. (provider: fmp)"
},
"price_earnings_ratio": {
"description": "Price earnings ratio. (provider: fmp)"
},
"price_to_free_cash_flows_ratio": {
"description": "Price to free cash flows ratio. (provider: fmp)"
},
"price_to_operating_cash_flows_ratio": {
"description": "Price to operating cash flows ratio. (provider: fmp)"
},
"price_cash_flow_ratio": {
"description": "Price cash flow ratio. (provider: fmp)"
},
"price_earnings_to_growth_ratio": {
"description": "Price earnings to growth ratio. (provider: fmp)"
},
"price_sales_ratio": {
"description": "Price sales ratio. (provider: fmp)"
},
"dividend_yield": {
"description": "Dividend yield. (provider: fmp)"
},
"dividend_yield_percentage": {
"description": "Dividend yield percentage. (provider: fmp)"
},
"dividend_per_share": {
"description": "Dividend per share. (provider: fmp)"
},
"enterprise_value_multiple": {
"description": "Enterprise value multiple. (provider: fmp)"
},
"price_fair_value": {
"description": "Price fair value. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.RATIOS(\"AAPL\")"
}
},
"/equity/fundamental/reported_financials": {
"name": "reported_financials",
"description": "Financial statements, as-reported.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.REPORTED_FINANCIALS(symbol;[period];[statement_type];[limit];[provider];[fiscal_year])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"period": {
"type": "Text",
"description": "Time period of the data to return.",
"required": false
},
"statement_type": {
"type": "Text",
"description": "The type of financial statement - i.e, balance, income, cash.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: intrinio, defaults to intrinio.",
"required": false
},
"fiscal_year": {
"type": "Number",
"description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)",
"required": false
}
},
"data": {
"period_ending": {
"description": "The ending date of the reporting period. "
},
"fiscal_period": {
"description": "The fiscal period of the report (e.g. FY, Q1, etc.). "
},
"fiscal_year": {
"description": "The fiscal year of the fiscal period. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.REPORTED_FINANCIALS(\"AAPL\")"
}
},
"/equity/fundamental/revenue_per_geography": {
"name": "revenue_per_geography",
"description": "Revenue Geographic. Geographic revenue data.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY(symbol;[period];[structure];[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"period": {
"type": "Text",
"description": "Time period of the data to return.",
"required": false
},
"structure": {
"type": "Text",
"description": "Structure of the returned data.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"geographic_segment": {
"description": "Day level data containing the revenue of the geographic segment. "
},
"americas": {
"description": "Revenue from the the American segment. "
},
"europe": {
"description": "Revenue from the the European segment. "
},
"greater_china": {
"description": "Revenue from the the Greater China segment. "
},
"japan": {
"description": "Revenue from the the Japan segment. "
},
"rest_of_asia_pacific": {
"description": "Revenue from the the Rest of Asia Pacific segment. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY(\"AAPL\")"
}
},
"/equity/fundamental/revenue_per_segment": {
"name": "revenue_per_segment",
"description": "Revenue Business Line. Business line revenue data.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT(symbol;[period];[structure];[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"period": {
"type": "Text",
"description": "Time period of the data to return.",
"required": false
},
"structure": {
"type": "Text",
"description": "Structure of the returned data.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"business_line": {
"description": "Day level data containing the revenue of the business line. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT(\"AAPL\")"
}
},
"/equity/fundamental/search_attributes": {
"name": "search_attributes",
"description": "Search Intrinio data tags.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES(query;[limit];[provider])",
"parameters": {
"query": {
"type": "Text",
"description": "Query to search for.",
"required": true
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: intrinio, defaults to intrinio.",
"required": false
}
},
"data": {
"id": {
"description": "ID of the financial attribute. "
},
"name": {
"description": "Name of the financial attribute. "
},
"tag": {
"description": "Tag of the financial attribute. "
},
"statement_code": {
"description": "Code of the financial statement. "
},
"statement_type": {
"description": "Type of the financial statement. "
},
"parent_name": {
"description": "Parent's name of the financial attribute. "
},
"sequence": {
"description": "Sequence of the financial statement. "
},
"factor": {
"description": "Unit of the financial attribute. "
},
"transaction": {
"description": "Transaction type (credit/debit) of the financial attribute. "
},
"type": {
"description": "Type of the financial attribute. "
},
"unit": {
"description": "Unit of the financial attribute. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES(\"ebitda\")"
}
},
"/equity/fundamental/trailing_dividend_yield": {
"name": "trailing_dividend_yield",
"description": "Trailing 1yr dividend yield.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.TRAILING_DIVIDEND_YIELD([symbol];[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: tiingo, defaults to tiingo.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"trailing_dividend_yield": {
"description": "Trailing dividend yield. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.TRAILING_DIVIDEND_YIELD()"
}
},
"/equity/fundamental/transcript": {
"name": "transcript",
"description": "Earnings Call Transcript. Earnings call transcript for a given company.",
"signature": "=OBB.EQUITY.FUNDAMENTAL.TRANSCRIPT(symbol;year;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"year": {
"type": "Number",
"description": "Year of the earnings call transcript.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"quarter": {
"description": "Quarter of the earnings call transcript. "
},
"year": {
"description": "Year of the earnings call transcript. "
},
"date": {
"description": "The date of the data. "
},
"content": {
"description": "Content of the earnings call transcript. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.FUNDAMENTAL.TRANSCRIPT(\"AAPL\";2022)"
}
},
"/equity/market_snapshots": {
"name": "market_snapshots",
"description": "Get a current, complete, market snapshot.",
"signature": "=OBB.EQUITY.MARKET_SNAPSHOTS([provider];[market])",
"parameters": {
"provider": {
"type": "Text",
"description": "Options: fmp, polygon, defaults to fmp.",
"required": false
},
"market": {
"type": "Text",
"description": "The market to fetch data for. (provider: fmp)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"open": {
"description": "The open price. "
},
"high": {
"description": "The high price. "
},
"low": {
"description": "The low price. "
},
"close": {
"description": "The close price. "
},
"prev_close": {
"description": "The previous closing price of the stock. "
},
"change": {
"description": "The change in price. "
},
"change_percent": {
"description": "The change, as a percent. "
},
"volume": {
"description": "The trading volume. "
},
"price": {
"description": "The last price of the stock. (provider: fmp)"
},
"avg_volume": {
"description": "Average volume of the stock. (provider: fmp)"
},
"ma50": {
"description": "The 50-day moving average. (provider: fmp)"
},
"ma200": {
"description": "The 200-day moving average. (provider: fmp)"
},
"year_high": {
"description": "The 52-week high. (provider: fmp)"
},
"year_low": {
"description": "The 52-week low. (provider: fmp)"
},
"market_cap": {
"description": "Market cap of the stock. (provider: fmp)"
},
"shares_outstanding": {
"description": "Number of shares outstanding. (provider: fmp)"
},
"eps": {
"description": "Earnings per share. (provider: fmp)"
},
"pe": {
"description": "Price to earnings ratio. (provider: fmp)"
},
"exchange": {
"description": "The exchange of the stock. (provider: fmp)"
},
"timestamp": {
"description": "The timestamp of the data. (provider: fmp)"
},
"earnings_announcement": {
"description": "The earnings announcement of the stock. (provider: fmp)"
},
"name": {
"description": "The name associated with the stock symbol. (provider: fmp)"
},
"vwap": {
"description": "The volume weighted average price of the stock on the current trading day. (provider: polygon)"
},
"prev_open": {
"description": "The previous trading session opening price. (provider: polygon)"
},
"prev_high": {
"description": "The previous trading session high price. (provider: polygon)"
},
"prev_low": {
"description": "The previous trading session low price. (provider: polygon)"
},
"prev_volume": {
"description": "The previous trading session volume. (provider: polygon)"
},
"prev_vwap": {
"description": "The previous trading session VWAP. (provider: polygon)"
},
"last_updated": {
"description": "The last time the data was updated. (provider: polygon)"
},
"bid": {
"description": "The current bid price. (provider: polygon)"
},
"bid_size": {
"description": "The current bid size. (provider: polygon)"
},
"ask_size": {
"description": "The current ask size. (provider: polygon)"
},
"ask": {
"description": "The current ask price. (provider: polygon)"
},
"quote_timestamp": {
"description": "The timestamp of the last quote. (provider: polygon)"
},
"last_trade_price": {
"description": "The last trade price. (provider: polygon)"
},
"last_trade_size": {
"description": "The last trade size. (provider: polygon)"
},
"last_trade_conditions": {
"description": "The last trade condition codes. (provider: polygon)"
},
"last_trade_exchange": {
"description": "The last trade exchange ID code. (provider: polygon)"
},
"last_trade_timestamp": {
"description": "The last trade timestamp. (provider: polygon)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.MARKET_SNAPSHOTS()"
}
},
"/equity/ownership/insider_trading": {
"name": "insider_trading",
"description": "Insider Trading. Information about insider trading.",
"signature": "=OBB.EQUITY.OWNERSHIP.INSIDER_TRADING(symbol;[limit];[provider];[transactionType];[start_date];[end_date];[ownership_type];[sort_by])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, defaults to fmp.",
"required": false
},
"transactionType": {
"type": "Any",
"description": "Type of the transaction. (provider: fmp)",
"required": false
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format. (provider: intrinio)",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format. (provider: intrinio)",
"required": false
},
"ownership_type": {
"type": "Text",
"description": "Type of ownership. (provider: intrinio)",
"required": false
},
"sort_by": {
"type": "Text",
"description": "Field to sort by. (provider: intrinio)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"company_cik": {
"description": "Company CIK of the insider trading. "
},
"filing_date": {
"description": "Filing date of the insider trading. "
},
"transaction_date": {
"description": "Transaction date of the insider trading. "
},
"owner_cik": {
"description": "Reporting CIK of the insider trading. "
},
"owner_name": {
"description": "Reporting name of the insider trading. "
},
"owner_title": {
"description": "Designation of owner of the insider trading. "
},
"transaction_type": {
"description": "Transaction type of the insider trading. "
},
"acquisition_or_disposition": {
"description": "Acquisition or disposition of the insider trading. "
},
"security_type": {
"description": "Security type of the insider trading. "
},
"securities_owned": {
"description": "Number of securities owned in the insider trading. "
},
"securities_transacted": {
"description": "Securities transacted of the insider trading. "
},
"transaction_price": {
"description": "Price of the insider trading. "
},
"filing_url": {
"description": "Link of the insider trading. "
},
"form_type": {
"description": "Form type of the insider trading. (provider: fmp)"
},
"company_name": {
"description": "Name of the company. (provider: intrinio)"
},
"conversion_exercise_price": {
"description": "Conversion/Exercise price of the insider trading. (provider: intrinio)"
},
"deemed_execution_date": {
"description": "Deemed execution date of the insider trading. (provider: intrinio)"
},
"exercise_date": {
"description": "Exercise date of the insider trading. (provider: intrinio)"
},
"expiration_date": {
"description": "Expiration date of the insider trading. (provider: intrinio)"
},
"underlying_security_title": {
"description": "Name of the underlying non-derivative security related to this derivative transaction. (provider: intrinio)"
},
"underlying_shares": {
"description": "Number of underlying shares related to this derivative transaction. (provider: intrinio)"
},
"nature_of_ownership": {
"description": "Nature of ownership of the insider trading. (provider: intrinio)"
},
"director": {
"description": "Whether the owner is a director. (provider: intrinio)"
},
"officer": {
"description": "Whether the owner is an officer. (provider: intrinio)"
},
"ten_percent_owner": {
"description": "Whether the owner is a 10% owner. (provider: intrinio)"
},
"other_relation": {
"description": "Whether the owner is having another relation. (provider: intrinio)"
},
"derivative_transaction": {
"description": "Whether the owner is having a derivative transaction. (provider: intrinio)"
},
"report_line_number": {
"description": "Report line number of the insider trading. (provider: intrinio)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.OWNERSHIP.INSIDER_TRADING(\"AAPL\")"
}
},
"/equity/ownership/institutional": {
"name": "institutional",
"description": "Institutional Ownership. Institutional ownership data.",
"signature": "=OBB.EQUITY.OWNERSHIP.INSTITUTIONAL(symbol;[provider];[include_current_quarter];[date];[page_size])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, defaults to fmp.",
"required": false
},
"include_current_quarter": {
"type": "Boolean",
"description": "Include current quarter data. (provider: fmp)",
"required": false
},
"date": {
"type": "Text",
"description": "A specific date to get data for. (provider: fmp)",
"required": false
},
"page_size": {
"type": "Number",
"description": "The number of data entries to return. (provider: intrinio)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"cik": {
"description": "Central Index Key (CIK) for the requested entity. "
},
"date": {
"description": "The date of the data. "
},
"investors_holding": {
"description": "Number of investors holding the stock. (provider: fmp)"
},
"last_investors_holding": {
"description": "Number of investors holding the stock in the last quarter. (provider: fmp)"
},
"investors_holding_change": {
"description": "Change in the number of investors holding the stock. (provider: fmp)"
},
"number_of_13f_shares": {
"description": "Number of 13F shares. (provider: fmp)"
},
"last_number_of_13f_shares": {
"description": "Number of 13F shares in the last quarter. (provider: fmp)"
},
"number_of_13f_shares_change": {
"description": "Change in the number of 13F shares. (provider: fmp)"
},
"total_invested": {
"description": "Total amount invested. (provider: fmp)"
},
"last_total_invested": {
"description": "Total amount invested in the last quarter. (provider: fmp)"
},
"total_invested_change": {
"description": "Change in the total amount invested. (provider: fmp)"
},
"ownership_percent": {
"description": "Ownership percent. (provider: fmp)"
},
"last_ownership_percent": {
"description": "Ownership percent in the last quarter. (provider: fmp)"
},
"ownership_percent_change": {
"description": "Change in the ownership percent. (provider: fmp)"
},
"new_positions": {
"description": "Number of new positions. (provider: fmp)"
},
"last_new_positions": {
"description": "Number of new positions in the last quarter. (provider: fmp)"
},
"new_positions_change": {
"description": "Change in the number of new positions. (provider: fmp)"
},
"increased_positions": {
"description": "Number of increased positions. (provider: fmp)"
},
"last_increased_positions": {
"description": "Number of increased positions in the last quarter. (provider: fmp)"
},
"increased_positions_change": {
"description": "Change in the number of increased positions. (provider: fmp)"
},
"closed_positions": {
"description": "Number of closed positions. (provider: fmp)"
},
"last_closed_positions": {
"description": "Number of closed positions in the last quarter. (provider: fmp)"
},
"closed_positions_change": {
"description": "Change in the number of closed positions. (provider: fmp)"
},
"reduced_positions": {
"description": "Number of reduced positions. (provider: fmp)"
},
"last_reduced_positions": {
"description": "Number of reduced positions in the last quarter. (provider: fmp)"
},
"reduced_positions_change": {
"description": "Change in the number of reduced positions. (provider: fmp)"
},
"total_calls": {
"description": "Total number of call options contracts traded for Apple Inc. on the specified date. (provider: fmp)"
},
"last_total_calls": {
"description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date. (provider: fmp)"
},
"total_calls_change": {
"description": "Change in the total number of call options contracts traded between the current and previous reporting dates. (provider: fmp)"
},
"total_puts": {
"description": "Total number of put options contracts traded for Apple Inc. on the specified date. (provider: fmp)"
},
"last_total_puts": {
"description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date. (provider: fmp)"
},
"total_puts_change": {
"description": "Change in the total number of put options contracts traded between the current and previous reporting dates. (provider: fmp)"
},
"put_call_ratio": {
"description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date. (provider: fmp)"
},
"last_put_call_ratio": {
"description": "Put-call ratio on the previous reporting date. (provider: fmp)"
},
"put_call_ratio_change": {
"description": "Change in the put-call ratio between the current and previous reporting dates. (provider: fmp)"
},
"name": {
"description": "Name of the institutional owner. (provider: intrinio)"
},
"value": {
"description": "Value of the institutional owner. (provider: intrinio)"
},
"amount": {
"description": "Amount of the institutional owner. (provider: intrinio)"
},
"sole_voting_authority": {
"description": "Sole voting authority of the institutional owner. (provider: intrinio)"
},
"shared_voting_authority": {
"description": "Shared voting authority of the institutional owner. (provider: intrinio)"
},
"no_voting_authority": {
"description": "No voting authority of the institutional owner. (provider: intrinio)"
},
"previous_amount": {
"description": "Previous amount of the institutional owner. (provider: intrinio)"
},
"amount_change": {
"description": "Amount change of the institutional owner. (provider: intrinio)"
},
"amount_percent_change": {
"description": "Amount percent change of the institutional owner. (provider: intrinio)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.OWNERSHIP.INSTITUTIONAL(\"AAPL\")"
}
},
"/equity/ownership/major_holders": {
"name": "major_holders",
"description": "Equity Ownership. Information about the company ownership.",
"signature": "=OBB.EQUITY.OWNERSHIP.MAJOR_HOLDERS(symbol;[date];[page];[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"date": {
"type": "Text",
"description": "A specific date to get data for.",
"required": false
},
"page": {
"type": "Number",
"description": "Page number of the data to fetch.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"cik": {
"description": "Central Index Key (CIK) for the requested entity. "
},
"filing_date": {
"description": "Filing date of the stock ownership. "
},
"investor_name": {
"description": "Investor name of the stock ownership. "
},
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"security_name": {
"description": "Security name of the stock ownership. "
},
"type_of_security": {
"description": "Type of security of the stock ownership. "
},
"security_cusip": {
"description": "Security cusip of the stock ownership. "
},
"shares_type": {
"description": "Shares type of the stock ownership. "
},
"put_call_share": {
"description": "Put call share of the stock ownership. "
},
"investment_discretion": {
"description": "Investment discretion of the stock ownership. "
},
"industry_title": {
"description": "Industry title of the stock ownership. "
},
"weight": {
"description": "Weight of the stock ownership. "
},
"last_weight": {
"description": "Last weight of the stock ownership. "
},
"change_in_weight": {
"description": "Change in weight of the stock ownership. "
},
"change_in_weight_percentage": {
"description": "Change in weight percentage of the stock ownership. "
},
"market_value": {
"description": "Market value of the stock ownership. "
},
"last_market_value": {
"description": "Last market value of the stock ownership. "
},
"change_in_market_value": {
"description": "Change in market value of the stock ownership. "
},
"change_in_market_value_percentage": {
"description": "Change in market value percentage of the stock ownership. "
},
"shares_number": {
"description": "Shares number of the stock ownership. "
},
"last_shares_number": {
"description": "Last shares number of the stock ownership. "
},
"change_in_shares_number": {
"description": "Change in shares number of the stock ownership. "
},
"change_in_shares_number_percentage": {
"description": "Change in shares number percentage of the stock ownership. "
},
"quarter_end_price": {
"description": "Quarter end price of the stock ownership. "
},
"avg_price_paid": {
"description": "Average price paid of the stock ownership. "
},
"is_new": {
"description": "Is the stock ownership new. "
},
"is_sold_out": {
"description": "Is the stock ownership sold out. "
},
"ownership": {
"description": "How much is the ownership. "
},
"last_ownership": {
"description": "Last ownership amount. "
},
"change_in_ownership": {
"description": "Change in ownership amount. "
},
"change_in_ownership_percentage": {
"description": "Change in ownership percentage. "
},
"holding_period": {
"description": "Holding period of the stock ownership. "
},
"first_added": {
"description": "First added date of the stock ownership. "
},
"performance": {
"description": "Performance of the stock ownership. "
},
"performance_percentage": {
"description": "Performance percentage of the stock ownership. "
},
"last_performance": {
"description": "Last performance of the stock ownership. "
},
"change_in_performance": {
"description": "Change in performance of the stock ownership. "
},
"is_counted_for_performance": {
"description": "Is the stock ownership counted for performance. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.OWNERSHIP.MAJOR_HOLDERS(\"AAPL\")"
}
},
"/equity/ownership/share_statistics": {
"name": "share_statistics",
"description": "Share Statistics. Share statistics for a given company.",
"signature": "=OBB.EQUITY.OWNERSHIP.SHARE_STATISTICS(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"date": {
"description": "The date of the data. "
},
"free_float": {
"description": "Percentage of unrestricted shares of a publicly-traded company. "
},
"float_shares": {
"description": "Number of shares available for trading by the general public. "
},
"outstanding_shares": {
"description": "Total number of shares of a publicly-traded company. "
},
"source": {
"description": "Source of the received data. "
},
"adjusted_outstanding_shares": {
"description": "Total number of shares of a publicly-traded company, adjusted for splits. (provider: intrinio)"
},
"public_float": {
"description": "Aggregate market value of the shares of a publicly-traded company. (provider: intrinio)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.OWNERSHIP.SHARE_STATISTICS(\"AAPL\")"
}
},
"/equity/price/historical": {
"name": "historical",
"description": "Equity Historical price. Load stock data for a specific ticker.",
"signature": "=OBB.EQUITY.PRICE.HISTORICAL(symbol;[interval];[start_date];[end_date];[provider];[limit];[sort];[start_time];[end_time];[timezone];[source];[sleep];[adjusted])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"interval": {
"type": "Text",
"description": "Time interval of the data to return.",
"required": false
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, polygon, tiingo, defaults to fmp.",
"required": false
},
"limit": {
"type": "Number",
"description": "Number of days to look back (Only for interval 1d). (provider: fmp); The number of results to return per page. (provider: intrinio); The number of data entries to return. (provider: polygon)",
"required": false
},
"sort": {
"type": "Text",
"description": "Sort the data in ascending or descending order. (provider: fmp); Sort order of the data. (provider: polygon)",
"required": false
},
"start_time": {
"type": "Text",
"description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio)",
"required": false
},
"end_time": {
"type": "Text",
"description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio)",
"required": false
},
"timezone": {
"type": "Text",
"description": "Timezone of the data, in the IANA format (Continent/City). (provider: intrinio)",
"required": false
},
"source": {
"type": "Text",
"description": "The source of the data. (provider: intrinio)",
"required": false
},
"sleep": {
"type": "Number",
"description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)",
"required": false
},
"adjusted": {
"type": "Boolean",
"description": "Output time series is adjusted by historical split and dividend events. (provider: polygon)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"open": {
"description": "The open price. "
},
"high": {
"description": "The high price. "
},
"low": {
"description": "The low price. "
},
"close": {
"description": "The close price. "
},
"volume": {
"description": "The trading volume. "
},
"vwap": {
"description": "Volume Weighted Average Price over the period. "
},
"label": {
"description": "Human readable format of the date. (provider: fmp)"
},
"adj_close": {
"description": "The adjusted close price. (provider: fmp); Adjusted closing price during the period. (provider: intrinio); Adjusted closing price during the period. (provider: tiingo)"
},
"unadjusted_volume": {
"description": "Unadjusted volume of the symbol. (provider: fmp)"
},
"change": {
"description": "Change in the price of the symbol from the previous day. (provider: fmp, intrinio)"
},
"change_percent": {
"description": "Change % in the price of the symbol. (provider: fmp)"
},
"change_over_time": {
"description": "Change % in the price of the symbol over a period of time. (provider: fmp)"
},
"close_time": {
"description": "The timestamp that represents the end of the interval span. (provider: intrinio)"
},
"interval": {
"description": "The data time frequency. (provider: intrinio)"
},
"average": {
"description": "Average trade price of an individual equity during the interval. (provider: intrinio)"
},
"intra_period": {
"description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period (provider: intrinio)"
},
"adj_open": {
"description": "Adjusted open price during the period. (provider: intrinio, tiingo)"
},
"adj_high": {
"description": "Adjusted high price during the period. (provider: intrinio, tiingo)"
},
"adj_low": {
"description": "Adjusted low price during the period. (provider: intrinio, tiingo)"
},
"adj_volume": {
"description": "Adjusted volume during the period. (provider: intrinio, tiingo)"
},
"factor": {
"description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices. (provider: intrinio)"
},
"split_ratio": {
"description": "Ratio of the equity split, if a equity split occurred. (provider: intrinio, tiingo)"
},
"dividend": {
"description": "Dividend amount, if a dividend was paid. (provider: intrinio, tiingo)"
},
"percent_change": {
"description": "Percent change in the price of the symbol from the previous day. (provider: intrinio)"
},
"fifty_two_week_high": {
"description": "52 week high price for the symbol. (provider: intrinio)"
},
"fifty_two_week_low": {
"description": "52 week low price for the symbol. (provider: intrinio)"
},
"transactions": {
"description": "Number of transactions for the symbol in the time period. (provider: polygon)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.PRICE.HISTORICAL(\"AAPL\")"
}
},
"/equity/price/nbbo": {
"name": "nbbo",
"description": "Equity NBBO. Load National Best Bid and Offer for a specific equity.",
"signature": "=OBB.EQUITY.PRICE.NBBO(symbol;[provider];[limit];[timestamp];[timestamp_lt];[timestamp_gt];[timestamp_lte];[timestamp_gte])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: polygon, defaults to polygon.",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols. (provider: polygon)",
"required": false
},
"timestamp": {
"type": "Text",
"description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges. (provider: polygon)",
"required": false
},
"timestamp_lt": {
"type": "Text",
"description": "Query by datetime, less than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string, YYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)",
"required": false
},
"timestamp_gt": {
"type": "Text",
"description": "Query by datetime, greater than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string, YYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)",
"required": false
},
"timestamp_lte": {
"type": "Text",
"description": "Query by datetime, less than or equal to. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string, YYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)",
"required": false
},
"timestamp_gte": {
"type": "Text",
"description": "Query by datetime, greater than or equal to. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string, YYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)",
"required": false
}
},
"data": {
"ask_exchange": {
"description": "The exchange ID for the ask. "
},
"ask": {
"description": "The last ask price. "
},
"ask_size": {
"description": " 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": {
"description": "The bid size in round lots. "
},
"bid": {
"description": "The last bid price. "
},
"bid_exchange": {
"description": "The exchange ID for the bid. "
},
"tape": {
"description": "The exchange tape. (provider: polygon)"
},
"conditions": {
"description": "A list of condition codes. (provider: polygon)"
},
"indicators": {
"description": "A list of indicator codes. (provider: polygon)"
},
"sequence_num": {
"description": " The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11) (provider: polygon)"
},
"participant_timestamp": {
"description": " The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. (provider: polygon)"
},
"sip_timestamp": {
"description": " The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. (provider: polygon)"
},
"trf_timestamp": {
"description": " The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote. (provider: polygon)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.PRICE.NBBO(\"AAPL\")"
}
},
"/equity/price/performance": {
"name": "performance",
"description": "Price performance as a return, over different periods.",
"signature": "=OBB.EQUITY.PRICE.PERFORMANCE(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"one_day": {
"description": "One-day return. "
},
"wtd": {
"description": "Week to date return. "
},
"one_week": {
"description": "One-week return. "
},
"mtd": {
"description": "Month to date return. "
},
"one_month": {
"description": "One-month return. "
},
"qtd": {
"description": "Quarter to date return. "
},
"three_month": {
"description": "Three-month return. "
},
"six_month": {
"description": "Six-month return. "
},
"ytd": {
"description": "Year to date return. "
},
"one_year": {
"description": "One-year return. "
},
"three_year": {
"description": "Three-year return. "
},
"five_year": {
"description": "Five-year return. "
},
"ten_year": {
"description": "Ten-year return. "
},
"max": {
"description": "Return from the beginning of the time series. "
},
"symbol": {
"description": "The ticker symbol. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.PRICE.PERFORMANCE(\"AAPL\")"
}
},
"/equity/price/quote": {
"name": "quote",
"description": "Equity Quote. Load stock data for a specific ticker.",
"signature": "=OBB.EQUITY.PRICE.QUOTE(symbol;[provider];[source])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for. In this case, the comma separated list of symbols.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, defaults to fmp.",
"required": false
},
"source": {
"type": "Text",
"description": "Source of the data. (provider: intrinio)",
"required": false
}
},
"data": {
"day_low": {
"description": "Lowest price of the stock in the current trading day. "
},
"day_high": {
"description": "Highest price of the stock in the current trading day. "
},
"date": {
"description": "The date of the data. "
},
"symbol": {
"description": "Symbol of the company. (provider: fmp)"
},
"name": {
"description": "Name of the company. (provider: fmp)"
},
"price": {
"description": "Current trading price of the equity. (provider: fmp)"
},
"changes_percentage": {
"description": "Change percentage of the equity price. (provider: fmp)"
},
"change": {
"description": "Change in the equity price. (provider: fmp)"
},
"year_high": {
"description": "Highest price of the equity in the last 52 weeks. (provider: fmp)"
},
"year_low": {
"description": "Lowest price of the equity in the last 52 weeks. (provider: fmp)"
},
"market_cap": {
"description": "Market cap of the company. (provider: fmp)"
},
"price_avg50": {
"description": "50 days average price of the equity. (provider: fmp)"
},
"price_avg200": {
"description": "200 days average price of the equity. (provider: fmp)"
},
"volume": {
"description": "Volume of the equity in the current trading day. (provider: fmp)"
},
"avg_volume": {
"description": "Average volume of the equity in the last 10 trading days. (provider: fmp)"
},
"exchange": {
"description": "Exchange the equity is traded on. (provider: fmp)"
},
"open": {
"description": "Opening price of the equity in the current trading day. (provider: fmp)"
},
"previous_close": {
"description": "Previous closing price of the equity. (provider: fmp)"
},
"eps": {
"description": "Earnings per share of the equity. (provider: fmp)"
},
"pe": {
"description": "Price earnings ratio of the equity. (provider: fmp)"
},
"earnings_announcement": {
"description": "Earnings announcement date of the equity. (provider: fmp)"
},
"shares_outstanding": {
"description": "Number of shares outstanding of the equity. (provider: fmp)"
},
"last_price": {
"description": "Price of the last trade. (provider: intrinio)"
},
"last_time": {
"description": "Date and Time when the last trade occurred. (provider: intrinio)"
},
"last_size": {
"description": "Size of the last trade. (provider: intrinio)"
},
"bid_price": {
"description": "Price of the top bid order. (provider: intrinio)"
},
"bid_size": {
"description": "Size of the top bid order. (provider: intrinio)"
},
"ask_price": {
"description": "Price of the top ask order. (provider: intrinio)"
},
"ask_size": {
"description": "Size of the top ask order. (provider: intrinio)"
},
"open_price": {
"description": "Open price for the trading day. (provider: intrinio)"
},
"close_price": {
"description": "Closing price for the trading day (IEX source only). (provider: intrinio)"
},
"high_price": {
"description": "High Price for the trading day. (provider: intrinio)"
},
"low_price": {
"description": "Low Price for the trading day. (provider: intrinio)"
},
"exchange_volume": {
"description": "Number of shares exchanged during the trading day on the exchange. (provider: intrinio)"
},
"market_volume": {
"description": "Number of shares exchanged during the trading day for the whole market. (provider: intrinio)"
},
"updated_on": {
"description": "Date and Time when the data was last updated. (provider: intrinio)"
},
"source": {
"description": "Source of the data. (provider: intrinio)"
},
"listing_venue": {
"description": "Listing venue where the trade took place (SIP source only). (provider: intrinio)"
},
"sales_conditions": {
"description": "Indicates any sales condition modifiers associated with the trade. (provider: intrinio)"
},
"quote_conditions": {
"description": "Indicates any quote condition modifiers associated with the trade. (provider: intrinio)"
},
"market_center_code": {
"description": "Market center character code. (provider: intrinio)"
},
"is_darkpool": {
"description": "Whether or not the current trade is from a darkpool. (provider: intrinio)"
},
"messages": {
"description": "Messages associated with the endpoint. (provider: intrinio)"
},
"security": {
"description": "Security details related to the quote. (provider: intrinio)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.PRICE.QUOTE(\"AAPL\")"
}
},
"/equity/profile": {
"name": "profile",
"description": "Equity Info. Get general price and performance metrics of a stock.",
"signature": "=OBB.EQUITY.PROFILE(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: intrinio, defaults to intrinio.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"name": {
"description": "Common name of the company. "
},
"cik": {
"description": "Central Index Key (CIK) for the requested entity. "
},
"lei": {
"description": "Legal Entity Identifier assigned to the company. "
},
"legal_name": {
"description": "Official legal name of the company. "
},
"stock_exchange": {
"description": "Stock exchange where the company is traded. "
},
"sic": {
"description": "Standard Industrial Classification code for the company. "
},
"short_description": {
"description": "Short description of the company. "
},
"long_description": {
"description": "Long description of the company. "
},
"ceo": {
"description": "Chief Executive Officer of the company. "
},
"company_url": {
"description": "URL of the company's website. "
},
"business_address": {
"description": "Address of the company's headquarters. "
},
"mailing_address": {
"description": "Mailing address of the company. "
},
"business_phone_no": {
"description": "Phone number of the company's headquarters. "
},
"hq_address1": {
"description": "Address of the company's headquarters. "
},
"hq_address2": {
"description": "Address of the company's headquarters. "
},
"hq_address_city": {
"description": "City of the company's headquarters. "
},
"hq_address_postal_code": {
"description": "Zip code of the company's headquarters. "
},
"hq_state": {
"description": "State of the company's headquarters. "
},
"hq_country": {
"description": "Country of the company's headquarters. "
},
"inc_state": {
"description": "State in which the company is incorporated. "
},
"inc_country": {
"description": "Country in which the company is incorporated. "
},
"employees": {
"description": "Number of employees working for the company. "
},
"entity_legal_form": {
"description": "Legal form of the company. "
},
"entity_status": {
"description": "Status of the company. "
},
"latest_filing_date": {
"description": "Date of the company's latest filing. "
},
"irs_number": {
"description": "IRS number assigned to the company. "
},
"sector": {
"description": "Sector in which the company operates. "
},
"industry_category": {
"description": "Category of industry in which the company operates. "
},
"industry_group": {
"description": "Group of industry in which the company operates. "
},
"template": {
"description": "Template used to standardize the company's financial statements. "
},
"standardized_active": {
"description": "Whether the company is active or not. "
},
"first_fundamental_date": {
"description": "Date of the company's first fundamental. "
},
"last_fundamental_date": {
"description": "Date of the company's last fundamental. "
},
"first_stock_price_date": {
"description": "Date of the company's first stock price. "
},
"last_stock_price_date": {
"description": "Date of the company's last stock price. "
},
"id": {
"description": "Intrinio ID for the company. (provider: intrinio)"
},
"thea_enabled": {
"description": "Whether the company has been enabled for Thea. (provider: intrinio)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.PROFILE(\"AAPL\")"
}
},
"/equity/screener": {
"name": "screener",
"description": "Equity Screen. Screen for companies meeting various criteria.",
"signature": "=OBB.EQUITY.SCREENER([provider];[mktcap_min];[mktcap_max];[price_min];[price_max];[beta_min];[beta_max];[volume_min];[volume_max];[dividend_min];[dividend_max];[is_etf];[is_active];[sector];[industry];[country];[exchange];[limit])",
"parameters": {
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
},
"mktcap_min": {
"type": "Number",
"description": "Filter by market cap greater than this value. (provider: fmp)",
"required": false
},
"mktcap_max": {
"type": "Number",
"description": "Filter by market cap less than this value. (provider: fmp)",
"required": false
},
"price_min": {
"type": "Number",
"description": "Filter by price greater than this value. (provider: fmp)",
"required": false
},
"price_max": {
"type": "Number",
"description": "Filter by price less than this value. (provider: fmp)",
"required": false
},
"beta_min": {
"type": "Number",
"description": "Filter by a beta greater than this value. (provider: fmp)",
"required": false
},
"beta_max": {
"type": "Number",
"description": "Filter by a beta less than this value. (provider: fmp)",
"required": false
},
"volume_min": {
"type": "Number",
"description": "Filter by volume greater than this value. (provider: fmp)",
"required": false
},
"volume_max": {
"type": "Number",
"description": "Filter by volume less than this value. (provider: fmp)",
"required": false
},
"dividend_min": {
"type": "Number",
"description": "Filter by dividend amount greater than this value. (provider: fmp)",
"required": false
},
"dividend_max": {
"type": "Number",
"description": "Filter by dividend amount less than this value. (provider: fmp)",
"required": false
},
"is_etf": {
"type": "Boolean",
"description": "If true, returns only ETFs. (provider: fmp)",
"required": false
},
"is_active": {
"type": "Boolean",
"description": "If false, returns only inactive tickers. (provider: fmp)",
"required": false
},
"sector": {
"type": "Text",
"description": "Filter by sector. (provider: fmp)",
"required": false
},
"industry": {
"type": "Text",
"description": "Filter by industry. (provider: fmp)",
"required": false
},
"country": {
"type": "Text",
"description": "Filter by country, as a two-letter country code. (provider: fmp)",
"required": false
},
"exchange": {
"type": "Text",
"description": "Filter by exchange. (provider: fmp)",
"required": false
},
"limit": {
"type": "Number",
"description": "Limit the number of results to return. (provider: fmp)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"name": {
"description": "Name of the company. "
},
"market_cap": {
"description": "The market cap of ticker. (provider: fmp)"
},
"sector": {
"description": "The sector the ticker belongs to. (provider: fmp)"
},
"industry": {
"description": "The industry ticker belongs to. (provider: fmp)"
},
"beta": {
"description": "The beta of the ETF. (provider: fmp)"
},
"price": {
"description": "The current price. (provider: fmp)"
},
"last_annual_dividend": {
"description": "The last annual amount dividend paid. (provider: fmp)"
},
"volume": {
"description": "The current trading volume. (provider: fmp)"
},
"exchange": {
"description": "The exchange code the asset trades on. (provider: fmp)"
},
"exchange_name": {
"description": "The full name of the primary exchange. (provider: fmp)"
},
"country": {
"description": "The two-letter country abbreviation where the head office is located. (provider: fmp)"
},
"is_etf": {
"description": "Whether the ticker is an ETF. (provider: fmp)"
},
"actively_trading": {
"description": "Whether the ETF is actively trading. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.SCREENER()"
}
},
"/equity/search": {
"name": "search",
"description": "Equity Search. Search for a company or stock ticker.",
"signature": "=OBB.EQUITY.SEARCH([query];[is_symbol];[provider];[active];[limit];[is_fund];[use_cache])",
"parameters": {
"query": {
"type": "Text",
"description": "Search query.",
"required": false
},
"is_symbol": {
"type": "Boolean",
"description": "Whether to search by ticker symbol.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: intrinio, sec, defaults to intrinio.",
"required": false
},
"active": {
"type": "Boolean",
"description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. (provider: intrinio)",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return. (provider: intrinio)",
"required": false
},
"is_fund": {
"type": "Boolean",
"description": "Whether to direct the search to the list of mutual funds and ETFs. (provider: sec)",
"required": false
},
"use_cache": {
"type": "Boolean",
"description": "Whether to use the cache or not. Company names, tickers, and CIKs are cached for seven days. (provider: sec)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"name": {
"description": "Name of the company. "
},
"cik": {
"description": "; Central Index Key (provider: sec)"
},
"lei": {
"description": "The Legal Entity Identifier (LEI) of the company. (provider: intrinio)"
},
"intrinio_id": {
"description": "The Intrinio ID of the company. (provider: intrinio)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.SEARCH()"
}
},
"/equity/shorts/fails_to_deliver": {
"name": "fails_to_deliver",
"description": "Get reported Fail-to-deliver (FTD) data.",
"signature": "=OBB.EQUITY.SHORTS.FAILS_TO_DELIVER(symbol;[provider];[limit];[skip_reports])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: sec, defaults to sec.",
"required": false
},
"limit": {
"type": "Number",
"description": "Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009. (provider: sec)",
"required": false
},
"skip_reports": {
"type": "Number",
"description": "Skip N number of reports from current. A value of 1 will skip the most recent report. (provider: sec)",
"required": false
}
},
"data": {
"settlement_date": {
"description": "The settlement date of the fail. "
},
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"cusip": {
"description": "CUSIP of the Security. "
},
"quantity": {
"description": "The number of fails on that settlement date. "
},
"price": {
"description": "The price at the previous closing price from the settlement date. "
},
"description": {
"description": "The description of the Security. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.EQUITY.SHORTS.FAILS_TO_DELIVER(\"AAPL\")"
}
},
"/etf/countries": {
"name": "countries",
"description": "ETF Country weighting.",
"signature": "=OBB.ETF.COUNTRIES(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for. (ETF)",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"country": {
"description": "The country of the exposure. Corresponding values are normalized percentage points. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ETF.COUNTRIES(\"SPY\")"
}
},
"/etf/holdings": {
"name": "holdings",
"description": "Get the holdings for an individual ETF.",
"signature": "=OBB.ETF.HOLDINGS(symbol;[provider];[date];[cik];[use_cache])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for. (ETF)",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, sec, defaults to fmp.",
"required": false
},
"date": {
"type": "Text",
"description": "A specific date to get data for. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF. (provider: fmp); A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)",
"required": false
},
"cik": {
"type": "Text",
"description": "The CIK of the filing entity. Overrides symbol. (provider: fmp)",
"required": false
},
"use_cache": {
"type": "Boolean",
"description": "Whether or not to use cache for the request. (provider: sec)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. (ETF) "
},
"name": {
"description": "Name of the ETF holding. "
},
"lei": {
"description": "The LEI of the holding. (provider: fmp, sec)"
},
"title": {
"description": "The title of the holding. (provider: fmp)"
},
"cusip": {
"description": "The CUSIP of the holding. (provider: fmp, sec)"
},
"isin": {
"description": "The ISIN of the holding. (provider: fmp, sec)"
},
"balance": {
"description": "The balance of the holding. (provider: fmp, sec)"
},
"units": {
"description": "The units of the holding. (provider: fmp, sec)"
},
"currency": {
"description": "The currency of the holding. (provider: fmp, sec)"
},
"value": {
"description": "The value of the holding in USD. (provider: fmp, sec)"
},
"weight": {
"description": "The weight of the holding in ETF in %. (provider: fmp, sec)"
},
"payoff_profile": {
"description": "The payoff profile of the holding. (provider: fmp, sec)"
},
"asset_category": {
"description": "The asset category of the holding. (provider: fmp, sec)"
},
"issuer_category": {
"description": "The issuer category of the holding. (provider: fmp, sec)"
},
"country": {
"description": "The country of the holding. (provider: fmp, sec)"
},
"is_restricted": {
"description": "Whether the holding is restricted. (provider: fmp, sec)"
},
"fair_value_level": {
"description": "The fair value level of the holding. (provider: fmp, sec)"
},
"is_cash_collateral": {
"description": "Whether the holding is cash collateral. (provider: fmp, sec)"
},
"is_non_cash_collateral": {
"description": "Whether the holding is non-cash collateral. (provider: fmp, sec)"
},
"is_loan_by_fund": {
"description": "Whether the holding is loan by fund. (provider: fmp, sec)"
},
"cik": {
"description": "The CIK of the filing. (provider: fmp)"
},
"acceptance_datetime": {
"description": "The acceptance datetime of the filing. (provider: fmp)"
},
"other_id": {
"description": "Internal identifier for the holding. (provider: sec)"
},
"loan_value": {
"description": "The loan value of the holding. (provider: sec)"
},
"issuer_conditional": {
"description": "The issuer conditions of the holding. (provider: sec)"
},
"asset_conditional": {
"description": "The asset conditions of the holding. (provider: sec)"
},
"maturity_date": {
"description": "The maturity date of the debt security. (provider: sec)"
},
"coupon_kind": {
"description": "The type of coupon for the debt security. (provider: sec)"
},
"rate_type": {
"description": "The type of rate for the debt security, floating or fixed. (provider: sec)"
},
"annualized_return": {
"description": "The annualized return on the debt security. (provider: sec)"
},
"is_default": {
"description": "If the debt security is defaulted. (provider: sec)"
},
"in_arrears": {
"description": "If the debt security is in arrears. (provider: sec)"
},
"is_paid_kind": {
"description": "If the debt security payments are are paid in kind. (provider: sec)"
},
"derivative_category": {
"description": "The derivative category of the holding. (provider: sec)"
},
"counterparty": {
"description": "The counterparty of the derivative. (provider: sec)"
},
"underlying_name": {
"description": "The name of the underlying asset associated with the derivative. (provider: sec)"
},
"option_type": {
"description": "The type of option. (provider: sec)"
},
"derivative_payoff": {
"description": "The payoff profile of the derivative. (provider: sec)"
},
"expiry_date": {
"description": "The expiry or termination date of the derivative. (provider: sec)"
},
"exercise_price": {
"description": "The exercise price of the option. (provider: sec)"
},
"exercise_currency": {
"description": "The currency of the option exercise price. (provider: sec)"
},
"shares_per_contract": {
"description": "The number of shares per contract. (provider: sec)"
},
"delta": {
"description": "The delta of the option. (provider: sec)"
},
"rate_type_rec": {
"description": "The type of rate for reveivable portion of the swap. (provider: sec)"
},
"receive_currency": {
"description": "The receive currency of the swap. (provider: sec)"
},
"upfront_receive": {
"description": "The upfront amount received of the swap. (provider: sec)"
},
"floating_rate_index_rec": {
"description": "The floating rate index for reveivable portion of the swap. (provider: sec)"
},
"floating_rate_spread_rec": {
"description": "The floating rate spread for reveivable portion of the swap. (provider: sec)"
},
"rate_tenor_rec": {
"description": "The rate tenor for reveivable portion of the swap. (provider: sec)"
},
"rate_tenor_unit_rec": {
"description": "The rate tenor unit for reveivable portion of the swap. (provider: sec)"
},
"reset_date_rec": {
"description": "The reset date for reveivable portion of the swap. (provider: sec)"
},
"reset_date_unit_rec": {
"description": "The reset date unit for reveivable portion of the swap. (provider: sec)"
},
"rate_type_pmnt": {
"description": "The type of rate for payment portion of the swap. (provider: sec)"
},
"payment_currency": {
"description": "The payment currency of the swap. (provider: sec)"
},
"upfront_payment": {
"description": "The upfront amount received of the swap. (provider: sec)"
},
"floating_rate_index_pmnt": {
"description": "The floating rate index for payment portion of the swap. (provider: sec)"
},
"floating_rate_spread_pmnt": {
"description": "The floating rate spread for payment portion of the swap. (provider: sec)"
},
"rate_tenor_pmnt": {
"description": "The rate tenor for payment portion of the swap. (provider: sec)"
},
"rate_tenor_unit_pmnt": {
"description": "The rate tenor unit for payment portion of the swap. (provider: sec)"
},
"reset_date_pmnt": {
"description": "The reset date for payment portion of the swap. (provider: sec)"
},
"reset_date_unit_pmnt": {
"description": "The reset date unit for payment portion of the swap. (provider: sec)"
},
"repo_type": {
"description": "The type of repo. (provider: sec)"
},
"is_cleared": {
"description": "If the repo is cleared. (provider: sec)"
},
"is_tri_party": {
"description": "If the repo is tri party. (provider: sec)"
},
"principal_amount": {
"description": "The principal amount of the repo. (provider: sec)"
},
"principal_currency": {
"description": "The currency of the principal amount. (provider: sec)"
},
"collateral_type": {
"description": "The collateral type of the repo. (provider: sec)"
},
"collateral_amount": {
"description": "The collateral amount of the repo. (provider: sec)"
},
"collateral_currency": {
"description": "The currency of the collateral amount. (provider: sec)"
},
"exchange_currency": {
"description": "The currency of the exchange rate. (provider: sec)"
},
"exchange_rate": {
"description": "The exchange rate. (provider: sec)"
},
"currency_sold": {
"description": "The currency sold in a Forward Derivative. (provider: sec)"
},
"currency_amount_sold": {
"description": "The amount of currency sold in a Forward Derivative. (provider: sec)"
},
"currency_bought": {
"description": "The currency bought in a Forward Derivative. (provider: sec)"
},
"currency_amount_bought": {
"description": "The amount of currency bought in a Forward Derivative. (provider: sec)"
},
"notional_amount": {
"description": "The notional amount of the derivative. (provider: sec)"
},
"notional_currency": {
"description": "The currency of the derivative's notional amount. (provider: sec)"
},
"unrealized_gain": {
"description": "The unrealized gain or loss on the derivative. (provider: sec)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ETF.HOLDINGS(\"SPY\")"
}
},
"/etf/holdings_date": {
"name": "holdings_date",
"description": "Get the holdings filing date for an individual ETF.",
"signature": "=OBB.ETF.HOLDINGS_DATE(symbol;[provider];[cik])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for. (ETF)",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
},
"cik": {
"type": "Text",
"description": "The CIK of the filing entity. Overrides symbol. (provider: fmp)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ETF.HOLDINGS_DATE(\"SPY\")"
}
},
"/etf/holdings_performance": {
"name": "holdings_performance",
"description": "Get the ETF holdings performance.",
"signature": "=OBB.ETF.HOLDINGS_PERFORMANCE(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"one_day": {
"description": "One-day return. "
},
"wtd": {
"description": "Week to date return. "
},
"one_week": {
"description": "One-week return. "
},
"mtd": {
"description": "Month to date return. "
},
"one_month": {
"description": "One-month return. "
},
"qtd": {
"description": "Quarter to date return. "
},
"three_month": {
"description": "Three-month return. "
},
"six_month": {
"description": "Six-month return. "
},
"ytd": {
"description": "Year to date return. "
},
"one_year": {
"description": "One-year return. "
},
"three_year": {
"description": "Three-year return. "
},
"five_year": {
"description": "Five-year return. "
},
"ten_year": {
"description": "Ten-year return. "
},
"max": {
"description": "Return from the beginning of the time series. "
},
"symbol": {
"description": "The ticker symbol. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ETF.HOLDINGS_PERFORMANCE(\"SPY\")"
}
},
"/etf/info": {
"name": "info",
"description": "ETF Information Overview.",
"signature": "=OBB.ETF.INFO(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for. (ETF)",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. (ETF) "
},
"name": {
"description": "Name of the ETF. "
},
"inception_date": {
"description": "Inception date of the ETF. "
},
"asset_class": {
"description": "Asset class of the ETF. (provider: fmp)"
},
"aum": {
"description": "Assets under management. (provider: fmp)"
},
"avg_volume": {
"description": "Average trading volume of the ETF. (provider: fmp)"
},
"cusip": {
"description": "CUSIP of the ETF. (provider: fmp)"
},
"description": {
"description": "Description of the ETF. (provider: fmp)"
},
"domicile": {
"description": "Domicile of the ETF. (provider: fmp)"
},
"etf_company": {
"description": "Company of the ETF. (provider: fmp)"
},
"expense_ratio": {
"description": "Expense ratio of the ETF. (provider: fmp)"
},
"isin": {
"description": "ISIN of the ETF. (provider: fmp)"
},
"nav": {
"description": "Net asset value of the ETF. (provider: fmp)"
},
"nav_currency": {
"description": "Currency of the ETF's net asset value. (provider: fmp)"
},
"website": {
"description": "Website link of the ETF. (provider: fmp)"
},
"holdings_count": {
"description": "Number of holdings in the ETF. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ETF.INFO(\"SPY\")"
}
},
"/etf/price_performance": {
"name": "price_performance",
"description": "Price performance as a return, over different periods.",
"signature": "=OBB.ETF.PRICE_PERFORMANCE(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"one_day": {
"description": "One-day return. "
},
"wtd": {
"description": "Week to date return. "
},
"one_week": {
"description": "One-week return. "
},
"mtd": {
"description": "Month to date return. "
},
"one_month": {
"description": "One-month return. "
},
"qtd": {
"description": "Quarter to date return. "
},
"three_month": {
"description": "Three-month return. "
},
"six_month": {
"description": "Six-month return. "
},
"ytd": {
"description": "Year to date return. "
},
"one_year": {
"description": "One-year return. "
},
"three_year": {
"description": "Three-year return. "
},
"five_year": {
"description": "Five-year return. "
},
"ten_year": {
"description": "Ten-year return. "
},
"max": {
"description": "Return from the beginning of the time series. "
},
"symbol": {
"description": "The ticker symbol. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ETF.PRICE_PERFORMANCE(\"SPY\")"
}
},
"/etf/search": {
"name": "search",
"description": "Search for ETFs. An empty query returns the full list of ETFs from the provider.",
"signature": "=OBB.ETF.SEARCH([query];[provider];[exchange];[is_active])",
"parameters": {
"query": {
"type": "Text",
"description": "Search query.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
},
"exchange": {
"type": "Text",
"description": "The exchange code the ETF trades on. (provider: fmp)",
"required": false
},
"is_active": {
"type": "Boolean",
"description": "Whether the ETF is actively trading. (provider: fmp)",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data.(ETF) "
},
"name": {
"description": "Name of the ETF. "
},
"market_cap": {
"description": "The market cap of the ETF. (provider: fmp)"
},
"sector": {
"description": "The sector of the ETF. (provider: fmp)"
},
"industry": {
"description": "The industry of the ETF. (provider: fmp)"
},
"beta": {
"description": "The beta of the ETF. (provider: fmp)"
},
"price": {
"description": "The current price of the ETF. (provider: fmp)"
},
"last_annual_dividend": {
"description": "The last annual dividend paid. (provider: fmp)"
},
"volume": {
"description": "The current trading volume of the ETF. (provider: fmp)"
},
"exchange": {
"description": "The exchange code the ETF trades on. (provider: fmp)"
},
"exchange_name": {
"description": "The full name of the exchange the ETF trades on. (provider: fmp)"
},
"country": {
"description": "The country the ETF is registered in. (provider: fmp)"
},
"actively_trading": {
"description": "Whether the ETF is actively trading. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ETF.SEARCH()"
}
},
"/etf/sectors": {
"name": "sectors",
"description": "ETF Sector weighting.",
"signature": "=OBB.ETF.SECTORS(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for. (ETF)",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"sector": {
"description": "Sector of exposure. "
},
"weight": {
"description": "Exposure of the ETF to the sector in normalized percentage points. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.ETF.SECTORS(\"SPY\")"
}
},
"/fixedincome/corporate/commercial_paper": {
"name": "commercial_paper",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.CORPORATE.COMMERCIAL_PAPER([start_date];[end_date];[maturity];[category];[grade];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"maturity": {
"type": "Text",
"description": "The maturity.",
"required": false
},
"category": {
"type": "Text",
"description": "The category.",
"required": false
},
"grade": {
"type": "Text",
"description": "The grade.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "Commercial Paper Rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.CORPORATE.COMMERCIAL_PAPER()"
}
},
"/fixedincome/corporate/hqm": {
"name": "hqm",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.CORPORATE.HQM([date];[yield_curve];[provider])",
"parameters": {
"date": {
"type": "Text",
"description": "A specific date to get data for.",
"required": false
},
"yield_curve": {
"type": "Text",
"description": "The yield curve type.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "HighQualityMarketCorporateBond Rate. "
},
"maturity": {
"description": "Maturity. "
},
"yield_curve": {
"description": "The yield curve type. "
},
"series_id": {
"description": "FRED series id. (provider: fred)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.CORPORATE.HQM()"
}
},
"/fixedincome/corporate/ice_bofa": {
"name": "ice_bofa",
"description": "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\u2019s, 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.",
"signature": "=OBB.FIXEDINCOME.CORPORATE.ICE_BOFA([start_date];[end_date];[index_type];[provider];[category];[area];[grade];[options])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"index_type": {
"type": "Text",
"description": "The type of series.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
},
"category": {
"type": "Text",
"description": "The type of category. (provider: fred)",
"required": false
},
"area": {
"type": "Text",
"description": "The type of area. (provider: fred)",
"required": false
},
"grade": {
"type": "Text",
"description": "The type of grade. (provider: fred)",
"required": false
},
"options": {
"type": "Boolean",
"description": "Whether to include options in the results. (provider: fred)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "ICE BofA US Corporate Bond Indices Rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.CORPORATE.ICE_BOFA()"
}
},
"/fixedincome/corporate/moody": {
"name": "moody",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.CORPORATE.MOODY([start_date];[end_date];[index_type];[provider];[spread])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"index_type": {
"type": "Text",
"description": "The type of series.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
},
"spread": {
"type": "Text",
"description": "The type of spread. (provider: fred)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "Moody Corporate Bond Index Rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.CORPORATE.MOODY()"
}
},
"/fixedincome/corporate/spot_rates": {
"name": "spot_rates",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.CORPORATE.SPOT_RATES([start_date];[end_date];[maturity];[category];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"maturity": {
"type": "Any",
"description": "The maturities in years.",
"required": false
},
"category": {
"type": "Any",
"description": "The category.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "Spot Rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.CORPORATE.SPOT_RATES()"
}
},
"/fixedincome/government/treasury_rates": {
"name": "treasury_rates",
"description": "Government Treasury Rates.",
"signature": "=OBB.FIXEDINCOME.GOVERNMENT.TREASURY_RATES([start_date];[end_date];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: federal_reserve, fmp, defaults to federal_reserve.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"month_1": {
"description": "1 month treasury rate. "
},
"month_2": {
"description": "2 month treasury rate. "
},
"month_3": {
"description": "3 month treasury rate. "
},
"month_6": {
"description": "6 month treasury rate. "
},
"year_1": {
"description": "1 year treasury rate. "
},
"year_2": {
"description": "2 year treasury rate. "
},
"year_3": {
"description": "3 year treasury rate. "
},
"year_5": {
"description": "5 year treasury rate. "
},
"year_7": {
"description": "7 year treasury rate. "
},
"year_10": {
"description": "10 year treasury rate. "
},
"year_20": {
"description": "20 year treasury rate. "
},
"year_30": {
"description": "30 year treasury rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.GOVERNMENT.TREASURY_RATES()"
}
},
"/fixedincome/government/us_yield_curve": {
"name": "us_yield_curve",
"description": "US Yield Curve. Get United States yield curve.",
"signature": "=OBB.FIXEDINCOME.GOVERNMENT.US_YIELD_CURVE([date];[inflation_adjusted];[provider])",
"parameters": {
"date": {
"type": "Text",
"description": "A specific date to get data for. Defaults to the most recent FRED entry.",
"required": false
},
"inflation_adjusted": {
"type": "Boolean",
"description": "Get inflation adjusted rates.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
}
},
"data": {
"maturity": {
"description": "Maturity of the treasury rate in years. "
},
"rate": {
"description": "Associated rate given in decimal form (0.05 is 5%) "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.GOVERNMENT.US_YIELD_CURVE()"
}
},
"/fixedincome/rate/ameribor": {
"name": "ameribor",
"description": "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).",
"signature": "=OBB.FIXEDINCOME.RATE.AMERIBOR([start_date];[end_date];[provider];[parameter])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
},
"parameter": {
"type": "Text",
"description": "Period of AMERIBOR rate. (provider: fred)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "AMERIBOR rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.RATE.AMERIBOR()"
}
},
"/fixedincome/rate/dpcredit": {
"name": "dpcredit",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.RATE.DPCREDIT([start_date];[end_date];[provider];[parameter])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
},
"parameter": {
"type": "Text",
"description": "FRED series ID of DWPCR data. (provider: fred)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "Discount Window Primary Credit Rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.RATE.DPCREDIT()"
}
},
"/fixedincome/rate/ecb": {
"name": "ecb",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.RATE.ECB([start_date];[end_date];[interest_rate_type];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"interest_rate_type": {
"type": "Text",
"description": "The type of interest rate.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "European Central Bank Interest Rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.RATE.ECB()"
}
},
"/fixedincome/rate/effr": {
"name": "effr",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.RATE.EFFR([start_date];[end_date];[provider];[parameter])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: federal_reserve, fred, defaults to federal_reserve.",
"required": false
},
"parameter": {
"type": "Text",
"description": "Period of FED rate. (provider: fred)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "FED rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.RATE.EFFR()"
}
},
"/fixedincome/rate/effr_forecast": {
"name": "effr_forecast",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.RATE.EFFR_FORECAST([provider];[long_run])",
"parameters": {
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
},
"long_run": {
"type": "Boolean",
"description": "Flag to show long run projections (provider: fred)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"range_high": {
"description": "High projection of rates. "
},
"central_tendency_high": {
"description": "Central tendency of high projection of rates. "
},
"median": {
"description": "Median projection of rates. "
},
"range_midpoint": {
"description": "Midpoint projection of rates. "
},
"central_tendency_midpoint": {
"description": "Central tendency of midpoint projection of rates. "
},
"range_low": {
"description": "Low projection of rates. "
},
"central_tendency_low": {
"description": "Central tendency of low projection of rates. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.RATE.EFFR_FORECAST()"
}
},
"/fixedincome/rate/estr": {
"name": "estr",
"description": "Euro Short-Term Rate. The euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in the euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on the previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been executed at arm\u2019s length and thus reflect market rates in an unbiased way.",
"signature": "=OBB.FIXEDINCOME.RATE.ESTR([start_date];[end_date];[provider];[parameter])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
},
"parameter": {
"type": "Text",
"description": "Period of ESTR rate. (provider: fred)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "ESTR rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.RATE.ESTR()"
}
},
"/fixedincome/rate/iorb": {
"name": "iorb",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.RATE.IORB([start_date];[end_date];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "IORB rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.RATE.IORB()"
}
},
"/fixedincome/rate/sonia": {
"name": "sonia",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.RATE.SONIA([start_date];[end_date];[provider];[parameter])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
},
"parameter": {
"type": "Text",
"description": "Period of SONIA rate. (provider: fred)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "SONIA rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.RATE.SONIA()"
}
},
"/fixedincome/sofr": {
"name": "sofr",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.SOFR([start_date];[end_date];[provider];[period])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
},
"period": {
"type": "Text",
"description": "Period of SOFR rate. (provider: fred)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "SOFR rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.SOFR()"
}
},
"/fixedincome/spreads/tmc": {
"name": "tmc",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.SPREADS.TMC([start_date];[end_date];[maturity];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"maturity": {
"type": "Text",
"description": "The maturity",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "TreasuryConstantMaturity Rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.SPREADS.TMC()"
}
},
"/fixedincome/spreads/tmc_effr": {
"name": "tmc_effr",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.SPREADS.TMC_EFFR([start_date];[end_date];[maturity];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"maturity": {
"type": "Text",
"description": "The maturity",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "Selected Treasury Constant Maturity Rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.SPREADS.TMC_EFFR()"
}
},
"/fixedincome/spreads/treasury_effr": {
"name": "treasury_effr",
"description": "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.",
"signature": "=OBB.FIXEDINCOME.SPREADS.TREASURY_EFFR([start_date];[end_date];[maturity];[provider])",
"parameters": {
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"maturity": {
"type": "Text",
"description": "The maturity",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fred, defaults to fred.",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"rate": {
"description": "SelectedTreasuryBill Rate. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.FIXEDINCOME.SPREADS.TREASURY_EFFR()"
}
},
"/index/available": {
"name": "available",
"description": "Available Indices. Available indices for a given provider.",
"signature": "=OBB.INDEX.AVAILABLE([provider])",
"parameters": {
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"name": {
"description": "Name of the index. "
},
"currency": {
"description": "Currency the index is traded in. "
},
"stock_exchange": {
"description": "Stock exchange where the index is listed. (provider: fmp)"
},
"exchange_short_name": {
"description": "Short name of the stock exchange where the index is listed. (provider: fmp)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.INDEX.AVAILABLE()"
}
},
"/index/constituents": {
"name": "constituents",
"description": "Index Constituents. Constituents of an index.",
"signature": "=OBB.INDEX.CONSTITUENTS([index];[provider])",
"parameters": {
"index": {
"type": "Text",
"description": "Index for which we want to fetch the constituents.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, defaults to fmp.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. "
},
"name": {
"description": "Name of the constituent company in the index. "
},
"sector": {
"description": "Sector the constituent company in the index belongs to. "
},
"sub_sector": {
"description": "Sub-sector the constituent company in the index belongs to. "
},
"headquarter": {
"description": "Location of the headquarter of the constituent company in the index. "
},
"date_first_added": {
"description": "Date the constituent company was added to the index. "
},
"cik": {
"description": "Central Index Key (CIK) for the requested entity. "
},
"founded": {
"description": "Founding year of the constituent company in the index. "
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.INDEX.CONSTITUENTS()"
}
},
"/index/market": {
"name": "market",
"description": "Historical Market Indices.",
"signature": "=OBB.INDEX.MARKET(symbol;[start_date];[end_date];[provider];[timeseries];[interval];[sort];[tag];[type];[limit];[sleep];[timespan];[adjusted];[multiplier])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"start_date": {
"type": "Text",
"description": "Start date of the data, in YYYY-MM-DD format.",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the data, in YYYY-MM-DD format.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: fmp, intrinio, polygon, defaults to fmp.",
"required": false
},
"timeseries": {
"type": "Number",
"description": "Number of days to look back. (provider: fmp)",
"required": false
},
"interval": {
"type": "Text",
"description": "Data granularity. (provider: fmp)",
"required": false
},
"sort": {
"type": "Text",
"description": "Sort the data in ascending or descending order. (provider: fmp); Sort order. (provider: intrinio); Sort order of the data. (provider: polygon)",
"required": false
},
"tag": {
"type": "Text",
"description": "Index tag. (provider: intrinio)",
"required": false
},
"type": {
"type": "Text",
"description": "Index type. (provider: intrinio)",
"required": false
},
"limit": {
"type": "Number",
"description": "The number of data entries to return. (provider: intrinio, polygon)",
"required": false
},
"sleep": {
"type": "Number",
"description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)",
"required": false
},
"timespan": {
"type": "Text",
"description": "Timespan of the data. (provider: polygon)",
"required": false
},
"adjusted": {
"type": "Boolean",
"description": "Whether the data is adjusted. (provider: polygon)",
"required": false
},
"multiplier": {
"type": "Number",
"description": "Multiplier of the timespan. (provider: polygon)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. "
},
"open": {
"description": "The open price. "
},
"high": {
"description": "The high price. "
},
"low": {
"description": "The low price. "
},
"close": {
"description": "The close price. "
},
"volume": {
"description": "The trading volume. "
},
"adj_close": {
"description": "The adjusted close price. (provider: fmp)"
},
"unadjusted_volume": {
"description": "Unadjusted volume of the symbol. (provider: fmp)"
},
"change": {
"description": "Change in the price of the symbol from the previous day. (provider: fmp)"
},
"change_percent": {
"description": "Change % in the price of the symbol. (provider: fmp)"
},
"label": {
"description": "Human readable format of the date. (provider: fmp)"
},
"change_over_time": {
"description": "Change % in the price of the symbol over a period of time. (provider: fmp)"
},
"transactions": {
"description": "Number of transactions for the symbol in the time period. (provider: polygon)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.INDEX.MARKET(\"^GSPC\")"
}
},
"/news/company": {
"name": "company",
"description": "Company News. Get news for one or more companies.",
"signature": "=OBB.NEWS.COMPANY(symbols;[limit];[provider];[display];[date];[start_date];[end_date];[updated_since];[published_since];[sort];[order];[isin];[cusip];[channels];[topics];[authors];[content_types];[page];[published_utc];[source])",
"parameters": {
"symbols": {
"type": "Text",
"description": "Here it is a separated list of symbols.",
"required": true
},
"limit": {
"type": "Number",
"description": "The number of data entries to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: benzinga, fmp, intrinio, polygon, tiingo, defaults to benzinga.",
"required": false
},
"display": {
"type": "Text",
"description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)",
"required": false
},
"date": {
"type": "Text",
"description": "Date of the news to retrieve. (provider: benzinga)",
"required": false
},
"start_date": {
"type": "Text",
"description": "Start date of the news to retrieve. (provider: benzinga)",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the news to retrieve. (provider: benzinga)",
"required": false
},
"updated_since": {
"type": "Number",
"description": "Number of seconds since the news was updated. (provider: benzinga)",
"required": false
},
"published_since": {
"type": "Number",
"description": "Number of seconds since the news was published. (provider: benzinga)",
"required": false
},
"sort": {
"type": "Text",
"description": "Key to sort the news by. (provider: benzinga)",
"required": false
},
"order": {
"type": "Text",
"description": "Order to sort the news by. (provider: benzinga); Sort order of the articles. (provider: polygon)",
"required": false
},
"isin": {
"type": "Text",
"description": "The ISIN of the news to retrieve. (provider: benzinga)",
"required": false
},
"cusip": {
"type": "Text",
"description": "The CUSIP of the news to retrieve. (provider: benzinga)",
"required": false
},
"channels": {
"type": "Text",
"description": "Channels of the news to retrieve. (provider: benzinga)",
"required": false
},
"topics": {
"type": "Text",
"description": "Topics of the news to retrieve. (provider: benzinga)",
"required": false
},
"authors": {
"type": "Text",
"description": "Authors of the news to retrieve. (provider: benzinga)",
"required": false
},
"content_types": {
"type": "Text",
"description": "Content types of the news to retrieve. (provider: benzinga)",
"required": false
},
"page": {
"type": "Number",
"description": "Page number of the results. Use in combination with limit. (provider: fmp)",
"required": false
},
"published_utc": {
"type": "Text",
"description": "Date query to fetch articles. Supports operators <, <=, >, >= (provider: polygon)",
"required": false
},
"source": {
"type": "Text",
"description": "A comma-separated list of the domains requested. (provider: tiingo)",
"required": false
}
},
"data": {
"symbols": {
"description": " Here it is a separated list of symbols. "
},
"date": {
"description": "The date of the data. Here it is the date of the news. "
},
"title": {
"description": "Title of the news. "
},
"image": {
"description": "Image URL of the news. "
},
"text": {
"description": "Text/body of the news. "
},
"url": {
"description": "URL of the news. "
},
"id": {
"description": "Article ID. (provider: benzinga, intrinio, polygon)"
},
"author": {
"description": "Author of the article. (provider: benzinga, polygon)"
},
"teaser": {
"description": "Teaser of the news. (provider: benzinga)"
},
"images": {
"description": "URL to the images of the news. (provider: benzinga, fmp)"
},
"channels": {
"description": "Channels associated with the news. (provider: benzinga)"
},
"stocks": {
"description": "Stocks associated with the news. (provider: benzinga)"
},
"tags": {
"description": "Tags associated with the news. (provider: benzinga, tiingo)"
},
"updated": {
"description": "Updated date of the news. (provider: benzinga)"
},
"site": {
"description": "Name of the news source. (provider: fmp); News source. (provider: tiingo)"
},
"amp_url": {
"description": "AMP URL. (provider: polygon)"
},
"image_url": {
"description": "Image URL. (provider: polygon)"
},
"keywords": {
"description": "Keywords in the article (provider: polygon)"
},
"publisher": {
"description": "Publisher of the article. (provider: polygon)"
},
"article_id": {
"description": "Unique ID of the news article. (provider: tiingo)"
},
"crawl_date": {
"description": "Date the news article was crawled. (provider: tiingo)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.NEWS.COMPANY(\"AAPL,MSFT\")"
}
},
"/news/world": {
"name": "world",
"description": "World News. Global news data.",
"signature": "=OBB.NEWS.WORLD([limit];[provider];[display];[date];[start_date];[end_date];[updated_since];[published_since];[sort];[order];[isin];[cusip];[channels];[topics];[authors];[content_types];[source])",
"parameters": {
"limit": {
"type": "Number",
"description": "The number of data entries to return. Here its the no. of articles to return.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: benzinga, fmp, intrinio, tiingo, defaults to benzinga.",
"required": false
},
"display": {
"type": "Text",
"description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)",
"required": false
},
"date": {
"type": "Text",
"description": "Date of the news to retrieve. (provider: benzinga)",
"required": false
},
"start_date": {
"type": "Text",
"description": "Start date of the news to retrieve. (provider: benzinga)",
"required": false
},
"end_date": {
"type": "Text",
"description": "End date of the news to retrieve. (provider: benzinga)",
"required": false
},
"updated_since": {
"type": "Number",
"description": "Number of seconds since the news was updated. (provider: benzinga)",
"required": false
},
"published_since": {
"type": "Number",
"description": "Number of seconds since the news was published. (provider: benzinga)",
"required": false
},
"sort": {
"type": "Text",
"description": "Key to sort the news by. (provider: benzinga)",
"required": false
},
"order": {
"type": "Text",
"description": "Order to sort the news by. (provider: benzinga)",
"required": false
},
"isin": {
"type": "Text",
"description": "The ISIN of the news to retrieve. (provider: benzinga)",
"required": false
},
"cusip": {
"type": "Text",
"description": "The CUSIP of the news to retrieve. (provider: benzinga)",
"required": false
},
"channels": {
"type": "Text",
"description": "Channels of the news to retrieve. (provider: benzinga)",
"required": false
},
"topics": {
"type": "Text",
"description": "Topics of the news to retrieve. (provider: benzinga)",
"required": false
},
"authors": {
"type": "Text",
"description": "Authors of the news to retrieve. (provider: benzinga)",
"required": false
},
"content_types": {
"type": "Text",
"description": "Content types of the news to retrieve. (provider: benzinga)",
"required": false
},
"source": {
"type": "Text",
"description": "A comma-separated list of the domains requested. (provider: tiingo)",
"required": false
}
},
"data": {
"date": {
"description": "The date of the data. Here it is the published date of the news. "
},
"title": {
"description": "Title of the news. "
},
"images": {
"description": "Images associated with the news. "
},
"text": {
"description": "Text/body of the news. "
},
"url": {
"description": "URL of the news. "
},
"id": {
"description": "Article ID. (provider: benzinga, intrinio)"
},
"author": {
"description": "Author of the news. (provider: benzinga)"
},
"teaser": {
"description": "Teaser of the news. (provider: benzinga)"
},
"channels": {
"description": "Channels associated with the news. (provider: benzinga)"
},
"stocks": {
"description": "Stocks associated with the news. (provider: benzinga)"
},
"tags": {
"description": "Tags associated with the news. (provider: benzinga, tiingo)"
},
"updated": {
"description": "Updated date of the news. (provider: benzinga)"
},
"site": {
"description": "News source. (provider: fmp, tiingo)"
},
"company": {
"description": "Company details related to the news article. (provider: intrinio)"
},
"symbols": {
"description": "Ticker tagged in the fetched news. (provider: tiingo)"
},
"article_id": {
"description": "Unique ID of the news article. (provider: tiingo)"
},
"crawl_date": {
"description": "Date the news article was crawled. (provider: tiingo)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.NEWS.WORLD()"
}
},
"/regulators/sec/cik_map": {
"name": "cik_map",
"description": "Get the CIK number corresponding to a ticker symbol.",
"signature": "=OBB.REGULATORS.SEC.CIK_MAP(symbol;[provider])",
"parameters": {
"symbol": {
"type": "Text",
"description": "Symbol to get data for.",
"required": true
},
"provider": {
"type": "Text",
"description": "Options: sec, defaults to sec.",
"required": false
}
},
"data": {
"cik": {
"description": "Central Index Key (provider: sec)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.REGULATORS.SEC.CIK_MAP(\"AAPL\")"
}
},
"/regulators/sec/institutions_search": {
"name": "institutions_search",
"description": "Look up institutions regulated by the SEC.",
"signature": "=OBB.REGULATORS.SEC.INSTITUTIONS_SEARCH([query];[provider];[use_cache])",
"parameters": {
"query": {
"type": "Text",
"description": "Search query.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: sec, defaults to sec.",
"required": false
},
"use_cache": {
"type": "Boolean",
"description": "Whether or not to use cache. If True, cache will store for seven days. (provider: sec)",
"required": false
}
},
"data": {
"name": {
"description": "The name of the institution. (provider: sec)"
},
"cik": {
"description": "Central Index Key (CIK) (provider: sec)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.REGULATORS.SEC.INSTITUTIONS_SEARCH()"
}
},
"/regulators/sec/rss_litigation": {
"name": "rss_litigation",
"description": "The RSS feed provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.",
"signature": "=OBB.REGULATORS.SEC.RSS_LITIGATION([provider])",
"parameters": {
"provider": {
"type": "Text",
"description": "Options: sec, defaults to sec.",
"required": false
}
},
"data": {
"published": {
"description": "The date of publication. (provider: sec)"
},
"title": {
"description": "The title of the release. (provider: sec)"
},
"summary": {
"description": "Short summary of the release. (provider: sec)"
},
"id": {
"description": "The identifier associated with the release. (provider: sec)"
},
"link": {
"description": "URL to the release. (provider: sec)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.REGULATORS.SEC.RSS_LITIGATION()"
}
},
"/regulators/sec/schema_files": {
"name": "schema_files",
"description": "Get lists of SEC XML schema files by year.",
"signature": "=OBB.REGULATORS.SEC.SCHEMA_FILES([query];[provider];[url])",
"parameters": {
"query": {
"type": "Text",
"description": "Search query.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: sec, defaults to sec.",
"required": false
},
"url": {
"type": "Text",
"description": "Enter an optional URL path to fetch the next level. (provider: sec)",
"required": false
}
},
"data": {
"files": {
"description": "Dictionary of URLs to SEC Schema Files (provider: sec)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.REGULATORS.SEC.SCHEMA_FILES()"
}
},
"/regulators/sec/sic_search": {
"name": "sic_search",
"description": "Search for Industry Titles, Reporting Office, and SIC Codes.",
"signature": "=OBB.REGULATORS.SEC.SIC_SEARCH([query];[provider];[use_cache])",
"parameters": {
"query": {
"type": "Text",
"description": "Search query.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: sec, defaults to sec.",
"required": false
},
"use_cache": {
"type": "Boolean",
"description": "Whether to use the cache or not. The full list will be cached for seven days if True. (provider: sec)",
"required": false
}
},
"data": {
"sic": {
"description": "Sector Industrial Code (SIC) (provider: sec)"
},
"industry": {
"description": "Industry title. (provider: sec)"
},
"office": {
"description": "Reporting office within the Corporate Finance Office (provider: sec)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.REGULATORS.SEC.SIC_SEARCH()"
}
},
"/regulators/sec/symbol_map": {
"name": "symbol_map",
"description": "Get the ticker symbol corresponding to a company's CIK.",
"signature": "=OBB.REGULATORS.SEC.SYMBOL_MAP([query];[provider])",
"parameters": {
"query": {
"type": "Text",
"description": "Search query.",
"required": false
},
"provider": {
"type": "Text",
"description": "Options: sec, defaults to sec.",
"required": false
}
},
"data": {
"symbol": {
"description": "Symbol representing the entity requested in the data. (provider: sec)"
}
},
"return": "matrix",
"examples": {
"A. Required": "=OBB.REGULATORS.SEC.SYMBOL_MAP()"
}
}
}
Reference in New Issue View Git Blame Copy Permalink