Management Discussion Analysis
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
ManagementDiscussionAnalysis | ManagementDiscussionAnalysisQueryParams | ManagementDiscussionAnalysisData |
Import Statement
from openbb_core.provider.standard_models.management_discussion_analysis import (
ManagementDiscussionAnalysisData,
ManagementDiscussionAnalysisQueryParams,
)
Parameters
- standard
- sec
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| calendar_year | int | Calendar year of the report. By default, is the current year. If the calendar period is not provided, but the calendar year is, it will return the annual report. | None | True |
| calendar_period | Literal['Q1', 'Q2', 'Q3', 'Q4'] | Calendar period of the report. By default, is the most recent report available for the symbol. If no calendar year and no calendar period are provided, it will return the most recent report. | None | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| calendar_year | int | Calendar year of the report. By default, is the current year. If the calendar period is not provided, but the calendar year is, it will return the annual report. | None | True |
| calendar_period | Literal['Q1', 'Q2', 'Q3', 'Q4'] | Calendar period of the report. By default, is the most recent report available for the symbol. If no calendar year and no calendar period are provided, it will return the most recent report. | None | True |
| strategy | Literal['inscriptis', 'trafilatura'] | The strategy to use for extracting the text. Default is 'trafilatura'. | trafilatura | True |
| wrap_length | int | The length to wrap the extracted text, excluding tables. Default is 120. | 120 | True |
| include_tables | bool | Return tables formatted as markdown in the text. Default is False. Tables may reveal 'missing' content, but will likely need some level of manual cleaning, post-request, to display properly. In some cases, tables may not be recoverable due to the nature of the document. | False | True |
| use_cache | bool | When True, the file will be cached for use later. Default is True. | True | True |
| raw_html | bool | When True, the raw HTML content of the entire filing will be returned. Default is False. Use this option to parse the document manually. | False | True |
Data
- standard
- sec
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |
| calendar_year | int | The calendar year of the report. |
| calendar_period | int | The calendar period of the report. |
| period_ending | date | The end date of the reporting period. |
| content | str | The content of the management discussion and analysis. |
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |
| calendar_year | int | The calendar year of the report. |
| calendar_period | int | The calendar period of the report. |
| period_ending | date | The end date of the reporting period. |
| content | str | The content of the management discussion and analysis. |
| url | str | The URL of the filing from which the data was extracted. |