Skip to content

Commit

Permalink
md files
Browse files Browse the repository at this point in the history
  • Loading branch information
hjoaquim committed Oct 10, 2023
1 parent 817714a commit bd2170e
Show file tree
Hide file tree
Showing 283 changed files with 18,871 additions and 2,094 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,16 @@ import TabItem from '@theme/TabItem';
| ---- | ---- | ----------- | ------- | -------- |
| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
| provider | Literal['fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. | fred | True |
| provider | Union[Literal['fred']] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. | fred | True |
</TabItem>

<TabItem value='fred' label='fred'>

| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
| provider | Union[Literal['fred']] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. | fred | True |
| parameter | Literal['overnight', 'term_30', 'term_90', '1_week_term_structure', '1_month_term_structure', '3_month_term_structure', '6_month_term_structure', '1_year_term_structure', '2_year_term_structure', '30_day_ma', '90_day_ma'] | Period of AMERIBOR rate. | overnight | True |
</TabItem>

Expand All @@ -39,7 +42,7 @@ import TabItem from '@theme/TabItem';
| Name | Type | Description |
| ---- | ---- | ----------- |
| date | date | The date of the data. |
| rate | float | AMERIBOR rate. |
| rate | Union[float] | AMERIBOR rate. |
</TabItem>

</Tabs>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import TabItem from '@theme/TabItem';
| symbol | Union[str, List[str]] | Symbol to get data for. | | False |
| period | Literal['quarter', 'annual'] | Period of the data to return. | annual | True |
| limit | int | The number of data entries to return. | 30 | True |
| provider | Literal['fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
| provider | Union[Literal['fmp']] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
</TabItem>

</Tabs>
Expand Down
84 changes: 84 additions & 0 deletions website/content/platform/data_models/AvailableIndices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: AvailableIndices
description: OpenBB Platform Data Model
---


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


---

## Parameters

<Tabs>
<TabItem value="standard" label="Standard">

| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| provider | Union[Literal['cboe', 'fmp', 'yfinance']] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | True |
</TabItem>

<TabItem value='cboe' label='cboe'>

| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| provider | Union[Literal['cboe', 'fmp', 'yfinance']] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | True |
| europe | bool | Filter for European indices. False for US indices. | False | True |
</TabItem>

</Tabs>

## Data

<Tabs>
<TabItem value="standard" label="Standard">

| Name | Type | Description |
| ---- | ---- | ----------- |
| name | Union[str] | Name of the index. |
| currency | Union[str] | Currency the index is traded in. |
</TabItem>

<TabItem value='cboe' label='cboe'>

| Name | Type | Description |
| ---- | ---- | ----------- |
| name | Union[str] | Name of the index. |
| currency | Union[str] | Currency the index is traded in. |
| isin | Union[str] | ISIN code for the index. Valid only for European indices. |
| region | Union[str] | Region for the index. Valid only for European indices |
| symbol | Union[str] | Symbol for the index. |
| description | Union[str] | Description for the index. Valid only for US indices. |
| data_delay | Union[int] | Data delay for the index. Valid only for US indices. |
| open_time | Union[datetime.time] | Opening time for the index. Valid only for US indices. |
| close_time | Union[datetime.time] | Closing time for the index. Valid only for US indices. |
| time_zone | Union[str] | Time zone for the index. Valid only for US indices. |
| tick_days | Union[str] | The trading days for the index. Valid only for US indices. |
| tick_frequency | Union[str] | The frequency of the index ticks. Valid only for US indices. |
| tick_period | Union[str] | The period of the index ticks. Valid only for US indices. |
</TabItem>

<TabItem value='fmp' label='fmp'>

| Name | Type | Description |
| ---- | ---- | ----------- |
| name | Union[str] | Name of the index. |
| currency | Union[str] | Currency the index is traded in. |
| stock_exchange | str | Stock exchange where the index is listed. |
| exchange_short_name | str | Short name of the stock exchange where the index is listed. |
</TabItem>

<TabItem value='yfinance' label='yfinance'>

| Name | Type | Description |
| ---- | ---- | ----------- |
| name | Union[str] | Name of the index. |
| currency | Union[str] | Currency the index is traded in. |
| code | str | ID code for keying the index in the OpenBB Terminal. |
| symbol | str | Symbol for the index. |
</TabItem>

</Tabs>

Loading

0 comments on commit bd2170e

Please sign in to comment.