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>
74 lines
1.7 KiB
Markdown
Vendored
74 lines
1.7 KiB
Markdown
Vendored
---
|
|
title: transcript
|
|
description: OpenBB Platform Function
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# transcript
|
|
|
|
Earnings Call Transcript. Earnings call transcript for a given company.
|
|
|
|
```python wordwrap
|
|
transcript(symbol: Union[str, List[str]], year: int, quarter: int = 1, provider: Literal[str] = fmp)
|
|
```
|
|
|
|
---
|
|
|
|
## 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>
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
```python wordwrap
|
|
OBBject
|
|
results : List[EarningsCallTranscript]
|
|
Serializable results.
|
|
|
|
provider : Optional[Literal['fmp']]
|
|
Provider name.
|
|
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
|
|
metadata: Optional[Metadata]
|
|
Metadata info about the command execution.
|
|
```
|
|
|
|
---
|
|
|
|
## 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>
|
|
|