re tool
Publicre_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.
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.
All current sources — FHFA, HUD, and NOAA NCEI — are U.S. government
public-domain data and are publicly redistributable. The payload keeps
source and license_tag attribution for downstream use.
Parameters
Input schema
| Name | Type | Required | Default | 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 | 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. |