summaryrefslogtreecommitdiffstats
path: root/website/content/platform/data_models/GdpReal.md
diff options
context:
space:
mode:
Diffstat (limited to 'website/content/platform/data_models/GdpReal.md')
-rw-r--r--website/content/platform/data_models/GdpReal.md25
1 files changed, 20 insertions, 5 deletions
diff --git a/website/content/platform/data_models/GdpReal.md b/website/content/platform/data_models/GdpReal.md
index 6bb86313691..91d0b304d28 100644
--- a/website/content/platform/data_models/GdpReal.md
+++ b/website/content/platform/data_models/GdpReal.md
@@ -1,6 +1,6 @@
---
-title: Real GDP Data
-description: OpenBB Platform Data Model
+title: "Gdp Real"
+description: "Real GDP Data"
---
<!-- markdownlint-disable MD012 MD031 MD033 -->
@@ -27,10 +27,13 @@ GdpRealQueryParams,
)
```
+---
+
## Parameters
<Tabs>
-<TabItem value="standard" label="Standard">
+
+<TabItem value='standard' label='standard'>
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
@@ -48,15 +51,26 @@ GdpRealQueryParams,
| 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['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True |
-| country | Literal['G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_19', 'europe', 'european_union_27', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'oecd_total', 'poland', 'portugal', 'romania', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states'] | Country to get GDP for. | united_states | True |
+| country | Literal['G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_19', 'europe', 'european_union_27', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'oecd_total', 'poland', 'portugal', 'romania', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all'] | Country to get GDP for. | united_states | True |
</TabItem>
</Tabs>
+---
+
## Data
<Tabs>
-<TabItem value="standard" label="Standard">
+
+<TabItem value='standard' label='standard'>
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| date | date | The date of the data. |
+| value | float | Nominal GDP value on the date. |
+</TabItem>
+
+<TabItem value='oecd' label='oecd'>
| Name | Type | Description |
| ---- | ---- | ----------- |
@@ -65,3 +79,4 @@ GdpRealQueryParams,
</TabItem>
</Tabs>
+