Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/excel update #5889

Merged
merged 5 commits into from
Dec 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
214 changes: 107 additions & 107 deletions website/content/excel/functions.json

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions website/content/excel/reference/hist.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!-- markdownlint-disable MD041 -->

Get historical data by providing symbol and field tag.
Get historical data by providing stock symbol and field tag. See tag options at: https://data.intrinio.com/data-tags.

## Syntax

```excel wordwrap
=OBB.HIST(required;[optional])
=OBB.HIST(required; [optional])
```

---
Expand All @@ -15,7 +15,7 @@ Get historical data by providing symbol and field tag.
| Name | Type | Description | Optional |
| ---- | ---- | ----------- | -------- |
| symbol | Text | Symbol to get data for, e.g. 'AAPL'. | False |
| field | Text | Field to get data for, e.g. 'ebitda'. | False |
| tag | Text | Field tag to get data for, e.g. 'EBITDA'. See options at: https://data.intrinio.com/data-tags. | False |
| start_date | Text | Start date of the data, in YYYY-MM-DD format, defaults to 5 years ago. | True |
| end_date | Text | End date of the data, in YYYY-MM-DD format, defaults to today. | True |
| frequency | Text | The frequency of the data, can be 'yearly' or 'quarterly', defaults to 'yearly'. | True |
Expand Down
4 changes: 2 additions & 2 deletions website/content/excel/reference/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ import ReferenceCard from '@site/src/components/General/NewReferenceCard';
<ul className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6'>
<ReferenceCard
title="last"
description="Get latest data point by providing symbol and field tag."
description="Get latest data point by providing stock symbol and tag. See tag options at:..."
url="reference/last"
command
/><ReferenceCard
title="hist"
description="Get historical data by providing symbol and field tag."
description="Get historical data by providing stock symbol and field tag. See tag options at:..."
url="reference/hist"
command
/><ReferenceCard
Expand Down
6 changes: 3 additions & 3 deletions website/content/excel/reference/last.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!-- markdownlint-disable MD041 -->

Get latest data point by providing symbol and field tag.
Get latest data point by providing stock symbol and tag. See tag options at: https://data.intrinio.com/data-tags.

## Syntax

```excel wordwrap
=OBB.LAST(required;[optional])
=OBB.LAST(required; [optional])
```

---
Expand All @@ -15,7 +15,7 @@ Get latest data point by providing symbol and field tag.
| Name | Type | Description | Optional |
| ---- | ---- | ----------- | -------- |
| symbol | Text | Symbol to get data for, e.g. 'AAPL'. | False |
| field | Text | Field to get data for, e.g. 'ebitda'. | False |
| tag | Text | Field tag to get data for, e.g. 'EBITDA'. See options at: https://data.intrinio.com/data-tags. | False |

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Cryptocurrency Historical Price. Cryptocurrency historical price data.
## Syntax

```excel wordwrap
=OBB.CRYPTO.PRICE.HISTORICAL(required;[optional])
=OBB.CRYPTO.PRICE.HISTORICAL(required; [optional])
```

---
Expand Down Expand Up @@ -73,6 +73,5 @@ Cryptocurrency Historical Price. Cryptocurrency historical price data.
| change_percent | Change % in the price of the symbol. (provider: fmp) |
| label | Human readable format of the date. (provider: fmp) |
| change_over_time | Change % in the price of the symbol over a period of time. (provider: fmp) |
| transactions | Number of transactions for the symbol in the time period. (provider: polygon);
Number of trades. (provider: tiingo) |
| transactions | Number of transactions for the symbol in the time period. (provider: polygon); Number of trades. (provider: 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) |
2 changes: 1 addition & 1 deletion website/content/excel/reference/library/crypto/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Cryptocurrency Search. Search available cryptocurrency pairs.
## Syntax

```excel wordwrap
=OBB.CRYPTO.SEARCH(required;[optional])
=OBB.CRYPTO.SEARCH(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Currency Historical Price. Currency historical data.
## Syntax

```excel wordwrap
=OBB.CURRENCY.PRICE.HISTORICAL(required;[optional])
=OBB.CURRENCY.PRICE.HISTORICAL(required; [optional])
```

---
Expand Down
2 changes: 1 addition & 1 deletion website/content/excel/reference/library/currency/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Currency Search. Search available currency pairs.
## Syntax

```excel wordwrap
=OBB.CURRENCY.SEARCH(required;[optional])
=OBB.CURRENCY.SEARCH(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Get the complete options chain for a ticker.
## Syntax

```excel wordwrap
=OBB.DERIVATIVES.OPTIONS.CHAINS(required;[optional])
=OBB.DERIVATIVES.OPTIONS.CHAINS(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Get the complete options chain for a ticker.
## Syntax

```excel wordwrap
=OBB.DERIVATIVES.OPTIONS.UNUSUAL(required;[optional])
=OBB.DERIVATIVES.OPTIONS.UNUSUAL(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Economic Calendar.
## Syntax

```excel wordwrap
=OBB.ECONOMY.CALENDAR(required;[optional])
=OBB.ECONOMY.CALENDAR(required; [optional])
```

---
Expand Down
2 changes: 1 addition & 1 deletion website/content/excel/reference/library/economy/cpi.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Consumer Price Index (CPI) Data.
## Syntax

```excel wordwrap
=OBB.ECONOMY.CPI(required;[optional])
=OBB.ECONOMY.CPI(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Search for FRED series or economic releases by ID or fuzzy query. This does not
## Syntax

```excel wordwrap
=OBB.ECONOMY.FRED_SEARCH(required;[optional])
=OBB.ECONOMY.FRED_SEARCH(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Get data by series ID from FRED.
## Syntax

```excel wordwrap
=OBB.ECONOMY.FRED_SERIES(required;[optional])
=OBB.ECONOMY.FRED_SERIES(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Forecasted GDP Data.
## Syntax

```excel wordwrap
=OBB.ECONOMY.GDP.FORECAST(required;[optional])
=OBB.ECONOMY.GDP.FORECAST(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Nominal GDP Data.
## Syntax

```excel wordwrap
=OBB.ECONOMY.GDP.NOMINAL(required;[optional])
=OBB.ECONOMY.GDP.NOMINAL(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Real GDP Data.
## Syntax

```excel wordwrap
=OBB.ECONOMY.GDP.REAL(required;[optional])
=OBB.ECONOMY.GDP.REAL(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Historical Market Risk Premium.
## Syntax

```excel wordwrap
=OBB.ECONOMY.RISK_PREMIUM(required;[optional])
=OBB.ECONOMY.RISK_PREMIUM(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Upcoming and Historical Dividend Calendar.
## Syntax

```excel wordwrap
=OBB.EQUITY.CALENDAR.DIVIDEND(required;[optional])
=OBB.EQUITY.CALENDAR.DIVIDEND(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Upcoming and Historical earnings calendar.
## Syntax

```excel wordwrap
=OBB.EQUITY.CALENDAR.EARNINGS(required;[optional])
=OBB.EQUITY.CALENDAR.EARNINGS(required; [optional])
```

---
Expand All @@ -59,8 +59,8 @@ Upcoming and Historical earnings calendar.
| name | Name of the entity. |
| eps_previous | The earnings-per-share from the same previously reported period. |
| eps_consensus | The analyst conesus earnings-per-share estimate. |
| actual_eps | The actual earnings per share announced. (provider: fmp) |
| actual_revenue | The actual reported revenue. (provider: fmp) |
| eps_actual | The actual earnings per share announced. (provider: fmp) |
| revenue_actual | The actual reported revenue. (provider: fmp) |
| revenue_consensus | The revenue forecast consensus. (provider: fmp) |
| period_ending | The fiscal period end date. (provider: fmp) |
| reporting_time | The reporting time - e.g. after market close. (provider: fmp) |
Expand Down
57 changes: 11 additions & 46 deletions website/content/excel/reference/library/equity/calendar/ipo.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Upcoming and Historical IPO Calendar.
## Syntax

```excel wordwrap
=OBB.EQUITY.CALENDAR.IPO(required;[optional])
=OBB.EQUITY.CALENDAR.IPO(required; [optional])
```

---
Expand All @@ -85,58 +85,23 @@ Upcoming and Historical IPO Calendar.
| ---- | ----------- |
| 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) |
| 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_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) |
| 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) |
| 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) |
| 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) |
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Calendar Splits. Show Stock Split Calendar.
## Syntax

```excel wordwrap
=OBB.EQUITY.CALENDAR.SPLITS(required;[optional])
=OBB.EQUITY.CALENDAR.SPLITS(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Equity Peers. Company peers.
## Syntax

```excel wordwrap
=OBB.EQUITY.COMPARE.PEERS(required;[optional])
=OBB.EQUITY.COMPARE.PEERS(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Get the most-recent filings submitted to the SEC.
## Syntax

```excel wordwrap
=OBB.EQUITY.DISCOVERY.FILINGS(required;[optional])
=OBB.EQUITY.DISCOVERY.FILINGS(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Price Target Consensus. Price target consensus data.
## Syntax

```excel wordwrap
=OBB.EQUITY.ESTIMATES.CONSENSUS(required;[optional])
=OBB.EQUITY.ESTIMATES.CONSENSUS(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Historical Analyst Estimates. Analyst stock recommendations.
## Syntax

```excel wordwrap
=OBB.EQUITY.ESTIMATES.HISTORICAL(required;[optional])
=OBB.EQUITY.ESTIMATES.HISTORICAL(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Price Target. Price target data.
## Syntax

```excel wordwrap
=OBB.EQUITY.ESTIMATES.PRICE_TARGET(required;[optional])
=OBB.EQUITY.ESTIMATES.PRICE_TARGET(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Balance Sheet. Balance sheet statement.
## Syntax

```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.BALANCE(required;[optional])
=OBB.EQUITY.FUNDAMENTAL.BALANCE(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Balance Sheet Statement Growth. Information about the growth of the company bala
## Syntax

```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.BALANCE_GROWTH(required;[optional])
=OBB.EQUITY.FUNDAMENTAL.BALANCE_GROWTH(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Cash Flow Statement. Information about the cash flow statement.
## Syntax

```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.CASH(required;[optional])
=OBB.EQUITY.FUNDAMENTAL.CASH(required; [optional])
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Cash Flow Statement Growth. Information about the growth of the company cash flo
## Syntax

```excel wordwrap
=OBB.EQUITY.FUNDAMENTAL.CASH_GROWTH(required;[optional])
=OBB.EQUITY.FUNDAMENTAL.CASH_GROWTH(required; [optional])
```

---
Expand Down
Loading
Loading