Fruit And Tree Nuts Data
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FruitAndTreeNutsData | FruitAndTreeNutsDataQueryParams | FruitAndTreeNutsDataData |
Import Statement
from openbb_core.provider.standard_models. import (
FruitAndTreeNutsDataData,
FruitAndTreeNutsDataQueryParams,
)
Parameters
- standard
- usda
category: str | None
Default: A
Description
Yearbook table category, used to narrow the table list. Valid categories are:
A (U.S. summary and per-capita availability), B (Noncitrus fruit), C (Citrus), D (Berries), E (Melons), F (Tree nuts), G (Supply and per-capita availability), H (Import share)
table: str | None
Default: A-1
Description
Yearbook table to retrieve, by its short code. Each of the 152 tables shares one long schema and is pivoted to a wide layout where the measure dimensions become value columns, with the unit in each column header. Valid tables are:
A-1, A-2, A-3, A-4, A-5, A-6, A-7, A-8, A-9, A-10, A-11, A-12, A-13, A-14, A-15, B-1, B-2, B-3, B-4, B-5, B-6, B-7, B-8, B-9, B-10, B-11, B-12, B-13, B-14, B-15, B-16, B-17, B-18, B-19, B-20, B-21, B-22, B-23, B-24, B-25, B-26, B-27, B-28, B-29, C-1, C-2, C-3, C-4, C-5, C-6, C-7, C-8, C-9, C-10, C-11, C-12, C-13, C-14, C-15, C-16, C-17, C-18, C-19, C-20, D-1, D-2, D-3, D-4, D-5, D-6, D-7, D-8, D-9, D-10, E-1, E-2, E-3, E-4, E-5, E-6, E-7, E-8, E-9, E-10, F-1, F-2, F-3, F-4, F-5, F-6, F-7, F-8, F-9, F-10, F-11, F-12, F-13, F-14, F-15, F-16, F-17, F-18, G-1, G-2, G-3, G-4, G-5, G-6, G-7, G-8, G-9, G-10, G-11, G-12, G-13, G-14, G-15, G-16, G-17, G-18, G-19, G-20, G-21, G-22, G-23, G-24, G-25, G-26, G-27, G-28, G-29, G-30, G-31, G-32, G-33, G-34, G-35, G-36, G-37, G-38, G-39, G-40, G-41, G-42, G-43, G-44, G-45, H-1, H-2, H-3, H-4, H-5
start_year: int | None
Start year for filtering the data, compared against the first four digits of the calendar or marketing year label. 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 calendar or marketing year label. If None, returns up to the most recent year.
Data
- standard
- usda
year: str
Period label of the observation, as published: a calendar year such as '1980', a marketing year such as '1980/81', or, on the tables that break a measure out by commodity down the rows, the commodity prefixed to that period.
commodity: str | None
Commodity of the observation, as published. Present only when the table breaks a measure out by commodity down the rows; otherwise the commodities are the value columns.
month: str | None
Month of the observation, for the monthly price tables. Absent on the annual tables.