{"slug":"realestate-us","domain":"property","title":"US rentals, AMI tables and utility allowances","summary":"Rental listings merged across sources, plus the HUD tables that decide what a subsidised rent may be.","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\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\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"}]},{"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"}]}],"default_enabled":false,"first_seen":"2026-09-09T04:30:35.160951Z","enabled":false}