Oil Crops Yearbook
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
OilCropsYearbook | OilCropsYearbookQueryParams | OilCropsYearbookData |
Import Statement
from openbb_core.provider.standard_models. import (
OilCropsYearbookData,
OilCropsYearbookQueryParams,
)
Parameters
- standard
- usda
table: str | None
Default: soybeans_supply_disappearance_price
Description
Oil Crops Yearbook table to retrieve. Each table is a set of named supply, use, price, or trade series indexed by year, and sometimes by month or quarter; the series spread into value columns while time stays in the rows. Valid tables are:
soybean_stocks_quarterly, soybeans_acreage_production_yield_value, soybeans_supply_disappearance_price, soybean_meal_supply_disappearance_price, soybean_oil_supply_disappearance_price, soybeans_supply_disappearance_by_quarter, soybean_meal_supply_disappearance_by_month, soybean_oil_supply_disappearance_by_month, soybean_crush_value_price_spread, peanuts_acreage_production_yield_value, peanuts_supply_disappearance_price, peanuts_food_use, peanuts_planted_acreage_by_state, peanuts_harvested_acreage_by_state, peanuts_production_by_state, peanuts_yield_by_state, cottonseed_acreage_production_yield_value, cottonseed_supply_disappearance_price, cottonseed_meal_supply_disappearance_price, cottonseed_oil_supply_disappearance_price, sunflowerseed_acreage_production_yield_value, sunflowerseed_supply_disappearance_price, sunflowerseed_meal_supply_disappearance_price, sunflowerseed_oil_supply_disappearance_price, canola_seed_supply_disappearance_price, canola_oil_supply_disappearance_price, canola_meal_supply_disappearance_price, flaxseed_acreage_production_yield_value, flaxseed_supply_disappearance_price, linseed_meal_supply_disappearance_price, linseed_oil_supply_disappearance_price, edible_fats_and_oils_supply_disappearance, corn_oil_supply_disappearance_price, prices_received_by_farmers, prices_terminal_markets, prices_oilmeals, prices_fats_and_oils_wholesale, prices_producer_price_indexes, lard_supply_disappearance_price, edible_tallow_supply_disappearance_price, world_soybean_complex_supply_and_use, soybean_exports_by_destination, soybean_meal_exports_by_destination, soybean_oil_exports_by_destination, world_oilseed_supply_and_distribution, world_vegetable_oils_supply_and_distribution, world_protein_meal_supply_and_distribution
frequency: str | None
Observation frequency to keep, one of the frequencies the selected table publishes: 'point_in_time', 'annual', 'quarterly', or 'monthly'. Filtering to one frequency yields a single aligned time series. If None, the table's default frequency is used.
start_year: int | None
Start year for filtering the data, compared against the first four digits of the marketing or calendar year. If None, returns from the beginning of the series.
end_year: int | None
End year for filtering the data, compared against the first four digits of the marketing or calendar year. If None, returns up to the most recent year.
Data
- standard
- usda
period: str
Row label of the observation: the marketing or calendar year for annual tables ('2024/25'), the year and month, quarter, or stocks date for sub-annual tables ('2024/25 October', '2024/25 March 1'), with any varying commodity or geography prefixed so each row is uniquely labeled.