REST reference

Available[4 endpoints]View as Markdown

Real Estate

US housing and real-estate indicators — FHFA house price indices and related series.

Paths are relative to https://api.agentdatasets.com. Every endpoint mirrors an MCP tool over the same service layer — the tool catalog documents the same operations for MCP clients.

Geographies Search

Resolve a place to geography keys, parents, and outgoing crosswalks.

Parameters

NameTypeRequiredDefaultConstraintsDescription
querystringYes——U.S. place, postal abbreviation, or Census/OMB code
limitintegerNo10min 1, max 50Maximum ranked matches to return

Example request

Required parameters only, with values taken from the schema. Optional parameters are in the table above.

[ BASH ]
curl --fail --silent --show-error \
  --header "X-API-KEY: adk_..." \
  "https://api.agentdatasets.com/v1/re/geographies/search?query=QUERY"

Response

200 Successful Response · expand a branch to see its fields.

  • dataREGeographySearchDatarequired
    • querystringrequired
    • matchesarray<REGeographyMatch>required
      • geo_keystringrequired
      • level"nation" | "state" | "county" | "cbsa" | "zip3" | "zcta" | "au_state" | "au_gccsa" | "au_sa4" | "au_sa3" | "au_lga"required
      • codestringrequired
      • namestringrequired
      • state_codestringrequirednullable
      • scorenumberrequired
      • match_reason"code_exact" | "postal_exact" | "name_exact" | "alias_exact" | "name_fuzzy" | "alias_fuzzy"required
      • parentsarray<REParentGeography>required
        • geo_keystringrequired
        • level"nation" | "state" | "county" | "cbsa" | "zip3" | "zcta" | "au_state" | "au_gccsa" | "au_sa4" | "au_sa3" | "au_lga"required
        • codestringrequired
        • namestringrequired
      • crosswalksarray<REGeographyCrosswalk>required
        • geo_keystringrequired
        • level"nation" | "state" | "county" | "cbsa" | "zip3" | "zcta" | "au_state" | "au_gccsa" | "au_sa4" | "au_sa3" | "au_lga"required
        • codestringrequired
        • namestringrequired
        • relation"zcta_county" | "county_cbsa"required
        • weightstringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
        • sourcestringrequired
        • vintagestringrequired
  • metaREGeographySearchMetarequiredBase meta plus the constant Census non-endorsement notice carried by every geography-search payload — the matches, parents, and crosswalks are Census Bureau / OMB derived.
    • sourcestringrequired
    • as_ofstring (date-time) | string (date)nullable
    • noticestringdefault "This product uses Census Bureau data but is not endorsed or certified by the Census Bureau."
  • paginationPaginationnullable
    • limitintegerrequired
    • has_morebooleanrequired
    • next_cursorstringnullable

GET/v1/re/hazard-profile

Hazard Profile

Return one county's newest FEMA National Risk Index profile.

Parameters

NameTypeRequiredDefaultConstraintsDescription
fips_or_geo_keystringYes——5-digit county FIPS or county geo_key

Example request

Required parameters only, with values taken from the schema. Optional parameters are in the table above.

[ BASH ]
curl --fail --silent --show-error \
  --header "X-API-KEY: adk_..." \
  "https://api.agentdatasets.com/v1/re/hazard-profile?fips_or_geo_key=FIPS_OR_GEO_KEY"

Response

200 Successful Response · expand a branch to see its fields.

  • dataREHazardProfileDatarequiredOne county's newest FEMA NRI release and its persisted hazard slices.
    • fipsstringrequired
    • county_namestringrequirednullable
    • state_namestringrequirednullable
    • state_abbrevstringrequirednullable
    • geo_keystringrequirednullable
    • release_versionstringrequired
    • release_datestring (date)required
    • risk_scorestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
    • risk_ratingstringrequirednullable
    • risk_valuestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
    • risk_percentilestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
    • eal_totalstringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
    • eal_scorestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
    • eal_ratingstringrequirednullable
    • eal_percentilestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
    • sovi_scorestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
    • sovi_ratingstringrequirednullable
    • resl_scorestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
    • resl_ratingstringrequirednullable
    • populationintegerrequirednullable
    • building_valuestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
    • agriculture_valuestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
    • hazardsarray<REHazardProfileHazard>required
      • hazard_codestringrequired
      • hazard_namestringrequired
      • risk_scorestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
      • risk_ratingstringrequirednullable
      • risk_valuestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
      • eal_totalstringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
      • eal_scorestringrequirednullablepattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
      • eal_ratingstringrequirednullable
  • metaMetarequiredResult-level provenance. ``source`` is a stable connector identifier (e.g. ``sec_edgar_companyfacts``); ``as_of`` is the freshest value-level ``as_of`` on the returned page, or ``None`` when the page is empty. Event-grained sources carry an aware datetime; date-grained sources (e.g. an SEC filing's report period) carry a plain date.
    • sourcestringrequired
    • as_ofstring (date-time) | string (date)nullable
  • paginationPaginationnullable
    • limitintegerrequired
    • has_morebooleanrequired
    • next_cursorstringnullable

GET/v1/re/series

Series

Return one real-estate series' bounded, newest-first observations.

Parameters

NameTypeRequiredDefaultConstraintsDescription
series_keystringYes——Exact series_key returned by real-estate series search
startstring (date) | nullNo——Inclusive observation-period start (YYYY-MM-DD)
endstring (date) | nullNo——Inclusive observation-period end (YYYY-MM-DD)
limitintegerNo100min 1, max 500Observations to return, newest first
cursorstring | nullNo——Opaque cursor from pagination.next_cursor

Example request

Required parameters only, with values taken from the schema. Optional parameters are in the table above.

[ BASH ]
curl --fail --silent --show-error \
  --header "X-API-KEY: adk_..." \
  "https://api.agentdatasets.com/v1/re/series?series_key=SERIES_KEY"

Response

200 Successful Response · expand a branch to see its fields.

  • dataRESeriesDatarequired
    • series_keystringrequired
    • dataset_keystringrequired
    • source"fhfa" | "hud" | "census" | "noaa" | "fdic_sod" | "abs" | "nyc_acris"required
    • source_series_idstringrequired
    • titlestringrequired
    • attributionstringrequirednullable
    • unitsstringrequired
    • base_periodstringrequirednullable
    • currencystringrequirednullable
    • frequency"daily" | "weekly" | "monthly" | "quarterly" | "annual"required
    • seasonal_adjustment"seasonally_adjusted" | "not_seasonally_adjusted" | "not_applicable"required
    • license_tagstringrequired
    • geographyagent_datasets__realestate__service__GeographyRefrequired
      • geo_keystringrequired
      • level"nation" | "state" | "county" | "cbsa" | "zip3" | "zcta" | "au_state" | "au_gccsa" | "au_sa4" | "au_sa3" | "au_lga"required
      • codestringrequired
      • namestringrequired
      • state_codestringrequirednullable
    • startstring (date)requirednullable
    • endstring (date)requirednullable
    • observationsarray<RESeriesObservation>required
      • periodstring (date)required
      • period_type"date" | "month" | "quarter" | "year"required
      • valuestringrequiredpattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
      • as_ofstring (date-time)required
      • source_vintagestringrequirednullable
      • effective_datestring (date)requirednullable
      • metaobjectrequirednullable
  • metaRESeriesMetarequiredSeries provenance with a courtesy notice for Census-owned data.
    • sourcestringrequired
    • as_ofstring (date-time) | string (date)nullable
    • noticestringnullable
  • paginationPaginationnullable
    • limitintegerrequired
    • has_morebooleanrequired
    • next_cursorstringnullable

Series Search

Search real-estate series by topic and/or exact geography.

Parameters

NameTypeRequiredDefaultConstraintsDescription
querystring | nullNo——Optional title or dataset-key token query
geo_keystring | nullNo——Optional exact geo_key returned by geography search
limitintegerNo10min 1, max 50Series matches to return
cursorstring | nullNo——Opaque cursor from pagination.next_cursor

Example request

Required parameters only, with values taken from the schema. Optional parameters are in the table above.

[ BASH ]
curl --fail --silent --show-error \
  --header "X-API-KEY: adk_..." \
  "https://api.agentdatasets.com/v1/re/series/search"

Response

200 Successful Response · expand a branch to see its fields.

  • dataRESeriesSearchDatarequired
    • querystringrequirednullable
    • geo_keystringrequirednullable
    • matchesarray<RESeriesMatch>required
      • series_keystringrequired
      • dataset_keystringrequired
      • source"fhfa" | "hud" | "census" | "noaa" | "fdic_sod" | "abs" | "nyc_acris"required
      • titlestringrequired
      • unitsstringrequired
      • base_periodstringrequirednullable
      • currencystringrequirednullable
      • frequency"daily" | "weekly" | "monthly" | "quarterly" | "annual"required
      • seasonal_adjustment"seasonally_adjusted" | "not_seasonally_adjusted" | "not_applicable"required
      • license_tagstringrequired
      • geographyagent_datasets__realestate__service__GeographyRefrequired
        • geo_keystringrequired
        • level"nation" | "state" | "county" | "cbsa" | "zip3" | "zcta" | "au_state" | "au_gccsa" | "au_sa4" | "au_sa3" | "au_lga"required
        • codestringrequired
        • namestringrequired
        • state_codestringrequirednullable
      • coverage_startstring (date)requirednullable
      • coverage_endstring (date)requirednullable
  • metaRESeriesSearchMetarequiredCatalog provenance plus a notice when the current page contains Census data.
    • sourcestringrequired
    • as_ofstring (date-time) | string (date)nullable
    • noticestringnullable
  • paginationPaginationnullable
    • limitintegerrequired
    • has_morebooleanrequired
    • next_cursorstringnullable