rice_yearbook
Get ERS rice data - the Rice Yearbook acreage, supply, use, stocks, price, and trade tables, each pivoted to a wide layout by year.
Examples
from openbb import obb
obb.usda.rice_yearbook(provider='usda')
# Get world rice trade on a milled basis since 2020.
obb.usda.rice_yearbook(table='world_trade_milled_basis', start_year=2020, provider='usda')
# Get the top 10 U.S. rice export markets.
obb.usda.rice_yearbook(table='us_top_export_markets', provider='usda')
Parameters
- standard
- usda
table: str | None
Default: us_supply_disappearance_price
Description
Rice-yearbook table to retrieve. Each table is a set of named acreage, supply-use, price, or trade series indexed by year and period; the series become the wide value columns while time stays in the rows. Valid tables are:
us_area_planted_by_class, us_state_yields, us_acreage_yield_production, us_production_by_class, us_state_acreage_yield_production_by_class, us_production_class_distribution, us_supply_use_by_class, us_supply_disappearance_price, long_grain_supply_disappearance_price, medium_short_grain_supply_disappearance_price, us_stocks_rough_and_milled, us_exports_by_type, us_top_export_markets, us_imports_by_origin, us_rough_price_by_month, us_rough_price_by_month_and_class, us_milled_price_milling_centers, us_byproduct_prices, us_brewers_rice_prices, us_prices_and_payment_rates, us_class_loan_values, world_market_prices_loan_basis, world_supply_and_utilization, world_trade_milled_basis, thailand_export_prices, vietnam_export_prices, india_export_prices, pakistan_export_prices
frequency: str | None
Observation frequency to keep, one of the frequencies the selected table publishes: 'Annual', 'Point-in-time', 'Weekly', or 'Monthly'. Filtering to one frequency yields a single aligned time series. If None, the finest frequency the table offers is used.
start_year: int | None
Start year for filtering the data, compared against the observation year. If None, returns from the beginning of the series.
end_year: int | None
End year for filtering the data, compared against the observation year. If None, returns up to the most recent year.
Returns
results: RiceYearbook
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- usda
period: str
Row label of the observation: the year for annual tables ('2020'), the year and month or stocks date for sub-annual tables ('2020 August', '2020 March 1'), with any varying class, location, or rank dimension prefixed so each row is uniquely labeled.