Petroleum Status Report
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
PetroleumStatusReport | PetroleumStatusReportQueryParams | PetroleumStatusReportData |
Import Statement
from openbb_core.provider.standard_models.petroleum_status_report import (
PetroleumStatusReportData,
PetroleumStatusReportQueryParams,
)
Parameters
- standard
- eia
| 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 |
| 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 |
| category | Literal['balance_sheet', 'inputs_and_production', 'refiner_blender_net_production', 'crude_petroleum_stocks', 'gasoline_fuel_stocks', 'total_gasoline_by_sub_padd', 'distillate_fuel_oil_stocks', 'imports', 'imports_by_country', 'weekly_estimates', 'spot_prices_crude_gas_heating', 'spot_prices_diesel_jet_fuel_propane', 'retail_prices'] | The group of data to be returned. The default is the balance sheet. | balance_sheet | True |
| table | Union[str, List[str]] | The specific table element within the category to be returned, default is 'stocks', if the category is 'weekly_estimates', else 'all'. Note: Choices represent all available tables from the entire collection and are not all available for every category. Invalid choices will raise a ValidationError with a message indicating the valid choices for the selected category. Choices are:; all; conventional_gas; crude; crude_production; crude_production_avg; diesel; ethanol_plant_production; ethanol_plant_production_avg; exports; exports_avg; heating_oil; imports; imports_avg; imports_by_country; imports_by_country_avg; inputs_and_utilization; inputs_and_utilization_avg; jet_fuel; monthly; net_imports_inc_spr_avg; net_imports_incl_spr; net_production; net_production_avg; net_production_by_product; net_production_by_production_avg; product_by_region; product_by_region_avg; product_supplied; product_supplied_avg; propane; rbob; refiner_blender_net_production; refiner_blender_net_production_avg; stocks; supply; supply_avg; ulta_low_sulfur_distillate_reclassification; ulta_low_sulfur_distillate_reclassification_avg; weekly Multiple items allowed for provider(s): eia. | None | True |
| use_cache | bool | Subsequent requests for the same source data are cached for the session using ALRU cache. | True | True |
Data
- standard
- eia
| Name | Type | Description |
|---|---|---|
| date | Union[date, str] | The date of the data. |
| table | str | Table name for the data. |
| symbol | str | Symbol representing the entity requested in the data. |
| order | int | Presented order of the data, relative to the table. |
| title | str | Title of the data. |
| value | Union[int, float] | Value of the data. |
| unit | str | Unit or scale of the data. |
| Name | Type | Description |
|---|---|---|
| date | Union[date, str] | The date of the data. |
| table | str | Table name for the data. |
| symbol | str | Symbol representing the entity requested in the data. |
| order | int | Presented order of the data, relative to the table. |
| title | str | Title of the data. |
| value | Union[int, float] | Value of the data. |
| unit | str | Unit or scale of the data. |