report_calendar
Get the USDA Foreign Agricultural Service calendar of upcoming report releases.
Examples
from openbb import obb
obb.usda.report_calendar(provider='usda')
# Get the upcoming Weekly Export Sales releases.
obb.usda.report_calendar(report_type='export_sales', provider='usda')
# Get upcoming releases covering cotton.
obb.usda.report_calendar(commodity='cotton', provider='usda')
Parameters
- standard
- usda
report_type: str | None
Filter by the type of report.
Choices
- export_sales
- trade_forecast
- world_markets_trade
commodity: str | None
Filter by commodity.
Choices
- beef
- coffee
- corn
- cotton
- cotton_and_hemp
- dairy_livestock_and_poultry
- dairy_products
- fresh_fruit
- fruits_and_vegetables
- grains_feeds_and_fodders
- oilseeds
- oilseeds_excluding_soybean
- pork
- poultry
- processed_food_products
- rice
- soybeans
- tree_nuts
- wheat
keyword: str | None
Free-text filter. Matches a release's associated commodities as well as its title, so it is broader than a title search.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format. Applied to the release date after fetching.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format. Applied to the release date after fetching.
Returns
results: FasReportCalendar
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
release_date: date
Date of the release, in Eastern Time.
release_time: str | None
Time of day of the release, in Eastern Time.
day_of_week: str | None
Day of the week of the release.
release_datetime: datetime | None
Timestamp of the release, in UTC. None for releases whose scheduled time has already passed, which the source stops publishing a calendar entry for.
report_type: str | None
Type of the report.
title: str
Title of the report.
url: str | None
URL of the release announcement.
released: bool
Whether the release time has already passed.