mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-15 22:02:31 +00:00
* pydantic v4
* flat structure
* md files
* Revert "md files"
This reverts commit bd2170e2ad.
* improve command descriptions
* nice title and description
* human readble data model names on left panel
* implementation details section
* content markdown files
* markdown versioned files
* showcase page
* updates
---------
Co-authored-by: tehcoderer <me@tehcoderer.com>
2.0 KiB
Vendored
2.0 KiB
Vendored
title, description
| title | description |
|---|---|
| Ameribor | OpenBB Platform Data Model |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
AMERIBOR |
AMERIBORQueryParams |
AMERIBORData |
Import Statement
from openbb_provider.standard_models.ameribor_rates import (
AMERIBORData,
AMERIBORQueryParams,
)
Parameters
| 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 | 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 |
| 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 | 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 |
Data
| Name | Type | Description |
|---|---|---|
| date | date | The date of the data. |
| rate | float | AMERIBOR rate. |