Eia Crude Oil Imports
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaCrudeOilImports | EiaCrudeOilImportsQueryParams | EiaCrudeOilImportsData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaCrudeOilImportsData,
EiaCrudeOilImportsQueryParams,
)
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'monthly'.
destination: str | None | list[str | None]
Destination Id filter. Accepts a comma-separated list of values. There are 513 valid values - use the facet_options endpoint to list them. Multiple items allowed.
destination_type: str | None | list[str | None]
Destination Type filter. Multiple items allowed.
Choices
- port
- port_padd
- port_state
- refinery
- refinery_padd
- refinery_state
- united_states
grade: str | None | list[str | None]
Grade Id filter. Multiple items allowed.
Choices
- heavy_sour
- heavy_sweet
- light_sour
- light_sweet
- medium
origin: str | None | list[str | None]
Origin Id filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- africa
- albania
- algeria
- angola
- argentina
- asia_pacific
- australia
- azerbaijan
- barbados
- belize
- bolivia
- brazil
- brunei
- cameroon
- canada
- canada_region
- chad
- china
- colombia
- congo_brazzaville
- congo_kinshasa
- cote_d_ivoire
- denmark
- ecuador
- egypt
- equatorial_guinea
- eurasia
- europe
- gabon
- ghana
- guatemala
- guyana
- indonesia
- iran
- iraq
- italy
- kazakhstan
- kuwait
- libya
- malaysia
- mauritania
- mexico
- middle_east
- netherlands
- nigeria
- non_opec
- norway
- opec
- oman
- other_americas
- panama
- papua_new_guinea
- peru
- qatar
- russia
- saudi_arabia
- senegal
- south_africa
- south_sudan
- spain
- syria
- thailand
- the_bahamas
- trinidad_and_tobago
- tunisia
- united_arab_emirates
- united_kingdom
- venezuela
- vietnam
- world
- yemen
origin_type: str | None | list[str | None]
Origin Type filter. Multiple items allowed.
Choices
- country
- opec_non_opec
- region
- world
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
destination: str | None
Destination Id code.
destination_name: str | None
Destination Id name.
destination_type: str | None
Destination Type code.
destination_type_name: str | None
Destination Type name.
grade: str | None
Grade Id code.
grade_name: str | None
Grade Id name.
origin: str | None
Origin Id code.
origin_name: str | None
Origin Id name.
origin_type: str | None
Origin Type code.
origin_type_name: str | None
Origin Type name.
quantity: float | None
Quantity (thousand barrels). Withheld or unavailable values return as null.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.