Food Availability Per Capita Data System
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FoodAvailabilityPerCapitaDataSystem | FoodAvailabilityPerCapitaDataSystemQueryParams | FoodAvailabilityPerCapitaDataSystemData |
Import Statement
from openbb_core.provider.standard_models. import (
FoodAvailabilityPerCapitaDataSystemData,
FoodAvailabilityPerCapitaDataSystemQueryParams,
)
Parameters
- standard
- usda
data_system: str | None
Default: food_availability
Description
Data system to retrieve. Each selection downloads one cached file, pivoted to a wide layout with the measures spread into columns and the years in the rows. Valid data systems are:
food_availability, loss_adjusted, nutrient
food_group: str | None
Food group file within the data system, as a slug. The same slug can appear under more than one data system. If None, the data system's default file is used.
commodity: str | None
Commodity block within the file, as its published name. If None, the file's first block is used.
start_year: int | None
Start year for filtering the data. If None, returns from the beginning of the series.
end_year: int | None
End year for filtering the data. If None, returns up to the most recent year.
Data
- standard
- usda
year: int
Calendar year of the observation.