{"slug":"realestate-us","domain":"property","title":"US rentals, AMI tables, utility allowances and tracts","summary":"Rental listings merged across sources, the HUD tables that decide what a subsidised rent may be, and tract-level ACS and opportunity data.","help":"realestate-us: listings and the tables that bound them, as JSON.\n\nRETURNS\n  One JSON object on stdout.\n\nOPTIONS\n  A study run with no arguments prints its own — `realestate-us search` on a\n  line by itself lists every flag it takes. Worth doing once per study: the\n  flags are where the defaults are, and a default is a decision somebody made\n  for you.\n\nSTART HERE\n  `ami-years` before assuming a year exists. The tables are published per\n  state and per year, and a missing year is not an empty answer, it is a\n  different question.\n\nWHERE A SITE IS\n  `resolve \"3403 Piedmont Ave, Oakland, CA\"` names the 2020 census tract,\n  county and place — `method` says whether the Census Geocoder or the stored\n  TIGER/Line polygons answered, and \"lat,lng\" works in place of an address.\n  `tract \u003cGEOID\u003e` and `tracts \u003cCOUNTY_FIPS\u003e` return ACS 5-year estimates with\n  their margins of error, and the CTCAC/HCD opportunity category. Every value\n  carries `evidence`: the source url, dataset, vintage and when it was read.\n\n  A value the Census suppressed has a null estimate and a flag\n  (`estimate_not_computed`); a top-coded median (\"$3,500+\") has a null\n  estimate, `top_coded`, and the threshold in `bound`. Neither is ever 0.\n\nWHAT SURROUNDS IT\n  `location 37.8015 -122.4092` measures a point: restaurants, cafés and bars\n  within 500 m, bus stops within 400 m and the nearest rail stop and park\n  (OpenStreetMap); the EPA walkability index with residents and jobs per\n  acre; and a year of police incidents (violent, property, disorder) and 311\n  street requests (encampments, cleaning) within 400 m. Crime and 311 are\n  each city's own: `location-coverage CA` lists the counties that have them,\n  and a county without lists them under `unsupported` — never as zero.\n\nINDIA IS A DIFFERENT PROGRAM\n  `realestate-in`, and deliberately not a subcommand of this one. There is no\n  AMI band there for a rent to be measured against, and no ZIP to search by;\n  the answers come from different vendors at a different price. A program that\n  sold both sold half of itself to everybody.\n\nStudies:\n  search            \u003czip_code\u003e\n      rental listings in one ZIP, merged across sources\n  detail            \u003ccomp_key\u003e\n      everything known about one listing, by its comp key\n  harvest           \u003czips\u003e\n      pull several ZIPs into the store at once — comma-separate them\n  ami-rents         \u003cstate\u003e\n      maximum rents by AMI percent and bedroom count\n  ami-income-limits \u003cstate\u003e\n      income limits by AMI percent and household size\n  ami-counties      \u003cstate\u003e\n      which counties a state has AMI tables for\n  ami-years         \u003cstate\u003e\n      which years a state has AMI tables for — check this before assuming one\n  utility-allowance \u003cstate\u003e\n      utility allowance schedules, which set what rent a voucher actually covers\n  resolve           \u003caddress\u003e\n      the 2020 census tract, county and place for an address or a coordinate\n  tract             \u003cgeoid\u003e\n      every ACS value for one tract, with its MOE and flags, and its opportunity category\n  tracts            \u003ccounty_fips\u003e\n      every tract in a county, the same rows as `tract`, for fitting a model\n  location          \u003clat\u003e \u003clon\u003e\n      what surrounds a point: restaurants, bars, transit, parks, walkability, residents and jobs per acre, and a year of crime and 311 requests within 400 m\n  location-coverage \u003cstate\u003e\n      which counties have crime and 311 sources for `location`\n  opportunity-seed  \u003cyear\u003e \u003csource_url\u003e\n      staff: load a year of the CTCAC/HCD Opportunity Map from TCAC's published file\n  vintages          \u003cstate\u003e\n      which ACS vintages, TIGER polygons and TCAC years are loaded for a state, and the last harvest's error\n  tracts-harvest    \u003cstates\u003e\n      staff: start a tract harvest pass now; watch `vintages` for it to land\n\nJSON to stdout, so it composes: pipe to `jq` to pick a field, or `\u003e /tmp/…` to keep it.\nRun a study with no arguments — `realestate-us search` — to see what it takes.\n","example_command":"realestate-us ami-rents CA --county Alameda","example_output":"","cost_class":"upstream-fetch","tier":"metered","billing_items":["realestate_rental","realestate_rental_detail"],"price_per_1k_calls":10,"price_is_from":true,"status":"available","commands":["realestate-us"],"studies":[{"call":"search","about":"rental listings in one ZIP, merged across sources","args":[{"name":"zip_code","positional":true,"list":false,"hint":""},{"name":"limit","positional":false,"list":false,"hint":"how many listings"},{"name":"page","positional":false,"list":false,"hint":"1-based"},{"name":"sort","positional":false,"list":false,"hint":"the vendor's own sort key"}]},{"call":"detail","about":"everything known about one listing, by its comp key","args":[{"name":"comp_key","positional":true,"list":false,"hint":""},{"name":"zip_code","positional":false,"list":false,"hint":"narrows the search for the listing"},{"name":"include_text","positional":false,"list":false,"hint":"true to also return the text amenities are read from"},{"name":"building","positional":false,"list":true,"hint":"building amenities to answer, comma-separated (default: a standard set)"},{"name":"unit","positional":false,"list":true,"hint":"unit amenities to answer, comma-separated (default: a standard set)"}]},{"call":"harvest","about":"pull several ZIPs into the store at once — comma-separate them","args":[{"name":"zips","positional":true,"list":true,"hint":""},{"name":"source","positional":false,"list":false,"hint":"one source instead of all"}]},{"call":"ami-rents","about":"maximum rents by AMI percent and bedroom count","args":[{"name":"state","positional":true,"list":false,"hint":""},{"name":"year","positional":false,"list":false,"hint":"defaults to the latest published"},{"name":"county","positional":false,"list":false,"hint":"a county name"},{"name":"zip","positional":false,"list":false,"hint":"a ZIP, resolved to its county"}]},{"call":"ami-income-limits","about":"income limits by AMI percent and household size","args":[{"name":"state","positional":true,"list":false,"hint":""},{"name":"year","positional":false,"list":false,"hint":"defaults to the latest published"},{"name":"county","positional":false,"list":false,"hint":"a county name"},{"name":"zip","positional":false,"list":false,"hint":"a ZIP, resolved to its county"}]},{"call":"ami-counties","about":"which counties a state has AMI tables for","args":[{"name":"state","positional":true,"list":false,"hint":""},{"name":"year","positional":false,"list":false,"hint":"defaults to the latest published"}]},{"call":"ami-years","about":"which years a state has AMI tables for — check this before assuming one","args":[{"name":"state","positional":true,"list":false,"hint":""}]},{"call":"utility-allowance","about":"utility allowance schedules, which set what rent a voucher actually covers","args":[{"name":"state","positional":true,"list":false,"hint":""},{"name":"authority_id","positional":false,"list":false,"hint":"one housing authority"},{"name":"county","positional":false,"list":false,"hint":"a county name"},{"name":"zip","positional":false,"list":false,"hint":"a ZIP, resolved to its county"},{"name":"on","positional":false,"list":false,"hint":"YYYY-MM-DD: the schedule in force that day"}]},{"call":"resolve","about":"the 2020 census tract, county and place for an address or a coordinate","args":[{"name":"address","positional":true,"list":false,"hint":"a one-line address, or \"lat,lng\""}]},{"call":"tract","about":"every ACS value for one tract, with its MOE and flags, and its opportunity category","args":[{"name":"geoid","positional":true,"list":false,"hint":"11-digit tract GEOID"},{"name":"vintage","positional":false,"list":false,"hint":"ACS end year; defaults to the latest loaded"},{"name":"opportunity_year","positional":false,"list":false,"hint":"TCAC map year; defaults to the latest loaded"}]},{"call":"tracts","about":"every tract in a county, the same rows as `tract`, for fitting a model","args":[{"name":"county_fips","positional":true,"list":false,"hint":"5-digit state+county, e.g. 06001"},{"name":"vintage","positional":false,"list":false,"hint":"ACS end year; defaults to the latest loaded"},{"name":"opportunity_year","positional":false,"list":false,"hint":"TCAC map year"},{"name":"format","positional":false,"list":false,"hint":"json | jsonl"}]},{"call":"location","about":"what surrounds a point: restaurants, bars, transit, parks, walkability, residents and jobs per acre, and a year of crime and 311 requests within 400 m","args":[{"name":"lat","positional":true,"list":false,"hint":""},{"name":"lon","positional":true,"list":false,"hint":""}]},{"call":"location-coverage","about":"which counties have crime and 311 sources for `location`","args":[{"name":"state","positional":true,"list":false,"hint":""}]},{"call":"opportunity-seed","about":"staff: load a year of the CTCAC/HCD Opportunity Map from TCAC's published file","args":[{"name":"year","positional":true,"list":false,"hint":"the TCAC map year"},{"name":"source_url","positional":true,"list":false,"hint":"the file's url on treasurer.ca.gov"},{"name":"geoid_column","positional":false,"list":false,"hint":"the id column, if it cannot be found by name"},{"name":"category_column","positional":false,"list":false,"hint":"the category column, likewise"}]},{"call":"vintages","about":"which ACS vintages, TIGER polygons and TCAC years are loaded for a state, and the last harvest's error","args":[{"name":"state","positional":true,"list":false,"hint":"state FIPS, e.g. 06"}]},{"call":"tracts-harvest","about":"staff: start a tract harvest pass now; watch `vintages` for it to land","args":[{"name":"states","positional":true,"list":true,"hint":"state FIPS, comma-separated"},{"name":"vintage","positional":false,"list":false,"hint":"ACS end year; defaults to the configured one"}]}],"default_enabled":false,"first_seen":"2026-09-09T04:30:35.160951Z","enabled":false}