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

Docs/remove core refs (#5957)

Browse Source 
* remove references to core: PathHandler + ProviderInterface

* remove unused function

* add comment

* regenerate

* fix a few examples

* add comment

* rename file
This commit is contained in:
montezdesousa
2024-01-15 15:24:20 +00:00
committed by GitHub
parent c8d5556858
commit 16cffc5f81
108 changed files with 45776 additions and 2854 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41495
website/content/excel/openapi.json vendored Normal file
View File

File diff suppressed because it is too large Load Diff

34
website/content/excel/reference/crypto/price/historical.md vendored
View File

@@ -31,7 +31,9 @@ Cryptocurrency Historical Price. Cryptocurrency historical price data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.CRYPTO.PRICE.HISTORICAL(symbol;[provider];[start_date];[end_date];[timeseries];[interval];[multiplier];[timespan];[sort];[limit];[adjusted];[exchanges])</span>```
```excel wordwrap
=OBB.CRYPTO.PRICE.HISTORICAL(symbol;[start_date];[end_date];[provider];[timeseries];[interval];[multiplier];[timespan];[sort];[limit];[adjusted];[exchanges])
```
### Example
@@ -43,20 +45,20 @@ Cryptocurrency Historical Price. Cryptocurrency historical price data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.** | **False** |
| provider | Text | Options: fmp, polygon, tiingo, defaults to fmp. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| timeseries | Number | Number of days to look back. (provider: fmp) | True |
| interval | Text | Data granularity. (provider: fmp, tiingo) | True |
| multiplier | Number | Multiplier of the timespan. (provider: polygon) | True |
| timespan | Text | Timespan of the data. (provider: polygon) | True |
| sort | Text | Sort order of the data. (provider: polygon) | True |
| limit | Number | The number of data entries to return. (provider: polygon) | True |
| adjusted | Boolean | Whether the data is adjusted. (provider: polygon) | True |
| exchanges | Any | To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] (provider: tiingo) | True |
| **symbol** | **Text** | **Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.** | **True** |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fmp, polygon, tiingo, defaults to fmp. | False |
| timeseries | Number | Number of days to look back. (provider: fmp) | False |
| interval | Text | Data granularity. (provider: fmp, tiingo) | False |
| multiplier | Number | Multiplier of the timespan. (provider: polygon) | False |
| timespan | Text | Timespan of the data. (provider: polygon) | False |
| sort | Text | Sort order of the data. (provider: polygon) | False |
| limit | Number | The number of data entries to return. (provider: polygon) | False |
| adjusted | Boolean | Whether the data is adjusted. (provider: polygon) | False |
| exchanges | Any | To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] (provider: tiingo) | False |
---
@@ -71,11 +73,11 @@ Cryptocurrency Historical Price. Cryptocurrency historical price data.
| close | The close price. |
| volume | The trading volume. |
| vwap | Volume Weighted Average Price over the period. |
| adj_close | Adjusted Close Price of the symbol. (provider: fmp) |
| adj_close | The adjusted close price. (provider: fmp) |
| unadjusted_volume | Unadjusted volume of the symbol. (provider: fmp) |
| change | Change in the price of the symbol from the previous day. (provider: fmp) |
| change_percent | Change % in the price of the symbol. (provider: fmp) |
| label | Human readable format of the date. (provider: fmp) |
| change_over_time | Change % in the price of the symbol over a period of time. (provider: fmp) |
| transactions | Number of transactions for the symbol in the time period. (provider: polygon); Number of trades. (provider: tiingo) |
| transactions | Number of transactions for the symbol in the time period. (provider: polygon, tiingo) |
| volume_notional | 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) |

10
website/content/excel/reference/crypto/search.md vendored
View File

@@ -28,7 +28,9 @@ Cryptocurrency Search. Search available cryptocurrency pairs.
## Syntax
```jsx<span style={color: 'red'}>=OBB.CRYPTO.SEARCH([provider];[query])</span>```
```excel wordwrap
=OBB.CRYPTO.SEARCH([query];[provider])
```
### Example
@@ -40,10 +42,10 @@ Cryptocurrency Search. Search available cryptocurrency pairs.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, defaults to fmp. | True |
| query | Text | Search query. | True |
| query | Text | Search query. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

28
website/content/excel/reference/currency/price/historical.md vendored
View File

@@ -31,7 +31,9 @@ Currency Historical Price. Currency historical data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.CURRENCY.PRICE.HISTORICAL(symbol;[provider];[start_date];[end_date];[interval];[multiplier];[timespan];[sort];[limit];[adjusted])</span>```
```excel wordwrap
=OBB.CURRENCY.PRICE.HISTORICAL(symbol;[start_date];[end_date];[provider];[interval];[multiplier];[timespan];[sort];[limit];[adjusted])
```
### Example
@@ -43,18 +45,18 @@ Currency Historical Price. Currency historical data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.** | **False** |
| provider | Text | Options: fmp, polygon, tiingo, defaults to fmp. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| interval | Text | Data granularity. (provider: fmp, tiingo) | True |
| multiplier | Number | Multiplier of the timespan. (provider: polygon) | True |
| timespan | Text | Timespan of the data. (provider: polygon) | True |
| sort | Text | Sort order of the data. (provider: polygon) | True |
| limit | Number | The number of data entries to return. (provider: polygon) | True |
| adjusted | Boolean | Whether the data is adjusted. (provider: polygon) | True |
| **symbol** | **Text** | **Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.** | **True** |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fmp, polygon, tiingo, defaults to fmp. | False |
| interval | Text | Data granularity. (provider: fmp, tiingo) | False |
| multiplier | Number | Multiplier of the timespan. (provider: polygon) | False |
| timespan | Text | Timespan of the data. (provider: polygon) | False |
| sort | Text | Sort order of the data. (provider: polygon) | False |
| limit | Number | The number of data entries to return. (provider: polygon) | False |
| adjusted | Boolean | Whether the data is adjusted. (provider: polygon) | False |
---
@@ -69,7 +71,7 @@ Currency Historical Price. Currency historical data.
| close | The close price. |
| volume | The trading volume. |
| vwap | Volume Weighted Average Price over the period. |
| adj_close | Adjusted Close Price of the symbol. (provider: fmp) |
| adj_close | The adjusted close price. (provider: fmp) |
| unadjusted_volume | Unadjusted volume of the symbol. (provider: fmp) |
| change | Change in the price of the symbol from the previous day. (provider: fmp) |
| change_percent | Change % in the price of the symbol. (provider: fmp) |

22
website/content/excel/reference/currency/search.md vendored
View File

@@ -48,7 +48,9 @@ Currency Search. Search available currency pairs.
## Syntax
```jsx<span style={color: 'red'}>=OBB.CURRENCY.SEARCH([provider];[symbol];[date];[search];[active];[order];[sort];[limit])</span>```
```excel wordwrap
=OBB.CURRENCY.SEARCH([provider];[symbol];[date];[search];[active];[order];[sort];[limit])
```
### Example
@@ -60,16 +62,16 @@ Currency Search. Search available currency pairs.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, intrinio, polygon, defaults to fmp. | True |
| symbol | Text | Symbol of the pair to search. (provider: polygon) | True |
| date | Text | A specific date to get data for. (provider: polygon) | True |
| search | Text | Search for terms within the ticker and/or company name. (provider: polygon) | True |
| active | Boolean | Specify if the tickers returned should be actively traded on the queried date. (provider: polygon) | True |
| order | Text | Order data by ascending or descending. (provider: polygon) | True |
| sort | Text | Sort field used for ordering. (provider: polygon) | True |
| limit | Number | The number of data entries to return. (provider: polygon) | True |
| provider | Text | Options: fmp, intrinio, polygon, defaults to fmp. | False |
| symbol | Text | Symbol of the pair to search. (provider: polygon) | False |
| date | Text | A specific date to get data for. (provider: polygon) | False |
| search | Text | Search for terms within the ticker and/or company name. (provider: polygon) | False |
| active | Boolean | Specify if the tickers returned should be actively traded on the queried date. (provider: polygon) | False |
| order | Text | Order data by ascending or descending. (provider: polygon) | False |
| sort | Text | Sort field used for ordering. (provider: polygon) | False |
| limit | Number | The number of data entries to return. (provider: polygon) | False |
---

23
website/content/excel/reference/derivatives/options/chains.md vendored
View File

@@ -42,7 +42,9 @@ Get the complete options chain for a ticker.
## Syntax
```jsx<span style={color: 'red'}>=OBB.DERIVATIVES.OPTIONS.CHAINS(symbol;[provider];[date])</span>```
```excel wordwrap
=OBB.DERIVATIVES.OPTIONS.CHAINS(symbol;[provider];[date])
```
### Example
@@ -54,11 +56,11 @@ Get the complete options chain for a ticker.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: intrinio, defaults to intrinio. | True |
| date | Text | Date for which the options chains are returned. (provider: intrinio) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: intrinio, defaults to intrinio. | False |
| date | Text | Date for which the options chains are returned. (provider: intrinio) | False |
---
@@ -92,14 +94,3 @@ Get the complete options chain for a ticker.
| gamma | Gamma of the option. |
| theta | Theta of the option. |
| vega | Vega of the option. |
| bid_size | Bid size for the option. (provider: cboe) |
| ask_size | Ask size for the option. (provider: cboe) |
| theoretical | Theoretical value of the option. (provider: cboe) |
| last_trade_price | Last trade price of the option. (provider: cboe) |
| tick | Whether the last tick was up or down in price. (provider: cboe) |
| prev_close | Previous closing price of the option. (provider: cboe) |
| change | Change in price of the option. (provider: cboe) |
| change_percent | Change, in percent, of the option. (provider: cboe) |
| rho | Rho of the option. (provider: cboe) |
| last_trade_timestamp | Last trade timestamp of the option. (provider: cboe) |
| dte | Days to expiration for the option. (provider: cboe) |

12
website/content/excel/reference/derivatives/options/unusual.md vendored
View File

@@ -33,7 +33,9 @@ Get the complete options chain for a ticker.
## Syntax
```jsx<span style={color: 'red'}>=OBB.DERIVATIVES.OPTIONS.UNUSUAL([provider];[symbol];[source])</span>```
```excel wordwrap
=OBB.DERIVATIVES.OPTIONS.UNUSUAL([symbol];[provider];[source])
```
### Example
@@ -45,11 +47,11 @@ Get the complete options chain for a ticker.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: intrinio, defaults to intrinio. | True |
| symbol | Text | Symbol to get data for. (the underlying symbol) | True |
| source | Text | The source of the data. Either realtime or delayed. (provider: intrinio) | True |
| symbol | Text | Symbol to get data for. (the underlying symbol) | False |
| provider | Text | Options: intrinio, defaults to intrinio. | False |
| source | Text | The source of the data. Either realtime or delayed. (provider: intrinio) | False |
---

4294
website/content/excel/reference/docs_map.json vendored
View File

File diff suppressed because it is too large Load Diff

19
website/content/excel/reference/economy/calendar.md vendored
View File

@@ -44,7 +44,9 @@ Economic Calendar.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ECONOMY.CALENDAR([provider];[start_date];[end_date];[country];[importance];[group])</span>```
```excel wordwrap
=OBB.ECONOMY.CALENDAR([start_date];[end_date];[provider];[country];[importance];[group])
```
### Example
@@ -56,14 +58,14 @@ Economic Calendar.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, tradingeconomics, defaults to fmp. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| country | Any | Country of the event (provider: tradingeconomics) | True |
| importance | Text | Importance of the event. (provider: tradingeconomics) | True |
| group | Text | Grouping of events (provider: tradingeconomics) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fmp, tradingeconomics, defaults to fmp. | False |
| country | Any | Country of the event (provider: tradingeconomics) | False |
| importance | Text | Importance of the event. (provider: tradingeconomics) | False |
| group | Text | Grouping of events (provider: tradingeconomics) | False |
---
@@ -89,4 +91,3 @@ Economic Calendar.
| change_percent | Percentage change since previous. (provider: fmp) |
| updated_at | Last updated timestamp. (provider: fmp) |
| created_at | Created at timestamp. (provider: fmp) |
| description | Event description. (provider: nasdaq) |

22
website/content/excel/reference/economy/cpi.md vendored
View File

@@ -29,27 +29,29 @@ Consumer Price Index (CPI). Returns either the rescaled index value, or a rate
## Syntax
```jsx<span style={color: 'red'}>=OBB.ECONOMY.CPI(countries;[provider];[units];[frequency];[harmonized];[start_date];[end_date])</span>```
```excel wordwrap
=OBB.ECONOMY.CPI(countries;[units];[frequency];[harmonized];[start_date];[end_date];[provider])
```
### Example
```excel wordwrap
=OBB.ECONOMY.CPI("united_states,germany")
=OBB.ECONOMY.CPI("united_states")
```
---
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **countries** | **Any** | **The country or countries to get data.** | **False** |
| provider | Text | Options: fred, defaults to fred. | True |
| units | Text | 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. | True |
| frequency | Text | The frequency of the data. Options: `monthly`, `quarter`, and `annual`. | True |
| harmonized | Boolean | Whether you wish to obtain harmonized data. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| **countries** | **Any** | **The country or countries to get data.** | **True** |
| units | Text | 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. | False |
| frequency | Text | The frequency of the data. Options: `monthly`, `quarter`, and `annual`. | False |
| harmonized | Boolean | Whether you wish to obtain harmonized data. | False |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fred, defaults to fred. | False |
---

57
website/content/excel/reference/economy/fred_search.md vendored Normal file
View File

@@ -0,0 +1,57 @@
<!-- markdownlint-disable MD041 -->
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()`.
## Syntax
```excel wordwrap
=OBB.ECONOMY.FRED_SEARCH([query];[provider];[is_release];[release_id];[limit];[offset];[filter_variable];[filter_value];[tag_names];[exclude_tag_names])
```
### Example
```excel wordwrap
=OBB.ECONOMY.FRED_SEARCH()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| query | Text | The search word(s). | False |
| provider | Text | Options: fred, defaults to fred. | False |
| is_release | Boolean | 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) | False |
| release_id | Any | A specific release ID to target. (provider: fred) | False |
| limit | Number | The number of data entries to return. (1-1000) (provider: fred) | False |
| offset | Number | Offset the results in conjunction with limit. (provider: fred) | False |
| filter_variable | Any | Filter by an attribute. (provider: fred) | False |
| filter_value | Text | String value to filter the variable by. Used in conjunction with filter_variable. (provider: fred) | False |
| tag_names | Text | A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' (provider: fred) | False |
| exclude_tag_names | Text | 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) | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| release_id | The release ID for queries. |
| series_id | The series ID for the item in the release. |
| name | The name of the release. |
| title | The title of the series. |
| observation_start | The date of the first observation in the series. |
| observation_end | The date of the last observation in the series. |
| frequency | The frequency of the data. |
| frequency_short | Short form of the data frequency. |
| units | The units of the data. |
| units_short | Short form of the data units. |
| seasonal_adjustment | The seasonal adjustment of the data. |
| seasonal_adjustment_short | Short form of the data seasonal adjustment. |
| last_updated | The datetime of the last update to the data. |
| notes | Description of the release. |
| press_release | If the release is a press release. |
| url | URL to the release. |
| popularity | Popularity of the series (provider: fred) |
| group_popularity | Group popularity of the release (provider: fred) |

41
website/content/excel/reference/economy/fred_series.md vendored Normal file
View File

@@ -0,0 +1,41 @@
<!-- markdownlint-disable MD041 -->
Get data by series ID from FRED.
## Syntax
```excel wordwrap
=OBB.ECONOMY.FRED_SERIES(symbol;[start_date];[end_date];[limit];[provider];[frequency];[aggregation_method];[transform];[all_pages];[sleep])
```
### Example
```excel wordwrap
=OBB.ECONOMY.FRED_SERIES("GFDGDPA188S")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: fred, intrinio, defaults to fred. | False |
| frequency | Any | 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) | False |
| aggregation_method | Any | 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) | False |
| transform | Any | 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) | False |
| all_pages | Boolean | Returns all pages of data from the API call at once. (provider: intrinio) | False |
| sleep | Number | Time to sleep between requests to avoid rate limiting. (provider: intrinio) | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| value | Value of the index. (provider: intrinio) |

18
website/content/excel/reference/economy/gdp/forecast.md vendored
View File

@@ -13,7 +13,9 @@ Forecasted GDP Data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ECONOMY.GDP.FORECAST([provider];[period];[start_date];[end_date];[type];[country])</span>```
```excel wordwrap
=OBB.ECONOMY.GDP.FORECAST([period];[start_date];[end_date];[type];[provider];[country])
```
### Example
@@ -25,14 +27,14 @@ Forecasted GDP Data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: oecd, defaults to oecd. | True |
| period | Text | Time period of the data to return. Units for nominal GDP period. Either quarter or annual. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| type | Text | Type of GDP to get forecast of. Either nominal or real. | True |
| country | Text | Country to get GDP for. (provider: oecd) | True |
| period | Text | Time period of the data to return. Units for nominal GDP period. Either quarter or annual. | False |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| type | Text | Type of GDP to get forecast of. Either nominal or real. | False |
| provider | Text | Options: oecd, defaults to oecd. | False |
| country | Text | Country to get GDP for. (provider: oecd) | False |
---

16
website/content/excel/reference/economy/gdp/nominal.md vendored
View File

@@ -13,7 +13,9 @@ Nominal GDP Data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ECONOMY.GDP.NOMINAL([provider];[units];[start_date];[end_date];[country])</span>```
```excel wordwrap
=OBB.ECONOMY.GDP.NOMINAL([units];[start_date];[end_date];[provider];[country])
```
### Example
@@ -25,13 +27,13 @@ Nominal GDP Data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: oecd, defaults to oecd. | True |
| units | Text | The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| country | Text | Country to get GDP for. (provider: oecd) | True |
| units | Text | The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita. | False |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: oecd, defaults to oecd. | False |
| country | Text | Country to get GDP for. (provider: oecd) | False |
---

16
website/content/excel/reference/economy/gdp/real.md vendored
View File

@@ -29,7 +29,9 @@ Real GDP Data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ECONOMY.GDP.REAL([provider];[units];[start_date];[end_date];[country])</span>```
```excel wordwrap
=OBB.ECONOMY.GDP.REAL([units];[start_date];[end_date];[provider];[country])
```
### Example
@@ -41,13 +43,13 @@ Real GDP Data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: oecd, defaults to oecd. | True |
| units | Text | The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| country | Text | Country to get GDP for. (provider: oecd) | True |
| units | Text | The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).) | False |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: oecd, defaults to oecd. | False |
| country | Text | Country to get GDP for. (provider: oecd) | False |
---

15
website/content/excel/reference/economy/index.mdx vendored
View File

@@ -18,11 +18,26 @@ import ReferenceCard from '@site/src/components/General/NewReferenceCard';
description="Economic Calendar."
url="economy/calendar"
command
/><ReferenceCard
title="fred_series"
description="Get data by series ID from FRED."
url="economy/fred_series"
command
/><ReferenceCard
title="risk_premium"
description="Historical Market Risk Premium."
url="economy/risk_premium"
command
/><ReferenceCard
title="money_measures"
description="Money Measures."
url="economy/money_measures"
command
/><ReferenceCard
title="fred_search"
description="Search for FRED series or economic releases by ID or string. This does not return the observation..."
url="economy/fred_search"
command
/><ReferenceCard
title="cpi"
description="Consumer Price Index (CPI). Returns either the rescaled index value, or a rate of change..."

41
website/content/excel/reference/economy/money_measures.md vendored Normal file
View File

@@ -0,0 +1,41 @@
<!-- markdownlint-disable MD041 -->
Money Measures.
## Syntax
```excel wordwrap
=OBB.ECONOMY.MONEY_MEASURES([start_date];[end_date];[adjusted];[provider])
```
### Example
```excel wordwrap
=OBB.ECONOMY.MONEY_MEASURES()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| adjusted | Boolean | Whether to return seasonally adjusted data. | False |
| provider | Text | Options: federal_reserve, defaults to federal_reserve. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| month | The date of the data. |
| M1 | Value of the M1 money supply in billions. |
| M2 | Value of the M2 money supply in billions. |
| currency | Value of currency in circulation in billions. |
| demand_deposits | Value of demand deposits in billions. |
| retail_money_market_funds | Value of retail money market funds in billions. |
| other_liquid_deposits | Value of other liquid deposits in billions. |
| small_denomination_time_deposits | Value of small denomination time deposits in billions. |

8
website/content/excel/reference/economy/risk_premium.md vendored
View File

@@ -29,7 +29,9 @@ Historical Market Risk Premium.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ECONOMY.RISK_PREMIUM([provider])</span>```
```excel wordwrap
=OBB.ECONOMY.RISK_PREMIUM([provider])
```
### Example
@@ -41,9 +43,9 @@ Historical Market Risk Premium.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, defaults to fmp. | True |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

16
website/content/excel/reference/equity/calendar/dividend.md vendored
View File

@@ -34,7 +34,9 @@ Upcoming and Historical Dividend Calendar.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.CALENDAR.DIVIDEND([provider];[start_date];[end_date])</span>```
```excel wordwrap
=OBB.EQUITY.CALENDAR.DIVIDEND([start_date];[end_date];[provider])
```
### Example
@@ -46,11 +48,11 @@ Upcoming and Historical Dividend Calendar.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, defaults to fmp. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
@@ -67,7 +69,3 @@ Upcoming and Historical Dividend Calendar.
| declaration_date | Declaration date of the dividend. |
| adjusted_amount | The adjusted-dividend amount. (provider: fmp) |
| label | Ex-dividend date formatted for display. (provider: fmp) |
| factor | factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices. (provider: intrinio) |
| dividend_currency | The currency of the dividend. (provider: intrinio) |
| split_ratio | The ratio of the stock split, if a stock split occurred. (provider: intrinio) |
| annualized_amount | The indicated annualized dividend amount. (provider: nasdaq) |

24
website/content/excel/reference/equity/calendar/earnings.md vendored
View File

@@ -34,7 +34,9 @@ Upcoming and Historical earnings calendar.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.CALENDAR.EARNINGS([provider];[start_date];[end_date])</span>```
```excel wordwrap
=OBB.EQUITY.CALENDAR.EARNINGS([start_date];[end_date];[provider])
```
### Example
@@ -46,11 +48,11 @@ Upcoming and Historical earnings calendar.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, defaults to fmp. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
@@ -63,13 +65,9 @@ Upcoming and Historical earnings calendar.
| name | Name of the entity. |
| eps_previous | The earnings-per-share from the same previously reported period. |
| eps_consensus | The analyst conesus earnings-per-share estimate. |
| actual_eps | The actual earnings per share announced. (provider: fmp, nasdaq) |
| actual_revenue | The actual reported revenue. (provider: fmp) |
| eps_actual | The actual earnings per share announced. (provider: fmp) |
| revenue_actual | The actual reported revenue. (provider: fmp) |
| revenue_consensus | The revenue forecast consensus. (provider: fmp) |
| period_ending | The fiscal period end date. (provider: fmp, nasdaq) |
| reporting_time | The reporting time - e.g. after market close. (provider: fmp, nasdaq) |
| period_ending | The fiscal period end date. (provider: fmp) |
| reporting_time | The reporting time - e.g. after market close. (provider: fmp) |
| updated_date | The date the data was updated last. (provider: fmp) |
| surprise_percent | The earnings surprise as normalized percentage points. (provider: nasdaq) |
| num_estimates | The number of analysts providing estimates for the consensus. (provider: nasdaq) |
| previous_report_date | The previous report date for the same period last year. (provider: nasdaq) |
| market_cap | The market cap (USD) of the reporting entity. (provider: nasdaq) |

5
website/content/excel/reference/equity/calendar/index.mdx vendored
View File

@@ -9,6 +9,11 @@ import ReferenceCard from '@site/src/components/General/NewReferenceCard';
description="Upcoming and Historical Dividend Calendar."
url="calendar/dividend"
command
/><ReferenceCard
title="splits"
description="Calendar Splits. Show Stock Split Calendar."
url="calendar/splits"
command
/><ReferenceCard
title="ipo"
description="Upcoming and Historical IPO Calendar."

31
website/content/excel/reference/equity/calendar/ipo.md vendored
View File

@@ -58,7 +58,9 @@ Upcoming and Historical IPO Calendar.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.CALENDAR.IPO([provider];[symbol];[start_date];[end_date];[limit];[status];[offer_amount_greater_than];[offer_amount_less_than])</span>```
```excel wordwrap
=OBB.EQUITY.CALENDAR.IPO([symbol];[start_date];[end_date];[limit];[provider];[status];[offer_amount_greater_than];[offer_amount_less_than])
```
### Example
@@ -70,16 +72,16 @@ Upcoming and Historical IPO Calendar.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: intrinio, defaults to intrinio. | True |
| symbol | Text | Symbol to get data for. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| limit | Number | The number of data entries to return. | True |
| status | Text | Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio) | True |
| offer_amount_greater_than | Number | Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio) | True |
| offer_amount_less_than | Number | Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio) | True |
| symbol | Text | Symbol to get data for. | False |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: intrinio, defaults to intrinio. | False |
| status | Text | Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio) | False |
| offer_amount_greater_than | Number | Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio) | False |
| offer_amount_less_than | Number | Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio) | False |
---
@@ -91,11 +93,11 @@ Upcoming and Historical IPO Calendar.
| ipo_date | The date of the IPO, when the stock first trades on a major exchange. |
| status | 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 | The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ. (provider: intrinio) |
| offer_amount | The total dollar amount of shares offered in the IPO. Typically this is share price * share count (provider: intrinio); The dollar value of the shares offered. (provider: nasdaq) |
| offer_amount | The total dollar amount of shares offered in the IPO. Typically this is share price * share count (provider: intrinio) |
| share_price | The price per share at which the IPO was offered. (provider: intrinio) |
| share_price_lowest | 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 | 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 | The number of shares offered in the IPO. (provider: intrinio, nasdaq) |
| share_count | The number of shares offered in the IPO. (provider: intrinio) |
| share_count_lowest | 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 | 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 | The URL to the company's announcement of the IPO (provider: intrinio) |
@@ -109,8 +111,3 @@ Upcoming and Historical IPO Calendar.
| id | The Intrinio ID of the IPO. (provider: intrinio) |
| company | The company that is going public via the IPO. (provider: intrinio) |
| security | The primary Security for the Company that is going public via the IPO (provider: intrinio) |
| name | The name of the company. (provider: nasdaq) |
| expected_price_date | The date the pricing is expected. (provider: nasdaq) |
| filed_date | The date the IPO was filed. (provider: nasdaq) |
| withdraw_date | The date the IPO was withdrawn. (provider: nasdaq) |
| deal_status | The status of the deal. (provider: nasdaq) |

37
website/content/excel/reference/equity/calendar/splits.md vendored Normal file
View File

@@ -0,0 +1,37 @@
<!-- markdownlint-disable MD041 -->
Calendar Splits. Show Stock Split Calendar.
## Syntax
```excel wordwrap
=OBB.EQUITY.CALENDAR.SPLITS([start_date];[end_date];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.CALENDAR.SPLITS()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| label | Label of the stock splits. |
| symbol | Symbol representing the entity requested in the data. |
| numerator | Numerator of the stock splits. |
| denominator | Denominator of the stock splits. |

10
website/content/excel/reference/equity/compare/peers.md vendored
View File

@@ -30,7 +30,9 @@ Equity Peers. Company peers.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.COMPARE.PEERS(symbol;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.COMPARE.PEERS(symbol;[provider])
```
### Example
@@ -42,10 +44,10 @@ Equity Peers. Company peers.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

18
website/content/excel/reference/equity/discovery/filings.md vendored
View File

@@ -13,7 +13,9 @@ Get the most-recent filings submitted to the SEC.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.DISCOVERY.FILINGS([provider];[start_date];[end_date];[form_type];[limit];[isDone])</span>```
```excel wordwrap
=OBB.EQUITY.DISCOVERY.FILINGS([start_date];[end_date];[form_type];[limit];[provider];[isDone])
```
### Example
@@ -25,14 +27,14 @@ Get the most-recent filings submitted to the SEC.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, defaults to fmp. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| form_type | Text | Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. | True |
| limit | Number | The number of data entries to return. | True |
| isDone | Boolean | Flag for whether or not the filing is done. (provider: fmp) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| form_type | Text | Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. | False |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
| isDone | Boolean | Flag for whether or not the filing is done. (provider: fmp) | False |
---

10
website/content/excel/reference/equity/estimates/consensus.md vendored
View File

@@ -26,7 +26,9 @@ Price Target Consensus. Price target consensus data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.ESTIMATES.CONSENSUS(symbol;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.ESTIMATES.CONSENSUS(symbol;[provider])
```
### Example
@@ -38,10 +40,10 @@ Price Target Consensus. Price target consensus data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

14
website/content/excel/reference/equity/estimates/historical.md vendored
View File

@@ -61,7 +61,9 @@ Historical Analyst Estimates. Analyst stock recommendations.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.ESTIMATES.HISTORICAL(symbol;[provider];[period];[limit])</span>```
```excel wordwrap
=OBB.EQUITY.ESTIMATES.HISTORICAL(symbol;[period];[limit];[provider])
```
### Example
@@ -73,12 +75,12 @@ Historical Analyst Estimates. Analyst stock recommendations.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| period | Text | Time period of the data to return. | True |
| limit | Number | The number of data entries to return. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| period | Text | Time period of the data to return. | False |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

12
website/content/excel/reference/equity/estimates/price_target.md vendored
View File

@@ -27,7 +27,9 @@ Price Target. Price target data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.ESTIMATES.PRICE_TARGET(symbol;[provider];[with_grade])</span>```
```excel wordwrap
=OBB.EQUITY.ESTIMATES.PRICE_TARGET(symbol;[provider];[with_grade])
```
### Example
@@ -39,11 +41,11 @@ Price Target. Price target data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| with_grade | Boolean | Include upgrades and downgrades in the response. (provider: fmp) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
| with_grade | Boolean | Include upgrades and downgrades in the response. (provider: fmp) | False |
---

225
website/content/excel/reference/equity/fundamental/balance.md vendored
View File

@@ -19,7 +19,9 @@ Balance Sheet. Balance sheet statement.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.BALANCE(symbol;[provider];[period];[limit];[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])</span>```
```excel wordwrap
=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])
```
### Example
@@ -31,26 +33,26 @@ Balance Sheet. Balance sheet statement.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, intrinio, polygon, defaults to fmp. | True |
| period | Text | Time period of the data to return. | True |
| limit | Number | The number of data entries to return. | True |
| fiscal_year | Number | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) | True |
| filing_date | Text | Filing date of the financial statement. (provider: polygon) | True |
| filing_date_lt | Text | Filing date less than the given date. (provider: polygon) | True |
| filing_date_lte | Text | Filing date less than or equal to the given date. (provider: polygon) | True |
| filing_date_gt | Text | Filing date greater than the given date. (provider: polygon) | True |
| filing_date_gte | Text | Filing date greater than or equal to the given date. (provider: polygon) | True |
| period_of_report_date | Text | Period of report date of the financial statement. (provider: polygon) | True |
| period_of_report_date_lt | Text | Period of report date less than the given date. (provider: polygon) | True |
| period_of_report_date_lte | Text | Period of report date less than or equal to the given date. (provider: polygon) | True |
| period_of_report_date_gt | Text | Period of report date greater than the given date. (provider: polygon) | True |
| period_of_report_date_gte | Text | Period of report date greater than or equal to the given date. (provider: polygon) | True |
| include_sources | Boolean | Whether to include the sources of the financial statement. (provider: polygon) | True |
| order | Text | Order of the financial statement. (provider: polygon) | True |
| sort | Text | Sort of the financial statement. (provider: polygon) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| period | Text | Time period of the data to return. | False |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: fmp, intrinio, polygon, defaults to fmp. | False |
| fiscal_year | Number | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) | False |
| filing_date | Text | Filing date of the financial statement. (provider: polygon) | False |
| filing_date_lt | Text | Filing date less than the given date. (provider: polygon) | False |
| filing_date_lte | Text | Filing date less than or equal to the given date. (provider: polygon) | False |
| filing_date_gt | Text | Filing date greater than the given date. (provider: polygon) | False |
| filing_date_gte | Text | Filing date greater than or equal to the given date. (provider: polygon) | False |
| period_of_report_date | Text | Period of report date of the financial statement. (provider: polygon) | False |
| period_of_report_date_lt | Text | Period of report date less than the given date. (provider: polygon) | False |
| period_of_report_date_lte | Text | Period of report date less than or equal to the given date. (provider: polygon) | False |
| period_of_report_date_gt | Text | Period of report date greater than the given date. (provider: polygon) | False |
| period_of_report_date_gte | Text | Period of report date greater than or equal to the given date. (provider: polygon) | False |
| include_sources | Boolean | Whether to include the sources of the financial statement. (provider: polygon) | False |
| order | Text | Order of the financial statement. (provider: polygon) | False |
| sort | Text | Sort of the financial statement. (provider: polygon) | False |
---
@@ -59,59 +61,130 @@ Balance Sheet. Balance sheet statement.
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| date | The date of the data. |
| cik | Central Index Key (CIK) for the requested entity. |
| currency | Reporting currency. |
| filling_date | Filling date. |
| accepted_date | Accepted date. |
| period | Reporting period of the statement. |
| cash_and_cash_equivalents | Cash and cash equivalents |
| short_term_investments | Short-term investments |
| long_term_investments | Long-term investments |
| inventory | Inventory |
| net_receivables | Receivables, net |
| marketable_securities | Marketable securities |
| property_plant_equipment_net | Property, plant and equipment, net |
| goodwill | Goodwill |
| assets | Total assets |
| current_assets | Total current assets |
| other_current_assets | Other current assets |
| intangible_assets | Intangible assets |
| tax_assets | Accrued income taxes |
| non_current_assets | Total non-current assets |
| other_non_current_assets | Other non-current assets |
| account_payables | Accounts payable |
| tax_payables | Accrued income taxes |
| deferred_revenue | Accrued income taxes, other deferred revenue |
| other_assets | Other assets |
| total_assets | Total assets |
| long_term_debt | Long-term debt, Operating lease obligations, Long-term finance lease obligations |
| short_term_debt | Short-term borrowings, Long-term debt due within one year, Operating lease obligations due within one year, Finance lease obligations due within one year |
| liabilities | Total liabilities |
| other_current_liabilities | Other current liabilities |
| current_liabilities | Total current liabilities |
| total_liabilities_and_total_equity | Total liabilities and total equity |
| other_non_current_liabilities | Other non-current liabilities |
| non_current_liabilities | Total non-current liabilities |
| total_liabilities_and_stockholders_equity | Total liabilities and stockholders' equity |
| other_stockholder_equity | Other stockholders equity |
| total_stockholders_equity | Total stockholders' equity |
| other_liabilities | Other liabilities |
| total_liabilities | Total liabilities |
| common_stock | Common stock |
| preferred_stock | Preferred stock |
| accumulated_other_comprehensive_income_loss | Accumulated other comprehensive income (loss) |
| retained_earnings | Retained earnings |
| minority_interest | Minority interest |
| total_equity | Total equity |
| calendar_year | Calendar Year (provider: fmp) |
| cash_and_short_term_investments | Cash and Short Term Investments (provider: fmp) |
| goodwill_and_intangible_assets | Goodwill and Intangible Assets (provider: fmp) |
| deferred_revenue_non_current | Deferred Revenue Non Current (provider: fmp) |
| total_investments | Total investments (provider: fmp) |
| capital_lease_obligations | Capital lease obligations (provider: fmp) |
| deferred_tax_liabilities_non_current | Deferred Tax Liabilities Non Current (provider: fmp) |
| total_debt | Total Debt (provider: fmp) |
| net_debt | Net Debt (provider: fmp) |
| link | Link to the statement. (provider: fmp) |
| final_link | Link to the final statement. (provider: fmp) |
| period_ending | The end date of the reporting period. |
| fiscal_period | The fiscal period of the report. |
| fiscal_year | The fiscal year of the fiscal period. |
| filing_date | The date when the filing was made. (provider: fmp) |
| accepted_date | The date and time when the filing was accepted. (provider: fmp) |
| reported_currency | The currency in which the balance sheet was reported. (provider: fmp, intrinio) |
| cash_and_cash_equivalents | Cash and cash equivalents. (provider: fmp, intrinio) |
| short_term_investments | Short term investments. (provider: fmp, intrinio) |
| cash_and_short_term_investments | Cash and short term investments. (provider: fmp) |
| net_receivables | Net receivables. (provider: fmp) |
| inventory | Inventory. (provider: fmp, polygon) |
| other_current_assets | Other current assets. (provider: fmp, intrinio, polygon) |
| total_current_assets | Total current assets. (provider: fmp, intrinio, polygon) |
| plant_property_equipment_net | Plant property equipment net. (provider: fmp, intrinio) |
| goodwill | Goodwill. (provider: fmp, intrinio) |
| intangible_assets | Intangible assets. (provider: fmp, intrinio, polygon) |
| goodwill_and_intangible_assets | Goodwill and intangible assets. (provider: fmp) |
| long_term_investments | Long term investments. (provider: fmp, intrinio) |
| tax_assets | Tax assets. (provider: fmp) |
| other_non_current_assets | Other non current assets. (provider: fmp, polygon) |
| non_current_assets | Total non current assets. (provider: fmp) |
| other_assets | Other assets. (provider: fmp, intrinio) |
| total_assets | Total assets. (provider: fmp, intrinio, polygon) |
| accounts_payable | Accounts payable. (provider: fmp, intrinio, polygon) |
| short_term_debt | Short term debt. (provider: fmp, intrinio) |
| tax_payables | Tax payables. (provider: fmp) |
| current_deferred_revenue | Current deferred revenue. (provider: fmp, intrinio) |
| other_current_liabilities | Other current liabilities. (provider: fmp, intrinio, polygon) |
| total_current_liabilities | Total current liabilities. (provider: fmp, intrinio, polygon) |
| long_term_debt | Long term debt. (provider: fmp, intrinio, polygon) |
| deferred_revenue_non_current | Non current deferred revenue. (provider: fmp) |
| deferred_tax_liabilities_non_current | Deferred tax liabilities non current. (provider: fmp) |
| other_non_current_liabilities | Other non current liabilities. (provider: fmp, polygon) |
| total_non_current_liabilities | Total non current liabilities. (provider: fmp, intrinio, polygon) |
| other_liabilities | Other liabilities. (provider: fmp) |
| capital_lease_obligations | Capital lease obligations. (provider: fmp, intrinio) |
| total_liabilities | Total liabilities. (provider: fmp, intrinio, polygon) |
| preferred_stock | Preferred stock. (provider: fmp, intrinio, polygon) |
| common_stock | Common stock. (provider: fmp, intrinio) |
| retained_earnings | Retained earnings. (provider: fmp, intrinio) |
| accumulated_other_comprehensive_income | Accumulated other comprehensive income (loss). (provider: fmp, intrinio) |
| other_shareholders_equity | Other shareholders equity. (provider: fmp) |
| other_total_shareholders_equity | Other total shareholders equity. (provider: fmp) |
| total_common_equity | Total common equity. (provider: fmp, intrinio) |
| total_equity_non_controlling_interests | Total equity non controlling interests. (provider: fmp, intrinio) |
| total_liabilities_and_shareholders_equity | Total liabilities and shareholders equity. (provider: fmp) |
| minority_interest | Minority interest. (provider: fmp, polygon) |
| total_liabilities_and_total_equity | Total liabilities and total equity. (provider: fmp) |
| total_investments | Total investments. (provider: fmp) |
| total_debt | Total debt. (provider: fmp) |
| net_debt | Net debt. (provider: fmp) |
| link | Link to the filing. (provider: fmp) |
| final_link | Link to the filing document. (provider: fmp) |
| cash_and_due_from_banks | Cash and due from banks. (provider: intrinio) |
| restricted_cash | Restricted cash. (provider: intrinio) |
| federal_funds_sold | Federal funds sold. (provider: intrinio) |
| accounts_receivable | Accounts receivable. (provider: intrinio, polygon) |
| note_and_lease_receivable | Note and lease receivable. (Vendor non-trade receivables) (provider: intrinio) |
| inventories | Net Inventories. (provider: intrinio) |
| customer_and_other_receivables | Customer and other receivables. (provider: intrinio) |
| interest_bearing_deposits_at_other_banks | Interest bearing deposits at other banks. (provider: intrinio) |
| time_deposits_placed_and_other_short_term_investments | Time deposits placed and other short term investments. (provider: intrinio) |
| trading_account_securities | Trading account securities. (provider: intrinio) |
| loans_and_leases | Loans and leases. (provider: intrinio) |
| allowance_for_loan_and_lease_losses | Allowance for loan and lease losses. (provider: intrinio) |
| current_deferred_refundable_income_taxes | Current deferred refundable income taxes. (provider: intrinio) |
| loans_and_leases_net_of_allowance | Loans and leases net of allowance. (provider: intrinio) |
| accrued_investment_income | Accrued investment income. (provider: intrinio) |
| other_current_non_operating_assets | Other current non-operating assets. (provider: intrinio) |
| loans_held_for_sale | Loans held for sale. (provider: intrinio) |
| prepaid_expenses | Prepaid expenses. (provider: intrinio, polygon) |
| plant_property_equipment_gross | Plant property equipment gross. (provider: intrinio) |
| accumulated_depreciation | Accumulated depreciation. (provider: intrinio) |
| premises_and_equipment_net | Net premises and equipment. (provider: intrinio) |
| mortgage_servicing_rights | Mortgage servicing rights. (provider: intrinio) |
| unearned_premiums_asset | Unearned premiums asset. (provider: intrinio) |
| non_current_note_lease_receivables | Non-current note lease receivables. (provider: intrinio) |
| deferred_acquisition_cost | Deferred acquisition cost. (provider: intrinio) |
| separate_account_business_assets | Separate account business assets. (provider: intrinio) |
| non_current_deferred_refundable_income_taxes | Noncurrent deferred refundable income taxes. (provider: intrinio) |
| employee_benefit_assets | Employee benefit assets. (provider: intrinio) |
| other_non_current_operating_assets | Other noncurrent operating assets. (provider: intrinio) |
| other_non_current_non_operating_assets | Other noncurrent non-operating assets. (provider: intrinio) |
| interest_bearing_deposits | Interest bearing deposits. (provider: intrinio) |
| total_non_current_assets | Total noncurrent assets. (provider: intrinio, polygon) |
| non_interest_bearing_deposits | Non interest bearing deposits. (provider: intrinio) |
| federal_funds_purchased_and_securities_sold | Federal funds purchased and securities sold. (provider: intrinio) |
| bankers_acceptance_outstanding | Bankers acceptance outstanding. (provider: intrinio) |
| current_deferred_payable_income_tax_liabilities | Current deferred payable income tax liabilities. (provider: intrinio) |
| accrued_interest_payable | Accrued interest payable. (provider: intrinio) |
| accrued_expenses | Accrued expenses. (provider: intrinio) |
| other_short_term_payables | Other short term payables. (provider: intrinio) |
| customer_deposits | Customer deposits. (provider: intrinio) |
| dividends_payable | Dividends payable. (provider: intrinio) |
| claims_and_claim_expense | Claims and claim expense. (provider: intrinio) |
| future_policy_benefits | Future policy benefits. (provider: intrinio) |
| current_employee_benefit_liabilities | Current employee benefit liabilities. (provider: intrinio) |
| unearned_premiums_liability | Unearned premiums liability. (provider: intrinio) |
| other_taxes_payable | Other taxes payable. (provider: intrinio) |
| policy_holder_funds | Policy holder funds. (provider: intrinio) |
| other_current_non_operating_liabilities | Other current non-operating liabilities. (provider: intrinio) |
| separate_account_business_liabilities | Separate account business liabilities. (provider: intrinio) |
| other_long_term_liabilities | Other long term liabilities. (provider: intrinio) |
| non_current_deferred_revenue | Non-current deferred revenue. (provider: intrinio) |
| non_current_deferred_payable_income_tax_liabilities | Non-current deferred payable income tax liabilities. (provider: intrinio) |
| non_current_employee_benefit_liabilities | Non-current employee benefit liabilities. (provider: intrinio) |
| other_non_current_operating_liabilities | Other non-current operating liabilities. (provider: intrinio) |
| other_non_current_non_operating_liabilities | Other non-current, non-operating liabilities. (provider: intrinio) |
| asset_retirement_reserve_litigation_obligation | Asset retirement reserve litigation obligation. (provider: intrinio) |
| commitments_contingencies | Commitments contingencies. (provider: intrinio) |
| redeemable_non_controlling_interest | Redeemable non-controlling interest. (provider: intrinio, polygon) |
| treasury_stock | Treasury stock. (provider: intrinio) |
| participating_policy_holder_equity | Participating policy holder equity. (provider: intrinio) |
| other_equity_adjustments | Other equity adjustments. (provider: intrinio) |
| total_preferred_common_equity | Total preferred common equity. (provider: intrinio) |
| non_controlling_interest | Non-controlling interest. (provider: intrinio) |
| total_liabilities_shareholders_equity | Total liabilities and shareholders equity. (provider: intrinio) |
| marketable_securities | Marketable securities (provider: polygon) |
| property_plant_equipment_net | Property plant and equipment net (provider: polygon) |
| employee_wages | Employee wages (provider: polygon) |
| temporary_equity_attributable_to_parent | Temporary equity attributable to parent (provider: polygon) |
| equity_attributable_to_parent | Equity attributable to parent (provider: polygon) |
| temporary_equity | Temporary equity (provider: polygon) |
| redeemable_non_controlling_interest_other | Redeemable non-controlling interest other (provider: polygon) |
| total_stock_holders_equity | Total stock holders equity (provider: polygon) |
| total_liabilities_and_stock_holders_equity | Total liabilities and stockholders equity (provider: polygon) |
| total_equity | Total equity (provider: polygon) |

12
website/content/excel/reference/equity/fundamental/balance_growth.md vendored
View File

@@ -55,7 +55,9 @@ Balance Sheet Statement Growth. Information about the growth of the company bala
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.BALANCE_GROWTH(symbol;[provider];[limit])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.BALANCE_GROWTH(symbol;[limit];[provider])
```
### Example
@@ -67,11 +69,11 @@ Balance Sheet Statement Growth. Information about the growth of the company bala
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| limit | Number | The number of data entries to return. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

158
website/content/excel/reference/equity/fundamental/cash.md vendored
View File

@@ -55,7 +55,9 @@ Cash Flow Statement. Information about the cash flow statement.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.CASH(symbol;[provider];[period];[limit];[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])</span>```
```excel wordwrap
=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])
```
### Example
@@ -67,26 +69,26 @@ Cash Flow Statement. Information about the cash flow statement.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, intrinio, polygon, defaults to fmp. | True |
| period | Text | Time period of the data to return. | True |
| limit | Number | The number of data entries to return. | True |
| fiscal_year | Number | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) | True |
| filing_date | Text | Filing date of the financial statement. (provider: polygon) | True |
| filing_date_lt | Text | Filing date less than the given date. (provider: polygon) | True |
| filing_date_lte | Text | Filing date less than or equal to the given date. (provider: polygon) | True |
| filing_date_gt | Text | Filing date greater than the given date. (provider: polygon) | True |
| filing_date_gte | Text | Filing date greater than or equal to the given date. (provider: polygon) | True |
| period_of_report_date | Text | Period of report date of the financial statement. (provider: polygon) | True |
| period_of_report_date_lt | Text | Period of report date less than the given date. (provider: polygon) | True |
| period_of_report_date_lte | Text | Period of report date less than or equal to the given date. (provider: polygon) | True |
| period_of_report_date_gt | Text | Period of report date greater than the given date. (provider: polygon) | True |
| period_of_report_date_gte | Text | Period of report date greater than or equal to the given date. (provider: polygon) | True |
| include_sources | Boolean | Whether to include the sources of the financial statement. (provider: polygon) | True |
| order | Any | Order of the financial statement. (provider: polygon) | True |
| sort | Any | Sort of the financial statement. (provider: polygon) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| period | Text | Time period of the data to return. | False |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: fmp, intrinio, polygon, defaults to fmp. | False |
| fiscal_year | Number | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) | False |
| filing_date | Text | Filing date of the financial statement. (provider: polygon) | False |
| filing_date_lt | Text | Filing date less than the given date. (provider: polygon) | False |
| filing_date_lte | Text | Filing date less than or equal to the given date. (provider: polygon) | False |
| filing_date_gt | Text | Filing date greater than the given date. (provider: polygon) | False |
| filing_date_gte | Text | Filing date greater than or equal to the given date. (provider: polygon) | False |
| period_of_report_date | Text | Period of report date of the financial statement. (provider: polygon) | False |
| period_of_report_date_lt | Text | Period of report date less than the given date. (provider: polygon) | False |
| period_of_report_date_lte | Text | Period of report date less than or equal to the given date. (provider: polygon) | False |
| period_of_report_date_gt | Text | Period of report date greater than the given date. (provider: polygon) | False |
| period_of_report_date_gte | Text | Period of report date greater than or equal to the given date. (provider: polygon) | False |
| include_sources | Boolean | Whether to include the sources of the financial statement. (provider: polygon) | False |
| order | Any | Order of the financial statement. (provider: polygon) | False |
| sort | Any | Sort of the financial statement. (provider: polygon) | False |
---
@@ -95,49 +97,83 @@ Cash Flow Statement. Information about the cash flow statement.
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| date | The date of the data. |
| period | Reporting period of the statement. |
| cik | Central Index Key (CIK) for the requested entity. |
| net_income | Net income. |
| depreciation_and_amortization | Depreciation and amortization. |
| stock_based_compensation | Stock based compensation. |
| deferred_income_tax | Deferred income tax. |
| other_non_cash_items | Other non-cash items. |
| changes_in_operating_assets_and_liabilities | Changes in operating assets and liabilities. |
| accounts_receivables | Accounts receivables. |
| inventory | Inventory. |
| vendor_non_trade_receivables | Vendor non-trade receivables. |
| other_current_and_non_current_assets | Other current and non-current assets. |
| accounts_payables | Accounts payables. |
| deferred_revenue | Deferred revenue. |
| other_current_and_non_current_liabilities | Other current and non-current liabilities. |
| net_cash_flow_from_operating_activities | Net cash flow from operating activities. |
| purchases_of_marketable_securities | Purchases of investments. |
| sales_from_maturities_of_investments | Sales and maturities of investments. |
| investments_in_property_plant_and_equipment | Investments in property, plant, and equipment. |
| payments_from_acquisitions | Acquisitions, net of cash acquired, and other |
| other_investing_activities | Other investing activities |
| net_cash_flow_from_investing_activities | Net cash used for investing activities. |
| taxes_paid_on_net_share_settlement | Taxes paid on net share settlement of equity awards. |
| dividends_paid | Payments for dividends and dividend equivalents |
| common_stock_repurchased | Payments related to repurchase of common stock |
| debt_proceeds | Proceeds from issuance of term debt |
| debt_repayment | Payments of long-term debt |
| other_financing_activities | Other financing activities, net |
| net_cash_flow_from_financing_activities | Net cash flow from financing activities. |
| net_change_in_cash | Net increase (decrease) in cash, cash equivalents, and restricted cash |
| reportedCurrency | Reported currency in the statement. (provider: fmp) |
| filling_date | Filling date. (provider: fmp) |
| accepted_date | Accepted date. (provider: fmp) |
| calendar_year | Calendar year. (provider: fmp) |
| period_ending | The end date of the reporting period. |
| fiscal_period | The fiscal period of the report. |
| fiscal_year | The fiscal year of the fiscal period. |
| filing_date | The date of the filing. (provider: fmp) |
| accepted_date | The date the filing was accepted. (provider: fmp) |
| reported_currency | 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 | Net income. (provider: fmp); Consolidated Net Income. (provider: intrinio) |
| depreciation_and_amortization | Depreciation and amortization. (provider: fmp) |
| deferred_income_tax | Deferred income tax. (provider: fmp) |
| stock_based_compensation | Stock-based compensation. (provider: fmp) |
| change_in_working_capital | Change in working capital. (provider: fmp) |
| other_working_capital | Other working capital. (provider: fmp) |
| common_stock_issued | Common stock issued. (provider: fmp) |
| effect_of_forex_changes_on_cash | Effect of forex changes on cash. (provider: fmp) |
| change_in_account_receivables | Change in account receivables. (provider: fmp) |
| change_in_inventory | Change in inventory. (provider: fmp) |
| change_in_account_payable | Change in account payable. (provider: fmp) |
| change_in_other_working_capital | Change in other working capital. (provider: fmp) |
| change_in_other_non_cash_items | Change in other non-cash items. (provider: fmp) |
| net_cash_from_operating_activities | Net cash from operating activities. (provider: fmp, intrinio) |
| purchase_of_property_plant_and_equipment | Purchase of property, plant and equipment. (provider: fmp, intrinio) |
| acquisitions | Acquisitions. (provider: fmp, intrinio) |
| purchase_of_investment_securities | Purchase of investment securities. (provider: fmp, intrinio) |
| sale_and_maturity_of_investments | Sale and maturity of investments. (provider: fmp, intrinio) |
| other_investing_activities | Other investing activities. (provider: fmp, intrinio) |
| net_cash_from_investing_activities | Net cash from investing activities. (provider: fmp, intrinio) |
| repayment_of_debt | Repayment of debt. (provider: fmp, intrinio) |
| issuance_of_common_equity | Issuance of common equity. (provider: fmp, intrinio) |
| repurchase_of_common_equity | Repurchase of common equity. (provider: fmp, intrinio) |
| payment_of_dividends | Payment of dividends. (provider: fmp, intrinio) |
| other_financing_activities | Other financing activities. (provider: fmp, intrinio) |
| net_cash_from_financing_activities | Net cash from financing activities. (provider: fmp, intrinio) |
| effect_of_exchange_rate_changes_on_cash | Effect of exchange rate changes on cash. (provider: fmp) |
| net_change_in_cash_and_equivalents | Net change in cash and equivalents. (provider: fmp, intrinio) |
| cash_at_beginning_of_period | Cash at beginning of period. (provider: fmp) |
| cash_at_end_of_period | Cash, cash equivalents, and restricted cash at end of period (provider: fmp) |
| cash_at_end_of_period | Cash at end of period. (provider: fmp) |
| operating_cash_flow | Operating cash flow. (provider: fmp) |
| capital_expenditure | Capital expenditure. (provider: fmp) |
| free_cash_flow | Free cash flow. (provider: fmp) |
| link | Link to the statement. (provider: fmp) |
| final_link | Link to the final statement. (provider: fmp) |
| link | Link to the filing. (provider: fmp) |
| final_link | Link to the filing document. (provider: fmp) |
| provision_for_loan_losses | Provision for Loan Losses (provider: intrinio) |
| provision_for_credit_losses | Provision for credit losses (provider: intrinio) |
| depreciation_expense | Depreciation Expense. (provider: intrinio) |
| amortization_expense | Amortization Expense. (provider: intrinio) |
| share_based_compensation | Share-based compensation. (provider: intrinio) |
| non_cash_adjustments_to_reconcile_net_income | Non-Cash Adjustments to Reconcile Net Income. (provider: intrinio) |
| changes_in_operating_assets_and_liabilities | Changes in Operating Assets and Liabilities (Net) (provider: intrinio) |
| net_cash_from_continuing_operating_activities | Net Cash from Continuing Operating Activities (provider: intrinio) |
| net_cash_from_discontinued_operating_activities | Net Cash from Discontinued Operating Activities (provider: intrinio) |
| net_income_continuing_operations | Net Income (Continuing Operations) (provider: intrinio) |
| net_income_discontinued_operations | Net Income (Discontinued Operations) (provider: intrinio) |
| divestitures | Divestitures (provider: intrinio) |
| sale_of_property_plant_and_equipment | Sale of Property, Plant, and Equipment (provider: intrinio) |
| purchase_of_investments | Purchase of Investments (provider: intrinio) |
| loans_held_for_sale | Loans Held for Sale (Net) (provider: intrinio) |
| net_cash_from_continuing_investing_activities | Net Cash from Continuing Investing Activities (provider: intrinio) |
| net_cash_from_discontinued_investing_activities | Net Cash from Discontinued Investing Activities (provider: intrinio) |
| repurchase_of_preferred_equity | Repurchase of Preferred Equity (provider: intrinio) |
| issuance_of_preferred_equity | Issuance of Preferred Equity (provider: intrinio) |
| issuance_of_debt | Issuance of Debt (provider: intrinio) |
| cash_interest_received | Cash Interest Received (provider: intrinio) |
| net_change_in_deposits | Net Change in Deposits (provider: intrinio) |
| net_increase_in_fed_funds_sold | Net Increase in Fed Funds Sold (provider: intrinio) |
| net_cash_from_continuing_financing_activities | Net Cash from Continuing Financing Activities (provider: intrinio) |
| net_cash_from_discontinued_financing_activities | Net Cash from Discontinued Financing Activities (provider: intrinio) |
| effect_of_exchange_rate_changes | Effect of Exchange Rate Changes (provider: intrinio) |
| other_net_changes_in_cash | Other Net Changes in Cash (provider: intrinio) |
| cash_income_taxes_paid | Cash Income Taxes Paid (provider: intrinio) |
| cash_interest_paid | Cash Interest Paid (provider: intrinio) |
| net_cash_flow_from_operating_activities_continuing | Net cash flow from operating activities continuing. (provider: polygon) |
| net_cash_flow_from_operating_activities_discontinued | Net cash flow from operating activities discontinued. (provider: polygon) |
| net_cash_flow_from_operating_activities | Net cash flow from operating activities. (provider: polygon) |
| net_cash_flow_from_investing_activities_continuing | Net cash flow from investing activities continuing. (provider: polygon) |
| net_cash_flow_from_investing_activities_discontinued | Net cash flow from investing activities discontinued. (provider: polygon) |
| net_cash_flow_from_investing_activities | Net cash flow from investing activities. (provider: polygon) |
| net_cash_flow_from_financing_activities_continuing | Net cash flow from financing activities continuing. (provider: polygon) |
| net_cash_flow_from_financing_activities_discontinued | Net cash flow from financing activities discontinued. (provider: polygon) |
| net_cash_flow_from_financing_activities | Net cash flow from financing activities. (provider: polygon) |
| net_cash_flow_continuing | Net cash flow continuing. (provider: polygon) |
| net_cash_flow_discontinued | Net cash flow discontinued. (provider: polygon) |
| exchange_gains_losses | Exchange gains losses. (provider: polygon) |
| net_cash_flow | Net cash flow. (provider: polygon) |

12
website/content/excel/reference/equity/fundamental/cash_growth.md vendored
View File

@@ -52,7 +52,9 @@ Cash Flow Statement Growth. Information about the growth of the company cash flo
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.CASH_GROWTH(symbol;[provider];[limit])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.CASH_GROWTH(symbol;[limit];[provider])
```
### Example
@@ -64,11 +66,11 @@ Cash Flow Statement Growth. Information about the growth of the company cash flo
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| limit | Number | The number of data entries to return. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

25
website/content/excel/reference/equity/fundamental/dividends.md vendored
View File

@@ -30,7 +30,9 @@ Historical Dividends. Historical dividends data for a given company.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.DIVIDENDS(symbol;[provider];[page_size])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.DIVIDENDS(symbol;[provider];[page_size])
```
### Example
@@ -42,11 +44,11 @@ Historical Dividends. Historical dividends data for a given company.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | True |
| page_size | Number | The number of data entries to return. (provider: intrinio) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | False |
| page_size | Number | The number of data entries to return. (provider: intrinio) | False |
---
@@ -55,9 +57,12 @@ Historical Dividends. Historical dividends data for a given company.
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| label | Label of the historical dividends. |
| adj_dividend | Adjusted dividend of the historical dividends. |
| dividend | Dividend of the historical dividends. |
| record_date | Record date of the historical dividends. |
| payment_date | Payment date of the historical dividends. |
| declaration_date | Declaration date of the historical dividends. |
| label | Label of the historical dividends. (provider: fmp) |
| adj_dividend | Adjusted dividend of the historical dividends. (provider: fmp) |
| record_date | Record date of the historical dividends. (provider: fmp) |
| payment_date | Payment date of the historical dividends. (provider: fmp) |
| declaration_date | Declaration date of the historical dividends. (provider: fmp) |
| factor | factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices. (provider: intrinio) |
| dividend_currency | The currency of the dividend. (provider: intrinio) |
| split_ratio | The ratio of the stock split, if a stock split occurred. (provider: intrinio) |

10
website/content/excel/reference/equity/fundamental/employee_count.md vendored
View File

@@ -29,7 +29,9 @@ Historical Employees. Historical number of employees.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT(symbol;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT(symbol;[provider])
```
### Example
@@ -41,10 +43,10 @@ Historical Employees. Historical number of employees.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

26
website/content/excel/reference/equity/fundamental/filings.md vendored
View File

@@ -40,7 +40,9 @@ Company Filings. Company filings data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.FILINGS([provider];[symbol];[form_type];[limit];[start_date];[end_date];[thea_enabled];[cik];[use_cache])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.FILINGS([symbol];[provider];[form_type];[limit];[start_date];[end_date];[thea_enabled];[cik];[use_cache])
```
### Example
@@ -52,17 +54,17 @@ Company Filings. Company filings data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, intrinio, sec, defaults to fmp. | True |
| symbol | Text | Symbol to get data for. | True |
| form_type | Text | Type of the SEC filing form. (provider: sec) | True |
| limit | Number | The number of data entries to return. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. (provider: intrinio) | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. (provider: intrinio) | True |
| thea_enabled | Boolean | Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio) | True |
| cik | Any | Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec) | True |
| use_cache | Boolean | Whether or not to use cache. If True, cache will store for one day. (provider: sec) | True |
| symbol | Text | Symbol to get data for. | False |
| provider | Text | Options: fmp, intrinio, sec, defaults to fmp. | False |
| form_type | Text | Type of the SEC filing form. (provider: sec) | False |
| limit | Number | The number of data entries to return. | False |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. (provider: intrinio) | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. (provider: intrinio) | False |
| thea_enabled | Boolean | Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio) | False |
| cik | Any | Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec) | False |
| use_cache | Boolean | Whether or not to use cache. If True, cache will store for one day. (provider: sec) | False |
---
@@ -95,4 +97,4 @@ Company Filings. Company filings data.
| is_xbrl | Whether the filing is an XBRL filing. (provider: sec) |
| size | The size of the filing. (provider: sec) |
| complete_submission_url | The URL to the complete filing submission. (provider: sec) |
| xml | The URL to the primary XML document. (provider: sec) |
| filing_detail_url | The URL to the filing details. (provider: sec) |

26
website/content/excel/reference/equity/fundamental/historical_attributes.md vendored
View File

@@ -4,29 +4,31 @@ Fetch the historical values of a data tag from Intrinio.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES(symbol;tag;[provider];[start_date];[end_date];[frequency];[limit];[type];[sort])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES(symbol;tag;[start_date];[end_date];[frequency];[limit];[type];[sort];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES("AAPL";"EBITDA")
=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES("AAPL";"ebitda")
```
---
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| **tag** | **Text** | **Intrinio data tag ID or code.** | **False** |
| provider | Text | Options: intrinio, defaults to intrinio. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| frequency | Text | The frequency of the data. | True |
| limit | Number | The number of data entries to return. | True |
| type | Text | Filter by type, when applicable. | True |
| sort | Text | Sort order. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| **tag** | **Text** | **Intrinio data tag ID or code.** | **True** |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| frequency | Text | The frequency of the data. | False |
| limit | Number | The number of data entries to return. | False |
| type | Text | Filter by type, when applicable. | False |
| sort | Text | Sort order. | False |
| provider | Text | Options: intrinio, defaults to intrinio. | False |
---

15
website/content/excel/reference/equity/fundamental/historical_eps.md vendored
View File

@@ -13,7 +13,9 @@ Historical earnings-per-share for a given company.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_EPS(symbol;[provider];[limit])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_EPS(symbol;[provider];[limit])
```
### Example
@@ -25,11 +27,11 @@ Historical earnings-per-share for a given company.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| limit | Number | The number of data entries to return. (provider: fmp) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
| limit | Number | The number of data entries to return. (provider: fmp) | False |
---
@@ -42,9 +44,8 @@ Historical earnings-per-share for a given company.
| announce_time | Timing of the earnings announcement. |
| eps_actual | Actual EPS from the earnings date. |
| eps_estimated | Estimated EPS for the earnings date. |
| actual_eps | The actual earnings per share announced. (provider: fmp) |
| revenue_estimated | Estimated consensus revenue for the reporting period. (provider: fmp) |
| actual_revenue | The actual reported revenue. (provider: fmp) |
| revenue_actual | The actual reported revenue. (provider: fmp) |
| reporting_time | The reporting time - e.g. after market close. (provider: fmp) |
| updated_at | The date when the data was last updated. (provider: fmp) |
| period_ending | The fiscal period end date. (provider: fmp) |

10
website/content/excel/reference/equity/fundamental/historical_splits.md vendored
View File

@@ -28,7 +28,9 @@ Historical Splits. Historical splits data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS(symbol;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS(symbol;[provider])
```
### Example
@@ -40,10 +42,10 @@ Historical Splits. Historical splits data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

209
website/content/excel/reference/equity/fundamental/income.md vendored
View File

@@ -49,7 +49,9 @@ Income Statement. Report on a company's financial performance.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.INCOME(symbol;[provider];[period];[limit];[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])</span>```
```excel wordwrap
=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])
```
### Example
@@ -61,26 +63,26 @@ Income Statement. Report on a company's financial performance.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, intrinio, polygon, defaults to fmp. | True |
| period | Text | Time period of the data to return. | True |
| limit | Number | The number of data entries to return. | True |
| fiscal_year | Number | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) | True |
| filing_date | Text | Filing date of the financial statement. (provider: polygon) | True |
| filing_date_lt | Text | Filing date less than the given date. (provider: polygon) | True |
| filing_date_lte | Text | Filing date less than or equal to the given date. (provider: polygon) | True |
| filing_date_gt | Text | Filing date greater than the given date. (provider: polygon) | True |
| filing_date_gte | Text | Filing date greater than or equal to the given date. (provider: polygon) | True |
| period_of_report_date | Text | Period of report date of the financial statement. (provider: polygon) | True |
| period_of_report_date_lt | Text | Period of report date less than the given date. (provider: polygon) | True |
| period_of_report_date_lte | Text | Period of report date less than or equal to the given date. (provider: polygon) | True |
| period_of_report_date_gt | Text | Period of report date greater than the given date. (provider: polygon) | True |
| period_of_report_date_gte | Text | Period of report date greater than or equal to the given date. (provider: polygon) | True |
| include_sources | Boolean | Whether to include the sources of the financial statement. (provider: polygon) | True |
| order | Text | Order of the financial statement. (provider: polygon) | True |
| sort | Text | Sort of the financial statement. (provider: polygon) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| period | Text | Time period of the data to return. | False |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: fmp, intrinio, polygon, defaults to fmp. | False |
| fiscal_year | Number | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) | False |
| filing_date | Text | Filing date of the financial statement. (provider: polygon) | False |
| filing_date_lt | Text | Filing date less than the given date. (provider: polygon) | False |
| filing_date_lte | Text | Filing date less than or equal to the given date. (provider: polygon) | False |
| filing_date_gt | Text | Filing date greater than the given date. (provider: polygon) | False |
| filing_date_gte | Text | Filing date greater than or equal to the given date. (provider: polygon) | False |
| period_of_report_date | Text | Period of report date of the financial statement. (provider: polygon) | False |
| period_of_report_date_lt | Text | Period of report date less than the given date. (provider: polygon) | False |
| period_of_report_date_lte | Text | Period of report date less than or equal to the given date. (provider: polygon) | False |
| period_of_report_date_gt | Text | Period of report date greater than the given date. (provider: polygon) | False |
| period_of_report_date_gte | Text | Period of report date greater than or equal to the given date. (provider: polygon) | False |
| include_sources | Boolean | Whether to include the sources of the financial statement. (provider: polygon) | False |
| order | Text | Order of the financial statement. (provider: polygon) | False |
| sort | Text | Sort of the financial statement. (provider: polygon) | False |
---
@@ -88,51 +90,126 @@ Income Statement. Report on a company's financial performance.
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| date | The date of the data. In this case, the date of the income statement. |
| period | Period of the income statement. |
| cik | Central Index Key (CIK) for the requested entity. |
| revenue | Revenue. |
| cost_of_revenue | Cost of revenue. |
| gross_profit | Gross profit. |
| cost_and_expenses | Cost and expenses. |
| gross_profit_ratio | Gross profit ratio. |
| research_and_development_expenses | Research and development expenses. |
| general_and_administrative_expenses | General and administrative expenses. |
| selling_and_marketing_expenses | Selling and marketing expenses. |
| selling_general_and_administrative_expenses | Selling, general and administrative expenses. |
| other_expenses | Other expenses. |
| operating_expenses | Operating expenses. |
| depreciation_and_amortization | Depreciation and amortization. |
| ebit | Earnings before interest, and taxes. |
| ebitda | Earnings before interest, taxes, depreciation and amortization. |
| ebitda_ratio | Earnings before interest, taxes, depreciation and amortization ratio. |
| operating_income | Operating income. |
| operating_income_ratio | Operating income ratio. |
| interest_income | Interest income. |
| interest_expense | Interest expense. |
| total_other_income_expenses_net | Total other income expenses net. |
| income_before_tax | Income before tax. |
| income_before_tax_ratio | Income before tax ratio. |
| income_tax_expense | Income tax expense. |
| net_income | Net income. |
| net_income_ratio | Net income ratio. |
| eps | Earnings per share. |
| eps_diluted | Earnings per share diluted. |
| weighted_average_shares_outstanding | Weighted average shares outstanding. |
| weighted_average_shares_outstanding_dil | Weighted average shares outstanding diluted. |
| link | Link to the income statement. |
| final_link | Final link to the income statement. |
| reportedCurrency | Reporting currency. (provider: fmp) |
| fillingDate | Filling date. (provider: fmp) |
| accepted_date | Accepted date. (provider: fmp) |
| calendar_year | Calendar year. (provider: fmp) |
| income_loss_from_continuing_operations_before_tax | Income/Loss From Continuing Operations After Tax (provider: polygon) |
| income_loss_from_continuing_operations_after_tax | Income (loss) from continuing operations after tax (provider: polygon) |
| period_ending | The end date of the reporting period. |
| fiscal_period | The fiscal period of the report. |
| fiscal_year | The fiscal year of the fiscal period. |
| symbol | Symbol representing the entity requested in the data. (provider: fmp); Symbol of the company. (provider: intrinio) |
| filing_date | The date when the filing was made. (provider: fmp) |
| accepted_date | The date and time when the filing was accepted. (provider: fmp) |
| reported_currency | The currency in which the balance sheet was reported. (provider: fmp, intrinio) |
| revenue | Total revenue. (provider: fmp, intrinio, polygon) |
| cost_of_revenue | Cost of revenue. (provider: fmp, intrinio, polygon) |
| gross_profit | Gross profit. (provider: fmp, intrinio, polygon) |
| gross_profit_margin | Gross profit margin. (provider: fmp); Gross margin ratio. (provider: intrinio) |
| general_and_admin_expense | General and administrative expenses. (provider: fmp) |
| research_and_development_expense | Research and development expenses. (provider: fmp, intrinio) |
| selling_and_marketing_expense | Selling and marketing expenses. (provider: fmp) |
| selling_general_and_admin_expense | Selling, general and administrative expenses. (provider: fmp, intrinio) |
| other_expenses | Other expenses. (provider: fmp) |
| total_operating_expenses | Total operating expenses. (provider: fmp, intrinio) |
| cost_and_expenses | Cost and expenses. (provider: fmp) |
| interest_income | Interest income. (provider: fmp) |
| total_interest_expense | Total interest expenses. (provider: fmp, intrinio); Interest Expense (provider: polygon) |
| depreciation_and_amortization | Depreciation and amortization. (provider: fmp, polygon) |
| ebitda | EBITDA. (provider: fmp); Earnings Before Interest, Taxes, Depreciation and Amortization. (provider: intrinio) |
| ebitda_margin | EBITDA margin. (provider: fmp); Margin on Earnings Before Interest, Taxes, Depreciation and Amortization. (provider: intrinio) |
| total_operating_income | Total operating income. (provider: fmp, intrinio) |
| operating_income_margin | Operating income margin. (provider: fmp) |
| total_other_income_expenses | Total other income and expenses. (provider: fmp) |
| total_pre_tax_income | Total pre-tax income. (provider: fmp, intrinio); Income Before Tax (provider: polygon) |
| pre_tax_income_margin | Pre-tax income margin. (provider: fmp, intrinio) |
| income_tax_expense | Income tax expense. (provider: fmp, intrinio, polygon) |
| consolidated_net_income | Consolidated net income. (provider: fmp, intrinio); Net Income/Loss (provider: polygon) |
| net_income_margin | Net income margin. (provider: fmp) |
| basic_earnings_per_share | Basic earnings per share. (provider: fmp, intrinio); Earnings Per Share (provider: polygon) |
| diluted_earnings_per_share | Diluted earnings per share. (provider: fmp, intrinio, polygon) |
| weighted_average_basic_shares_outstanding | Weighted average basic shares outstanding. (provider: fmp, intrinio); Basic Average Shares (provider: polygon) |
| weighted_average_diluted_shares_outstanding | Weighted average diluted shares outstanding. (provider: fmp, intrinio); Diluted Average Shares (provider: polygon) |
| link | Link to the filing. (provider: fmp) |
| final_link | Link to the filing document. (provider: fmp) |
| operating_revenue | Total operating revenue (provider: intrinio) |
| operating_cost_of_revenue | Total operating cost of revenue (provider: intrinio) |
| provision_for_credit_losses | Provision for credit losses (provider: intrinio) |
| salaries_and_employee_benefits | Salaries and employee benefits (provider: intrinio) |
| marketing_expense | Marketing expense (provider: intrinio) |
| net_occupancy_and_equipment_expense | Net occupancy and equipment expense (provider: intrinio) |
| other_operating_expenses | Other operating expenses (provider: intrinio, polygon) |
| depreciation_expense | Depreciation expense (provider: intrinio) |
| amortization_expense | Amortization expense (provider: intrinio) |
| amortization_of_deferred_policy_acquisition_costs | Amortization of deferred policy acquisition costs (provider: intrinio) |
| exploration_expense | Exploration expense (provider: intrinio) |
| depletion_expense | Depletion expense (provider: intrinio) |
| deposits_and_money_market_investments_interest_income | Deposits and money market investments interest income (provider: intrinio) |
| federal_funds_sold_and_securities_borrowed_interest_income | Federal funds sold and securities borrowed interest income (provider: intrinio) |
| investment_securities_interest_income | Investment securities interest income (provider: intrinio) |
| loans_and_leases_interest_income | Loans and leases interest income (provider: intrinio) |
| trading_account_interest_income | Trading account interest income (provider: intrinio) |
| other_interest_income | Other interest income (provider: intrinio) |
| total_non_interest_income | Total non-interest income (provider: intrinio) |
| interest_and_investment_income | Interest and investment income (provider: intrinio) |
| short_term_borrowings_interest_expense | Short-term borrowings interest expense (provider: intrinio) |
| long_term_debt_interest_expense | Long-term debt interest expense (provider: intrinio) |
| capitalized_lease_obligations_interest_expense | Capitalized lease obligations interest expense (provider: intrinio) |
| deposits_interest_expense | Deposits interest expense (provider: intrinio) |
| federal_funds_purchased_and_securities_sold_interest_expense | Federal funds purchased and securities sold interest expense (provider: intrinio) |
| other_interest_expense | Other interest expense (provider: intrinio) |
| net_interest_income | Net interest income (provider: intrinio); Interest Income Net (provider: polygon) |
| other_non_interest_income | Other non-interest income (provider: intrinio) |
| investment_banking_income | Investment banking income (provider: intrinio) |
| trust_fees_by_commissions | Trust fees by commissions (provider: intrinio) |
| premiums_earned | Premiums earned (provider: intrinio) |
| insurance_policy_acquisition_costs | Insurance policy acquisition costs (provider: intrinio) |
| current_and_future_benefits | Current and future benefits (provider: intrinio) |
| property_and_liability_insurance_claims | Property and liability insurance claims (provider: intrinio) |
| total_non_interest_expense | Total non-interest expense (provider: intrinio) |
| net_realized_and_unrealized_capital_gains_on_investments | Net realized and unrealized capital gains on investments (provider: intrinio) |
| other_gains | Other gains (provider: intrinio) |
| non_operating_income | Non-operating income (provider: intrinio); Non Operating Income/Loss (provider: polygon) |
| other_income | Other income (provider: intrinio) |
| other_revenue | Other revenue (provider: intrinio) |
| extraordinary_income | Extraordinary income (provider: intrinio) |
| total_other_income | Total other income (provider: intrinio) |
| ebit | Earnings Before Interest and Taxes. (provider: intrinio) |
| impairment_charge | Impairment charge (provider: intrinio) |
| restructuring_charge | Restructuring charge (provider: intrinio) |
| service_charges_on_deposit_accounts | Service charges on deposit accounts (provider: intrinio) |
| other_service_charges | Other service charges (provider: intrinio) |
| other_special_charges | Other special charges (provider: intrinio) |
| other_cost_of_revenue | Other cost of revenue (provider: intrinio) |
| net_income_continuing_operations | Net income (continuing operations) (provider: intrinio) |
| net_income_discontinued_operations | Net income (discontinued operations) (provider: intrinio) |
| other_adjustments_to_consolidated_net_income | Other adjustments to consolidated net income (provider: intrinio) |
| other_adjustment_to_net_income_attributable_to_common_shareholders | Other adjustment to net income attributable to common shareholders (provider: intrinio) |
| net_income_attributable_to_noncontrolling_interest | Net income attributable to noncontrolling interest (provider: intrinio) |
| net_income_attributable_to_common_shareholders | Net income attributable to common shareholders (provider: intrinio); Net Income/Loss Available To Common Stockholders Basic (provider: polygon) |
| basic_and_diluted_earnings_per_share | Basic and diluted earnings per share (provider: intrinio) |
| cash_dividends_to_common_per_share | Cash dividends to common per share (provider: intrinio) |
| preferred_stock_dividends_declared | Preferred stock dividends declared (provider: intrinio) |
| weighted_average_basic_and_diluted_shares_outstanding | Weighted average basic and diluted shares outstanding (provider: intrinio) |
| cost_of_revenue_goods | Cost of Revenue - Goods (provider: polygon) |
| cost_of_revenue_services | Cost of Revenue - Services (provider: polygon) |
| provisions_for_loan_lease_and_other_losses | Provisions for loan lease and other losses (provider: polygon) |
| income_tax_expense_benefit_current | Income tax expense benefit current (provider: polygon) |
| deferred_tax_benefit | Deferred tax benefit (provider: polygon) |
| benefits_costs_expenses | Benefits, costs and expenses (provider: polygon) |
| net_income_loss_attributable_to_noncontrolling_interest | Net income (loss) attributable to noncontrolling interest (provider: polygon) |
| net_income_loss_attributable_to_parent | Net income (loss) attributable to parent (provider: polygon) |
| net_income_loss_available_to_common_stockholders_basic | Net Income/Loss Available To Common Stockholders Basic (provider: polygon) |
| participating_securities_distributed_and_undistributed_earnings_loss_basic | Participating Securities Distributed And Undistributed Earnings Loss Basic (provider: polygon) |
| nonoperating_income_loss | Nonoperating Income Loss (provider: polygon) |
| selling_general_and_administrative_expense | Selling, general and administrative expense (provider: polygon) |
| research_and_development | Research and development (provider: polygon) |
| costs_and_expenses | Costs and expenses (provider: polygon) |
| operating_expenses | Operating expenses (provider: polygon) |
| operating_income | Operating Income/Loss (provider: polygon) |
| interest_and_dividend_income | Interest and Dividend Income (provider: polygon) |
| interest_and_debt_expense | Interest and Debt Expense (provider: polygon) |
| interest_income_after_provision_for_losses | Interest Income After Provision for Losses (provider: polygon) |
| non_interest_expense | Non-Interest Expense (provider: polygon) |
| non_interest_income | Non-Interest Income (provider: polygon) |
| income_from_discontinued_operations_net_of_tax_on_disposal | Income From Discontinued Operations Net of Tax on Disposal (provider: polygon) |
| income_from_discontinued_operations_net_of_tax | Income From Discontinued Operations Net of Tax (provider: polygon) |
| income_before_equity_method_investments | Income Before Equity Method Investments (provider: polygon) |
| income_from_equity_method_investments | Income From Equity Method Investments (provider: polygon) |
| income_after_tax | Income After Tax (provider: polygon) |
| net_income_attributable_noncontrolling_interest | Net income (loss) attributable to noncontrolling interest (provider: polygon) |
| net_income_attributable_to_parent | Net income (loss) attributable to parent (provider: polygon) |
| participating_securities_earnings | Participating Securities Distributed And Undistributed Earnings Loss Basic (provider: polygon) |
| undistributed_earnings_allocated_to_participating_securities | Undistributed Earnings Allocated To Participating Securities (provider: polygon) |
| common_stock_dividends | Common Stock Dividends (provider: polygon) |
| preferred_stock_dividends_and_other_adjustments | Preferred stock dividends and other adjustments (provider: polygon) |

14
website/content/excel/reference/equity/fundamental/income_growth.md vendored
View File

@@ -50,7 +50,9 @@ Income Statement Growth. Information about the growth of the company income stat
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.INCOME_GROWTH(symbol;[provider];[limit];[period])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.INCOME_GROWTH(symbol;[limit];[period];[provider])
```
### Example
@@ -62,12 +64,12 @@ Income Statement Growth. Information about the growth of the company income stat
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| limit | Number | The number of data entries to return. | True |
| period | Text | Time period of the data to return. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| limit | Number | The number of data entries to return. | False |
| period | Text | Time period of the data to return. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

5
website/content/excel/reference/equity/fundamental/index.mdx vendored
View File

@@ -34,6 +34,11 @@ import ReferenceCard from '@site/src/components/General/NewReferenceCard';
description="Historical Dividends. Historical dividends data for a given company."
url="fundamental/dividends"
command
/><ReferenceCard
title="reported_financials"
description="Financial statements, as-reported."
url="fundamental/reported_financials"
command
/><ReferenceCard
title="balance"
description="Balance Sheet. Balance sheet statement."

14
website/content/excel/reference/equity/fundamental/latest_attributes.md vendored
View File

@@ -4,23 +4,25 @@ Fetch the latest value of a data tag from Intrinio.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES(symbol;tag;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES(symbol;tag;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES("AAPL";"EBITDA")
=OBB.EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES("AAPL";"ebitda")
```
---
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| **tag** | **Text** | **Intrinio data tag ID or code.** | **False** |
| provider | Text | Options: intrinio, defaults to intrinio. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| **tag** | **Text** | **Intrinio data tag ID or code.** | **True** |
| provider | Text | Options: intrinio, defaults to intrinio. | False |
---

10
website/content/excel/reference/equity/fundamental/management.md vendored
View File

@@ -23,7 +23,9 @@ Key Executives. Key executives for a given company.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT(symbol;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT(symbol;[provider])
```
### Example
@@ -35,10 +37,10 @@ Key Executives. Key executives for a given company.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

10
website/content/excel/reference/equity/fundamental/management_compensation.md vendored
View File

@@ -33,7 +33,9 @@ Get Executive Compensation. Information about the executive compensation for a g
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION(symbol;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION(symbol;[provider])
```
### Example
@@ -45,10 +47,10 @@ Get Executive Compensation. Information about the executive compensation for a g
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

16
website/content/excel/reference/equity/fundamental/metrics.md vendored
View File

@@ -80,7 +80,9 @@ Key Metrics. Key metrics for a given company.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.METRICS(symbol;[provider];[period];[limit];[with_ttm])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.METRICS(symbol;[period];[limit];[provider];[with_ttm])
```
### Example
@@ -92,13 +94,13 @@ Key Metrics. Key metrics for a given company.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | True |
| period | Text | Time period of the data to return. | True |
| limit | Number | The number of data entries to return. | True |
| with_ttm | Boolean | Include trailing twelve months (TTM) data. (provider: fmp) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| period | Text | Time period of the data to return. | False |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | False |
| with_ttm | Boolean | Include trailing twelve months (TTM) data. (provider: fmp) | False |
---

11
website/content/excel/reference/equity/fundamental/multiples.md vendored
View File

@@ -72,7 +72,9 @@ Equity Valuation Multiples. Valuation multiples for a stock ticker.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.MULTIPLES(symbol;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.MULTIPLES(symbol;[provider])
```
### Example
@@ -84,10 +86,10 @@ Equity Valuation Multiples. Valuation multiples for a stock ticker.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
@@ -95,6 +97,7 @@ Equity Valuation Multiples. Valuation multiples for a stock ticker.
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| revenue_per_share_ttm | Revenue per share calculated as trailing twelve months. |
| net_income_per_share_ttm | Net income per share calculated as trailing twelve months. |
| operating_cash_flow_per_share_ttm | Operating cash flow per share calculated as trailing twelve months. |

10
website/content/excel/reference/equity/fundamental/overview.md vendored
View File

@@ -54,7 +54,9 @@ Company Overview. General information about a company.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.OVERVIEW(symbol;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.OVERVIEW(symbol;[provider])
```
### Example
@@ -66,10 +68,10 @@ Company Overview. General information about a company.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

136
website/content/excel/reference/equity/fundamental/ratios.md vendored
View File

@@ -29,7 +29,9 @@ Extensive set of ratios over time. Financial ratios for a given company.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.RATIOS(symbol;[provider];[period];[limit];[with_ttm];[fiscal_year])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.RATIOS(symbol;[period];[limit];[provider];[with_ttm];[fiscal_year])
```
### Example
@@ -41,14 +43,14 @@ Extensive set of ratios over time. Financial ratios for a given company.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | True |
| period | Text | Time period of the data to return. | True |
| limit | Number | The number of data entries to return. | True |
| with_ttm | Boolean | Include trailing twelve months (TTM) data. (provider: fmp, intrinio) | True |
| fiscal_year | Number | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| period | Text | Time period of the data to return. | False |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | False |
| with_ttm | Boolean | Include trailing twelve months (TTM) data. (provider: fmp, intrinio) | False |
| fiscal_year | Number | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) | False |
---
@@ -56,62 +58,62 @@ Extensive set of ratios over time. Financial ratios for a given company.
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| date | The date of the data. |
| period | Period of the financial ratios. |
| current_ratio | Current ratio. |
| quick_ratio | Quick ratio. |
| cash_ratio | Cash ratio. |
| days_of_sales_outstanding | Days of sales outstanding. |
| days_of_inventory_outstanding | Days of inventory outstanding. |
| operating_cycle | Operating cycle. |
| days_of_payables_outstanding | Days of payables outstanding. |
| cash_conversion_cycle | Cash conversion cycle. |
| gross_profit_margin | Gross profit margin. |
| operating_profit_margin | Operating profit margin. |
| pretax_profit_margin | Pretax profit margin. |
| net_profit_margin | Net profit margin. |
| effective_tax_rate | Effective tax rate. |
| return_on_assets | Return on assets. |
| return_on_equity | Return on equity. |
| return_on_capital_employed | Return on capital employed. |
| net_income_per_ebt | Net income per EBT. |
| ebt_per_ebit | EBT per EBIT. |
| ebit_per_revenue | EBIT per revenue. |
| debt_ratio | Debt ratio. |
| debt_equity_ratio | Debt equity ratio. |
| long_term_debt_to_capitalization | Long term debt to capitalization. |
| total_debt_to_capitalization | Total debt to capitalization. |
| interest_coverage | Interest coverage. |
| cash_flow_to_debt_ratio | Cash flow to debt ratio. |
| company_equity_multiplier | Company equity multiplier. |
| receivables_turnover | Receivables turnover. |
| payables_turnover | Payables turnover. |
| inventory_turnover | Inventory turnover. |
| fixed_asset_turnover | Fixed asset turnover. |
| asset_turnover | Asset turnover. |
| operating_cash_flow_per_share | Operating cash flow per share. |
| free_cash_flow_per_share | Free cash flow per share. |
| cash_per_share | Cash per share. |
| payout_ratio | Payout ratio. |
| operating_cash_flow_sales_ratio | Operating cash flow sales ratio. |
| free_cash_flow_operating_cash_flow_ratio | Free cash flow operating cash flow ratio. |
| cash_flow_coverage_ratios | Cash flow coverage ratios. |
| short_term_coverage_ratios | Short term coverage ratios. |
| capital_expenditure_coverage_ratio | Capital expenditure coverage ratio. |
| dividend_paid_and_capex_coverage_ratio | Dividend paid and capex coverage ratio. |
| dividend_payout_ratio | Dividend payout ratio. |
| price_book_value_ratio | Price book value ratio. |
| price_to_book_ratio | Price to book ratio. |
| price_to_sales_ratio | Price to sales ratio. |
| price_earnings_ratio | Price earnings ratio. |
| price_to_free_cash_flows_ratio | Price to free cash flows ratio. |
| price_to_operating_cash_flows_ratio | Price to operating cash flows ratio. |
| price_cash_flow_ratio | Price cash flow ratio. |
| price_earnings_to_growth_ratio | Price earnings to growth ratio. |
| price_sales_ratio | Price sales ratio. |
| dividend_yield | Dividend yield. |
| dividend_yield_percentage | Dividend yield percentage. |
| dividend_per_share | Dividend per share. |
| enterprise_value_multiple | Enterprise value multiple. |
| price_fair_value | Price fair value. |
| period_ending | The date of the data. |
| fiscal_period | Period of the financial ratios. |
| fiscal_year | Fiscal year. |
| current_ratio | Current ratio. (provider: fmp) |
| quick_ratio | Quick ratio. (provider: fmp) |
| cash_ratio | Cash ratio. (provider: fmp) |
| days_of_sales_outstanding | Days of sales outstanding. (provider: fmp) |
| days_of_inventory_outstanding | Days of inventory outstanding. (provider: fmp) |
| operating_cycle | Operating cycle. (provider: fmp) |
| days_of_payables_outstanding | Days of payables outstanding. (provider: fmp) |
| cash_conversion_cycle | Cash conversion cycle. (provider: fmp) |
| gross_profit_margin | Gross profit margin. (provider: fmp) |
| operating_profit_margin | Operating profit margin. (provider: fmp) |
| pretax_profit_margin | Pretax profit margin. (provider: fmp) |
| net_profit_margin | Net profit margin. (provider: fmp) |
| effective_tax_rate | Effective tax rate. (provider: fmp) |
| return_on_assets | Return on assets. (provider: fmp) |
| return_on_equity | Return on equity. (provider: fmp) |
| return_on_capital_employed | Return on capital employed. (provider: fmp) |
| net_income_per_ebt | Net income per EBT. (provider: fmp) |
| ebt_per_ebit | EBT per EBIT. (provider: fmp) |
| ebit_per_revenue | EBIT per revenue. (provider: fmp) |
| debt_ratio | Debt ratio. (provider: fmp) |
| debt_equity_ratio | Debt equity ratio. (provider: fmp) |
| long_term_debt_to_capitalization | Long term debt to capitalization. (provider: fmp) |
| total_debt_to_capitalization | Total debt to capitalization. (provider: fmp) |
| interest_coverage | Interest coverage. (provider: fmp) |
| cash_flow_to_debt_ratio | Cash flow to debt ratio. (provider: fmp) |
| company_equity_multiplier | Company equity multiplier. (provider: fmp) |
| receivables_turnover | Receivables turnover. (provider: fmp) |
| payables_turnover | Payables turnover. (provider: fmp) |
| inventory_turnover | Inventory turnover. (provider: fmp) |
| fixed_asset_turnover | Fixed asset turnover. (provider: fmp) |
| asset_turnover | Asset turnover. (provider: fmp) |
| operating_cash_flow_per_share | Operating cash flow per share. (provider: fmp) |
| free_cash_flow_per_share | Free cash flow per share. (provider: fmp) |
| cash_per_share | Cash per share. (provider: fmp) |
| payout_ratio | Payout ratio. (provider: fmp) |
| operating_cash_flow_sales_ratio | Operating cash flow sales ratio. (provider: fmp) |
| free_cash_flow_operating_cash_flow_ratio | Free cash flow operating cash flow ratio. (provider: fmp) |
| cash_flow_coverage_ratios | Cash flow coverage ratios. (provider: fmp) |
| short_term_coverage_ratios | Short term coverage ratios. (provider: fmp) |
| capital_expenditure_coverage_ratio | Capital expenditure coverage ratio. (provider: fmp) |
| dividend_paid_and_capex_coverage_ratio | Dividend paid and capex coverage ratio. (provider: fmp) |
| dividend_payout_ratio | Dividend payout ratio. (provider: fmp) |
| price_book_value_ratio | Price book value ratio. (provider: fmp) |
| price_to_book_ratio | Price to book ratio. (provider: fmp) |
| price_to_sales_ratio | Price to sales ratio. (provider: fmp) |
| price_earnings_ratio | Price earnings ratio. (provider: fmp) |
| price_to_free_cash_flows_ratio | Price to free cash flows ratio. (provider: fmp) |
| price_to_operating_cash_flows_ratio | Price to operating cash flows ratio. (provider: fmp) |
| price_cash_flow_ratio | Price cash flow ratio. (provider: fmp) |
| price_earnings_to_growth_ratio | Price earnings to growth ratio. (provider: fmp) |
| price_sales_ratio | Price sales ratio. (provider: fmp) |
| dividend_yield | Dividend yield. (provider: fmp) |
| dividend_yield_percentage | Dividend yield percentage. (provider: fmp) |
| dividend_per_share | Dividend per share. (provider: fmp) |
| enterprise_value_multiple | Enterprise value multiple. (provider: fmp) |
| price_fair_value | Price fair value. (provider: fmp) |

38
website/content/excel/reference/equity/fundamental/reported_financials.md vendored Normal file
View File

@@ -0,0 +1,38 @@
<!-- markdownlint-disable MD041 -->
Financial statements, as-reported.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.REPORTED_FINANCIALS(symbol;[period];[statement_type];[limit];[provider];[fiscal_year])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.REPORTED_FINANCIALS("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| period | Text | Time period of the data to return. | False |
| statement_type | Text | The type of financial statement - i.e, balance, income, cash. | False |
| limit | Number | 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. | False |
| provider | Text | Options: intrinio, defaults to intrinio. | False |
| fiscal_year | Number | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| period_ending | The ending date of the reporting period. |
| fiscal_period | The fiscal period of the report (e.g. FY, Q1, etc.). |
| fiscal_year | The fiscal year of the fiscal period. |

14
website/content/excel/reference/equity/fundamental/revenue_per_geography.md vendored
View File

@@ -33,7 +33,9 @@ Revenue Geographic. Geographic revenue data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY(symbol;[provider];[period];[structure])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY(symbol;[period];[structure];[provider])
```
### Example
@@ -45,12 +47,12 @@ Revenue Geographic. Geographic revenue data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| period | Text | Time period of the data to return. | True |
| structure | Text | Structure of the returned data. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| period | Text | Time period of the data to return. | False |
| structure | Text | Structure of the returned data. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

14
website/content/excel/reference/equity/fundamental/revenue_per_segment.md vendored
View File

@@ -25,7 +25,9 @@ Revenue Business Line. Business line revenue data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT(symbol;[provider];[period];[structure])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT(symbol;[period];[structure];[provider])
```
### Example
@@ -37,12 +39,12 @@ Revenue Business Line. Business line revenue data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| period | Text | Time period of the data to return. | True |
| structure | Text | Structure of the returned data. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| period | Text | Time period of the data to return. | False |
| structure | Text | Structure of the returned data. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

14
website/content/excel/reference/equity/fundamental/search_attributes.md vendored
View File

@@ -4,23 +4,25 @@ Search Intrinio data tags.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES(query;[provider];[limit])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES(query;[limit];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES("EBITDA")
=OBB.EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES("ebitda")
```
---
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **query** | **Text** | **Query to search for.** | **False** |
| provider | Text | Options: intrinio, defaults to intrinio. | True |
| limit | Number | The number of data entries to return. | True |
| **query** | **Text** | **Query to search for.** | **True** |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: intrinio, defaults to intrinio. | False |
---

10
website/content/excel/reference/equity/fundamental/trailing_dividend_yield.md vendored
View File

@@ -13,7 +13,9 @@ Trailing 1yr dividend yield.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.TRAILING_DIVIDEND_YIELD([provider];[symbol])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.TRAILING_DIVIDEND_YIELD([symbol];[provider])
```
### Example
@@ -25,10 +27,10 @@ Trailing 1yr dividend yield.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: tiingo, defaults to tiingo. | True |
| symbol | Text | Symbol to get data for. | True |
| symbol | Text | Symbol to get data for. | False |
| provider | Text | Options: tiingo, defaults to tiingo. | False |
---

12
website/content/excel/reference/equity/fundamental/transcript.md vendored
View File

@@ -22,7 +22,9 @@ Earnings Call Transcript. Earnings call transcript for a given company.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.FUNDAMENTAL.TRANSCRIPT(symbol;year;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.TRANSCRIPT(symbol;year;[provider])
```
### Example
@@ -34,11 +36,11 @@ Earnings Call Transcript. Earnings call transcript for a given company.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| **year** | **Number** | **Year of the earnings call transcript.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| **year** | **Number** | **Year of the earnings call transcript.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

4
website/content/excel/reference/equity/index.mdx vendored
View File

@@ -6,7 +6,7 @@ import ReferenceCard from '@site/src/components/General/NewReferenceCard';
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="calendar"
description="dividend, ipo, earnings"
description="dividend, splits, ipo, earnings"
url="equity/calendar"
/><ReferenceCard
title="estimates"
@@ -18,7 +18,7 @@ import ReferenceCard from '@site/src/components/General/NewReferenceCard';
url="equity/discovery"
/><ReferenceCard
title="fundamental"
description="historical_eps, filings, management, overview, management_compensation, dividends, balance,..."
description="historical_eps, filings, management, overview, management_compensation, dividends,..."
url="equity/fundamental"
/><ReferenceCard
title="ownership"

10
website/content/excel/reference/equity/market_snapshots.md vendored
View File

@@ -30,7 +30,9 @@ Get a current, complete, market snapshot.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.MARKET_SNAPSHOTS([provider];[market])</span>```
```excel wordwrap
=OBB.EQUITY.MARKET_SNAPSHOTS([provider];[market])
```
### Example
@@ -42,10 +44,10 @@ Get a current, complete, market snapshot.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, polygon, defaults to fmp. | True |
| market | Text | The market to fetch data for. (provider: fmp) | True |
| provider | Text | Options: fmp, polygon, defaults to fmp. | False |
| market | Text | The market to fetch data for. (provider: fmp) | False |
---

22
website/content/excel/reference/equity/ownership/insider_trading.md vendored
View File

@@ -38,7 +38,9 @@ Insider Trading. Information about insider trading.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.OWNERSHIP.INSIDER_TRADING(symbol;[provider];[limit];[transactionType];[start_date];[end_date];[ownership_type];[sort_by])</span>```
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.INSIDER_TRADING(symbol;[limit];[provider];[transactionType];[start_date];[end_date];[ownership_type];[sort_by])
```
### Example
@@ -50,16 +52,16 @@ Insider Trading. Information about insider trading.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | True |
| limit | Number | The number of data entries to return. | True |
| transactionType | Any | Type of the transaction. (provider: fmp) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. (provider: intrinio) | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. (provider: intrinio) | True |
| ownership_type | Text | Type of ownership. (provider: intrinio) | True |
| sort_by | Text | Field to sort by. (provider: intrinio) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | False |
| transactionType | Any | Type of the transaction. (provider: fmp) | False |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. (provider: intrinio) | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. (provider: intrinio) | False |
| ownership_type | Text | Type of ownership. (provider: intrinio) | False |
| sort_by | Text | Field to sort by. (provider: intrinio) | False |
---

16
website/content/excel/reference/equity/ownership/institutional.md vendored
View File

@@ -64,7 +64,9 @@ Institutional Ownership. Institutional ownership data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.OWNERSHIP.INSTITUTIONAL(symbol;[provider];[include_current_quarter];[date];[page_size])</span>```
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.INSTITUTIONAL(symbol;[provider];[include_current_quarter];[date];[page_size])
```
### Example
@@ -76,13 +78,13 @@ Institutional Ownership. Institutional ownership data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | True |
| include_current_quarter | Boolean | Include current quarter data. (provider: fmp) | True |
| date | Text | A specific date to get data for. (provider: fmp) | True |
| page_size | Number | The number of data entries to return. (provider: intrinio) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | False |
| include_current_quarter | Boolean | Include current quarter data. (provider: fmp) | False |
| date | Text | A specific date to get data for. (provider: fmp) | False |
| page_size | Number | The number of data entries to return. (provider: intrinio) | False |
---

14
website/content/excel/reference/equity/ownership/major_holders.md vendored
View File

@@ -41,7 +41,9 @@ Equity Ownership. Information about the company ownership.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.OWNERSHIP.MAJOR_HOLDERS(symbol;[provider];[date];[page])</span>```
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.MAJOR_HOLDERS(symbol;[date];[page];[provider])
```
### Example
@@ -53,12 +55,12 @@ Equity Ownership. Information about the company ownership.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| date | Text | A specific date to get data for. | True |
| page | Number | Page number of the data to fetch. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| date | Text | A specific date to get data for. | False |
| page | Number | Page number of the data to fetch. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

10
website/content/excel/reference/equity/ownership/share_statistics.md vendored
View File

@@ -22,7 +22,9 @@ Share Statistics. Share statistics for a given company.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.OWNERSHIP.SHARE_STATISTICS(symbol;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.SHARE_STATISTICS(symbol;[provider])
```
### Example
@@ -34,10 +36,10 @@ Share Statistics. Share statistics for a given company.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | False |
---

39
website/content/excel/reference/equity/price/historical.md vendored
View File

@@ -31,7 +31,9 @@ Equity Historical price. Load stock data for a specific ticker.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.PRICE.HISTORICAL(symbol;[provider];[interval];[start_date];[end_date];[limit];[sort];[start_time];[end_time];[timezone];[source];[sleep];[adjusted])</span>```
```excel wordwrap
=OBB.EQUITY.PRICE.HISTORICAL(symbol;[interval];[start_date];[end_date];[provider];[limit];[sort];[start_time];[end_time];[timezone];[source];[sleep];[adjusted])
```
### Example
@@ -43,21 +45,21 @@ Equity Historical price. Load stock data for a specific ticker.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, intrinio, polygon, tiingo, defaults to fmp. | True |
| interval | Text | Time interval of the data to return. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| limit | Number | 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) | True |
| sort | Text | Sort the data in ascending or descending order. (provider: fmp); Sort order of the data. (provider: polygon) | True |
| start_time | Text | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio) | True |
| end_time | Text | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio) | True |
| timezone | Text | Timezone of the data, in the IANA format (Continent/City). (provider: intrinio) | True |
| source | Text | The source of the data. (provider: intrinio) | True |
| sleep | Number | Time to sleep between requests to avoid rate limiting. (provider: intrinio) | True |
| adjusted | Boolean | Output time series is adjusted by historical split and dividend events. (provider: polygon) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| interval | Text | Time interval of the data to return. | False |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fmp, intrinio, polygon, tiingo, defaults to fmp. | False |
| limit | Number | 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) | False |
| sort | Text | Sort the data in ascending or descending order. (provider: fmp); Sort order of the data. (provider: polygon) | False |
| start_time | Text | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio) | False |
| end_time | Text | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio) | False |
| timezone | Text | Timezone of the data, in the IANA format (Continent/City). (provider: intrinio) | False |
| source | Text | The source of the data. (provider: intrinio) | False |
| sleep | Number | Time to sleep between requests to avoid rate limiting. (provider: intrinio) | False |
| adjusted | Boolean | Output time series is adjusted by historical split and dividend events. (provider: polygon) | False |
---
@@ -72,13 +74,8 @@ Equity Historical price. Load stock data for a specific ticker.
| close | The close price. |
| volume | The trading volume. |
| vwap | Volume Weighted Average Price over the period. |
| adj_close | The adjusted close price. (provider: alpha_vantage); Adjusted Close Price of the symbol. (provider: fmp); Adjusted closing price during the period. (provider: intrinio); Adjusted closing price during the period. (provider: tiingo) |
| dividend_amount | Dividend amount paid for the corresponding date. (provider: alpha_vantage) |
| split_coefficient | Split coefficient for the corresponding date. (provider: alpha_vantage) |
| calls_volume | Number of calls traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) |
| puts_volume | Number of puts traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) |
| total_options_volume | Total number of options traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) |
| label | Human readable format of the date. (provider: fmp) |
| adj_close | The adjusted close price. (provider: fmp); Adjusted closing price during the period. (provider: intrinio); Adjusted closing price during the period. (provider: tiingo) |
| unadjusted_volume | Unadjusted volume of the symbol. (provider: fmp) |
| change | Change in the price of the symbol from the previous day. (provider: fmp, intrinio) |
| change_percent | Change % in the price of the symbol. (provider: fmp) |

22
website/content/excel/reference/equity/price/nbbo.md vendored
View File

@@ -43,7 +43,9 @@ Equity NBBO. Load National Best Bid and Offer for a specific equity.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.PRICE.NBBO(symbol;[provider];[limit];[timestamp];[timestamp_lt];[timestamp_gt];[timestamp_lte];[timestamp_gte])</span>```
```excel wordwrap
=OBB.EQUITY.PRICE.NBBO(symbol;[provider];[limit];[timestamp];[timestamp_lt];[timestamp_gt];[timestamp_lte];[timestamp_gte])
```
### Example
@@ -55,16 +57,16 @@ Equity NBBO. Load National Best Bid and Offer for a specific equity.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: polygon, defaults to polygon. | True |
| limit | Number | 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) | True |
| timestamp | Text | A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges. (provider: polygon) | True |
| timestamp_lt | Text | 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) | True |
| timestamp_gt | Text | 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) | True |
| timestamp_lte | Text | 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) | True |
| timestamp_gte | Text | 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) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: polygon, defaults to polygon. | False |
| limit | Number | 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) | False |
| timestamp | Text | A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges. (provider: polygon) | False |
| timestamp_lt | Text | 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) | False |
| timestamp_gt | Text | 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) | False |
| timestamp_lte | Text | 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) | False |
| timestamp_gte | Text | 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) | False |
---

10
website/content/excel/reference/equity/price/performance.md vendored
View File

@@ -37,7 +37,9 @@ Price performance as a return, over different periods.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.PRICE.PERFORMANCE(symbol;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.PRICE.PERFORMANCE(symbol;[provider])
```
### Example
@@ -49,10 +51,10 @@ Price performance as a return, over different periods.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

16
website/content/excel/reference/equity/price/quote.md vendored
View File

@@ -67,7 +67,9 @@ Equity Quote. Load stock data for a specific ticker.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.PRICE.QUOTE(symbol;[provider];[source])</span>```
```excel wordwrap
=OBB.EQUITY.PRICE.QUOTE(symbol;[provider];[source])
```
### Example
@@ -79,11 +81,11 @@ Equity Quote. Load stock data for a specific ticker.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for. In this case, the comma separated list of symbols.** | **False** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | True |
| source | Text | Source of the data. (provider: intrinio) | True |
| **symbol** | **Text** | **Symbol to get data for. In this case, the comma separated list of symbols.** | **True** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | False |
| source | Text | Source of the data. (provider: intrinio) | False |
---
@@ -102,8 +104,8 @@ Equity Quote. Load stock data for a specific ticker.
| year_high | Highest price of the equity in the last 52 weeks. (provider: fmp) |
| year_low | Lowest price of the equity in the last 52 weeks. (provider: fmp) |
| market_cap | Market cap of the company. (provider: fmp) |
| priceAvg50 | 50 days average price of the equity. (provider: fmp) |
| priceAvg200 | 200 days average price of the equity. (provider: fmp) |
| price_avg50 | 50 days average price of the equity. (provider: fmp) |
| price_avg200 | 200 days average price of the equity. (provider: fmp) |
| volume | Volume of the equity in the current trading day. (provider: fmp) |
| avg_volume | Average volume of the equity in the last 10 trading days. (provider: fmp) |
| exchange | Exchange the equity is traded on. (provider: fmp) |

31
website/content/excel/reference/equity/profile.md vendored
View File

@@ -53,7 +53,9 @@ Equity Info. Get general price and performance metrics of a stock.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.PROFILE(symbol;[provider])</span>```
```excel wordwrap
=OBB.EQUITY.PROFILE(symbol;[provider])
```
### Example
@@ -65,10 +67,10 @@ Equity Info. Get general price and performance metrics of a stock.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: intrinio, defaults to intrinio. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: intrinio, defaults to intrinio. | False |
---
@@ -112,26 +114,5 @@ Equity Info. Get general price and performance metrics of a stock.
| last_fundamental_date | Date of the company's last fundamental. |
| first_stock_price_date | Date of the company's first stock price. |
| last_stock_price_date | Date of the company's last stock price. |
| type | Type of asset. (provider: cboe) |
| exchange_id | The Exchange ID number. (provider: cboe) |
| tick | Whether the last sale was an up or down tick. (provider: cboe) |
| bid | Current bid price. (provider: cboe) |
| bid_size | Bid lot size. (provider: cboe) |
| ask | Current ask price. (provider: cboe) |
| ask_size | Ask lot size. (provider: cboe) |
| volume | Stock volume for the current trading day. (provider: cboe) |
| iv30 | The 30-day implied volatility of the stock. (provider: cboe) |
| iv30_change | Change in 30-day implied volatility of the stock. (provider: cboe) |
| last_trade_timestamp | Last trade timestamp for the stock. (provider: cboe) |
| iv30_annual_high | The 1-year high of implied volatility. (provider: cboe) |
| hv30_annual_high | The 1-year high of realized volatility. (provider: cboe) |
| iv30_annual_low | The 1-year low of implied volatility. (provider: cboe) |
| hv30_annual_low | The 1-year low of realized volatility. (provider: cboe) |
| iv60_annual_high | The 60-day high of implied volatility. (provider: cboe) |
| hv60_annual_high | The 60-day high of realized volatility. (provider: cboe) |
| iv60_annual_low | The 60-day low of implied volatility. (provider: cboe) |
| hv60_annual_low | The 60-day low of realized volatility. (provider: cboe) |
| iv90_annual_high | The 90-day high of implied volatility. (provider: cboe) |
| hv90_annual_high | The 90-day high of realized volatility. (provider: cboe) |
| id | Intrinio ID for the company. (provider: intrinio) |
| thea_enabled | Whether the company has been enabled for Thea. (provider: intrinio) |

42
website/content/excel/reference/equity/screener.md vendored
View File

@@ -12,7 +12,9 @@ Equity Screen. Screen for companies meeting various criteria.
## Syntax
```jsx<span style={color: 'red'}>=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])</span>```
```excel wordwrap
=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])
```
### Example
@@ -24,26 +26,26 @@ Equity Screen. Screen for companies meeting various criteria.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, defaults to fmp. | True |
| mktcap_min | Number | Filter by market cap greater than this value. (provider: fmp) | True |
| mktcap_max | Number | Filter by market cap less than this value. (provider: fmp) | True |
| price_min | Number | Filter by price greater than this value. (provider: fmp) | True |
| price_max | Number | Filter by price less than this value. (provider: fmp) | True |
| beta_min | Number | Filter by a beta greater than this value. (provider: fmp) | True |
| beta_max | Number | Filter by a beta less than this value. (provider: fmp) | True |
| volume_min | Number | Filter by volume greater than this value. (provider: fmp) | True |
| volume_max | Number | Filter by volume less than this value. (provider: fmp) | True |
| dividend_min | Number | Filter by dividend amount greater than this value. (provider: fmp) | True |
| dividend_max | Number | Filter by dividend amount less than this value. (provider: fmp) | True |
| is_etf | Boolean | If true, returns only ETFs. (provider: fmp) | True |
| is_active | Boolean | If false, returns only inactive tickers. (provider: fmp) | True |
| sector | Text | Filter by sector. (provider: fmp) | True |
| industry | Text | Filter by industry. (provider: fmp) | True |
| country | Text | Filter by country, as a two-letter country code. (provider: fmp) | True |
| exchange | Text | Filter by exchange. (provider: fmp) | True |
| limit | Number | Limit the number of results to return. (provider: fmp) | True |
| provider | Text | Options: fmp, defaults to fmp. | False |
| mktcap_min | Number | Filter by market cap greater than this value. (provider: fmp) | False |
| mktcap_max | Number | Filter by market cap less than this value. (provider: fmp) | False |
| price_min | Number | Filter by price greater than this value. (provider: fmp) | False |
| price_max | Number | Filter by price less than this value. (provider: fmp) | False |
| beta_min | Number | Filter by a beta greater than this value. (provider: fmp) | False |
| beta_max | Number | Filter by a beta less than this value. (provider: fmp) | False |
| volume_min | Number | Filter by volume greater than this value. (provider: fmp) | False |
| volume_max | Number | Filter by volume less than this value. (provider: fmp) | False |
| dividend_min | Number | Filter by dividend amount greater than this value. (provider: fmp) | False |
| dividend_max | Number | Filter by dividend amount less than this value. (provider: fmp) | False |
| is_etf | Boolean | If true, returns only ETFs. (provider: fmp) | False |
| is_active | Boolean | If false, returns only inactive tickers. (provider: fmp) | False |
| sector | Text | Filter by sector. (provider: fmp) | False |
| industry | Text | Filter by industry. (provider: fmp) | False |
| country | Text | Filter by country, as a two-letter country code. (provider: fmp) | False |
| exchange | Text | Filter by exchange. (provider: fmp) | False |
| limit | Number | Limit the number of results to return. (provider: fmp) | False |
---

26
website/content/excel/reference/equity/search.md vendored
View File

@@ -55,7 +55,9 @@ Equity Search. Search for a company or stock ticker.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.SEARCH([provider];[query];[is_symbol];[active];[limit];[is_fund];[use_cache])</span>```
```excel wordwrap
=OBB.EQUITY.SEARCH([query];[is_symbol];[provider];[active];[limit];[is_fund];[use_cache])
```
### Example
@@ -67,15 +69,15 @@ Equity Search. Search for a company or stock ticker.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: intrinio, sec, defaults to intrinio. | True |
| query | Text | Search query. | True |
| is_symbol | Boolean | Whether to search by ticker symbol. | True |
| active | Boolean | 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) | True |
| limit | Number | The number of data entries to return. (provider: intrinio) | True |
| is_fund | Boolean | Whether to direct the search to the list of mutual funds and ETFs. (provider: sec) | True |
| use_cache | Boolean | Whether to use the cache or not. Company names, tickers, and CIKs are cached for seven days. (provider: sec) | True |
| query | Text | Search query. | False |
| is_symbol | Boolean | Whether to search by ticker symbol. | False |
| provider | Text | Options: intrinio, sec, defaults to intrinio. | False |
| active | Boolean | 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) | False |
| limit | Number | The number of data entries to return. (provider: intrinio) | False |
| is_fund | Boolean | Whether to direct the search to the list of mutual funds and ETFs. (provider: sec) | False |
| use_cache | Boolean | Whether to use the cache or not. Company names, tickers, and CIKs are cached for seven days. (provider: sec) | False |
---
@@ -85,6 +87,6 @@ Equity Search. Search for a company or stock ticker.
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| name | Name of the company. |
| dpm_name | Name of the primary market maker. (provider: cboe) |
| post_station | Post and station location on the CBOE trading floor. (provider: cboe) |
| cik | Central Index Key (provider: sec) |
| cik | ; Central Index Key (provider: sec) |
| lei | The Legal Entity Identifier (LEI) of the company. (provider: intrinio) |
| intrinio_id | The Intrinio ID of the company. (provider: intrinio) |

14
website/content/excel/reference/equity/shorts/fails_to_deliver.md vendored
View File

@@ -24,7 +24,9 @@ Get reported Fail-to-deliver (FTD) data.
## Syntax
```jsx<span style={color: 'red'}>=OBB.EQUITY.SHORTS.FAILS_TO_DELIVER(symbol;[provider];[limit];[skip_reports])</span>```
```excel wordwrap
=OBB.EQUITY.SHORTS.FAILS_TO_DELIVER(symbol;[provider];[limit];[skip_reports])
```
### Example
@@ -36,12 +38,12 @@ Get reported Fail-to-deliver (FTD) data.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: sec, defaults to sec. | True |
| limit | Number | Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009. (provider: sec) | True |
| skip_reports | Number | Skip N number of reports from current. A value of 1 will skip the most recent report. (provider: sec) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: sec, defaults to sec. | False |
| limit | Number | Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009. (provider: sec) | False |
| skip_reports | Number | Skip N number of reports from current. A value of 1 will skip the most recent report. (provider: sec) | False |
---

10
website/content/excel/reference/etf/countries.md vendored
View File

@@ -21,7 +21,9 @@ ETF Country weighting.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ETF.COUNTRIES(symbol;[provider])</span>```
```excel wordwrap
=OBB.ETF.COUNTRIES(symbol;[provider])
```
### Example
@@ -33,10 +35,10 @@ ETF Country weighting.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for. (ETF)** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for. (ETF)** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

106
website/content/excel/reference/etf/holdings.md vendored
View File

@@ -47,7 +47,9 @@ Get the holdings for an individual ETF.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ETF.HOLDINGS(symbol;[provider];[date];[cik];[use_cache])</span>```
```excel wordwrap
=OBB.ETF.HOLDINGS(symbol;[provider];[date];[cik];[use_cache])
```
### Example
@@ -59,13 +61,13 @@ Get the holdings for an individual ETF.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for. (ETF)** | **False** |
| provider | Text | Options: fmp, sec, defaults to fmp. | True |
| date | Text | 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) | True |
| cik | Text | The CIK of the filing entity. Overrides symbol. (provider: fmp) | True |
| use_cache | Boolean | Whether or not to use cache for the request. (provider: sec) | True |
| **symbol** | **Text** | **Symbol to get data for. (ETF)** | **True** |
| provider | Text | Options: fmp, sec, defaults to fmp. | False |
| date | Text | 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) | False |
| cik | Text | The CIK of the filing entity. Overrides symbol. (provider: fmp) | False |
| use_cache | Boolean | Whether or not to use cache for the request. (provider: sec) | False |
---
@@ -75,23 +77,79 @@ Get the holdings for an individual ETF.
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. (ETF) |
| name | Name of the ETF holding. |
| lei | The LEI of the holding. (provider: fmp) |
| lei | The LEI of the holding. (provider: fmp, sec) |
| title | The title of the holding. (provider: fmp) |
| cusip | The CUSIP of the holding. (provider: fmp) |
| isin | The ISIN of the holding. (provider: fmp) |
| balance | The balance of the holding. (provider: fmp) |
| units | The units of the holding. (provider: fmp) |
| currency | The currency of the holding. (provider: fmp) |
| value | The value of the holding in USD. (provider: fmp) |
| weight | The weight of the holding in ETF in %. (provider: fmp) |
| payoff_profile | The payoff profile of the holding. (provider: fmp) |
| asset_category | The asset category of the holding. (provider: fmp) |
| issuer_category | The issuer category of the holding. (provider: fmp) |
| country | The country of the holding. (provider: fmp) |
| is_restricted | Whether the holding is restricted. (provider: fmp) |
| fair_value_level | The fair value level of the holding. (provider: fmp) |
| is_cash_collateral | Whether the holding is cash collateral. (provider: fmp) |
| is_non_cash_collateral | Whether the holding is non-cash collateral. (provider: fmp) |
| is_loan_by_fund | Whether the holding is loan by fund. (provider: fmp) |
| cusip | The CUSIP of the holding. (provider: fmp, sec) |
| isin | The ISIN of the holding. (provider: fmp, sec) |
| balance | The balance of the holding. (provider: fmp, sec) |
| units | The units of the holding. (provider: fmp, sec) |
| currency | The currency of the holding. (provider: fmp, sec) |
| value | The value of the holding in USD. (provider: fmp, sec) |
| weight | The weight of the holding in ETF in %. (provider: fmp, sec) |
| payoff_profile | The payoff profile of the holding. (provider: fmp, sec) |
| asset_category | The asset category of the holding. (provider: fmp, sec) |
| issuer_category | The issuer category of the holding. (provider: fmp, sec) |
| country | The country of the holding. (provider: fmp, sec) |
| is_restricted | Whether the holding is restricted. (provider: fmp, sec) |
| fair_value_level | The fair value level of the holding. (provider: fmp, sec) |
| is_cash_collateral | Whether the holding is cash collateral. (provider: fmp, sec) |
| is_non_cash_collateral | Whether the holding is non-cash collateral. (provider: fmp, sec) |
| is_loan_by_fund | Whether the holding is loan by fund. (provider: fmp, sec) |
| cik | The CIK of the filing. (provider: fmp) |
| acceptance_datetime | The acceptance datetime of the filing. (provider: fmp) |
| other_id | Internal identifier for the holding. (provider: sec) |
| loan_value | The loan value of the holding. (provider: sec) |
| issuer_conditional | The issuer conditions of the holding. (provider: sec) |
| asset_conditional | The asset conditions of the holding. (provider: sec) |
| maturity_date | The maturity date of the debt security. (provider: sec) |
| coupon_kind | The type of coupon for the debt security. (provider: sec) |
| rate_type | The type of rate for the debt security, floating or fixed. (provider: sec) |
| annualized_return | The annualized return on the debt security. (provider: sec) |
| is_default | If the debt security is defaulted. (provider: sec) |
| in_arrears | If the debt security is in arrears. (provider: sec) |
| is_paid_kind | If the debt security payments are are paid in kind. (provider: sec) |
| derivative_category | The derivative category of the holding. (provider: sec) |
| counterparty | The counterparty of the derivative. (provider: sec) |
| underlying_name | The name of the underlying asset associated with the derivative. (provider: sec) |
| option_type | The type of option. (provider: sec) |
| derivative_payoff | The payoff profile of the derivative. (provider: sec) |
| expiry_date | The expiry or termination date of the derivative. (provider: sec) |
| exercise_price | The exercise price of the option. (provider: sec) |
| exercise_currency | The currency of the option exercise price. (provider: sec) |
| shares_per_contract | The number of shares per contract. (provider: sec) |
| delta | The delta of the option. (provider: sec) |
| rate_type_rec | The type of rate for reveivable portion of the swap. (provider: sec) |
| receive_currency | The receive currency of the swap. (provider: sec) |
| upfront_receive | The upfront amount received of the swap. (provider: sec) |
| floating_rate_index_rec | The floating rate index for reveivable portion of the swap. (provider: sec) |
| floating_rate_spread_rec | The floating rate spread for reveivable portion of the swap. (provider: sec) |
| rate_tenor_rec | The rate tenor for reveivable portion of the swap. (provider: sec) |
| rate_tenor_unit_rec | The rate tenor unit for reveivable portion of the swap. (provider: sec) |
| reset_date_rec | The reset date for reveivable portion of the swap. (provider: sec) |
| reset_date_unit_rec | The reset date unit for reveivable portion of the swap. (provider: sec) |
| rate_type_pmnt | The type of rate for payment portion of the swap. (provider: sec) |
| payment_currency | The payment currency of the swap. (provider: sec) |
| upfront_payment | The upfront amount received of the swap. (provider: sec) |
| floating_rate_index_pmnt | The floating rate index for payment portion of the swap. (provider: sec) |
| floating_rate_spread_pmnt | The floating rate spread for payment portion of the swap. (provider: sec) |
| rate_tenor_pmnt | The rate tenor for payment portion of the swap. (provider: sec) |
| rate_tenor_unit_pmnt | The rate tenor unit for payment portion of the swap. (provider: sec) |
| reset_date_pmnt | The reset date for payment portion of the swap. (provider: sec) |
| reset_date_unit_pmnt | The reset date unit for payment portion of the swap. (provider: sec) |
| repo_type | The type of repo. (provider: sec) |
| is_cleared | If the repo is cleared. (provider: sec) |
| is_tri_party | If the repo is tri party. (provider: sec) |
| principal_amount | The principal amount of the repo. (provider: sec) |
| principal_currency | The currency of the principal amount. (provider: sec) |
| collateral_type | The collateral type of the repo. (provider: sec) |
| collateral_amount | The collateral amount of the repo. (provider: sec) |
| collateral_currency | The currency of the collateral amount. (provider: sec) |
| exchange_currency | The currency of the exchange rate. (provider: sec) |
| exchange_rate | The exchange rate. (provider: sec) |
| currency_sold | The currency sold in a Forward Derivative. (provider: sec) |
| currency_amount_sold | The amount of currency sold in a Forward Derivative. (provider: sec) |
| currency_bought | The currency bought in a Forward Derivative. (provider: sec) |
| currency_amount_bought | The amount of currency bought in a Forward Derivative. (provider: sec) |
| notional_amount | The notional amount of the derivative. (provider: sec) |
| notional_currency | The currency of the derivative's notional amount. (provider: sec) |
| unrealized_gain | The unrealized gain or loss on the derivative. (provider: sec) |

12
website/content/excel/reference/etf/holdings_date.md vendored
View File

@@ -27,7 +27,9 @@ Get the holdings filing date for an individual ETF.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ETF.HOLDINGS_DATE(symbol;[provider];[cik])</span>```
```excel wordwrap
=OBB.ETF.HOLDINGS_DATE(symbol;[provider];[cik])
```
### Example
@@ -39,11 +41,11 @@ Get the holdings filing date for an individual ETF.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for. (ETF)** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| cik | Text | The CIK of the filing entity. Overrides symbol. (provider: fmp) | True |
| **symbol** | **Text** | **Symbol to get data for. (ETF)** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
| cik | Text | The CIK of the filing entity. Overrides symbol. (provider: fmp) | False |
---

10
website/content/excel/reference/etf/holdings_performance.md vendored
View File

@@ -24,7 +24,9 @@ Get the ETF holdings performance.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ETF.HOLDINGS_PERFORMANCE(symbol;[provider])</span>```
```excel wordwrap
=OBB.ETF.HOLDINGS_PERFORMANCE(symbol;[provider])
```
### Example
@@ -36,10 +38,10 @@ Get the ETF holdings performance.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

10
website/content/excel/reference/etf/info.md vendored
View File

@@ -33,7 +33,9 @@ ETF Information Overview.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ETF.INFO(symbol;[provider])</span>```
```excel wordwrap
=OBB.ETF.INFO(symbol;[provider])
```
### Example
@@ -45,10 +47,10 @@ ETF Information Overview.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for. (ETF)** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for. (ETF)** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

10
website/content/excel/reference/etf/price_performance.md vendored
View File

@@ -37,7 +37,9 @@ Price performance as a return, over different periods.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ETF.PRICE_PERFORMANCE(symbol;[provider])</span>```
```excel wordwrap
=OBB.ETF.PRICE_PERFORMANCE(symbol;[provider])
```
### Example
@@ -49,10 +51,10 @@ Price performance as a return, over different periods.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

14
website/content/excel/reference/etf/search.md vendored
View File

@@ -27,7 +27,9 @@ Search for ETFs. An empty query returns the full list of ETFs from the provider
## Syntax
```jsx<span style={color: 'red'}>=OBB.ETF.SEARCH([provider];[query];[exchange];[is_active])</span>```
```excel wordwrap
=OBB.ETF.SEARCH([query];[provider];[exchange];[is_active])
```
### Example
@@ -39,12 +41,12 @@ Search for ETFs. An empty query returns the full list of ETFs from the provider
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, defaults to fmp. | True |
| query | Text | Search query. | True |
| exchange | Text | The exchange code the ETF trades on. (provider: fmp) | True |
| is_active | Boolean | Whether the ETF is actively trading. (provider: fmp) | True |
| query | Text | Search query. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
| exchange | Text | The exchange code the ETF trades on. (provider: fmp) | False |
| is_active | Boolean | Whether the ETF is actively trading. (provider: fmp) | False |
---

10
website/content/excel/reference/etf/sectors.md vendored
View File

@@ -28,7 +28,9 @@ ETF Sector weighting.
## Syntax
```jsx<span style={color: 'red'}>=OBB.ETF.SECTORS(symbol;[provider])</span>```
```excel wordwrap
=OBB.ETF.SECTORS(symbol;[provider])
```
### Example
@@ -40,10 +42,10 @@ ETF Sector weighting.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for. (ETF)** | **False** |
| provider | Text | Options: fmp, defaults to fmp. | True |
| **symbol** | **Text** | **Symbol to get data for. (ETF)** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

18
website/content/excel/reference/fixedincome/corporate/commercial_paper.md vendored
View File

@@ -31,7 +31,9 @@ Commercial Paper. Commercial paper (CP) consists of short-term, promissory note
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.CORPORATE.COMMERCIAL_PAPER([provider];[start_date];[end_date];[maturity];[category];[grade])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.CORPORATE.COMMERCIAL_PAPER([start_date];[end_date];[maturity];[category];[grade];[provider])
```
### Example
@@ -43,14 +45,14 @@ Commercial Paper. Commercial paper (CP) consists of short-term, promissory note
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| maturity | Text | The maturity. | True |
| category | Text | The category. | True |
| grade | Text | The grade. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| maturity | Text | The maturity. | False |
| category | Text | The category. | False |
| grade | Text | The grade. | False |
| provider | Text | Options: fred, defaults to fred. | False |
---

13
website/content/excel/reference/fixedincome/corporate/hqm.md vendored
View File

@@ -24,7 +24,9 @@ High Quality Market Corporate Bond. The HQM yield curve represents the high qua
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.CORPORATE.HQM([provider];[date];[yield_curve])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.CORPORATE.HQM([date];[yield_curve];[provider])
```
### Example
@@ -36,11 +38,11 @@ High Quality Market Corporate Bond. The HQM yield curve represents the high qua
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| date | Text | A specific date to get data for. | True |
| yield_curve | Text | The yield curve type. | True |
| date | Text | A specific date to get data for. | False |
| yield_curve | Text | The yield curve type. | False |
| provider | Text | Options: fred, defaults to fred. | False |
---
@@ -52,3 +54,4 @@ High Quality Market Corporate Bond. The HQM yield curve represents the high qua
| rate | HighQualityMarketCorporateBond Rate. |
| maturity | Maturity. |
| yield_curve | The yield curve type. |
| series_id | FRED series id. (provider: fred) |

22
website/content/excel/reference/fixedincome/corporate/ice_bofa.md vendored
View File

@@ -41,7 +41,9 @@ ICE BofA US Corporate Bond Indices. The ICE BofA US Corporate Index tracks the
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.CORPORATE.ICE_BOFA([provider];[start_date];[end_date];[index_type];[category];[area];[grade];[options])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.CORPORATE.ICE_BOFA([start_date];[end_date];[index_type];[provider];[category];[area];[grade];[options])
```
### Example
@@ -53,16 +55,16 @@ ICE BofA US Corporate Bond Indices. The ICE BofA US Corporate Index tracks the
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| index_type | Text | The type of series. | True |
| category | Text | The type of category. (provider: fred) | True |
| area | Text | The type of area. (provider: fred) | True |
| grade | Text | The type of grade. (provider: fred) | True |
| options | Boolean | Whether to include options in the results. (provider: fred) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| index_type | Text | The type of series. | False |
| provider | Text | Options: fred, defaults to fred. | False |
| category | Text | The type of category. (provider: fred) | False |
| area | Text | The type of area. (provider: fred) | False |
| grade | Text | The type of grade. (provider: fred) | False |
| options | Boolean | Whether to include options in the results. (provider: fred) | False |
---

16
website/content/excel/reference/fixedincome/corporate/moody.md vendored
View File

@@ -13,7 +13,9 @@ Moody Corporate Bond Index. Moody's Aaa and Baa are investment bonds that acts
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.CORPORATE.MOODY([provider];[start_date];[end_date];[index_type];[spread])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.CORPORATE.MOODY([start_date];[end_date];[index_type];[provider];[spread])
```
### Example
@@ -25,13 +27,13 @@ Moody Corporate Bond Index. Moody's Aaa and Baa are investment bonds that acts
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| index_type | Text | The type of series. | True |
| spread | Text | The type of spread. (provider: fred) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| index_type | Text | The type of series. | False |
| provider | Text | Options: fred, defaults to fred. | False |
| spread | Text | The type of spread. (provider: fred) | False |
---

16
website/content/excel/reference/fixedincome/corporate/spot_rates.md vendored
View File

@@ -31,7 +31,9 @@ Spot Rates. The spot rates for any maturity is the yield on a bond that provide
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.CORPORATE.SPOT_RATES([provider];[start_date];[end_date];[maturity];[category])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.CORPORATE.SPOT_RATES([start_date];[end_date];[maturity];[category];[provider])
```
### Example
@@ -43,13 +45,13 @@ Spot Rates. The spot rates for any maturity is the yield on a bond that provide
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| maturity | Any | The maturities in years. | True |
| category | Any | The category. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| maturity | Any | The maturities in years. | False |
| category | Any | The category. | False |
| provider | Text | Options: fred, defaults to fred. | False |
---

12
website/content/excel/reference/fixedincome/government/treasury_rates.md vendored
View File

@@ -13,7 +13,9 @@ Government Treasury Rates.
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.GOVERNMENT.TREASURY_RATES([provider];[start_date];[end_date])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.GOVERNMENT.TREASURY_RATES([start_date];[end_date];[provider])
```
### Example
@@ -25,11 +27,11 @@ Government Treasury Rates.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: federal_reserve, fmp, defaults to federal_reserve. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: federal_reserve, fmp, defaults to federal_reserve. | False |
---

12
website/content/excel/reference/fixedincome/government/us_yield_curve.md vendored
View File

@@ -26,7 +26,9 @@ US Yield Curve. Get United States yield curve.
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.GOVERNMENT.US_YIELD_CURVE([provider];[date];[inflation_adjusted])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.GOVERNMENT.US_YIELD_CURVE([date];[inflation_adjusted];[provider])
```
### Example
@@ -38,11 +40,11 @@ US Yield Curve. Get United States yield curve.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| date | Text | A specific date to get data for. Defaults to the most recent FRED entry. | True |
| inflation_adjusted | Boolean | Get inflation adjusted rates. | True |
| date | Text | A specific date to get data for. Defaults to the most recent FRED entry. | False |
| inflation_adjusted | Boolean | Get inflation adjusted rates. | False |
| provider | Text | Options: fred, defaults to fred. | False |
---

14
website/content/excel/reference/fixedincome/rate/ameribor.md vendored
View File

@@ -13,7 +13,9 @@ Ameribor. Ameribor (short for the American interbank offered rate) is a benchma
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.RATE.AMERIBOR([provider];[start_date];[end_date];[parameter])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.RATE.AMERIBOR([start_date];[end_date];[provider];[parameter])
```
### Example
@@ -25,12 +27,12 @@ Ameribor. Ameribor (short for the American interbank offered rate) is a benchma
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| parameter | Text | Period of AMERIBOR rate. (provider: fred) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fred, defaults to fred. | False |
| parameter | Text | Period of AMERIBOR rate. (provider: fred) | False |
---

14
website/content/excel/reference/fixedincome/rate/dpcredit.md vendored
View File

@@ -13,7 +13,9 @@ Discount Window Primary Credit Rate. A bank rate is the interest rate a nation'
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.RATE.DPCREDIT([provider];[start_date];[end_date];[parameter])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.RATE.DPCREDIT([start_date];[end_date];[provider];[parameter])
```
### Example
@@ -25,12 +27,12 @@ Discount Window Primary Credit Rate. A bank rate is the interest rate a nation'
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| parameter | Text | FRED series ID of DWPCR data. (provider: fred) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fred, defaults to fred. | False |
| parameter | Text | FRED series ID of DWPCR data. (provider: fred) | False |
---

14
website/content/excel/reference/fixedincome/rate/ecb.md vendored
View File

@@ -24,7 +24,9 @@ European Central Bank Interest Rates. The Governing Council of the ECB sets the
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.RATE.ECB([provider];[start_date];[end_date];[interest_rate_type])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.RATE.ECB([start_date];[end_date];[interest_rate_type];[provider])
```
### Example
@@ -36,12 +38,12 @@ European Central Bank Interest Rates. The Governing Council of the ECB sets the
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| interest_rate_type | Text | The type of interest rate. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| interest_rate_type | Text | The type of interest rate. | False |
| provider | Text | Options: fred, defaults to fred. | False |
---

14
website/content/excel/reference/fixedincome/rate/effr.md vendored
View File

@@ -13,7 +13,9 @@ Fed Funds Rate. Get Effective Federal Funds Rate data. A bank rate is the inter
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.RATE.EFFR([provider];[start_date];[end_date];[parameter])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.RATE.EFFR([start_date];[end_date];[provider];[parameter])
```
### Example
@@ -25,12 +27,12 @@ Fed Funds Rate. Get Effective Federal Funds Rate data. A bank rate is the inter
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: federal_reserve, fred, defaults to federal_reserve. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| parameter | Text | Period of FED rate. (provider: fred) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: federal_reserve, fred, defaults to federal_reserve. | False |
| parameter | Text | Period of FED rate. (provider: fred) | False |
---

10
website/content/excel/reference/fixedincome/rate/effr_forecast.md vendored
View File

@@ -13,7 +13,9 @@ Fed Funds Rate Projections. The projections for the federal funds rate are the
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.RATE.EFFR_FORECAST([provider];[long_run])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.RATE.EFFR_FORECAST([provider];[long_run])
```
### Example
@@ -25,10 +27,10 @@ Fed Funds Rate Projections. The projections for the federal funds rate are the
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| long_run | Boolean | Flag to show long run projections (provider: fred) | True |
| provider | Text | Options: fred, defaults to fred. | False |
| long_run | Boolean | Flag to show long run projections (provider: fred) | False |
---

14
website/content/excel/reference/fixedincome/rate/estr.md vendored
View File

@@ -13,7 +13,9 @@ Euro Short-Term Rate. The euro short-term rate (€STR) reflects the wholesale
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.RATE.ESTR([provider];[start_date];[end_date];[parameter])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.RATE.ESTR([start_date];[end_date];[provider];[parameter])
```
### Example
@@ -25,12 +27,12 @@ Euro Short-Term Rate. The euro short-term rate (€STR) reflects the wholesale
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| parameter | Text | Period of ESTR rate. (provider: fred) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fred, defaults to fred. | False |
| parameter | Text | Period of ESTR rate. (provider: fred) | False |
---

12
website/content/excel/reference/fixedincome/rate/iorb.md vendored
View File

@@ -13,7 +13,9 @@ Interest on Reserve Balances. Get Interest Rate on Reserve Balances data A bank
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.RATE.IORB([provider];[start_date];[end_date])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.RATE.IORB([start_date];[end_date];[provider])
```
### Example
@@ -25,11 +27,11 @@ Interest on Reserve Balances. Get Interest Rate on Reserve Balances data A bank
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fred, defaults to fred. | False |
---

14
website/content/excel/reference/fixedincome/rate/sonia.md vendored
View File

@@ -13,7 +13,9 @@ Sterling Overnight Index Average. SONIA (Sterling Overnight Index Average) is a
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.RATE.SONIA([provider];[start_date];[end_date];[parameter])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.RATE.SONIA([start_date];[end_date];[provider];[parameter])
```
### Example
@@ -25,12 +27,12 @@ Sterling Overnight Index Average. SONIA (Sterling Overnight Index Average) is a
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| parameter | Text | Period of SONIA rate. (provider: fred) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fred, defaults to fred. | False |
| parameter | Text | Period of SONIA rate. (provider: fred) | False |
---

14
website/content/excel/reference/fixedincome/sofr.md vendored
View File

@@ -31,7 +31,9 @@ Secured Overnight Financing Rate. The Secured Overnight Financing Rate (SOFR) i
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.SOFR([provider];[start_date];[end_date];[period])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.SOFR([start_date];[end_date];[provider];[period])
```
### Example
@@ -43,12 +45,12 @@ Secured Overnight Financing Rate. The Secured Overnight Financing Rate (SOFR) i
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| period | Text | Period of SOFR rate. (provider: fred) | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fred, defaults to fred. | False |
| period | Text | Period of SOFR rate. (provider: fred) | False |
---

14
website/content/excel/reference/fixedincome/spreads/tmc.md vendored
View File

@@ -28,7 +28,9 @@ Treasury Constant Maturity. Get data for 10-Year Treasury Constant Maturity Min
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.SPREADS.TMC([provider];[start_date];[end_date];[maturity])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.SPREADS.TMC([start_date];[end_date];[maturity];[provider])
```
### Example
@@ -40,12 +42,12 @@ Treasury Constant Maturity. Get data for 10-Year Treasury Constant Maturity Min
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| maturity | Text | The maturity | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| maturity | Text | The maturity | False |
| provider | Text | Options: fred, defaults to fred. | False |
---

14
website/content/excel/reference/fixedincome/spreads/tmc_effr.md vendored
View File

@@ -32,7 +32,9 @@ Select Treasury Constant Maturity. Get data for Selected Treasury Constant Matu
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.SPREADS.TMC_EFFR([provider];[start_date];[end_date];[maturity])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.SPREADS.TMC_EFFR([start_date];[end_date];[maturity];[provider])
```
### Example
@@ -44,12 +46,12 @@ Select Treasury Constant Maturity. Get data for Selected Treasury Constant Matu
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| maturity | Text | The maturity | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| maturity | Text | The maturity | False |
| provider | Text | Options: fred, defaults to fred. | False |
---

14
website/content/excel/reference/fixedincome/spreads/treasury_effr.md vendored
View File

@@ -32,7 +32,9 @@ Select Treasury Bill. Get Selected Treasury Bill Minus Federal Funds Rate. Cons
## Syntax
```jsx<span style={color: 'red'}>=OBB.FIXEDINCOME.SPREADS.TREASURY_EFFR([provider];[start_date];[end_date];[maturity])</span>```
```excel wordwrap
=OBB.FIXEDINCOME.SPREADS.TREASURY_EFFR([start_date];[end_date];[maturity];[provider])
```
### Example
@@ -44,12 +46,12 @@ Select Treasury Bill. Get Selected Treasury Bill Minus Federal Funds Rate. Cons
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fred, defaults to fred. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| maturity | Text | The maturity | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| maturity | Text | The maturity | False |
| provider | Text | Options: fred, defaults to fred. | False |
---

2
website/content/excel/reference/index.mdx vendored
View File

@@ -9,7 +9,7 @@ import ReferenceCard from '@site/src/components/General/NewReferenceCard';
url="reference/crypto"
/><ReferenceCard
title="economy"
description="gdp, calendar, risk_premium, cpi, nominal, forecast, real"
description="gdp, calendar, fred_series, risk_premium, money_measures, fred_search, cpi, nominal, forecast, real"
url="reference/economy"
/><ReferenceCard
title="derivatives"

20
website/content/excel/reference/index/available.md vendored
View File

@@ -12,7 +12,9 @@ Available Indices. Available indices for a given provider.
## Syntax
```jsx<span style={color: 'red'}>=OBB.INDEX.AVAILABLE([provider])</span>```
```excel wordwrap
=OBB.INDEX.AVAILABLE([provider])
```
### Example
@@ -24,9 +26,9 @@ Available Indices. Available indices for a given provider.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, defaults to fmp. | True |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
@@ -36,17 +38,5 @@ Available Indices. Available indices for a given provider.
| ---- | ----------- |
| name | Name of the index. |
| currency | Currency the index is traded in. |
| isin | ISIN code for the index. Valid only for European indices. (provider: cboe) |
| region | Region for the index. Valid only for European indices (provider: cboe) |
| symbol | Symbol for the index. (provider: cboe, yfinance) |
| description | Description for the index. Valid only for US indices. (provider: cboe) |
| data_delay | Data delay for the index. Valid only for US indices. (provider: cboe) |
| open_time | Opening time for the index. Valid only for US indices. (provider: cboe) |
| close_time | Closing time for the index. Valid only for US indices. (provider: cboe) |
| time_zone | Time zone for the index. Valid only for US indices. (provider: cboe) |
| tick_days | The trading days for the index. Valid only for US indices. (provider: cboe) |
| tick_frequency | The frequency of the index ticks. Valid only for US indices. (provider: cboe) |
| tick_period | The period of the index ticks. Valid only for US indices. (provider: cboe) |
| stock_exchange | Stock exchange where the index is listed. (provider: fmp) |
| exchange_short_name | Short name of the stock exchange where the index is listed. (provider: fmp) |
| code | ID code for keying the index in the OpenBB Terminal. (provider: yfinance) |

10
website/content/excel/reference/index/constituents.md vendored
View File

@@ -26,7 +26,9 @@ Index Constituents. Constituents of an index.
## Syntax
```jsx<span style={color: 'red'}>=OBB.INDEX.CONSTITUENTS([provider];[index])</span>```
```excel wordwrap
=OBB.INDEX.CONSTITUENTS([index];[provider])
```
### Example
@@ -38,10 +40,10 @@ Index Constituents. Constituents of an index.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, defaults to fmp. | True |
| index | Text | Index for which we want to fetch the constituents. | True |
| index | Text | Index for which we want to fetch the constituents. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---

42
website/content/excel/reference/index/market.md vendored
View File

@@ -48,34 +48,36 @@ Historical Market Indices.
## Syntax
```jsx<span style={color: 'red'}>=OBB.INDEX.MARKET(symbol;[provider];[start_date];[end_date];[timeseries];[interval];[sort];[tag];[type];[limit];[sleep];[timespan];[adjusted];[multiplier])</span>```
```excel wordwrap
=OBB.INDEX.MARKET(symbol;[start_date];[end_date];[provider];[timeseries];[interval];[sort];[tag];[type];[limit];[sleep];[timespan];[adjusted];[multiplier])
```
### Example
```excel wordwrap
=OBB.INDEX.MARKET("SPX")
=OBB.INDEX.MARKET("^GSPC")
```
---
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **False** |
| provider | Text | Options: fmp, intrinio, polygon, defaults to fmp. | True |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | True |
| timeseries | Number | Number of days to look back. (provider: fmp) | True |
| interval | Text | Data granularity. (provider: fmp) | True |
| sort | Text | Sort the data in ascending or descending order. (provider: fmp); Sort order. (provider: intrinio); Sort order of the data. (provider: polygon) | True |
| tag | Text | Index tag. (provider: intrinio) | True |
| type | Text | Index type. (provider: intrinio) | True |
| limit | Number | The number of data entries to return. (provider: intrinio, polygon) | True |
| sleep | Number | Time to sleep between requests to avoid rate limiting. (provider: intrinio) | True |
| timespan | Text | Timespan of the data. (provider: polygon) | True |
| adjusted | Boolean | Whether the data is adjusted. (provider: polygon) | True |
| multiplier | Number | Multiplier of the timespan. (provider: polygon) | True |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| start_date | Text | Start date of the data, in YYYY-MM-DD format. | False |
| end_date | Text | End date of the data, in YYYY-MM-DD format. | False |
| provider | Text | Options: fmp, intrinio, polygon, defaults to fmp. | False |
| timeseries | Number | Number of days to look back. (provider: fmp) | False |
| interval | Text | Data granularity. (provider: fmp) | False |
| sort | Text | Sort the data in ascending or descending order. (provider: fmp); Sort order. (provider: intrinio); Sort order of the data. (provider: polygon) | False |
| tag | Text | Index tag. (provider: intrinio) | False |
| type | Text | Index type. (provider: intrinio) | False |
| limit | Number | The number of data entries to return. (provider: intrinio, polygon) | False |
| sleep | Number | Time to sleep between requests to avoid rate limiting. (provider: intrinio) | False |
| timespan | Text | Timespan of the data. (provider: polygon) | False |
| adjusted | Boolean | Whether the data is adjusted. (provider: polygon) | False |
| multiplier | Number | Multiplier of the timespan. (provider: polygon) | False |
---
@@ -89,14 +91,10 @@ Historical Market Indices.
| low | The low price. |
| close | The close price. |
| volume | The trading volume. |
| calls_volume | Number of calls traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) |
| puts_volume | Number of puts traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) |
| total_options_volume | Total number of options traded during the most recent trading period. Only valid if interval is 1m. (provider: cboe) |
| adj_close | Adjusted Close Price of the symbol. (provider: fmp) |
| adj_close | The adjusted close price. (provider: fmp) |
| unadjusted_volume | Unadjusted volume of the symbol. (provider: fmp) |
| change | Change in the price of the symbol from the previous day. (provider: fmp) |
| change_percent | Change % in the price of the symbol. (provider: fmp) |
| label | Human readable format of the date. (provider: fmp) |
| change_over_time | Change % in the price of the symbol over a period of time. (provider: fmp) |
| value | Index value. (provider: intrinio) |
| transactions | Number of transactions for the symbol in the time period. (provider: polygon) |

64
website/content/excel/reference/news/company.md vendored
View File

@@ -39,7 +39,9 @@ Company News. Get news for one or more companies.
## Syntax
```jsx<span style={color: 'red'}>=OBB.NEWS.COMPANY(symbols;[provider];[limit];[display];[date];[start_date];[end_date];[updated_since];[published_since];[sort];[order];[isin];[cusip];[channels];[topics];[authors];[content_types];[page];[published_utc];[source])</span>```
```excel wordwrap
=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])
```
### Example
@@ -51,28 +53,28 @@ Company News. Get news for one or more companies.
## Parameters
| Name | Type | Description | Optional |
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbols** | **Text** | **Here it is a separated list of symbols.** | **False** |
| provider | Text | Options: benzinga, fmp, intrinio, polygon, tiingo, defaults to benzinga. | True |
| limit | Number | The number of data entries to return. | True |
| display | Text | Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga) | True |
| date | Text | Date of the news to retrieve. (provider: benzinga) | True |
| start_date | Text | Start date of the news to retrieve. (provider: benzinga) | True |
| end_date | Text | End date of the news to retrieve. (provider: benzinga) | True |
| updated_since | Number | Number of seconds since the news was updated. (provider: benzinga) | True |
| published_since | Number | Number of seconds since the news was published. (provider: benzinga) | True |
| sort | Text | Key to sort the news by. (provider: benzinga) | True |
| order | Text | Order to sort the news by. (provider: benzinga); Sort order of the articles. (provider: polygon) | True |
| isin | Text | The ISIN of the news to retrieve. (provider: benzinga) | True |
| cusip | Text | The CUSIP of the news to retrieve. (provider: benzinga) | True |
| channels | Text | Channels of the news to retrieve. (provider: benzinga) | True |
| topics | Text | Topics of the news to retrieve. (provider: benzinga) | True |
| authors | Text | Authors of the news to retrieve. (provider: benzinga) | True |
| content_types | Text | Content types of the news to retrieve. (provider: benzinga) | True |
| page | Number | Page number of the results. Use in combination with limit. (provider: fmp) | True |
| published_utc | Text | Date query to fetch articles. Supports operators <, <=, >, >= (provider: polygon) | True |
| source | Text | A comma-separated list of the domains requested. (provider: tiingo) | True |
| **symbols** | **Text** | **Here it is a separated list of symbols.** | **True** |
| limit | Number | The number of data entries to return. | False |
| provider | Text | Options: benzinga, fmp, intrinio, polygon, tiingo, defaults to benzinga. | False |
| display | Text | Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga) | False |
| date | Text | Date of the news to retrieve. (provider: benzinga) | False |
| start_date | Text | Start date of the news to retrieve. (provider: benzinga) | False |
| end_date | Text | End date of the news to retrieve. (provider: benzinga) | False |
| updated_since | Number | Number of seconds since the news was updated. (provider: benzinga) | False |
| published_since | Number | Number of seconds since the news was published. (provider: benzinga) | False |
| sort | Text | Key to sort the news by. (provider: benzinga) | False |
| order | Text | Order to sort the news by. (provider: benzinga); Sort order of the articles. (provider: polygon) | False |
| isin | Text | The ISIN of the news to retrieve. (provider: benzinga) | False |
| cusip | Text | The CUSIP of the news to retrieve. (provider: benzinga) | False |
| channels | Text | Channels of the news to retrieve. (provider: benzinga) | False |
| topics | Text | Topics of the news to retrieve. (provider: benzinga) | False |
| authors | Text | Authors of the news to retrieve. (provider: benzinga) | False |
| content_types | Text | Content types of the news to retrieve. (provider: benzinga) | False |
| page | Number | Page number of the results. Use in combination with limit. (provider: fmp) | False |
| published_utc | Text | Date query to fetch articles. Supports operators <, <=, >, >= (provider: polygon) | False |
| source | Text | A comma-separated list of the domains requested. (provider: tiingo) | False |
---
@@ -80,30 +82,24 @@ Company News. Get news for one or more companies.
| Name | Description |
| ---- | ----------- |
| symbols | Here it is a separated list of symbols. |
| date | The date of the data. Here it is the date of the news. |
| title | Title of the news. |
| image | Image URL of the news. |
| text | Text/body of the news. |
| url | URL of the news. |
| id | ID of the news. (provider: benzinga); Intrinio ID for the article. (provider: intrinio); Article ID. (provider: polygon) |
| author | Author of the news. (provider: benzinga); Author of the article. (provider: polygon) |
| id | Article ID. (provider: benzinga, intrinio, polygon) |
| author | Author of the article. (provider: benzinga, polygon) |
| teaser | Teaser of the news. (provider: benzinga) |
| images | Images associated with the news. (provider: benzinga); URL to the images of the news. (provider: fmp) |
| images | URL to the images of the news. (provider: benzinga, fmp) |
| channels | Channels associated with the news. (provider: benzinga) |
| stocks | Stocks associated with the news. (provider: benzinga) |
| tags | Tags associated with the news. (provider: benzinga, tiingo) |
| updated | Updated date of the news. (provider: benzinga) |
| symbol | Ticker of the fetched news. (provider: fmp) |
| site | Name of the news source. (provider: fmp, tiingo) |
| site | Name of the news source. (provider: fmp); News source. (provider: tiingo) |
| amp_url | AMP URL. (provider: polygon) |
| image_url | Image URL. (provider: polygon) |
| keywords | Keywords in the article (provider: polygon) |
| publisher | Publisher of the article. (provider: polygon, yfinance) |
| tickers | Tickers covered in the article. (provider: polygon) |
| symbols | Ticker tagged in the fetched news. (provider: tiingo) |
| publisher | Publisher of the article. (provider: polygon) |
| article_id | Unique ID of the news article. (provider: tiingo) |
| crawl_date | Date the news article was crawled. (provider: tiingo) |
| uuid | Unique identifier for the news article (provider: yfinance) |
| type | Type of the news article (provider: yfinance) |
| thumbnail | Thumbnail related data to the ticker news article. (provider: yfinance) |
| related_tickers | Tickers related to the news article. (provider: yfinance) |

Some files were not shown because too many files have changed in this diff Show More