re_get_series
Fetch a bounded, newest-first page of one real-estate series.
Description
Fetch a bounded, newest-first page of one real-estate series.
The shared envelope returns series metadata, exact decimal observations,
per-value as_of, source vintage/effective date, and cursor pagination.
This tool serves latest values only: it has no as_known_at
point-in-time parameter yet, so stored vintages are not queryable here.
The default is 100 observations and the limit is 1–500. To continue,
pass pagination.next_cursor back as cursor; stop when has_more is
false. Prefer start/end for a bounded analysis window.
Call re_search_series first unless you already have the exact key.
Example: fetch fhfa_hpi_at_quarterly_nsa_cbsa_12420 after resolving
Austin with re_search_geographies. unknown_entity means the key is
not held and may include suggestions; recover by calling
re_search_series. bad_parameter means the cursor is malformed.
Sources include FHFA and HUD housing, NOAA NCEI hazards, Census ACS
housing, and Census BPS permits. ACS observations carry 90-percent
margins of error in meta.moe. These U.S. government datasets are
public-domain; payloads retain source, license_tag, and attribution.
Parameters
Input schema advertised to MCP clients and mirrored by the REST query string.
| Name | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| series_key | string | Yes | — | — | Exact series_key returned by re_search_series, for example 'fhfa_hpi_at_quarterly_nsa_cbsa_12420'. Call re_search_series first for discovery; this tool does not fuzzy-match. |
| start | string (date) | null | No | null | — | Inclusive observation-period start (YYYY-MM-DD). |
| end | string (date) | null | No | null | — | Inclusive observation-period end (YYYY-MM-DD). |
| limit | integer | No | 100 | min 1, max 500 | Observations to return, newest first (1–500). |
| cursor | string | null | No | null | — | Opaque cursor from the previous response's pagination.next_cursor. Keep series_key, start, and end constant while paging; omit to start from the newest observation. |
Provenance
Sources behind every value this tool returns.
- absAustralian Bureau of Statistics
- censusU.S. Census Bureau
- fdic_sodFederal Deposit Insurance Corporation
- fhfaFederal Housing Finance Agency
- hudU.S. Department of Housing and Urban Development
- noaaNational Oceanic and Atmospheric Administration
Dataset registry: realestate_abs_au_building, realestate_census_acs_housing, realestate_census_bps_permits, realestate_fdic_sod, realestate_fhfa_hpi, realestate_hud_fmr, realestate_noaa_storm_events