{"contractVersion":"parcelops.connector.v1","name":"hud-user","displayName":"HUD Rents, Income Limits & ZIP Crosswalks","description":"Official HUD Fair Market Rents, program income limits, area identifiers, and USPS ZIP-to-statistical-geography crosswalks.","tags":["hud","fair-market-rent","income-limits","affordable-housing","zip-crosswalk","residential","united-states"],"authentication":{"type":"bearer_token","required":true},"provenance":{"sourceName":"US Department of Housing and Urban Development, HUD USER Data API","sourceUrl":"https://www.huduser.gov/hudapi/public","apiBaseUrl":"https://www.huduser.gov/hudapi/public","documentationUrl":"https://www.huduser.gov/portal/dataset/fmr-api.html"},"freshness":{"status":"declared","value":{"mode":"scheduled","observedAtField":"requestedYear","notes":"FMRs and Income Limits publish by HUD fiscal year; USPS crosswalks publish by year and quarter."}},"coverage":{"geographic":{"status":"declared","value":["United States","District of Columbia","Puerto Rico","HUD-published territories and areas"]},"temporal":{"status":"not_declared"}},"methods":{"total":5,"items":[{"name":"getFmr","description":"Get HUD Fair Market Rents for a county/town or metro entity.","requiredParams":["entityId"],"inputSchema":{"type":"object","properties":{"entityId":{"type":"string","pattern":"^[A-Za-z0-9]{5,30}$"},"year":{"type":"integer","minimum":1980,"maximum":2100}},"required":["entityId"],"additionalProperties":false},"access":{"classification":"read"},"freshness":{"status":"declared","value":{"mode":"scheduled","observedAtField":"requestedYear","notes":"FMRs and Income Limits publish by HUD fiscal year; USPS crosswalks publish by year and quarter."},"scope":"connector"},"entities":{"status":"declared","value":["fair-market-rent-area"]},"pagination":{"status":"declared","value":{"style":"none"}},"output":{"schema":{"status":"not_declared"},"units":{"status":"not_declared"},"coordinateReferenceSystem":{"status":"not_declared"}},"caveats":["A free bearer token must be registered for each requested HUD dataset.","FMRs and income limits are area/program benchmarks, not parcel facts, appraisals, or asking-rent estimates.","HUD USER terms require the non-endorsement notice returned by every data method.","Area rent benchmarks are not observed or estimated rent for an individual property."]},{"name":"getIncomeLimits","description":"Get HUD median income and program income-limit tables for a county/town or metro entity.","requiredParams":["entityId"],"inputSchema":{"type":"object","properties":{"entityId":{"type":"string","pattern":"^[A-Za-z0-9]{5,30}$"},"year":{"type":"integer","minimum":1980,"maximum":2100}},"required":["entityId"],"additionalProperties":false},"access":{"classification":"read"},"freshness":{"status":"declared","value":{"mode":"scheduled","observedAtField":"requestedYear","notes":"FMRs and Income Limits publish by HUD fiscal year; USPS crosswalks publish by year and quarter."},"scope":"connector"},"entities":{"status":"declared","value":["hud-income-limit-area"]},"pagination":{"status":"declared","value":{"style":"none"}},"output":{"schema":{"status":"not_declared"},"units":{"status":"not_declared"},"coordinateReferenceSystem":{"status":"not_declared"}},"caveats":["A free bearer token must be registered for each requested HUD dataset.","FMRs and income limits are area/program benchmarks, not parcel facts, appraisals, or asking-rent estimates.","HUD USER terms require the non-endorsement notice returned by every data method.","Use the applicable official HUD program file for final eligibility determinations."]},{"name":"listAreas","description":"List HUD county/town or metro entity IDs used by the rent and income-limit methods.","requiredParams":["type"],"inputSchema":{"type":"object","properties":{"type":{"type":"string","enum":["counties","metros"]},"state":{"type":"string","pattern":"^[A-Za-z]{2}$"},"updated":{"type":"integer","minimum":1980,"maximum":2100}},"required":["type"],"additionalProperties":false},"access":{"classification":"read"},"freshness":{"status":"declared","value":{"mode":"scheduled","observedAtField":"requestedYear","notes":"FMRs and Income Limits publish by HUD fiscal year; USPS crosswalks publish by year and quarter."},"scope":"connector"},"entities":{"status":"not_declared"},"pagination":{"status":"not_declared"},"output":{"schema":{"status":"not_declared"},"units":{"status":"not_declared"},"coordinateReferenceSystem":{"status":"not_declared"}},"caveats":["A free bearer token must be registered for each requested HUD dataset.","FMRs and income limits are area/program benchmarks, not parcel facts, appraisals, or asking-rent estimates.","HUD USER terms require the non-endorsement notice returned by every data method."]},{"name":"getZipCrosswalk","description":"Map one exact ZIP or Census/HUD geography through the HUD USPS crosswalk.","requiredParams":["type","query"],"inputSchema":{"type":"object","properties":{"type":{"type":"integer","minimum":1,"maximum":12},"query":{"type":"string","minLength":4,"maxLength":11,"description":"Exact ZIP/GEOID appropriate for the selected crosswalk type. State-wide and All-file queries are rejected."},"year":{"type":"integer","minimum":1980,"maximum":2100},"quarter":{"type":"integer","minimum":1,"maximum":4}},"required":["type","query"],"additionalProperties":false},"access":{"classification":"read"},"freshness":{"status":"declared","value":{"mode":"scheduled","observedAtField":"requestedYear","notes":"FMRs and Income Limits publish by HUD fiscal year; USPS crosswalks publish by year and quarter."},"scope":"connector"},"entities":{"status":"declared","value":["zip-statistical-geography-crosswalk"]},"pagination":{"status":"declared","value":{"style":"none"}},"output":{"schema":{"status":"not_declared"},"units":{"status":"not_declared"},"coordinateReferenceSystem":{"status":"not_declared"}},"caveats":["A free bearer token must be registered for each requested HUD dataset.","FMRs and income limits are area/program benchmarks, not parcel facts, appraisals, or asking-rent estimates.","HUD USER terms require the non-endorsement notice returned by every data method.","Address-allocation ratios do not identify parcels or establish legal boundaries."]},{"name":"getServiceInfo","description":"Return auth, attribution, rate limit, supported datasets, and use caveats.","inputSchema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"access":{"classification":"read"},"freshness":{"status":"declared","value":{"mode":"scheduled","observedAtField":"requestedYear","notes":"FMRs and Income Limits publish by HUD fiscal year; USPS crosswalks publish by year and quarter."},"scope":"connector"},"entities":{"status":"not_declared"},"pagination":{"status":"not_declared"},"output":{"schema":{"status":"not_declared"},"units":{"status":"not_declared"},"coordinateReferenceSystem":{"status":"not_declared"}},"caveats":["A free bearer token must be registered for each requested HUD dataset.","FMRs and income limits are area/program benchmarks, not parcel facts, appraisals, or asking-rent estimates.","HUD USER terms require the non-endorsement notice returned by every data method."]}]},"caveats":["A free bearer token must be registered for each requested HUD dataset.","FMRs and income limits are area/program benchmarks, not parcel facts, appraisals, or asking-rent estimates.","HUD USER terms require the non-endorsement notice returned by every data method."]}