re tool
Publicre_search_series
Discover real-estate series for a topic and/or exact geography.
Description
Discover real-estate series for a topic and/or exact geography.
Call re_search_geographies first when a place has not been resolved,
then pass its geo_key here. The shared envelope echoes query and
geo_key; each match carries its series_key, dataset/source metadata,
geography, and nullable observation coverage_start/coverage_end.
Results sort by series_key ascending. The limit is 1–50; when
pagination.has_more is true, pass pagination.next_cursor back as
cursor with the same filters. Then pass the chosen series_key to
re_get_series.
Provide at least one non-blank filter. Example: geo_key cbsa_12420
plus query house price can return
fhfa_hpi_at_quarterly_nsa_cbsa_12420. Errors use bad_parameter for
missing filters or a malformed cursor and unknown_entity for an
unknown geo_key; recover from the latter by calling
re_search_geographies first.
Parameters
Input schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| query | string | null | No | null | Optional case-insensitive topic fragment. Every whitespace token must appear in the series title or dataset_key. Combine with geo_key to narrow discovery; provide query and/or geo_key. |
| geo_key | string | null | No | null | Optional exact geography key from re_search_geographies, such as 'cbsa_12420'. Unknown keys return unknown_entity with suggestions. |
| limit | integer | No | 10 | Series matches to return in series_key order (1–50). |
| cursor | string | null | No | null | Opaque cursor from the previous response's pagination.next_cursor. Keep query and geo_key constant while paging; omit to start at the first series_key. |
Provenance
Sources
- fhfaFederal Housing Finance Agency
- hudU.S. Department of Housing and Urban Development
- noaaNational Oceanic and Atmospheric Administration
- realestate_catalogCurated internal catalog (FHFA, HUD, NOAA NCEI)
Dataset registry: realestate_fhfa_hpi, realestate_hud_fmr, realestate_noaa_storm_events