Commodity Costs And Returns
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
CommodityCostsAndReturns | CommodityCostsAndReturnsQueryParams | CommodityCostsAndReturnsData |
Import Statement
from openbb_core.provider.standard_models. import (
CommodityCostsAndReturnsData,
CommodityCostsAndReturnsQueryParams,
)
Parameters
- standard
- usda
commodity: str | None
Default: corn
Description
Commodity budget to retrieve; selects the per-commodity cost-and-return file. Valid commodities are:
corn, cotton, barley, peanuts, rice, sorghum, oats, soybeans, wheat, milk, cow_calf, hogs_all, hogs_farrow_finish, hogs_farrow_feeder, hogs_feeder_finish, hogs_farrow_weanling, hogs_weanling_feeder
region: str | None
ERS Farm Resource Region to retrieve, as the published region label. The region set varies per commodity. If None, every region in the commodity's budget is returned, with 'U.S. total' the national aggregate.
category: str | None
Description
Budget section to retrieve. If None, all sections are returned. Valid sections are:
gross_value_of_production, operating_costs, net_value, allocated_overhead, costs_listed, supporting_information, production_practices, size_of_operation, production_arrangement
start_year: int | None
Start year for filtering the data. None returns from the commodity's first available year.
end_year: int | None
End year for filtering the data. If None, returns up to the most recent year.
Data
- standard
- usda
commodity: str
Commodity name, as published.
region: str
ERS Farm Resource Region of the budget, or 'U.S. total' for the national aggregate.
category: str
Budget section of the line, as published, e.g. 'Operating costs' or 'Gross value of production'.
item: str
Budget line item, as published, with footnote superscripts and stray whitespace stripped.
units: str
Unit of the line's values, as published, e.g. 'dollars per planted acre' or 'bushels per planted acre'.
survey_base_year: str | None
Survey base of the most recent year in the row, as published, e.g. 'Base survey of 2021'.