Eia Petroleum Us Crude Oil Supply Disposition
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaPetroleumUsCrudeOilSupplyDisposition | EiaPetroleumUsCrudeOilSupplyDispositionQueryParams | EiaPetroleumUsCrudeOilSupplyDispositionData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaPetroleumUsCrudeOilSupplyDispositionData,
EiaPetroleumUsCrudeOilSupplyDispositionQueryParams,
)
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'monthly'.
process: str | None | list[str | None]
Process filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- days_of_petroleum_net_imports
- ending_stocks
- ending_stocks_excluding_spr
- ending_stocks_spr
- exports
- field_production
- imports
- imports_excluding_spr
- imports_spr
- imports_by_others_for_spr
- percent_of_crude_oil_stocks
- percent_of_total_petroleum_stocks
- product_supplied
- refinery_and_blender_net_input
- spr_receipts_detail_domestic
- spr_receipts_detail_receipts
- spr_stock_change
- stock_change
- stock_change_excluding_spr
- stocks_at_leases
- stocks_at_refineries
- stocks_at_tank_farms
- stocks_in_transit_from_alaska
- supply_adjustment
region: str | None | list[str | None]
DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- na
- us
- usa_ak
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- alaska_field_production_of_crude_oil
- cushing_ok_ending_stocks_of_crude_oil
- lower_48_states_field_production_of_crude_oil
- us_crude_oil_imports_excluding_spr
- us_crude_oil_imports_for_spr_by_others_from_all_countries
- us_crude_oil_spr_imports_from_all_countries
- us_crude_oil_spr_stock_change
- us_crude_oil_stock_change
- us_crude_oil_stock_change_excluding_spr
- us_crude_oil_stocks_at_leases
- us_crude_oil_stocks_at_refineries
- us_crude_oil_stocks_at_tank_farms_and_pipelines
- us_crude_oil_stocks_in_transit_from_alaska
- us_crude_oil_spr_receipts_detail_domestic
- us_crude_oil_spr_receipts_detail_receipts
- us_ending_stocks_excluding_spr_of_crude_oil
- us_ending_stocks_of_crude_oil
- us_ending_stocks_of_crude_oil_in_spr
- us_exports_of_crude_oil
- us_field_production_of_crude_oil
- us_imports_of_crude_oil
- us_percent_of_crude_oil_stocks_held_in_spr
- us_percent_of_total_petroleum_stocks_held_in_spr
- us_product_supplied_of_crude_oil
- us_refinery_and_blender_net_input_of_crude_oil
- us_spr_stocks_as_days_of_supply_of_total_petroleum_net
- us_supply_adjustment_of_crude_oil
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
sort: str | None
Default: asc
Sort the results by date.
limit: int | None
Maximum number of rows to return. The default returns all rows, paginating requests as needed.
Data
- standard
- eia
process: str | None
Process code.
process_name: str | None
Process name.
product: str | None
Product code.
product_name: str | None
Product name.
region: str | None
DuoArea code.
region_name: str | None
DuoArea name.
series: str | None
Series code.
series_name: str | None
Series name.
value: float | None
Value. Withheld or unavailable values return as null.
units: str | None
Unit of the value.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.