re tool
Publicre_search_geographies
Resolve a U.S. place to geography keys and containment links.
Description
Resolve a U.S. place to geography keys and containment links.
The shared envelope returns data.query and ranked data.matches.
Each match carries geo_key, level, code, name, state_code, score,
match_reason, a bottom-up parents chain, and outgoing crosswalks
with relation, weight, source, and vintage. ZCTA-to-county crosswalks
can have weights; county-to-CBSA weights are null. meta.source is
census_geo and meta.notice repeats the payload-level Census
attribution notice; pagination is null because this is a bounded
relevance list. The limit is 1–50. A blank query is a normal empty
success.
Use this before re_search_series when you have a place rather than an
exact geo_key. Example: search Austin, TX, choose cbsa_12420, then
discover series for that CBSA. Census Bureau geography files and OMB
delineation lists are the origin. This product uses Census Bureau data but is not endorsed or certified by the Census Bureau.
Parameters
Input schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| query | string | Yes | — | Free-form U.S. place, postal abbreviation, or Census/OMB code. Call this first to resolve a place to a stable geo_key, then pass that geo_key to re_search_series. For example, 'Austin, TX' resolves to the Austin CBSA geo_key 'cbsa_12420'. |
| limit | integer | No | 10 | Maximum ranked geography matches to return (1–50). |
Provenance
Sources
- census_geoU.S. Census Bureau
- census_rel2020U.S. Census Bureau
- fhfaFederal Housing Finance Agency
- hudU.S. Department of Housing and Urban Development
- noaaNational Oceanic and Atmospheric Administration
- omb_delineation_2023Office of Management and Budget (delineation lists distributed via the U.S. Census Bureau)
Dataset registry: realestate_fhfa_hpi, realestate_hud_fmr, realestate_noaa_storm_events