frontier_and_remote_area_codes
Get ERS frontier and remote (FAR) area codes - a ZIP-code geographic classification lookup at four FAR levels with grid population, land area, and population density, in a single-vintage lookup table scoped by State.
Examples
from openbb import obb
obb.usda.frontier_and_remote_area_codes(provider='usda')
# Get the 2020 frontier and remote area codes for California ZIP Codes.
obb.usda.frontier_and_remote_area_codes(year='2020', state='CA', provider='usda')
# Get the 2000 vintage for Massachusetts ZIP Codes.
obb.usda.frontier_and_remote_area_codes(year='2000', state='MA', provider='usda')
Parameters
- standard
- usda
year: str | None
Default: 2020
Description
Decennial classification vintage to retrieve, selecting the source workbook. Valid vintages are:
2020, 2010, 2000
state: str | None
Default: MT
State to retrieve, as a two-letter postal abbreviation. The ZIP-code lookup carries tens of thousands of rows, so the state is the primary scope filter. The 2000 vintage covers the contiguous States and excludes Alaska and Hawaii. If None, defaults to Montana.
Returns
results: FrontierAndRemoteAreaCodes
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
zip_code: str
ZIP Code of the area.
state: str
Two-letter postal abbreviation of the area's State.
po_name: str | None
Post office name of the ZIP-code area, as published. The 2000 vintage carries no area name.
far_level_1: int | None
FAR level 1 flag: 1 when the area is frontier and remote at level 1, else 0.
far_level_2: int | None
FAR level 2 flag: 1 when the area is frontier and remote at level 2, else 0.
far_level_3: int | None
FAR level 3 flag: 1 when the area is frontier and remote at level 3, else 0.
far_level_4: int | None
FAR level 4 flag: 1 when the area is frontier and remote at level 4, else 0.
grid_population: float | None
Population of the area's populated grid cells.
land_area_sq_mi: float | None
Land area of the area, in square miles.
population_density: float | None
Population density of the area, in persons per square mile.
far_level_1_population: float | None
Population of the area classified as FAR level 1.
far_level_2_population: float | None
Population of the area classified as FAR level 2.
far_level_3_population: float | None
Population of the area classified as FAR level 3.
far_level_4_population: float | None
Population of the area classified as FAR level 4.
far_level_1_population_pct: float | None
Share of the area's grid population classified as FAR level 1, in percent.
far_level_2_population_pct: float | None
Share of the area's grid population classified as FAR level 2, in percent.
far_level_3_population_pct: float | None
Share of the area's grid population classified as FAR level 3, in percent.
far_level_4_population_pct: float | None
Share of the area's grid population classified as FAR level 4, in percent.