mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-01 06:51:38 +00:00
2d8c35df7a
* 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>
61 lines
1.5 KiB
Markdown
Vendored
61 lines
1.5 KiB
Markdown
Vendored
---
|
|
title: Earnings Call Transcript
|
|
description: OpenBB Platform Data Model
|
|
---
|
|
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
|
|
---
|
|
|
|
## Implementation details
|
|
|
|
### Class names
|
|
|
|
| Model name | Parameters class | Data class |
|
|
| ---------- | ---------------- | ---------- |
|
|
| `EarningsCallTranscript` | `EarningsCallTranscriptQueryParams` | `EarningsCallTranscriptData` |
|
|
|
|
### Import Statement
|
|
|
|
```python
|
|
from openbb_provider.standard_models.earnings_call_transcript import (
|
|
EarningsCallTranscriptData,
|
|
EarningsCallTranscriptQueryParams,
|
|
)
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | Union[str, List[str]] | Symbol to get data for. | | False |
|
|
| year | int | Year of the earnings call transcript. | | False |
|
|
| quarter | int | Quarter of the earnings call transcript. | 1 | 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 |
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
## Data
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| symbol | str | Symbol to get data for. |
|
|
| quarter | int | Quarter of the earnings call transcript. |
|
|
| year | int | Year of the earnings call transcript. |
|
|
| date | datetime | The date of the data. |
|
|
| content | str | Content of the earnings call transcript. |
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|