jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Uppercase excel reference (#5958)

Browse Source 
* uppercase reference

* fix name header

* add tab title

* remove reference excel folder

* add to gitignore excel reference files

---------

Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
This commit is contained in:
montezdesousa
2024-01-18 12:10:40 +00:00
committed by GitHub
parent c6c003e47e
commit e9ddbd36cf
164 changed files with 54 additions and 17311 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.gitignore vendored
View File

@@ -83,4 +83,8 @@ lightning_logs/
*.pem
# Platform auto generated files
openbb_platform/openbb/package/*
openbb_platform/openbb/package/*
# Reference files
website/content/excel/reference/*
website/content/excel/reference/*/*

4
website/content/excel/getting-started/basics.md vendored
View File

@@ -10,6 +10,10 @@ keywords:
- Functions
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Basics | OpenBB Add-in for Excel Docs" />
The OpenBB Excel Add-in provides direct access to the OpenBB platform, where each function implements the following pattern:
- `OBB.[MENU].[SUB_MENU].[COMMAND]`

4
website/content/excel/getting-started/formula_builder.md vendored
View File

@@ -8,6 +8,10 @@ keywords:
- Formula Builder
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Formula Builder | OpenBB Add-in for Excel Docs" />
You can use the formula builder to get more details about the available functions.
<!-- markdownlint-disable MD033 -->

4
website/content/excel/getting-started/installation.md vendored
View File

@@ -7,6 +7,10 @@ keywords:
- Add-in
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Installation | OpenBB Add-in for Excel Docs" />
## Requirements
- The OpenBB Excel Add-in is available on the following platforms: Windows (Microsoft 365), Mac (Microsoft 365), Excel on the web.
- Access to the OpenBB Terminal Pro. If you don't have access you can sign up for the waitlist [here](https://my.openbb.co/app/pro).

4
website/content/excel/getting-started/templates.mdx vendored
View File

@@ -10,6 +10,10 @@ keywords:
- Template
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Templates | OpenBB Add-in for Excel Docs" />
OpenBB Excel Add-In offered by OpenBB. These templates are designed to help you perform a variety of tasks, from equity analysis to economic analysis. They can be used as-is or customized to suit your needs.
These can be downloaded in the [OpenBB Hub](https://my.openbb.co).

10
website/content/excel/openapi.json vendored
View File

@@ -19750,16 +19750,16 @@
"anyOf": [
{
"items": {
"additionalProperties": {
"type": "string"
},
"type": "object"
"type": "string"
},
"type": "array"
},
{
"items": {
"type": "string"
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": "array"
}

4
website/content/excel/reference/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "Reference",
"position": 3
}

4
website/content/excel/reference/crypto/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "crypto",
"position": 1
}

23
website/content/excel/reference/crypto/index.mdx vendored
View File

@@ -1,23 +0,0 @@
# crypto
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Menus
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="price"
description="historical"
url="crypto/price"
/>
</ul>
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="search"
description="Cryptocurrency Search. Search available cryptocurrency pairs."
url="crypto/search"
command
/>
</ul>

4
website/content/excel/reference/crypto/price/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "price",
"position": 1
}

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

@@ -1,83 +0,0 @@
---
title: historical
description: Learn how to use the `obb.equity.price.historical` function to load historical
price data for a specific stock ticker. Find out about the available parameters
and providers, as well as the structure of the returned data and the columns it
contains.
keywords:
- equity historical price
- load stock data
- specific ticker
- python function
- equity data parameters
- alpha vantage provider
- fmp provider
- intrinio provider
- polygon provider
- yfinance provider
- equity historical data returns
- equity data columns
- alpha vantage data columns
- cboe data columns
- fmp data columns
- intrinio data columns
- polygon data columns
- yfinance data columns
---
<!-- markdownlint-disable MD041 -->
Cryptocurrency Historical Price. Cryptocurrency historical price data.
## Syntax
```excel wordwrap
=OBB.CRYPTO.PRICE.HISTORICAL(symbol;[start_date];[end_date];[provider];[timeseries];[interval];[multiplier];[timespan];[sort];[limit];[adjusted];[exchanges])
```
### Example
```excel wordwrap
=OBB.CRYPTO.PRICE.HISTORICAL("BTCUSD")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| open | The open price. |
| high | The high price. |
| low | The low price. |
| close | The close price. |
| volume | The trading volume. |
| vwap | Volume Weighted Average Price over the period. |
| 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, 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) |

14
website/content/excel/reference/crypto/price/index.mdx vendored
View File

@@ -1,14 +0,0 @@
# price
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="historical"
description="Cryptocurrency Historical Price. Cryptocurrency historical price data."
url="price/historical"
command
/>
</ul>

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

@@ -1,60 +0,0 @@
---
title: search
description: The documentation page provides information on how to perform a cryptocurrency
search, including the search query and provider parameters, as well as the resulting
crypto search data such as symbol, name, currency, and exchange information.
keywords:
- cryptocurrency search
- available cryptocurrency pairs
- python obb crypto search
- search query parameter
- provider parameter
- crypto search results
- crypto search provider
- crypto search warnings
- crypto search chart
- crypto search metadata
- crypto data
- symbol
- crypto name
- crypto currency
- crypto exchange
- crypto exchange name
---
<!-- markdownlint-disable MD041 -->
Cryptocurrency Search. Search available cryptocurrency pairs.
## Syntax
```excel wordwrap
=OBB.CRYPTO.SEARCH([query];[provider])
```
### Example
```excel wordwrap
=OBB.CRYPTO.SEARCH()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| query | Text | Search query. | False |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. (Crypto) |
| name | Name of the crypto. |
| currency | The currency the crypto trades for. (provider: fmp) |
| exchange | The exchange code the crypto trades on. (provider: fmp) |
| exchange_name | The short name of the exchange the crypto trades on. (provider: fmp) |

4
website/content/excel/reference/currency/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "currency",
"position": 9
}

23
website/content/excel/reference/currency/index.mdx vendored
View File

@@ -1,23 +0,0 @@
# currency
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Menus
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="price"
description="historical"
url="currency/price"
/>
</ul>
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="search"
description="Currency Search. Search available currency pairs."
url="currency/search"
command
/>
</ul>

4
website/content/excel/reference/currency/price/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "price",
"position": 1
}

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

@@ -1,80 +0,0 @@
---
title: historical
description: Learn how to use the `obb.equity.price.historical` function to load historical
price data for a specific stock ticker. Find out about the available parameters
and providers, as well as the structure of the returned data and the columns it
contains.
keywords:
- equity historical price
- load stock data
- specific ticker
- python function
- equity data parameters
- alpha vantage provider
- fmp provider
- intrinio provider
- polygon provider
- yfinance provider
- equity historical data returns
- equity data columns
- alpha vantage data columns
- cboe data columns
- fmp data columns
- intrinio data columns
- polygon data columns
- yfinance data columns
---
<!-- markdownlint-disable MD041 -->
Currency Historical Price. Currency historical data.
## Syntax
```excel wordwrap
=OBB.CURRENCY.PRICE.HISTORICAL(symbol;[start_date];[end_date];[provider];[interval];[multiplier];[timespan];[sort];[limit];[adjusted])
```
### Example
```excel wordwrap
=OBB.CURRENCY.PRICE.HISTORICAL("EURUSD")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| open | The open price. |
| high | The high price. |
| low | The low price. |
| close | The close price. |
| volume | The trading volume. |
| vwap | Volume Weighted Average Price over the period. |
| 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) |

14
website/content/excel/reference/currency/price/index.mdx vendored
View File

@@ -1,14 +0,0 @@
# price
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="historical"
description="Currency Historical Price. Currency historical data."
url="price/historical"
command
/>
</ul>

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

@@ -1,97 +0,0 @@
---
title: search
description: Learn how to search for available currency pairs using the `obb.currency.search`
function, and retrieve a list of results, including provider name, warnings, chart,
and metadata. Explore the various parameters such as provider, symbol, date, search
terms, active tickers, order data, sort field, and limit. Dive into the details
of the returned data, including name, symbol, currency, stock exchange, exchange
short name, code, base currency, quote currency, market, locale, currency symbol,
currency name, base currency symbol, base currency name, last updated timestamp
in UTC, and delisted timestamp in UTC.
keywords:
- currency search
- available currency pairs
- obb.currency.search
- provider
- symbol
- date
- search terms
- active tickers
- order data
- sort field
- limit
- results
- warnings
- chart
- metadata
- name
- symbol
- currency
- stock exchange
- exchange short name
- code
- base currency
- quote currency
- market
- locale
- currency symbol
- currency name
- base currency symbol
- base currency name
- last updated utc
- delisted utc
---
<!-- markdownlint-disable MD041 -->
Currency Search. Search available currency pairs.
## Syntax
```excel wordwrap
=OBB.CURRENCY.SEARCH([provider];[symbol];[date];[search];[active];[order];[sort];[limit])
```
### Example
```excel wordwrap
=OBB.CURRENCY.SEARCH()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| name | Name of the currency pair. |
| symbol | Symbol of the currency pair. (provider: fmp) |
| currency | Base currency of the currency pair. (provider: fmp) |
| stock_exchange | Stock exchange of the currency pair. (provider: fmp) |
| exchange_short_name | Short name of the stock exchange of the currency pair. (provider: fmp) |
| code | Code of the currency pair. (provider: intrinio) |
| base_currency | ISO 4217 currency code of the base currency. (provider: intrinio) |
| quote_currency | ISO 4217 currency code of the quote currency. (provider: intrinio) |
| market | Name of the trading market. Always 'fx'. (provider: polygon) |
| locale | Locale of the currency pair. (provider: polygon) |
| currency_symbol | The symbol of the quote currency. (provider: polygon) |
| currency_name | Name of the quote currency. (provider: polygon) |
| base_currency_symbol | The symbol of the base currency. (provider: polygon) |
| base_currency_name | Name of the base currency. (provider: polygon) |
| last_updated_utc | The last updated timestamp in UTC. (provider: polygon) |
| delisted_utc | The delisted timestamp in UTC. (provider: polygon) |

4
website/content/excel/reference/derivatives/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "derivatives",
"position": 3
}

13
website/content/excel/reference/derivatives/index.mdx vendored
View File

@@ -1,13 +0,0 @@
# derivatives
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Menus
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="options"
description="unusual, chains"
url="derivatives/options"
/>
</ul>

4
website/content/excel/reference/derivatives/options/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "options",
"position": 1
}

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

@@ -1,96 +0,0 @@
---
title: chains
description: Learn how to get the complete options chain for a ticker using the OBB.equity.options.chains
function. Explore the available parameters like symbol and provider, and understand
the data returned, including contract symbol, expiration, strike price, and more.
keywords:
- options chain
- ticker
- complete options chain
- symbol
- provider
- data
- contract symbol
- expiration
- strike price
- option type
- eod date
- trading volume
- open price
- open interest
- high price
- low price
- implied volatility
- delta
- gamma
- theta
- vega
- bid size
- ask size
- theoretical value
- last trade price
- prev close
- change percent
- rho
- last trade timestamp
- dte
---
<!-- markdownlint-disable MD041 -->
Get the complete options chain for a ticker.
## Syntax
```excel wordwrap
=OBB.DERIVATIVES.OPTIONS.CHAINS(symbol;[provider];[date])
```
### Example
```excel wordwrap
=OBB.DERIVATIVES.OPTIONS.CHAINS("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| contract_symbol | Contract symbol for the option. |
| symbol | Symbol representing the entity requested in the data. Here its the underlying symbol for the option. |
| expiration | Expiration date of the contract. |
| strike | Strike price of the contract. |
| option_type | Call or Put. |
| eod_date | Date for which the options chains are returned. |
| close | The close price. |
| close_bid | The closing bid price for the option that day. |
| close_ask | The closing ask price for the option that day. |
| volume | The trading volume. |
| open | The open price. |
| open_bid | The opening bid price for the option that day. |
| open_ask | The opening ask price for the option that day. |
| open_interest | Open interest on the contract. |
| high | The high price. |
| low | The low price. |
| mark | The mid-price between the latest bid-ask spread. |
| ask_high | The highest ask price for the option that day. |
| ask_low | The lowest ask price for the option that day. |
| bid_high | The highest bid price for the option that day. |
| bid_low | The lowest bid price for the option that day. |
| implied_volatility | Implied volatility of the option. |
| delta | Delta of the option. |
| gamma | Gamma of the option. |
| theta | Theta of the option. |
| vega | Vega of the option. |

19
website/content/excel/reference/derivatives/options/index.mdx vendored
View File

@@ -1,19 +0,0 @@
# options
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="unusual"
description="Get the complete options chain for a ticker."
url="options/unusual"
command
/><ReferenceCard
title="chains"
description="Get the complete options chain for a ticker."
url="options/chains"
command
/>
</ul>

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

@@ -1,72 +0,0 @@
---
title: unusual
description: Learn how to get the complete options chain for a ticker with the equity
options unusual API. Explore the available parameters such as symbol and provider.
Retrieve valuable data like the underlying symbol, contract symbol, trade type,
sentiment, total value, total size, average price, ask/bid prices at execution,
underlying price at execution, and timestamp.
keywords:
- complete options chain
- ticker options
- equity options unusual
- symbol
- provider
- intrinio
- source
- data
- underlying symbol
- contract symbol
- trade type
- sentiment
- total value
- total size
- average price
- ask at execution
- bid at execution
- underlying price at execution
- timestamp
---
<!-- markdownlint-disable MD041 -->
Get the complete options chain for a ticker.
## Syntax
```excel wordwrap
=OBB.DERIVATIVES.OPTIONS.UNUSUAL([symbol];[provider];[source])
```
### Example
```excel wordwrap
=OBB.DERIVATIVES.OPTIONS.UNUSUAL()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| underlying_symbol | Symbol representing the entity requested in the data. (the underlying symbol) |
| contract_symbol | Contract symbol for the option. |
| trade_type | The type of unusual trade. (provider: intrinio) |
| sentiment | Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price. (provider: intrinio) |
| total_value | The aggregated value of all option contract premiums included in the trade. (provider: intrinio) |
| total_size | The total number of contracts involved in a single transaction. (provider: intrinio) |
| average_price | The average premium paid per option contract. (provider: intrinio) |
| ask_at_execution | Ask price at execution. (provider: intrinio) |
| bid_at_execution | Bid price at execution. (provider: intrinio) |
| underlying_price_at_execution | Price of the underlying security at execution of trade. (provider: intrinio) |
| timestamp | The UTC timestamp of order placement. (provider: intrinio) |

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

File diff suppressed because it is too large Load Diff

4
website/content/excel/reference/economy/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "economy",
"position": 2
}

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

@@ -1,93 +0,0 @@
---
title: calendar
description: The Economic Calendar provides information on economic events and data.
Use the OBB Python function `obb.economy.calendar()` to retrieve economic calendar
data. The function accepts parameters such as start date, end date, provider, country,
importance, and group. It returns a list of economic calendar data, including the
date, event, reference, source, actual value, previous value, consensus value, and
forecast value. The data can be filtered by provider such as FMP, Nasdaq, or Trading
Economics.
keywords:
- economic calendar
- python obb.economy.calendar
- parameters
- start date
- end date
- provider
- country
- importance
- group
- returns
- data
- date
- event
- reference
- source
- source url
- actual
- previous
- consensus
- forecast
- url
- currency
- unit
- change
- change percent
- updated at
- created at
- description
---
<!-- markdownlint-disable MD041 -->
Economic Calendar.
## Syntax
```excel wordwrap
=OBB.ECONOMY.CALENDAR([start_date];[end_date];[provider];[country];[importance];[group])
```
### Example
```excel wordwrap
=OBB.ECONOMY.CALENDAR()
```
---
## 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, 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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| country | Country of event. |
| event | Event name. |
| reference | Abbreviated period for which released data refers to. |
| source | Source of the data. |
| sourceurl | Source URL. |
| actual | Latest released value. |
| previous | Value for the previous period after the revision (if revision is applicable). |
| consensus | Average forecast among a representative group of economists. |
| forecast | Trading Economics projections |
| url | Trading Economics URL |
| importance | Importance of the event. 1-Low, 2-Medium, 3-High |
| currency | Currency of the data. |
| unit | Unit of the data. |
| change | Value change since previous. (provider: fmp) |
| change_percent | Percentage change since previous. (provider: fmp) |
| updated_at | Last updated timestamp. (provider: fmp) |
| created_at | Created at timestamp. (provider: fmp) |

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

@@ -1,62 +0,0 @@
---
title: cpi
description: Get Consumer Price Index (CPI) data for various countries and calculate
inflation measurements. This economic indicator provides insights into the growth
rate of prices on a monthly, quarterly, and annual basis. Harmonized CPI data is
also available. Specify the start and end dates for the desired data range. The
data provider and metadata information are included in the results.
keywords:
- Consumer Price Index (CPI) Data
- CPI data
- CPI calculation
- inflation measurement
- economic indicator
- country-wise CPI data
- growth rate
- monthly CPI
- quarterly CPI
- annual CPI
- harmonized CPI
- start date
- end date
- data provider
- metadata info
---
<!-- markdownlint-disable MD041 -->
Consumer Price Index (CPI). Returns either the rescaled index value, or a rate of change (inflation).
## Syntax
```excel wordwrap
=OBB.ECONOMY.CPI(countries;[units];[frequency];[harmonized];[start_date];[end_date];[provider])
```
### Example
```excel wordwrap
=OBB.ECONOMY.CPI("united_states")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |

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

@@ -1,57 +0,0 @@
<!-- 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
View File

@@ -1,41 +0,0 @@
<!-- 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) |

4
website/content/excel/reference/economy/gdp/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "gdp",
"position": 1
}

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

@@ -1,46 +0,0 @@
---
title: forecast
description: Forecasted GDP Data
keywords:
- economy
- gdp
- forecast
---
<!-- markdownlint-disable MD041 -->
Forecasted GDP Data.
## Syntax
```excel wordwrap
=OBB.ECONOMY.GDP.FORECAST([period];[start_date];[end_date];[type];[provider];[country])
```
### Example
```excel wordwrap
=OBB.ECONOMY.GDP.FORECAST()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| value | Nominal GDP value on the date. |

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

@@ -1,24 +0,0 @@
# gdp
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="nominal"
description="Nominal GDP Data."
url="gdp/nominal"
command
/><ReferenceCard
title="forecast"
description="Forecasted GDP Data."
url="gdp/forecast"
command
/><ReferenceCard
title="real"
description="Real GDP Data."
url="gdp/real"
command
/>
</ul>

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

@@ -1,45 +0,0 @@
---
title: nominal
description: Nominal GDP Data
keywords:
- economy
- gdp
- nominal
---
<!-- markdownlint-disable MD041 -->
Nominal GDP Data.
## Syntax
```excel wordwrap
=OBB.ECONOMY.GDP.NOMINAL([units];[start_date];[end_date];[provider];[country])
```
### Example
```excel wordwrap
=OBB.ECONOMY.GDP.NOMINAL()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| value | Nominal GDP value on the date. |

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

@@ -1,61 +0,0 @@
---
title: real
description: Learn about Real GDP Data and how to access it using the provided parameters.
Find detailed descriptions of the available parameters and the data returned. Understand
the structure of the returns and explore the data attributes.
keywords:
- Real GDP Data
- parameters
- units
- start date
- end date
- provider
- country
- returns
- results
- GdpReal
- warnings
- chart
- metadata
- data
- date
- value
- documentation
---
<!-- markdownlint-disable MD041 -->
Real GDP Data.
## Syntax
```excel wordwrap
=OBB.ECONOMY.GDP.REAL([units];[start_date];[end_date];[provider];[country])
```
### Example
```excel wordwrap
=OBB.ECONOMY.GDP.REAL()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| value | Nominal GDP value on the date. |

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

@@ -1,48 +0,0 @@
# economy
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Menus
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="gdp"
description="nominal, forecast, real"
url="economy/gdp"
/>
</ul>
### Commands
<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="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..."
url="economy/cpi"
command
/>
</ul>

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

@@ -1,41 +0,0 @@
<!-- 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. |

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

@@ -1,59 +0,0 @@
---
title: risk_premium
description: Learn about Historical Market Risk Premium and the obb.economy.risk_premium
function. Explore the parameters, returns, and data available, including results,
warnings, chart, metadata, country, continent, total equity risk premium, and country
risk premium.
keywords:
- Historical Market Risk Premium
- obb.economy.risk_premium
- parameters
- provider
- returns
- OBBject
- results
- RiskPremium
- warnings
- chart
- metadata
- data
- country
- continent
- total equity risk premium
- country risk premium
---
<!-- markdownlint-disable MD041 -->
Historical Market Risk Premium.
## Syntax
```excel wordwrap
=OBB.ECONOMY.RISK_PREMIUM([provider])
```
### Example
```excel wordwrap
=OBB.ECONOMY.RISK_PREMIUM()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| country | Market country. |
| continent | Continent of the country. |
| total_equity_risk_premium | Total equity risk premium for the country. |
| country_risk_premium | Country-specific risk premium. |

4
website/content/excel/reference/equity/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "equity",
"position": 6
}

4
website/content/excel/reference/equity/calendar/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "calendar",
"position": 1
}

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

@@ -1,71 +0,0 @@
---
title: dividend
description: Get upcoming and historical dividend data with the OBB.equity.calendar.dividend
method. This method allows you to retrieve dividend information such as dates, amounts,
and provider details. It also provides warnings, charts, and metadata for further
analysis.
keywords:
- dividend calendar
- upcoming dividends
- historical dividends
- dividend data
- dividend schedule
- dividend information
- dividend dates
- dividend amounts
- dividend provider
- dividend warnings
- dividend chart
- dividend metadata
- ex-dividend date
- record date
- payment date
- declaration date
- dividend symbol
- dividend name
- dividend adjusted amount
- dividend label
- annualized dividend amount
---
<!-- markdownlint-disable MD041 -->
Upcoming and Historical Dividend Calendar.
## Syntax
```excel wordwrap
=OBB.EQUITY.CALENDAR.DIVIDEND([start_date];[end_date];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.CALENDAR.DIVIDEND()
```
---
## 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. (Ex-Dividend) |
| symbol | Symbol representing the entity requested in the data. |
| amount | Dividend amount, per-share. |
| name | Name of the entity. |
| record_date | The record date of ownership for eligibility. |
| payment_date | The payment date of the dividend. |
| declaration_date | Declaration date of the dividend. |
| adjusted_amount | The adjusted-dividend amount. (provider: fmp) |
| label | Ex-dividend date formatted for display. (provider: fmp) |

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

@@ -1,73 +0,0 @@
---
title: earnings
description: Learn how to retrieve upcoming and historical earnings calendar data
using the OBB.equity.calendar.earnings Python function. The function allows you
to specify symbols, limit the number of data entries, and choose a data provider.
The returned data includes EPS, revenue, and other important details for the specified
symbols and dates.
keywords:
- earnings calendar
- upcoming earnings
- historical earnings
- Python function
- earnings data retrieval
- symbol
- limit
- provider
- data entries
- chart
- metadata
- data
- EPS
- revenue
- estimated EPS
- estimated revenue
- date
- time
- updated from date
- fiscal date ending
---
<!-- markdownlint-disable MD041 -->
Upcoming and Historical earnings calendar.
## Syntax
```excel wordwrap
=OBB.EQUITY.CALENDAR.EARNINGS([start_date];[end_date];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.CALENDAR.EARNINGS()
```
---
## 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 |
| ---- | ----------- |
| report_date | The date of the earnings report. |
| symbol | Symbol representing the entity requested in the data. |
| 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. |
| 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) |
| reporting_time | The reporting time - e.g. after market close. (provider: fmp) |
| updated_date | The date the data was updated last. (provider: fmp) |

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

@@ -1,29 +0,0 @@
# calendar
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="dividend"
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."
url="calendar/ipo"
command
/><ReferenceCard
title="earnings"
description="Upcoming and Historical earnings calendar."
url="calendar/earnings"
command
/>
</ul>

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

@@ -1,113 +0,0 @@
---
title: ipo
description: Access the Upcoming and Historical IPO Calendars and retrieve IPO information
using Python.
keywords:
- Upcoming IPO Calendar
- Historical IPO Calendar
- Python function
- equity.calendar.ipo
- symbol
- start_date
- end_date
- limit
- provider
- intrinio
- nasdaq
- status
- min_value
- max_value
- OBBject
- results
- CalendarIpo
- warnings
- Chart
- Metadata
- data
- ipo_date
- status
- exchange
- offer_amount
- share_price
- share_price_lowest
- share_price_highest
- share_count
- share_count_lowest
- share_count_highest
- announcement_url
- sec_report_url
- open_price
- close_price
- volume
- day_change
- week_change
- month_change
- id
- company
- security
- name
- expected_price_date
- filed_date
- withdraw_date
- deal_status
---
<!-- markdownlint-disable MD041 -->
Upcoming and Historical IPO Calendar.
## Syntax
```excel wordwrap
=OBB.EQUITY.CALENDAR.IPO([symbol];[start_date];[end_date];[limit];[provider];[status];[offer_amount_greater_than];[offer_amount_less_than])
```
### Example
```excel wordwrap
=OBB.EQUITY.CALENDAR.IPO()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| 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) |
| 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) |
| 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) |
| sec_report_url | The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place. (provider: intrinio) |
| open_price | The opening price at the beginning of the first trading day (only available for priced IPOs). (provider: intrinio) |
| close_price | The closing price at the end of the first trading day (only available for priced IPOs). (provider: intrinio) |
| volume | The volume at the end of the first trading day (only available for priced IPOs). (provider: intrinio) |
| day_change | The percentage change between the open price and the close price on the first trading day (only available for priced IPOs). (provider: intrinio) |
| week_change | The percentage change between the open price on the first trading day and the close price approximately a week after the first trading day (only available for priced IPOs). (provider: intrinio) |
| month_change | The percentage change between the open price on the first trading day and the close price approximately a month after the first trading day (only available for priced IPOs). (provider: intrinio) |
| id | 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) |

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

@@ -1,37 +0,0 @@
<!-- 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. |

4
website/content/excel/reference/equity/compare/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "compare",
"position": 8
}

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

@@ -1,14 +0,0 @@
# compare
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="peers"
description="Equity Peers. Company peers."
url="compare/peers"
command
/>
</ul>

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

@@ -1,58 +0,0 @@
---
title: peers
description: Learn how to compare and analyze equity peers with the `obb.equity.compare.peers`
function. This function allows you to retrieve a list of company peers based on
symbol, sector, exchange, and market cap. Understand the parameters, returns, and
data structure provided by this function.
keywords:
- equity peers
- company peers
- compare peers
- symbol
- provider
- parameter
- returns
- data
- list of peers
- sector
- exchange
- market cap
- serializable results
- chart object
- metadata
- command execution
- warnings
---
<!-- markdownlint-disable MD041 -->
Equity Peers. Company peers.
## Syntax
```excel wordwrap
=OBB.EQUITY.COMPARE.PEERS(symbol;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.COMPARE.PEERS("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| peers_list | A list of equity peers based on sector, exchange and market cap. |

4
website/content/excel/reference/equity/discovery/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "discovery",
"position": 3
}

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

@@ -1,50 +0,0 @@
---
title: filings
description: Get the most-recent filings submitted to the SEC
keywords:
- equity
- discovery
- filings
---
<!-- markdownlint-disable MD041 -->
Get the most-recent filings submitted to the SEC.
## Syntax
```excel wordwrap
=OBB.EQUITY.DISCOVERY.FILINGS([start_date];[end_date];[form_type];[limit];[provider];[isDone])
```
### Example
```excel wordwrap
=OBB.EQUITY.DISCOVERY.FILINGS()
```
---
## 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 |
| 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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| cik | Central Index Key (CIK) for the requested entity. |
| title | Title of the filing. |
| date | The date of the data. |
| form_type | The form type of the filing |
| link | URL to the filing page on the SEC site. |

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

@@ -1,14 +0,0 @@
# discovery
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="filings"
description="Get the most-recent filings submitted to the SEC."
url="discovery/filings"
command
/>
</ul>

4
website/content/excel/reference/equity/estimates/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "estimates",
"position": 2
}

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

@@ -1,58 +0,0 @@
---
title: consensus
description: Learn how to access and use the Price Target Consensus functionality
in your application. Explore the available parameters and understand the returned
data structure.
keywords:
- Price target consensus data
- equity estimates consensus
- symbol parameter
- provider parameter
- results attribute
- provider attribute
- warnings attribute
- chart attribute
- metadata attribute
- data table
- target_high column
- target_low column
- target_consensus column
- target_median column
---
<!-- markdownlint-disable MD041 -->
Price Target Consensus. Price target consensus data.
## Syntax
```excel wordwrap
=OBB.EQUITY.ESTIMATES.CONSENSUS(symbol;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.ESTIMATES.CONSENSUS("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| target_high | High target of the price target consensus. |
| target_low | Low target of the price target consensus. |
| target_consensus | Consensus target of the price target consensus. |
| target_median | Median target of the price target consensus. |

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

@@ -1,112 +0,0 @@
---
title: historical
description: Learn about historical analyst estimates and analyst stock recommendations
with the OBBPy library in Python. Explore the usage of the `obb.equity.estimates.historical`
function and its parameters, including `symbol`, `period`, `limit`, and `provider`.
Understand the structure of the returned object, `OBBject`, with `results`, `provider`,
`warnings`, `chart`, and `metadata` properties. Dive into the available data such
as `symbol`, `date`, `estimated revenue`, `ebitda`, `ebit`, `net income`, `SGA expense`,
`EPS`, and the number of analysts who estimated revenue and EPS.
keywords:
- historical analyst estimates
- analyst stock recommendations
- python obb.equity.estimates.historical
- parameters
- standard
- symbol
- union[str, list[str]]
- period
- literal['quarter', 'annual']
- limit
- int
- provider
- literal['fmp']
- returns
- obbject
- list[analystestimates]
- serializable results
- optional[literal['fmp']]
- optional[list[warning_]]
- optional[chart]
- optional[metadata]
- data
- symbol
- str
- date
- estimated revenue low
- estimated revenue high
- estimated revenue average
- estimated ebitda low
- estimated ebitda high
- estimated ebitda average
- estimated ebit low
- estimated ebit high
- estimated ebit average
- estimated net income low
- estimated net income high
- estimated net income average
- estimated sga expense low
- estimated sga expense high
- estimated sga expense average
- estimated eps average
- estimated eps high
- estimated eps low
- number of analysts who estimated revenue
- number of analysts who estimated eps
---
<!-- markdownlint-disable MD041 -->
Historical Analyst Estimates. Analyst stock recommendations.
## Syntax
```excel wordwrap
=OBB.EQUITY.ESTIMATES.HISTORICAL(symbol;[period];[limit];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.ESTIMATES.HISTORICAL("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| date | The date of the data. |
| estimated_revenue_low | Estimated revenue low. |
| estimated_revenue_high | Estimated revenue high. |
| estimated_revenue_avg | Estimated revenue average. |
| estimated_ebitda_low | Estimated EBITDA low. |
| estimated_ebitda_high | Estimated EBITDA high. |
| estimated_ebitda_avg | Estimated EBITDA average. |
| estimated_ebit_low | Estimated EBIT low. |
| estimated_ebit_high | Estimated EBIT high. |
| estimated_ebit_avg | Estimated EBIT average. |
| estimated_net_income_low | Estimated net income low. |
| estimated_net_income_high | Estimated net income high. |
| estimated_net_income_avg | Estimated net income average. |
| estimated_sga_expense_low | Estimated SGA expense low. |
| estimated_sga_expense_high | Estimated SGA expense high. |
| estimated_sga_expense_avg | Estimated SGA expense average. |
| estimated_eps_avg | Estimated EPS average. |
| estimated_eps_high | Estimated EPS high. |
| estimated_eps_low | Estimated EPS low. |
| number_analyst_estimated_revenue | Number of analysts who estimated revenue. |
| number_analysts_estimated_eps | Number of analysts who estimated EPS. |

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

@@ -1,24 +0,0 @@
# estimates
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="consensus"
description="Price Target Consensus. Price target consensus data."
url="estimates/consensus"
command
/><ReferenceCard
title="price_target"
description="Price Target. Price target data."
url="estimates/price_target"
command
/><ReferenceCard
title="historical"
description="Historical Analyst Estimates. Analyst stock recommendations."
url="estimates/historical"
command
/>
</ul>

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

@@ -1,69 +0,0 @@
---
title: price_target
description: Get price target data for an equity symbol. Retrieve information such
as publication date, analyst details, price target, and more. Supports multiple
symbols and customizable providers.
keywords:
- price target data
- equity estimates
- symbol
- provider
- grade
- published date
- news URL
- news title
- analyst name
- analyst company
- price target
- adjusted price target
- price when posted
- news publisher
- news base URL
---
<!-- markdownlint-disable MD041 -->
Price Target. Price target data.
## Syntax
```excel wordwrap
=OBB.EQUITY.ESTIMATES.PRICE_TARGET(symbol;[provider];[with_grade])
```
### Example
```excel wordwrap
=OBB.EQUITY.ESTIMATES.PRICE_TARGET("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| published_date | Published date of the price target. |
| news_url | News URL of the price target. |
| news_title | News title of the price target. |
| analyst_name | Analyst name. |
| analyst_company | Analyst company. |
| price_target | Price target. |
| adj_price_target | Adjusted price target. |
| price_when_posted | Price when posted. |
| news_publisher | News publisher of the price target. |
| news_base_url | News base URL of the price target. |
| new_grade | New grade (provider: fmp) |
| previous_grade | Previous grade (provider: fmp) |
| grading_company | Grading company (provider: fmp) |

4
website/content/excel/reference/equity/fundamental/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "fundamental",
"position": 4
}

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

@@ -1,190 +0,0 @@
---
title: balance
description: Learn how to use the balance sheet function in Python to retrieve financial
statement data. This documentation provides details about the function parameters,
return values, and available data types.
keywords:
- balance sheet statement
- balance sheet function
- python function
- financial statement function
- balance sheet data parameters
- balance sheet data returns
- balance sheet data types
---
<!-- markdownlint-disable MD041 -->
Balance Sheet. Balance sheet statement.
## Syntax
```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
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.BALANCE("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| 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) |

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

@@ -1,125 +0,0 @@
---
title: balance_growth
description: Learn about balance sheet statement growth, equity data for a company,
parameters like symbol, limit, and provider, and explore the returned results, warnings,
charts, and metadata. Retrieve detailed data on various balance sheet growth metrics
like cash and cash equivalents, short-term investments, inventory, total assets,
total liabilities, and more.
keywords:
- balance sheet statement growth
- company balance sheet growth
- equity data
- symbol
- limit parameter
- provider parameter
- results
- balance sheet growth
- warnings
- chart
- metadata
- data
- cash and cash equivalents
- short-term investments
- net receivables
- inventory
- current assets
- property, plant, and equipment
- goodwill
- intangible assets
- long-term investments
- tax assets
- other non-current assets
- total non-current assets
- other assets
- total assets
- accounts payable
- short-term debt
- total current liabilities
- long-term debt
- non-current deferred revenue
- non-current deferred tax liabilities
- total non-current liabilities
- common stock
- retained earnings
- accumulated other comprehensive income/loss
- total stockholders' equity
- total liabilities and stockholders' equity
- total investments
- total debt
- net debt
---
<!-- markdownlint-disable MD041 -->
Balance Sheet Statement Growth. Information about the growth of the company balance sheet.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.BALANCE_GROWTH(symbol;[limit];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.BALANCE_GROWTH("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| date | The date of the data. |
| period | Reporting period. |
| growth_cash_and_cash_equivalents | Growth rate of cash and cash equivalents. |
| growth_short_term_investments | Growth rate of short-term investments. |
| growth_cash_and_short_term_investments | Growth rate of cash and short-term investments. |
| growth_net_receivables | Growth rate of net receivables. |
| growth_inventory | Growth rate of inventory. |
| growth_other_current_assets | Growth rate of other current assets. |
| growth_total_current_assets | Growth rate of total current assets. |
| growth_property_plant_equipment_net | Growth rate of net property, plant, and equipment. |
| growth_goodwill | Growth rate of goodwill. |
| growth_intangible_assets | Growth rate of intangible assets. |
| growth_goodwill_and_intangible_assets | Growth rate of goodwill and intangible assets. |
| growth_long_term_investments | Growth rate of long-term investments. |
| growth_tax_assets | Growth rate of tax assets. |
| growth_other_non_current_assets | Growth rate of other non-current assets. |
| growth_total_non_current_assets | Growth rate of total non-current assets. |
| growth_other_assets | Growth rate of other assets. |
| growth_total_assets | Growth rate of total assets. |
| growth_account_payables | Growth rate of accounts payable. |
| growth_short_term_debt | Growth rate of short-term debt. |
| growth_tax_payables | Growth rate of tax payables. |
| growth_deferred_revenue | Growth rate of deferred revenue. |
| growth_other_current_liabilities | Growth rate of other current liabilities. |
| growth_total_current_liabilities | Growth rate of total current liabilities. |
| growth_long_term_debt | Growth rate of long-term debt. |
| growth_deferred_revenue_non_current | Growth rate of non-current deferred revenue. |
| growth_deferrred_tax_liabilities_non_current | Growth rate of non-current deferred tax liabilities. |
| growth_other_non_current_liabilities | Growth rate of other non-current liabilities. |
| growth_total_non_current_liabilities | Growth rate of total non-current liabilities. |
| growth_other_liabilities | Growth rate of other liabilities. |
| growth_total_liabilities | Growth rate of total liabilities. |
| growth_common_stock | Growth rate of common stock. |
| growth_retained_earnings | Growth rate of retained earnings. |
| growth_accumulated_other_comprehensive_income_loss | Growth rate of accumulated other comprehensive income/loss. |
| growth_othertotal_stockholders_equity | Growth rate of other total stockholders' equity. |
| growth_total_stockholders_equity | Growth rate of total stockholders' equity. |
| growth_total_liabilities_and_stockholders_equity | Growth rate of total liabilities and stockholders' equity. |
| growth_total_investments | Growth rate of total investments. |
| growth_total_debt | Growth rate of total debt. |
| growth_net_debt | Growth rate of net debt. |

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

@@ -1,179 +0,0 @@
---
title: cash
description: Learn how to use the Cash Flow Statement API endpoint to retrieve information
about cash flow statements. Understand the parameters and return values of the API,
and explore the available data fields for cash flow statements.
keywords:
- Cash Flow Statement
- cash flow statement parameters
- cash flow statement returns
- cash flow statement data
- python obb.equity.fundamental.cash
- symbol
- period
- limit
- provider
- cik
- filing date
- period of report date
- include sources
- order
- sort
- net income
- depreciation and amortization
- stock based compensation
- deferred income tax
- other non-cash items
- changes in operating assets and liabilities
- accounts receivables
- inventory
- vendor non-trade receivables
- other current and non-current assets
- accounts payables
- deferred revenue
- other current and non-current liabilities
- net cash flow from operating activities
- purchases of marketable securities
- sales from maturities of investments
- investments in property plant and equipment
- payments from acquisitions
- other investing activities
- net cash flow from investing activities
- taxes paid on net share settlement
- dividends paid
- common stock repurchased
- debt proceeds
- debt repayment
- other financing activities
- net cash flow from financing activities
- net change in cash
---
<!-- markdownlint-disable MD041 -->
Cash Flow Statement. Information about the cash flow statement.
## Syntax
```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
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.CASH("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| 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) |
| 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 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 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) |

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

@@ -1,113 +0,0 @@
---
title: cash_growth
description: Learn about Cash Flow Statement Growth and how to retrieve cash growth
data using the Python function obb.equity.fundamental.cash_growth(). This page provides
details on the function's parameters and the data it returns, including information
on net income, depreciation and amortization, working capital, investments, financing
activities, and more.
keywords:
- Cash Flow Statement Growth
- company cash flow
- cash growth
- Python
- function
- parameters
- symbol
- limit
- provider
- data
- returns
- net income
- depreciation and amortization
- deferred income tax
- stock-based compensation
- working capital
- accounts receivables
- inventory
- accounts payables
- other non-cash items
- net cash provided by operating activities
- investments in property, plant, and equipment
- net acquisitions
- purchases of investments
- sales maturities of investments
- net cash used for investing activities
- debt repayment
- common stock issued
- common stock repurchased
- dividends paid
- net cash used/provided by financing activities
- foreign exchange changes on cash
- net change in cash
- cash at end of period
- cash at beginning of period
- operating cash flow
- capital expenditure
- free cash flow
---
<!-- markdownlint-disable MD041 -->
Cash Flow Statement Growth. Information about the growth of the company cash flow statement.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.CASH_GROWTH(symbol;[limit];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.CASH_GROWTH("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| date | The date of the data. |
| period | Period the statement is returned for. |
| growth_net_income | Growth rate of net income. |
| growth_depreciation_and_amortization | Growth rate of depreciation and amortization. |
| growth_deferred_income_tax | Growth rate of deferred income tax. |
| growth_stock_based_compensation | Growth rate of stock-based compensation. |
| growth_change_in_working_capital | Growth rate of change in working capital. |
| growth_accounts_receivables | Growth rate of accounts receivables. |
| growth_inventory | Growth rate of inventory. |
| growth_accounts_payables | Growth rate of accounts payables. |
| growth_other_working_capital | Growth rate of other working capital. |
| growth_other_non_cash_items | Growth rate of other non-cash items. |
| growth_net_cash_provided_by_operating_activities | Growth rate of net cash provided by operating activities. |
| growth_investments_in_property_plant_and_equipment | Growth rate of investments in property, plant, and equipment. |
| growth_acquisitions_net | Growth rate of net acquisitions. |
| growth_purchases_of_investments | Growth rate of purchases of investments. |
| growth_sales_maturities_of_investments | Growth rate of sales maturities of investments. |
| growth_other_investing_activities | Growth rate of other investing activities. |
| growth_net_cash_used_for_investing_activities | Growth rate of net cash used for investing activities. |
| growth_debt_repayment | Growth rate of debt repayment. |
| growth_common_stock_issued | Growth rate of common stock issued. |
| growth_common_stock_repurchased | Growth rate of common stock repurchased. |
| growth_dividends_paid | Growth rate of dividends paid. |
| growth_other_financing_activities | Growth rate of other financing activities. |
| growth_net_cash_used_provided_by_financing_activities | Growth rate of net cash used/provided by financing activities. |
| growth_effect_of_forex_changes_on_cash | Growth rate of the effect of foreign exchange changes on cash. |
| growth_net_change_in_cash | Growth rate of net change in cash. |
| growth_cash_at_end_of_period | Growth rate of cash at the end of the period. |
| growth_cash_at_beginning_of_period | Growth rate of cash at the beginning of the period. |
| growth_operating_cash_flow | Growth rate of operating cash flow. |
| growth_capital_expenditure | Growth rate of capital expenditure. |
| growth_free_cash_flow | Growth rate of free cash flow. |

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

@@ -1,68 +0,0 @@
---
title: dividends
description: Get historical dividends data for a given company with the OBB.equity.fundamental.dividends
function. Explore parameters like symbol and provider, and understand the returned
results, warnings, and metadata. View the data fields, including date, label, adj_dividend,
dividend, record_date, payment_date, and declaration_date.
keywords:
- historical dividends
- dividends data
- company dividends
- symbol
- data provider
- default provider
- results
- warnings
- chart
- metadata
- date
- label
- adj_dividend
- dividend
- record_date
- payment_date
- declaration_date
---
<!-- markdownlint-disable MD041 -->
Historical Dividends. Historical dividends data for a given company.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.DIVIDENDS(symbol;[provider];[page_size])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.DIVIDENDS("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| dividend | Dividend 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) |

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

@@ -1,65 +0,0 @@
---
title: employee_count
description: Learn how to retrieve historical employee count data using the Python
API. Understand the parameters, returns, and data structure for the OBB.equity.fundamental.employee_count
method.
keywords:
- historical employees
- employee count
- Python API
- data retrieval
- symbol
- provider
- warnings
- chart object
- metadata
- data
- CIK
- acceptance time
- period of report
- company name
- form type
- filing date
- source URL
---
<!-- markdownlint-disable MD041 -->
Historical Employees. Historical number of employees.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT(symbol;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| cik | Central Index Key (CIK) for the requested entity. |
| acceptance_time | Time of acceptance of the company employee. |
| period_of_report | Date of reporting of the company employee. |
| company_name | Registered name of the company to retrieve the historical employees of. |
| form_type | Form type of the company employee. |
| filing_date | Filing date of the company employee |
| employee_count | Count of employees of the company. |
| source | Source URL which retrieves this data for the company. |

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

@@ -1,100 +0,0 @@
---
title: filings
description: Learn how to retrieve company filings data such as date, type of document,
and link. Understand the available parameters to filter the data, including symbol,
limit, provider, type, and page. Explore the different fields in the data, such
as ticker symbol, accepted date, and final link.
keywords:
- company filings
- data entries
- symbol
- limit
- provider
- type
- page
- cik
- date
- link
- ticker symbol
- accepted date
- final link
- report date
- act
- items
- primary doc description
- primary doc
- accession number
- file number
- film number
- is inline xbrl
- is xbrl
- size
- complete submission url
- filing detail url
- xml
---
<!-- markdownlint-disable MD041 -->
Company Filings. Company filings data.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.FILINGS([symbol];[provider];[form_type];[limit];[start_date];[end_date];[thea_enabled];[cik];[use_cache])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.FILINGS()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| cik | Central Index Key (CIK) for the requested entity. |
| filing_date | Filing date of the SEC report. |
| accepted_date | Accepted date of the SEC report. |
| report_type | Type of the SEC report. |
| filing_url | URL to the filing page on the SEC site. |
| report_url | URL to the actual report on the SEC site. |
| id | Intrinio ID of the filing. (provider: intrinio) |
| period_end_date | Ending date of the fiscal period for the filing. (provider: intrinio) |
| sec_unique_id | SEC unique ID of the filing. (provider: intrinio) |
| instance_url | URL for the XBRL filing for the report. (provider: intrinio) |
| industry_group | Industry group of the company. (provider: intrinio) |
| industry_category | Industry category of the company. (provider: intrinio) |
| report_date | The date of the filing. (provider: sec) |
| act | The SEC Act number. (provider: sec) |
| items | The SEC Item numbers. (provider: sec) |
| primary_doc_description | The description of the primary document. (provider: sec) |
| primary_doc | The filename of the primary document. (provider: sec) |
| accession_number | The accession number. (provider: sec) |
| file_number | The file number. (provider: sec) |
| film_number | The film number. (provider: sec) |
| is_inline_xbrl | Whether the filing is an inline XBRL filing. (provider: sec) |
| 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) |
| filing_detail_url | The URL to the filing details. (provider: sec) |

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

@@ -1,40 +0,0 @@
<!-- markdownlint-disable MD041 -->
Fetch the historical values of a data tag from Intrinio.
## Syntax
```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")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| value | The value of the data. |

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

@@ -1,51 +0,0 @@
---
title: historical_eps
description: Historical earnings-per-share for a given company
keywords:
- equity
- fundamental
- historical_eps
---
<!-- markdownlint-disable MD041 -->
Historical earnings-per-share for a given company.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_EPS(symbol;[provider];[limit])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_EPS("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| symbol | Symbol representing the entity requested in the data. |
| announce_time | Timing of the earnings announcement. |
| eps_actual | Actual EPS from the earnings date. |
| eps_estimated | Estimated EPS for the earnings date. |
| revenue_estimated | Estimated consensus revenue for the reporting period. (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) |

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

@@ -1,59 +0,0 @@
---
title: historical_splits
description: Learn how to retrieve historical stock splits data using the Python obb.equity.fundamental.historical_splits
function. Understand the parameters, returns, and data structure for this API call.
keywords:
- historical stock splits
- stock splits data
- python obb.equity.fundamental.historical_splits
- parameters
- symbol
- provider
- returns
- results
- provider name
- warnings
- chart object
- metadata
- data
- date
- label
- numerator
- denominator
---
<!-- markdownlint-disable MD041 -->
Historical Splits. Historical splits data.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS(symbol;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| label | Label of the historical stock splits. |
| numerator | Numerator of the historical stock splits. |
| denominator | Denominator of the historical stock splits. |

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

@@ -1,215 +0,0 @@
---
title: income
description: Get income statement and financial performance data for a company. Parameters
include symbol, period, limit, provider, and more. Data includes revenue, gross
profit, operating expenses, net income, and more.
keywords:
- income statement
- financial performance
- get income data
- period
- limit
- provider
- symbol
- cik
- filing date
- period of report date
- include sources
- order
- sort
- revenue
- cost of revenue
- gross profit
- cost and expenses
- research and development expenses
- general and administrative expenses
- selling and marketing expenses
- other expenses
- operating expenses
- depreciation and amortization
- ebitda
- operating income
- interest income
- interest expense
- income before tax
- income tax expense
- net income
- eps
- weighted average shares outstanding
- link
- reported currency
- filling date
- accepted date
- calendar year
---
<!-- markdownlint-disable MD041 -->
Income Statement. Report on a company's financial performance.
## Syntax
```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
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.INCOME("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| 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) |
| 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) |

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

@@ -1,108 +0,0 @@
---
title: income_growth
description: Explore the growth of a company's income statement with the Python function
obb.equity.fundamental.income_growth. Retrieve data for symbols, specify the limit,
period, and provider, and get detailed information on various aspects of the income
statement growth.
keywords:
- income statement growth
- company income statement
- python obb.equity.fundamental.income_growth
- symbol
- limit
- period
- provider
- data entries
- time period
- provider name
- warnings
- chart object
- metadata
- symbol data
- date
- growth revenue
- cost of goods sold
- gross profit
- gross profit ratio
- research and development expenses
- general and administrative expenses
- selling and marketing expenses
- operating expenses
- total costs and expenses
- interest expenses
- depreciation and amortization expenses
- ebitda
- ebitda ratio
- operating income
- operating income ratio
- total other income expenses net
- income before tax
- income tax expenses
- net income
- eps
- eps diluted
- weighted average shares outstanding
---
<!-- markdownlint-disable MD041 -->
Income Statement Growth. Information about the growth of the company income statement.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.INCOME_GROWTH(symbol;[limit];[period];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.INCOME_GROWTH("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| date | The date of the data. |
| period | Period the statement is returned for. |
| growth_revenue | Growth rate of total revenue. |
| growth_cost_of_revenue | Growth rate of cost of goods sold. |
| growth_gross_profit | Growth rate of gross profit. |
| growth_gross_profit_ratio | Growth rate of gross profit as a percentage of revenue. |
| growth_research_and_development_expenses | Growth rate of expenses on research and development. |
| growth_general_and_administrative_expenses | Growth rate of general and administrative expenses. |
| growth_selling_and_marketing_expenses | Growth rate of expenses on selling and marketing activities. |
| growth_other_expenses | Growth rate of other operating expenses. |
| growth_operating_expenses | Growth rate of total operating expenses. |
| growth_cost_and_expenses | Growth rate of total costs and expenses. |
| growth_interest_expense | Growth rate of interest expenses. |
| growth_depreciation_and_amortization | Growth rate of depreciation and amortization expenses. |
| growth_ebitda | Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization. |
| growth_ebitda_ratio | Growth rate of EBITDA as a percentage of revenue. |
| growth_operating_income | Growth rate of operating income. |
| growth_operating_income_ratio | Growth rate of operating income as a percentage of revenue. |
| growth_total_other_income_expenses_net | Growth rate of net total other income and expenses. |
| growth_income_before_tax | Growth rate of income before taxes. |
| growth_income_before_tax_ratio | Growth rate of income before taxes as a percentage of revenue. |
| growth_income_tax_expense | Growth rate of income tax expenses. |
| growth_net_income | Growth rate of net income. |
| growth_net_income_ratio | Growth rate of net income as a percentage of revenue. |
| growth_eps | Growth rate of Earnings Per Share (EPS). |
| growth_eps_diluted | Growth rate of diluted Earnings Per Share (EPS). |
| growth_weighted_average_shs_out | Growth rate of weighted average shares outstanding. |
| growth_weighted_average_shs_out_dil | Growth rate of diluted weighted average shares outstanding. |

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

@@ -1,134 +0,0 @@
# fundamental
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="historical_eps"
description="Historical earnings-per-share for a given company."
url="fundamental/historical_eps"
command
/><ReferenceCard
title="filings"
description="Company Filings. Company filings data."
url="fundamental/filings"
command
/><ReferenceCard
title="management"
description="Key Executives. Key executives for a given company."
url="fundamental/management"
command
/><ReferenceCard
title="overview"
description="Company Overview. General information about a company."
url="fundamental/overview"
command
/><ReferenceCard
title="management_compensation"
description="Get Executive Compensation. Information about the executive compensation for a given company."
url="fundamental/management_compensation"
command
/><ReferenceCard
title="dividends"
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."
url="fundamental/balance"
command
/><ReferenceCard
title="balance_growth"
description="Balance Sheet Statement Growth. Information about the growth of the company balance sheet."
url="fundamental/balance_growth"
command
/><ReferenceCard
title="historical_attributes"
description="Fetch the historical values of a data tag from Intrinio."
url="fundamental/historical_attributes"
command
/><ReferenceCard
title="ratios"
description="Extensive set of ratios over time. Financial ratios for a given company."
url="fundamental/ratios"
command
/><ReferenceCard
title="multiples"
description="Equity Valuation Multiples. Valuation multiples for a stock ticker."
url="fundamental/multiples"
command
/><ReferenceCard
title="employee_count"
description="Historical Employees. Historical number of employees."
url="fundamental/employee_count"
command
/><ReferenceCard
title="revenue_per_segment"
description="Revenue Business Line. Business line revenue data."
url="fundamental/revenue_per_segment"
command
/><ReferenceCard
title="trailing_dividend_yield"
description="Trailing 1yr dividend yield."
url="fundamental/trailing_dividend_yield"
command
/><ReferenceCard
title="revenue_per_geography"
description="Revenue Geographic. Geographic revenue data."
url="fundamental/revenue_per_geography"
command
/><ReferenceCard
title="income_growth"
description="Income Statement Growth. Information about the growth of the company income statement."
url="fundamental/income_growth"
command
/><ReferenceCard
title="historical_splits"
description="Historical Splits. Historical splits data."
url="fundamental/historical_splits"
command
/><ReferenceCard
title="transcript"
description="Earnings Call Transcript. Earnings call transcript for a given company."
url="fundamental/transcript"
command
/><ReferenceCard
title="cash"
description="Cash Flow Statement. Information about the cash flow statement."
url="fundamental/cash"
command
/><ReferenceCard
title="income"
description="Income Statement. Report on a company's financial performance."
url="fundamental/income"
command
/><ReferenceCard
title="metrics"
description="Key Metrics. Key metrics for a given company."
url="fundamental/metrics"
command
/><ReferenceCard
title="latest_attributes"
description="Fetch the latest value of a data tag from Intrinio."
url="fundamental/latest_attributes"
command
/><ReferenceCard
title="search_attributes"
description="Search Intrinio data tags."
url="fundamental/search_attributes"
command
/><ReferenceCard
title="cash_growth"
description="Cash Flow Statement Growth. Information about the growth of the company cash flow statement."
url="fundamental/cash_growth"
command
/>
</ul>

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

@@ -1,33 +0,0 @@
<!-- markdownlint-disable MD041 -->
Fetch the latest value of a data tag from Intrinio.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES(symbol;tag;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES("AAPL";"ebitda")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| value | The value of the data. |

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

@@ -1,57 +0,0 @@
---
title: management
description: Learn about key executives for a company and how to retrieve their data
using the `obb.equity.fundamental.management` function. Get details such as designation,
name, pay, currency, gender, birth year, and title since.
keywords:
- key executives
- company executives
- symbol
- data
- designation
- name
- pay
- currency
- gender
- birth year
- title since
---
<!-- markdownlint-disable MD041 -->
Key Executives. Key executives for a given company.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT(symbol;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| title | Designation of the key executive. |
| name | Name of the key executive. |
| pay | Pay of the key executive. |
| currency_pay | Currency of the pay. |
| gender | Gender of the key executive. |
| year_born | Birth year of the key executive. |
| title_since | Date the tile was held since. |

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

@@ -1,73 +0,0 @@
---
title: management_compensation
description: Learn how to retrieve executive compensation data for a company using
the equity management compensation function in Python. Understand the parameters,
return values, and available data fields such as symbol, salary, bonus, stock award,
and more.
keywords:
- executive compensation
- company executive compensation
- equity management compensation
- symbol parameter
- provider parameter
- return values
- data
- symbol
- cik
- filing date
- accepted date
- name and position
- year of compensation
- salary
- bonus
- stock award
- incentive plan compensation
- all other compensation
- total compensation
- URL
---
<!-- markdownlint-disable MD041 -->
Get Executive Compensation. Information about the executive compensation for a given company.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION(symbol;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| cik | Central Index Key (CIK) for the requested entity. |
| filing_date | Date of the filing. |
| accepted_date | Date the filing was accepted. |
| name_and_position | Name and position of the executive. |
| year | Year of the compensation. |
| salary | Salary of the executive. |
| bonus | Bonus of the executive. |
| stock_award | Stock award of the executive. |
| incentive_plan_compensation | Incentive plan compensation of the executive. |
| all_other_compensation | All other compensation of the executive. |
| total | Total compensation of the executive. |
| url | URL of the filing data. |

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

@@ -1,175 +0,0 @@
---
title: metrics
description: Learn about key metrics for a given company using the `obb.equity.fundamental.metrics`
Python function. This API endpoint provides data such as revenue per share, net
income per share, market capitalization, price-to-earnings ratio, and more. Explore
the available parameters and returned data to analyze financial performance. Full
documentation and usage examples available.
keywords:
- key metrics
- python function
- documentation
- API
- parameters
- returns
- data
- symbol
- period
- limit
- provider
- with_ttm
- revenue per share
- net income per share
- operating cash flow per share
- free cash flow per share
- cash per share
- book value per share
- tangible book value per share
- shareholders equity per share
- interest debt per share
- market capitalization
- enterprise value
- price-to-earnings ratio
- price-to-sales ratio
- price-to-operating cash flow ratio
- price-to-free cash flow ratio
- price-to-book ratio
- price-to-tangible book ratio
- earnings yield
- free cash flow yield
- debt-to-equity ratio
- debt-to-assets ratio
- net debt-to-EBITDA ratio
- current ratio
- interest coverage
- income quality
- dividend yield
- payout ratio
- sales general and administrative expenses-to-revenue ratio
- research and development expenses-to-revenue ratio
- intangibles-to-total assets ratio
- capital expenditures-to-operating cash flow ratio
- capital expenditures-to-revenue ratio
- capital expenditures-to-depreciation ratio
- stock-based compensation-to-revenue ratio
- Graham number
- return on invested capital
- return on tangible assets
- Graham net-net working capital
- working capital
- tangible asset value
- net current asset value
- invested capital
- average receivables
- average payables
- average inventory
- days sales outstanding
- days payables outstanding
- days of inventory on hand
- receivables turnover
- payables turnover
- inventory turnover
- return on equity
- capital expenditures per share
- calendar year
---
<!-- markdownlint-disable MD041 -->
Key Metrics. Key metrics for a given company.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.METRICS(symbol;[period];[limit];[provider];[with_ttm])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.METRICS("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| market_cap | Market capitalization |
| pe_ratio | Price-to-earnings ratio (P/E ratio) |
| date | The date of the data. (provider: fmp) |
| period | Period of the data. (provider: fmp) |
| calendar_year | Calendar year. (provider: fmp) |
| revenue_per_share | Revenue per share (provider: fmp) |
| net_income_per_share | Net income per share (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) |
| book_value_per_share | Book value per share (provider: fmp) |
| tangible_book_value_per_share | Tangible book value per share (provider: fmp) |
| shareholders_equity_per_share | Shareholders equity per share (provider: fmp) |
| interest_debt_per_share | Interest debt per share (provider: fmp) |
| enterprise_value | Enterprise value (provider: fmp) |
| price_to_sales_ratio | Price-to-sales ratio (provider: fmp) |
| pocf_ratio | Price-to-operating cash flow ratio (provider: fmp) |
| pfcf_ratio | Price-to-free cash flow ratio (provider: fmp) |
| pb_ratio | Price-to-book ratio (provider: fmp) |
| ptb_ratio | Price-to-tangible book ratio (provider: fmp) |
| ev_to_sales | Enterprise value-to-sales ratio (provider: fmp) |
| enterprise_value_over_ebitda | Enterprise value-to-EBITDA ratio (provider: fmp) |
| ev_to_operating_cash_flow | Enterprise value-to-operating cash flow ratio (provider: fmp) |
| ev_to_free_cash_flow | Enterprise value-to-free cash flow ratio (provider: fmp) |
| earnings_yield | Earnings yield (provider: fmp) |
| free_cash_flow_yield | Free cash flow yield (provider: fmp) |
| debt_to_equity | Debt-to-equity ratio (provider: fmp) |
| debt_to_assets | Debt-to-assets ratio (provider: fmp) |
| net_debt_to_ebitda | Net debt-to-EBITDA ratio (provider: fmp) |
| current_ratio | Current ratio (provider: fmp) |
| interest_coverage | Interest coverage (provider: fmp) |
| income_quality | Income quality (provider: fmp) |
| dividend_yield | Dividend yield (provider: fmp, intrinio) |
| payout_ratio | Payout ratio (provider: fmp) |
| sales_general_and_administrative_to_revenue | Sales general and administrative expenses-to-revenue ratio (provider: fmp) |
| research_and_development_to_revenue | Research and development expenses-to-revenue ratio (provider: fmp) |
| intangibles_to_total_assets | Intangibles-to-total assets ratio (provider: fmp) |
| capex_to_operating_cash_flow | Capital expenditures-to-operating cash flow ratio (provider: fmp) |
| capex_to_revenue | Capital expenditures-to-revenue ratio (provider: fmp) |
| capex_to_depreciation | Capital expenditures-to-depreciation ratio (provider: fmp) |
| stock_based_compensation_to_revenue | Stock-based compensation-to-revenue ratio (provider: fmp) |
| graham_number | Graham number (provider: fmp) |
| roic | Return on invested capital (provider: fmp) |
| return_on_tangible_assets | Return on tangible assets (provider: fmp) |
| graham_net_net | Graham net-net working capital (provider: fmp) |
| working_capital | Working capital (provider: fmp) |
| tangible_asset_value | Tangible asset value (provider: fmp) |
| net_current_asset_value | Net current asset value (provider: fmp) |
| invested_capital | Invested capital (provider: fmp) |
| average_receivables | Average receivables (provider: fmp) |
| average_payables | Average payables (provider: fmp) |
| average_inventory | Average inventory (provider: fmp) |
| days_sales_outstanding | Days sales outstanding (provider: fmp) |
| days_payables_outstanding | Days payables outstanding (provider: fmp) |
| days_of_inventory_on_hand | Days of inventory on hand (provider: fmp) |
| receivables_turnover | Receivables turnover (provider: fmp) |
| payables_turnover | Payables turnover (provider: fmp) |
| inventory_turnover | Inventory turnover (provider: fmp) |
| roe | Return on equity (provider: fmp) |
| capex_per_share | Capital expenditures per share (provider: fmp) |
| beta | Beta (provider: intrinio) |
| volume | Volume (provider: intrinio) |
| fifty_two_week_high | 52 week high (provider: intrinio) |
| fifty_two_week_low | 52 week low (provider: intrinio) |

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

@@ -1,160 +0,0 @@
---
title: multiples
description: Learn how to calculate equity valuation multiples for a stock ticker
using the OBB Python function. Discover the available parameters and the data returned,
including revenue per share, net income per share, market capitalization, price-to-earnings
ratio, and more. Improve your investment analysis with this powerful tool.
keywords:
- equity valuation multiples
- stock ticker valuation
- python function
- parameters
- returns
- data
- revenue per share
- net income per share
- operating cash flow per share
- free cash flow per share
- cash per share
- book value per share
- tangible book value per share
- shareholders equity per share
- market capitalization
- price-to-earnings ratio
- price-to-sales ratio
- price-to-operating cash flow ratio
- price-to-free cash flow ratio
- price-to-book ratio
- price-to-tangible book ratio
- enterprise value-to-sales ratio
- enterprise value-to-EBITDA ratio
- earnings yield
- free cash flow yield
- debt-to-equity ratio
- debt-to-assets ratio
- net debt-to-EBITDA ratio
- current ratio
- interest coverage
- income quality
- dividend yield
- payout ratio
- sales general and administrative expenses-to-revenue ratio
- research and development expenses-to-revenue ratio
- intangibles-to-total assets ratio
- capital expenditures-to-operating cash flow ratio
- capital expenditures-to-revenue ratio
- capital expenditures-to-depreciation ratio
- stock-based compensation-to-revenue ratio
- graham number
- return on invested capital
- return on tangible assets
- graham net-net working capital
- working capital
- tangible asset value
- net current asset value
- invested capital
- average receivables
- average payables
- average inventory
- days sales outstanding
- days payables outstanding
- days of inventory on hand
- receivables turnover
- payables turnover
- inventory turnover
- return on equity
- capital expenditures per share
---
<!-- markdownlint-disable MD041 -->
Equity Valuation Multiples. Valuation multiples for a stock ticker.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.MULTIPLES(symbol;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.MULTIPLES("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| 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. |
| free_cash_flow_per_share_ttm | Free cash flow per share calculated as trailing twelve months. |
| cash_per_share_ttm | Cash per share calculated as trailing twelve months. |
| book_value_per_share_ttm | Book value per share calculated as trailing twelve months. |
| tangible_book_value_per_share_ttm | Tangible book value per share calculated as trailing twelve months. |
| shareholders_equity_per_share_ttm | Shareholders equity per share calculated as trailing twelve months. |
| interest_debt_per_share_ttm | Interest debt per share calculated as trailing twelve months. |
| market_cap_ttm | Market capitalization calculated as trailing twelve months. |
| enterprise_value_ttm | Enterprise value calculated as trailing twelve months. |
| pe_ratio_ttm | Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months. |
| price_to_sales_ratio_ttm | Price-to-sales ratio calculated as trailing twelve months. |
| pocf_ratio_ttm | Price-to-operating cash flow ratio calculated as trailing twelve months. |
| pfcf_ratio_ttm | Price-to-free cash flow ratio calculated as trailing twelve months. |
| pb_ratio_ttm | Price-to-book ratio calculated as trailing twelve months. |
| ptb_ratio_ttm | Price-to-tangible book ratio calculated as trailing twelve months. |
| ev_to_sales_ttm | Enterprise value-to-sales ratio calculated as trailing twelve months. |
| enterprise_value_over_ebitda_ttm | Enterprise value-to-EBITDA ratio calculated as trailing twelve months. |
| ev_to_operating_cash_flow_ttm | Enterprise value-to-operating cash flow ratio calculated as trailing twelve months. |
| ev_to_free_cash_flow_ttm | Enterprise value-to-free cash flow ratio calculated as trailing twelve months. |
| earnings_yield_ttm | Earnings yield calculated as trailing twelve months. |
| free_cash_flow_yield_ttm | Free cash flow yield calculated as trailing twelve months. |
| debt_to_equity_ttm | Debt-to-equity ratio calculated as trailing twelve months. |
| debt_to_assets_ttm | Debt-to-assets ratio calculated as trailing twelve months. |
| net_debt_to_ebitda_ttm | Net debt-to-EBITDA ratio calculated as trailing twelve months. |
| current_ratio_ttm | Current ratio calculated as trailing twelve months. |
| interest_coverage_ttm | Interest coverage calculated as trailing twelve months. |
| income_quality_ttm | Income quality calculated as trailing twelve months. |
| dividend_yield_ttm | Dividend yield calculated as trailing twelve months. |
| dividend_yield_percentage_ttm | Dividend yield percentage calculated as trailing twelve months. |
| dividend_to_market_cap_ttm | Dividend to market capitalization ratio calculated as trailing twelve months. |
| dividend_per_share_ttm | Dividend per share calculated as trailing twelve months. |
| payout_ratio_ttm | Payout ratio calculated as trailing twelve months. |
| sales_general_and_administrative_to_revenue_ttm | Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months. |
| research_and_development_to_revenue_ttm | Research and development expenses-to-revenue ratio calculated as trailing twelve months. |
| intangibles_to_total_assets_ttm | Intangibles-to-total assets ratio calculated as trailing twelve months. |
| capex_to_operating_cash_flow_ttm | Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months. |
| capex_to_revenue_ttm | Capital expenditures-to-revenue ratio calculated as trailing twelve months. |
| capex_to_depreciation_ttm | Capital expenditures-to-depreciation ratio calculated as trailing twelve months. |
| stock_based_compensation_to_revenue_ttm | Stock-based compensation-to-revenue ratio calculated as trailing twelve months. |
| graham_number_ttm | Graham number calculated as trailing twelve months. |
| roic_ttm | Return on invested capital calculated as trailing twelve months. |
| return_on_tangible_assets_ttm | Return on tangible assets calculated as trailing twelve months. |
| graham_net_net_ttm | Graham net-net working capital calculated as trailing twelve months. |
| working_capital_ttm | Working capital calculated as trailing twelve months. |
| tangible_asset_value_ttm | Tangible asset value calculated as trailing twelve months. |
| net_current_asset_value_ttm | Net current asset value calculated as trailing twelve months. |
| invested_capital_ttm | Invested capital calculated as trailing twelve months. |
| average_receivables_ttm | Average receivables calculated as trailing twelve months. |
| average_payables_ttm | Average payables calculated as trailing twelve months. |
| average_inventory_ttm | Average inventory calculated as trailing twelve months. |
| days_sales_outstanding_ttm | Days sales outstanding calculated as trailing twelve months. |
| days_payables_outstanding_ttm | Days payables outstanding calculated as trailing twelve months. |
| days_of_inventory_on_hand_ttm | Days of inventory on hand calculated as trailing twelve months. |
| receivables_turnover_ttm | Receivables turnover calculated as trailing twelve months. |
| payables_turnover_ttm | Payables turnover calculated as trailing twelve months. |
| inventory_turnover_ttm | Inventory turnover calculated as trailing twelve months. |
| roe_ttm | Return on equity calculated as trailing twelve months. |
| capex_per_share_ttm | Capital expenditures per share calculated as trailing twelve months. |

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

@@ -1,117 +0,0 @@
---
title: overview
description: Learn about the company overview and get essential information, including
symbol, price, beta, volume average, market capitalization, last dividend, industry,
website, CEO, sector, country, and more.
keywords:
- company overview
- overview symbol
- equity fundamental overview
- parameters
- returns
- data
- symbol
- price
- beta
- vol_avg
- mkt_cap
- last_div
- range
- changes
- company_name
- currency
- cik
- isin
- cusip
- exchange
- exchange_short_name
- industry
- website
- description
- ceo
- sector
- country
- full_time_employees
- phone
- address
- city
- state
- zip
- dcf_diff
- dcf
- image
- ipo_date
- default_image
- is_etf
- is_actively_trading
- is_adr
- is_fund
---
<!-- markdownlint-disable MD041 -->
Company Overview. General information about a company.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.OVERVIEW(symbol;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.OVERVIEW("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| price | Price of the company. |
| beta | Beta of the company. |
| vol_avg | Volume average of the company. |
| mkt_cap | Market capitalization of the company. |
| last_div | Last dividend of the company. |
| range | Range of the company. |
| changes | Changes of the company. |
| company_name | Company name of the company. |
| currency | Currency of the company. |
| cik | Central Index Key (CIK) for the requested entity. |
| isin | ISIN of the company. |
| cusip | CUSIP of the company. |
| exchange | Exchange of the company. |
| exchange_short_name | Exchange short name of the company. |
| industry | Industry of the company. |
| website | Website of the company. |
| description | Description of the company. |
| ceo | CEO of the company. |
| sector | Sector of the company. |
| country | Country of the company. |
| full_time_employees | Full time employees of the company. |
| phone | Phone of the company. |
| address | Address of the company. |
| city | City of the company. |
| state | State of the company. |
| zip | Zip of the company. |
| dcf_diff | Discounted cash flow difference of the company. |
| dcf | Discounted cash flow of the company. |
| image | Image of the company. |
| ipo_date | IPO date of the company. |
| default_image | If the image is the default image. |
| is_etf | If the company is an ETF. |
| is_actively_trading | If the company is actively trading. |
| is_adr | If the company is an ADR. |
| is_fund | If the company is a fund. |

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

@@ -1,119 +0,0 @@
---
title: ratios
description: Learn about financial ratios for a given company over time. Explore various
equity ratios, such as current ratio, quick ratio, and cash conversion cycle. Understand
key profitability metrics like return on equity and profit margin. Analyze debt
ratios, inventory turnover, and operating and free cash flows. Evaluate the price
to earnings ratio and dividend yield.
keywords:
- financial ratios
- company ratios
- ratios over time
- equity ratios
- current ratio
- quick ratio
- cash conversion cycle
- return on equity
- profit margin
- debt ratio
- inventory turnover
- operating cash flow
- free cash flow
- price to earnings ratio
- dividend yield
---
<!-- markdownlint-disable MD041 -->
Extensive set of ratios over time. Financial ratios for a given company.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.RATIOS(symbol;[period];[limit];[provider];[with_ttm];[fiscal_year])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.RATIOS("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| 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
View File

@@ -1,38 +0,0 @@
<!-- 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. |

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

@@ -1,69 +0,0 @@
---
title: revenue_per_geography
description: Learn about the revenue per geography data with the geographic revenue
data Python function in this documentation page. Understand the symbol, period,
structure, and provider parameters. Explore the returns, results, metadata, and
the data structure including the date, geographic segment, and revenue by region
(Americas, Europe, Greater China, Japan, Rest of Asia Pacific).
keywords:
- geographic revenue data
- revenue per geography
- Python function
- documentation page
- symbol parameter
- period parameter
- structure parameter
- provider parameter
- returns
- results
- metadata
- data
- date
- geographic segment
- Americas
- Europe
- Greater China
- Japan
- Rest of Asia Pacific
---
<!-- markdownlint-disable MD041 -->
Revenue Geographic. Geographic revenue data.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY(symbol;[period];[structure];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| geographic_segment | Day level data containing the revenue of the geographic segment. |
| americas | Revenue from the the American segment. |
| europe | Revenue from the the European segment. |
| greater_china | Revenue from the the Greater China segment. |
| japan | Revenue from the the Japan segment. |
| rest_of_asia_pacific | Revenue from the the Rest of Asia Pacific segment. |

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

@@ -1,56 +0,0 @@
---
title: revenue_per_segment
description: Learn how to get revenue data for a specific business line using the
equity fundamental revenue per segment function.
keywords:
- Revenue Business Line
- business line revenue data
- equity fundamental revenue per segment
- symbol
- period
- structure
- provider
- results
- RevenueBusinessLine
- chart
- metadata
- data
- date
- business line
---
<!-- markdownlint-disable MD041 -->
Revenue Business Line. Business line revenue data.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT(symbol;[period];[structure];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| business_line | Day level data containing the revenue of the business line. |

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

@@ -1,43 +0,0 @@
<!-- markdownlint-disable MD041 -->
Search Intrinio data tags.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES(query;[limit];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES("ebitda")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| id | ID of the financial attribute. |
| name | Name of the financial attribute. |
| tag | Tag of the financial attribute. |
| statement_code | Code of the financial statement. |
| statement_type | Type of the financial statement. |
| parent_name | Parent's name of the financial attribute. |
| sequence | Sequence of the financial statement. |
| factor | Unit of the financial attribute. |
| transaction | Transaction type (credit/debit) of the financial attribute. |
| type | Type of the financial attribute. |
| unit | Unit of the financial attribute. |

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

@@ -1,42 +0,0 @@
---
title: trailing_dividend_yield
description: Trailing 1yr dividend yield
keywords:
- equity
- fundamental
- trailing_dividend_yield
---
<!-- markdownlint-disable MD041 -->
Trailing 1yr dividend yield.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.TRAILING_DIVIDEND_YIELD([symbol];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.TRAILING_DIVIDEND_YIELD()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| symbol | Text | Symbol to get data for. | False |
| provider | Text | Options: tiingo, defaults to tiingo. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| trailing_dividend_yield | Trailing dividend yield. |

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

@@ -1,55 +0,0 @@
---
title: transcript
description: Learn how to retrieve earnings call transcripts for a given company using
Python obb.equity.fundamental.transcript. Understand the data parameters, returns,
symbol, year, quarter, and metadata associated with the transcripts.
keywords:
- earnings call transcript
- python obb.equity.fundamental.transcript
- data parameters
- returns
- symbols
- year
- quar
- content
- metadata
- provider
---
<!-- markdownlint-disable MD041 -->
Earnings Call Transcript. Earnings call transcript for a given company.
## Syntax
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.TRANSCRIPT(symbol;year;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.TRANSCRIPT("AAPL";2022)
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| quarter | Quarter of the earnings call transcript. |
| year | Year of the earnings call transcript. |
| date | The date of the data. |
| content | Content of the earnings call transcript. |

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

@@ -1,66 +0,0 @@
# equity
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Menus
<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, splits, ipo, earnings"
url="equity/calendar"
/><ReferenceCard
title="estimates"
description="consensus, price_target, historical"
url="equity/estimates"
/><ReferenceCard
title="discovery"
description="filings"
url="equity/discovery"
/><ReferenceCard
title="fundamental"
description="historical_eps, filings, management, overview, management_compensation, dividends,..."
url="equity/fundamental"
/><ReferenceCard
title="ownership"
description="insider_trading, major_holders, share_statistics, institutional"
url="equity/ownership"
/><ReferenceCard
title="price"
description="nbbo, performance, historical, quote"
url="equity/price"
/><ReferenceCard
title="shorts"
description="fails_to_deliver"
url="equity/shorts"
/><ReferenceCard
title="compare"
description="peers"
url="equity/compare"
/>
</ul>
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="search"
description="Equity Search. Search for a company or stock ticker."
url="equity/search"
command
/><ReferenceCard
title="market_snapshots"
description="Get a current, complete, market snapshot."
url="equity/market_snapshots"
command
/><ReferenceCard
title="screener"
description="Equity Screen. Screen for companies meeting various criteria."
url="equity/screener"
command
/><ReferenceCard
title="profile"
description="Equity Info. Get general price and performance metrics of a stock."
url="equity/profile"
command
/>
</ul>

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

@@ -1,97 +0,0 @@
---
title: market_snapshots
description: Get a current, complete market snapshot with the obb.equity.market_snapshots
Python method. Retrieve equity data such as stock information, financial data, market
analysis, and trading volume. Explore details like stock performance, price change,
moving averages, 52-week high and low, market cap, earnings per share, price to
earnings ratio, and stock exchange.
keywords:
- market snapshot
- equity data
- market data
- stock information
- financial data
- market analysis
- trading volume
- stock performance
- price change
- moving averages
- 52-week high
- 52-week low
- market cap
- earnings per share
- price to earnings ratio
- stock exchange
---
<!-- markdownlint-disable MD041 -->
Get a current, complete, market snapshot.
## Syntax
```excel wordwrap
=OBB.EQUITY.MARKET_SNAPSHOTS([provider];[market])
```
### Example
```excel wordwrap
=OBB.EQUITY.MARKET_SNAPSHOTS()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | Text | Options: fmp, polygon, defaults to fmp. | False |
| market | Text | The market to fetch data for. (provider: fmp) | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| open | The open price. |
| high | The high price. |
| low | The low price. |
| close | The close price. |
| prev_close | The previous closing price of the stock. |
| change | The change in price. |
| change_percent | The change, as a percent. |
| volume | The trading volume. |
| price | The last price of the stock. (provider: fmp) |
| avg_volume | Average volume of the stock. (provider: fmp) |
| ma50 | The 50-day moving average. (provider: fmp) |
| ma200 | The 200-day moving average. (provider: fmp) |
| year_high | The 52-week high. (provider: fmp) |
| year_low | The 52-week low. (provider: fmp) |
| market_cap | Market cap of the stock. (provider: fmp) |
| shares_outstanding | Number of shares outstanding. (provider: fmp) |
| eps | Earnings per share. (provider: fmp) |
| pe | Price to earnings ratio. (provider: fmp) |
| exchange | The exchange of the stock. (provider: fmp) |
| timestamp | The timestamp of the data. (provider: fmp) |
| earnings_announcement | The earnings announcement of the stock. (provider: fmp) |
| name | The name associated with the stock symbol. (provider: fmp) |
| vwap | The volume weighted average price of the stock on the current trading day. (provider: polygon) |
| prev_open | The previous trading session opening price. (provider: polygon) |
| prev_high | The previous trading session high price. (provider: polygon) |
| prev_low | The previous trading session low price. (provider: polygon) |
| prev_volume | The previous trading session volume. (provider: polygon) |
| prev_vwap | The previous trading session VWAP. (provider: polygon) |
| last_updated | The last time the data was updated. (provider: polygon) |
| bid | The current bid price. (provider: polygon) |
| bid_size | The current bid size. (provider: polygon) |
| ask_size | The current ask size. (provider: polygon) |
| ask | The current ask price. (provider: polygon) |
| quote_timestamp | The timestamp of the last quote. (provider: polygon) |
| last_trade_price | The last trade price. (provider: polygon) |
| last_trade_size | The last trade size. (provider: polygon) |
| last_trade_conditions | The last trade condition codes. (provider: polygon) |
| last_trade_exchange | The last trade exchange ID code. (provider: polygon) |
| last_trade_timestamp | The last trade timestamp. (provider: polygon) |

4
website/content/excel/reference/equity/ownership/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "ownership",
"position": 5
}

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

@@ -1,29 +0,0 @@
# ownership
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="insider_trading"
description="Insider Trading. Information about insider trading."
url="ownership/insider_trading"
command
/><ReferenceCard
title="major_holders"
description="Equity Ownership. Information about the company ownership."
url="ownership/major_holders"
command
/><ReferenceCard
title="share_statistics"
description="Share Statistics. Share statistics for a given company."
url="ownership/share_statistics"
command
/><ReferenceCard
title="institutional"
description="Institutional Ownership. Institutional ownership data."
url="ownership/institutional"
command
/>
</ul>

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

@@ -1,100 +0,0 @@
---
title: insider_trading
description: Learn how to use the stock insider trading Python function to get information
about insider trading, including parameter details, return types, and data descriptions.
keywords:
- stock insider trading
- equity ownership
- Python function
- parameter details
- data description
- symbol
- transaction type
- limit
- provider
- returns
- results
- chart
- metadata
- data
- filing date
- transaction date
- reporting CIK
- securities owned
- company CIK
- reporting name
- type of owner
- acquisition or disposition
- form type
- securities transacted
- price
- security name
- link
---
<!-- markdownlint-disable MD041 -->
Insider Trading. Information about insider trading.
## Syntax
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.INSIDER_TRADING(symbol;[limit];[provider];[transactionType];[start_date];[end_date];[ownership_type];[sort_by])
```
### Example
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.INSIDER_TRADING("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| company_cik | Company CIK of the insider trading. |
| filing_date | Filing date of the insider trading. |
| transaction_date | Transaction date of the insider trading. |
| owner_cik | Reporting CIK of the insider trading. |
| owner_name | Reporting name of the insider trading. |
| owner_title | Designation of owner of the insider trading. |
| transaction_type | Transaction type of the insider trading. |
| acquisition_or_disposition | Acquisition or disposition of the insider trading. |
| security_type | Security type of the insider trading. |
| securities_owned | Number of securities owned in the insider trading. |
| securities_transacted | Securities transacted of the insider trading. |
| transaction_price | Price of the insider trading. |
| filing_url | Link of the insider trading. |
| form_type | Form type of the insider trading. (provider: fmp) |
| company_name | Name of the company. (provider: intrinio) |
| conversion_exercise_price | Conversion/Exercise price of the insider trading. (provider: intrinio) |
| deemed_execution_date | Deemed execution date of the insider trading. (provider: intrinio) |
| exercise_date | Exercise date of the insider trading. (provider: intrinio) |
| expiration_date | Expiration date of the insider trading. (provider: intrinio) |
| underlying_security_title | Name of the underlying non-derivative security related to this derivative transaction. (provider: intrinio) |
| underlying_shares | Number of underlying shares related to this derivative transaction. (provider: intrinio) |
| nature_of_ownership | Nature of ownership of the insider trading. (provider: intrinio) |
| director | Whether the owner is a director. (provider: intrinio) |
| officer | Whether the owner is an officer. (provider: intrinio) |
| ten_percent_owner | Whether the owner is a 10% owner. (provider: intrinio) |
| other_relation | Whether the owner is having another relation. (provider: intrinio) |
| derivative_transaction | Whether the owner is having a derivative transaction. (provider: intrinio) |
| report_line_number | Report line number of the insider trading. (provider: intrinio) |

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

@@ -1,139 +0,0 @@
---
title: institutional
description: Learn about institutional ownership data, and how to use the OBB.equity.ownership.institutional
function in Python to access the data. Explore the symbol, include_current_quarter,
date, and provider parameters. Understand the meaning and usage of the results,
provider, warnings, chart, and metadata properties. Additionally, get detailed descriptions
of the various data fields such as symbol, cik, date, investors_holding, number_of_13f_shares,
total_invested, ownership_percent, new_positions, closed_positions, total_calls,
total_puts, and put_call_ratio.
keywords:
- institutional ownership data
- python OBB.equity.ownership.institutional function
- symbol parameter
- include_current_quarter parameter
- date parameter
- provider parameter
- results property
- provider property
- warnings property
- chart property
- metadata property
- data description
- symbol data
- cik data
- date data
- investors_holding data
- last_investors_holding data
- investors_holding_change data
- number_of_13f_shares data
- last_number_of_13f_shares data
- number_of_13f_shares_change data
- total_invested data
- last_total_invested data
- total_invested_change data
- ownership_percent data
- last_ownership_percent data
- ownership_percent_change data
- new_positions data
- last_new_positions data
- new_positions_change data
- increased_positions data
- last_increased_positions data
- increased_positions_change data
- closed_positions data
- last_closed_positions data
- closed_positions_change data
- reduced_positions data
- last_reduced_positions data
- reduced_positions_change data
- total_calls data
- last_total_calls data
- total_calls_change data
- total_puts data
- last_total_puts data
- total_puts_change data
- put_call_ratio data
- last_put_call_ratio data
- put_call_ratio_change data
---
<!-- markdownlint-disable MD041 -->
Institutional Ownership. Institutional ownership data.
## Syntax
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.INSTITUTIONAL(symbol;[provider];[include_current_quarter];[date];[page_size])
```
### Example
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.INSTITUTIONAL("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| cik | Central Index Key (CIK) for the requested entity. |
| date | The date of the data. |
| investors_holding | Number of investors holding the stock. (provider: fmp) |
| last_investors_holding | Number of investors holding the stock in the last quarter. (provider: fmp) |
| investors_holding_change | Change in the number of investors holding the stock. (provider: fmp) |
| number_of_13f_shares | Number of 13F shares. (provider: fmp) |
| last_number_of_13f_shares | Number of 13F shares in the last quarter. (provider: fmp) |
| number_of_13f_shares_change | Change in the number of 13F shares. (provider: fmp) |
| total_invested | Total amount invested. (provider: fmp) |
| last_total_invested | Total amount invested in the last quarter. (provider: fmp) |
| total_invested_change | Change in the total amount invested. (provider: fmp) |
| ownership_percent | Ownership percent. (provider: fmp) |
| last_ownership_percent | Ownership percent in the last quarter. (provider: fmp) |
| ownership_percent_change | Change in the ownership percent. (provider: fmp) |
| new_positions | Number of new positions. (provider: fmp) |
| last_new_positions | Number of new positions in the last quarter. (provider: fmp) |
| new_positions_change | Change in the number of new positions. (provider: fmp) |
| increased_positions | Number of increased positions. (provider: fmp) |
| last_increased_positions | Number of increased positions in the last quarter. (provider: fmp) |
| increased_positions_change | Change in the number of increased positions. (provider: fmp) |
| closed_positions | Number of closed positions. (provider: fmp) |
| last_closed_positions | Number of closed positions in the last quarter. (provider: fmp) |
| closed_positions_change | Change in the number of closed positions. (provider: fmp) |
| reduced_positions | Number of reduced positions. (provider: fmp) |
| last_reduced_positions | Number of reduced positions in the last quarter. (provider: fmp) |
| reduced_positions_change | Change in the number of reduced positions. (provider: fmp) |
| total_calls | Total number of call options contracts traded for Apple Inc. on the specified date. (provider: fmp) |
| last_total_calls | Total number of call options contracts traded for Apple Inc. on the previous reporting date. (provider: fmp) |
| total_calls_change | Change in the total number of call options contracts traded between the current and previous reporting dates. (provider: fmp) |
| total_puts | Total number of put options contracts traded for Apple Inc. on the specified date. (provider: fmp) |
| last_total_puts | Total number of put options contracts traded for Apple Inc. on the previous reporting date. (provider: fmp) |
| total_puts_change | Change in the total number of put options contracts traded between the current and previous reporting dates. (provider: fmp) |
| put_call_ratio | Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date. (provider: fmp) |
| last_put_call_ratio | Put-call ratio on the previous reporting date. (provider: fmp) |
| put_call_ratio_change | Change in the put-call ratio between the current and previous reporting dates. (provider: fmp) |
| name | Name of the institutional owner. (provider: intrinio) |
| value | Value of the institutional owner. (provider: intrinio) |
| amount | Amount of the institutional owner. (provider: intrinio) |
| sole_voting_authority | Sole voting authority of the institutional owner. (provider: intrinio) |
| shared_voting_authority | Shared voting authority of the institutional owner. (provider: intrinio) |
| no_voting_authority | No voting authority of the institutional owner. (provider: intrinio) |
| previous_amount | Previous amount of the institutional owner. (provider: intrinio) |
| amount_change | Amount change of the institutional owner. (provider: intrinio) |
| amount_percent_change | Amount percent change of the institutional owner. (provider: intrinio) |

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

@@ -1,109 +0,0 @@
---
title: major_holders
description: Get detailed information about equity ownership and stock ownership,
including investment data, security data, market value data, shares data, performance
data, and ownership data. Use the equity ownership API to retrieve equity ownership
details, and explore various stock ownership parameters and returns. Access company
ownership data, investor data, filing data, industry data, and more.
keywords:
- equity ownership
- company ownership
- equity ownership API
- equity ownership data
- equity ownership parameters
- equity ownership returns
- equity ownership data fields
- stock ownership
- stock ownership data
- stock ownership API
- stock ownership parameters
- stock ownership returns
- stock ownership data fields
- investment data
- security data
- market value data
- shares data
- performance data
- ownership data
- equity ownership details
- stock ownership details
- equity ownership information
- stock ownership information
- company ownership data
- investor data
- filing data
- industry data
---
<!-- markdownlint-disable MD041 -->
Equity Ownership. Information about the company ownership.
## Syntax
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.MAJOR_HOLDERS(symbol;[date];[page];[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.MAJOR_HOLDERS("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| cik | Central Index Key (CIK) for the requested entity. |
| filing_date | Filing date of the stock ownership. |
| investor_name | Investor name of the stock ownership. |
| symbol | Symbol representing the entity requested in the data. |
| security_name | Security name of the stock ownership. |
| type_of_security | Type of security of the stock ownership. |
| security_cusip | Security cusip of the stock ownership. |
| shares_type | Shares type of the stock ownership. |
| put_call_share | Put call share of the stock ownership. |
| investment_discretion | Investment discretion of the stock ownership. |
| industry_title | Industry title of the stock ownership. |
| weight | Weight of the stock ownership. |
| last_weight | Last weight of the stock ownership. |
| change_in_weight | Change in weight of the stock ownership. |
| change_in_weight_percentage | Change in weight percentage of the stock ownership. |
| market_value | Market value of the stock ownership. |
| last_market_value | Last market value of the stock ownership. |
| change_in_market_value | Change in market value of the stock ownership. |
| change_in_market_value_percentage | Change in market value percentage of the stock ownership. |
| shares_number | Shares number of the stock ownership. |
| last_shares_number | Last shares number of the stock ownership. |
| change_in_shares_number | Change in shares number of the stock ownership. |
| change_in_shares_number_percentage | Change in shares number percentage of the stock ownership. |
| quarter_end_price | Quarter end price of the stock ownership. |
| avg_price_paid | Average price paid of the stock ownership. |
| is_new | Is the stock ownership new. |
| is_sold_out | Is the stock ownership sold out. |
| ownership | How much is the ownership. |
| last_ownership | Last ownership amount. |
| change_in_ownership | Change in ownership amount. |
| change_in_ownership_percentage | Change in ownership percentage. |
| holding_period | Holding period of the stock ownership. |
| first_added | First added date of the stock ownership. |
| performance | Performance of the stock ownership. |
| performance_percentage | Performance percentage of the stock ownership. |
| last_performance | Last performance of the stock ownership. |
| change_in_performance | Change in performance of the stock ownership. |
| is_counted_for_performance | Is the stock ownership counted for performance. |

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

@@ -1,57 +0,0 @@
---
title: share_statistics
description: Learn how to retrieve and analyze share statistics for a given company
using the obb.equity.ownership.share_statistics API endpoint. This documentation
provides details on the parameters, return values, and data structure.
keywords:
- share statistics
- company statistics
- equity ownership
- symbol
- provider
- data
- free float
- float shares
- outstanding shares
- source
---
<!-- markdownlint-disable MD041 -->
Share Statistics. Share statistics for a given company.
## Syntax
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.SHARE_STATISTICS(symbol;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.OWNERSHIP.SHARE_STATISTICS("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, intrinio, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| date | The date of the data. |
| free_float | Percentage of unrestricted shares of a publicly-traded company. |
| float_shares | Number of shares available for trading by the general public. |
| outstanding_shares | Total number of shares of a publicly-traded company. |
| source | Source of the received data. |
| adjusted_outstanding_shares | Total number of shares of a publicly-traded company, adjusted for splits. (provider: intrinio) |
| public_float | Aggregate market value of the shares of a publicly-traded company. (provider: intrinio) |

4
website/content/excel/reference/equity/price/_category_.json vendored
View File

@@ -1,4 +0,0 @@
{
"label": "price",
"position": 6
}

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

@@ -1,97 +0,0 @@
---
title: historical
description: Learn how to use the `obb.equity.price.historical` function to load historical
price data for a specific stock ticker. Find out about the available parameters
and providers, as well as the structure of the returned data and the columns it
contains.
keywords:
- equity historical price
- load stock data
- specific ticker
- python function
- equity data parameters
- alpha vantage provider
- fmp provider
- intrinio provider
- polygon provider
- yfinance provider
- equity historical data returns
- equity data columns
- alpha vantage data columns
- cboe data columns
- fmp data columns
- intrinio data columns
- polygon data columns
- yfinance data columns
---
<!-- markdownlint-disable MD041 -->
Equity Historical price. Load stock data for a specific ticker.
## Syntax
```excel wordwrap
=OBB.EQUITY.PRICE.HISTORICAL(symbol;[interval];[start_date];[end_date];[provider];[limit];[sort];[start_time];[end_time];[timezone];[source];[sleep];[adjusted])
```
### Example
```excel wordwrap
=OBB.EQUITY.PRICE.HISTORICAL("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| date | The date of the data. |
| open | The open price. |
| high | The high price. |
| low | The low price. |
| close | The close price. |
| volume | The trading volume. |
| vwap | Volume Weighted Average Price over the period. |
| 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) |
| change_over_time | Change % in the price of the symbol over a period of time. (provider: fmp) |
| close_time | The timestamp that represents the end of the interval span. (provider: intrinio) |
| interval | The data time frequency. (provider: intrinio) |
| average | Average trade price of an individual equity during the interval. (provider: intrinio) |
| intra_period | If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period (provider: intrinio) |
| adj_open | Adjusted open price during the period. (provider: intrinio, tiingo) |
| adj_high | Adjusted high price during the period. (provider: intrinio, tiingo) |
| adj_low | Adjusted low price during the period. (provider: intrinio, tiingo) |
| adj_volume | Adjusted volume during the period. (provider: intrinio, tiingo) |
| factor | factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices. (provider: intrinio) |
| split_ratio | Ratio of the equity split, if a equity split occurred. (provider: intrinio, tiingo) |
| dividend | Dividend amount, if a dividend was paid. (provider: intrinio, tiingo) |
| percent_change | Percent change in the price of the symbol from the previous day. (provider: intrinio) |
| fifty_two_week_high | 52 week high price for the symbol. (provider: intrinio) |
| fifty_two_week_low | 52 week low price for the symbol. (provider: intrinio) |
| transactions | Number of transactions for the symbol in the time period. (provider: polygon) |

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

@@ -1,29 +0,0 @@
# price
import ReferenceCard from '@site/src/components/General/NewReferenceCard';
### Commands
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="nbbo"
description="Equity NBBO. Load National Best Bid and Offer for a specific equity."
url="price/nbbo"
command
/><ReferenceCard
title="performance"
description="Price performance as a return, over different periods."
url="price/performance"
command
/><ReferenceCard
title="historical"
description="Equity Historical price. Load stock data for a specific ticker."
url="price/historical"
command
/><ReferenceCard
title="quote"
description="Equity Quote. Load stock data for a specific ticker."
url="price/quote"
command
/>
</ul>

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

@@ -1,89 +0,0 @@
---
title: nbbo
description: Learn how to load the National Best Bid and Offer (NBBO) for a specific
equity using the OBB.equity.price.nbbo API. Explore the parameters and data returned
by the query, including ask price, bid price, ask size, bid size, exchange details,
timestamps, and more.
keywords:
- Equity Quote
- National Best Bid and Offer
- specific equity
- symbol
- provider
- polygon
- query
- limit
- date
- timestamp
- OBBject
- results
- EquityNBBO
- warnings
- Chart
- Metadata
- ask_exchange
- ask
- ask_size
- bid_size
- bid
- bid_exchange
- tape
- conditions
- indicators
- sequence_num
- participant_timestamp
- sip_timestamp
- trf_timestamp
- data
---
<!-- markdownlint-disable MD041 -->
Equity NBBO. Load National Best Bid and Offer for a specific equity.
## Syntax
```excel wordwrap
=OBB.EQUITY.PRICE.NBBO(symbol;[provider];[limit];[timestamp];[timestamp_lt];[timestamp_gt];[timestamp_lte];[timestamp_gte])
```
### Example
```excel wordwrap
=OBB.EQUITY.PRICE.NBBO("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| ask_exchange | The exchange ID for the ask. |
| ask | The last ask price. |
| ask_size | The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. |
| bid_size | The bid size in round lots. |
| bid | The last bid price. |
| bid_exchange | The exchange ID for the bid. |
| tape | The exchange tape. (provider: polygon) |
| conditions | A list of condition codes. (provider: polygon) |
| indicators | A list of indicator codes. (provider: polygon) |
| sequence_num | The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11) (provider: polygon) |
| participant_timestamp | The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. (provider: polygon) |
| sip_timestamp | The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. (provider: polygon) |
| trf_timestamp | The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote. (provider: polygon) |

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

@@ -1,79 +0,0 @@
---
title: performance
description: Learn how to calculate the price performance return for a symbol over
different time periods using the OBB.equity.price.performance function. Retrieve
data such as one-day return, week to date return, one-week return, month to date
return, and more. Understand the parameters, returns, and data structure of the
function.
keywords:
- price performance
- return
- symbol
- data
- provider
- chart
- metadata
- one-day return
- week to date return
- one-week return
- month to date return
- one-month return
- quarter to date return
- three-month return
- six-month return
- year to date return
- one-year return
- three-year return
- five-year return
- ten-year return
- max return
- time series
- ticker symbol
---
<!-- markdownlint-disable MD041 -->
Price performance as a return, over different periods.
## Syntax
```excel wordwrap
=OBB.EQUITY.PRICE.PERFORMANCE(symbol;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.PRICE.PERFORMANCE("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: fmp, defaults to fmp. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| one_day | One-day return. |
| wtd | Week to date return. |
| one_week | One-week return. |
| mtd | Month to date return. |
| one_month | One-month return. |
| qtd | Quarter to date return. |
| three_month | Three-month return. |
| six_month | Six-month return. |
| ytd | Year to date return. |
| one_year | One-year return. |
| three_year | Three-year return. |
| five_year | Five-year return. |
| ten_year | Ten-year return. |
| max | Return from the beginning of the time series. |
| symbol | The ticker symbol. (provider: fmp) |

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

@@ -1,139 +0,0 @@
---
title: quote
description: Learn how to load stock data for a specific ticker with the Equity Quote
function. Discover the various parameters and data returned, including day low,
day high, date, symbol, name, price, volume, and more.
keywords:
- equity quote
- stock data
- ticker
- parameters
- symbol
- provider
- returns
- data
- day low
- day high
- date
- fmp
- intrinio
- source
- results
- warnings
- chart
- metadata
- price
- changes percentage
- change
- year high
- year low
- market cap
- price avg50
- price avg200
- volume
- avg volume
- exchange
- open
- previous close
- eps
- pe
- earnings announcement
- shares outstanding
- last price
- last time
- last size
- bid price
- bid size
- ask price
- ask size
- close price
- high price
- low price
- exchange volume
- market volume
- updated on
- listing venue
- sales conditions
- quote conditions
- market center code
- is darkpool
- messages
- security
---
<!-- markdownlint-disable MD041 -->
Equity Quote. Load stock data for a specific ticker.
## Syntax
```excel wordwrap
=OBB.EQUITY.PRICE.QUOTE(symbol;[provider];[source])
```
### Example
```excel wordwrap
=OBB.EQUITY.PRICE.QUOTE("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| day_low | Lowest price of the stock in the current trading day. |
| day_high | Highest price of the stock in the current trading day. |
| date | The date of the data. |
| symbol | Symbol of the company. (provider: fmp) |
| name | Name of the company. (provider: fmp) |
| price | Current trading price of the equity. (provider: fmp) |
| changes_percentage | Change percentage of the equity price. (provider: fmp) |
| change | Change in the equity price. (provider: fmp) |
| 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) |
| 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) |
| open | Opening price of the equity in the current trading day. (provider: fmp) |
| previous_close | Previous closing price of the equity. (provider: fmp) |
| eps | Earnings per share of the equity. (provider: fmp) |
| pe | Price earnings ratio of the equity. (provider: fmp) |
| earnings_announcement | Earnings announcement date of the equity. (provider: fmp) |
| shares_outstanding | Number of shares outstanding of the equity. (provider: fmp) |
| last_price | Price of the last trade. (provider: intrinio) |
| last_time | Date and Time when the last trade occurred. (provider: intrinio) |
| last_size | Size of the last trade. (provider: intrinio) |
| bid_price | Price of the top bid order. (provider: intrinio) |
| bid_size | Size of the top bid order. (provider: intrinio) |
| ask_price | Price of the top ask order. (provider: intrinio) |
| ask_size | Size of the top ask order. (provider: intrinio) |
| open_price | Open price for the trading day. (provider: intrinio) |
| close_price | Closing price for the trading day (IEX source only). (provider: intrinio) |
| high_price | High Price for the trading day. (provider: intrinio) |
| low_price | Low Price for the trading day. (provider: intrinio) |
| exchange_volume | Number of shares exchanged during the trading day on the exchange. (provider: intrinio) |
| market_volume | Number of shares exchanged during the trading day for the whole market. (provider: intrinio) |
| updated_on | Date and Time when the data was last updated. (provider: intrinio) |
| source | Source of the data. (provider: intrinio) |
| listing_venue | Listing venue where the trade took place (SIP source only). (provider: intrinio) |
| sales_conditions | Indicates any sales condition modifiers associated with the trade. (provider: intrinio) |
| quote_conditions | Indicates any quote condition modifiers associated with the trade. (provider: intrinio) |
| market_center_code | Market center character code. (provider: intrinio) |
| is_darkpool | Whether or not the current trade is from a darkpool. (provider: intrinio) |
| messages | Messages associated with the endpoint. (provider: intrinio) |
| security | Security details related to the quote. (provider: intrinio) |

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

@@ -1,118 +0,0 @@
---
title: profile
description: Get general price and performance metrics of a stock with the Equity
Information API. Retrieve data such as the symbol, name, price, open price, high
price, low price, close price, change in price, change percent, previous close,
type, exchange ID, bid, ask, volume, implied volatility, realized volatility, last
trade timestamp, annual high, and annual low.
keywords:
- equity info
- price and performance metrics
- stock data
- equity profile
- symbol
- provider
- data
- parameters
- returns
- cboe
- EquityInfo
- warnings
- chart
- metadata
- Data
- name
- price
- open price
- high price
- low price
- close price
- change percent
- previous close
- type
- exchange ID
- bid
- ask
- volume
- implied volatility
- realized volatility
- last trade timestamp
- annual high
- annual low
- iv30
- hv30
- iv60
- hv60
- iv90
- hv90
---
<!-- markdownlint-disable MD041 -->
Equity Info. Get general price and performance metrics of a stock.
## Syntax
```excel wordwrap
=OBB.EQUITY.PROFILE(symbol;[provider])
```
### Example
```excel wordwrap
=OBB.EQUITY.PROFILE("AAPL")
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| **symbol** | **Text** | **Symbol to get data for.** | **True** |
| provider | Text | Options: intrinio, defaults to intrinio. | False |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| name | Common name of the company. |
| cik | Central Index Key (CIK) for the requested entity. |
| lei | Legal Entity Identifier assigned to the company. |
| legal_name | Official legal name of the company. |
| stock_exchange | Stock exchange where the company is traded. |
| sic | Standard Industrial Classification code for the company. |
| short_description | Short description of the company. |
| long_description | Long description of the company. |
| ceo | Chief Executive Officer of the company. |
| company_url | URL of the company's website. |
| business_address | Address of the company's headquarters. |
| mailing_address | Mailing address of the company. |
| business_phone_no | Phone number of the company's headquarters. |
| hq_address1 | Address of the company's headquarters. |
| hq_address2 | Address of the company's headquarters. |
| hq_address_city | City of the company's headquarters. |
| hq_address_postal_code | Zip code of the company's headquarters. |
| hq_state | State of the company's headquarters. |
| hq_country | Country of the company's headquarters. |
| inc_state | State in which the company is incorporated. |
| inc_country | Country in which the company is incorporated. |
| employees | Number of employees working for the company. |
| entity_legal_form | Legal form of the company. |
| entity_status | Status of the company. |
| latest_filing_date | Date of the company's latest filing. |
| irs_number | IRS number assigned to the company. |
| sector | Sector in which the company operates. |
| industry_category | Category of industry in which the company operates. |
| industry_group | Group of industry in which the company operates. |
| template | Template used to standardize the company's financial statements. |
| standardized_active | Whether the company is active or not. |
| first_fundamental_date | Date of the company's first fundamental. |
| 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. |
| id | Intrinio ID for the company. (provider: intrinio) |
| thea_enabled | Whether the company has been enabled for Thea. (provider: intrinio) |

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

@@ -1,69 +0,0 @@
---
title: screener
description: Equity Screen
keywords:
- equity
- screener
---
<!-- markdownlint-disable MD041 -->
Equity Screen. Screen for companies meeting various criteria.
## Syntax
```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
```excel wordwrap
=OBB.EQUITY.SCREENER()
```
---
## Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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 |
---
## Return Data
| Name | Description |
| ---- | ----------- |
| symbol | Symbol representing the entity requested in the data. |
| name | Name of the company. |
| market_cap | The market cap of ticker. (provider: fmp) |
| sector | The sector the ticker belongs to. (provider: fmp) |
| industry | The industry ticker belongs to. (provider: fmp) |
| beta | The beta of the ETF. (provider: fmp) |
| price | The current price. (provider: fmp) |
| last_annual_dividend | The last annual amount dividend paid. (provider: fmp) |
| volume | The current trading volume. (provider: fmp) |
| exchange | The exchange code the asset trades on. (provider: fmp) |
| exchange_name | The full name of the primary exchange. (provider: fmp) |
| country | The two-letter country abbreviation where the head office is located. (provider: fmp) |
| is_etf | Whether the ticker is an ETF. (provider: fmp) |
| actively_trading | Whether the ETF is actively trading. (provider: fmp) |

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