{"contractVersion":"parcelops.connector.v1","name":"hmda","displayName":"HMDA Mortgage & Multifamily Lending","description":"Official public mortgage-market aggregations and bounded loan-application records for residential and multifamily research.","tags":["hmda","mortgages","multifamily","residential","lending","county","msa"],"authentication":{"type":"none","required":false},"provenance":{"sourceName":"FFIEC HMDA Data Browser API","sourceUrl":"https://ffiec.cfpb.gov/v2/data-browser-api","apiBaseUrl":"https://ffiec.cfpb.gov/v2/data-browser-api","documentationUrl":"https://ffiec.cfpb.gov/documentation/api/data-browser/"},"freshness":{"status":"declared","value":{"mode":"scheduled","cadence":"P1Y","notes":"HMDA publishes annual data and may revise recent years."}},"coverage":{"geographic":{"status":"declared","value":["United States, by published state, county, and MSA/MD geography"]},"temporal":{"status":"not_declared"}},"methods":{"total":3,"items":[{"name":"getAggregations","description":"Get a bounded official HMDA aggregation for exactly one geography and focused filter set.","notes":"countyFips identifies the state; optional stateAlpha must match it.","requiredParams":["year"],"inputSchema":{"type":"object","properties":{"year":{"type":"integer","minimum":2018,"maximum":2025},"stateAlpha":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"State-only geography, or a redundant state hint matching countyFips."},"countyFips":{"type":"string","pattern":"^\\d{5}$"},"msaMd":{"type":"string","pattern":"^\\d{5}$"},"lei":{"type":"string","pattern":"^[A-Za-z0-9]{20}$"},"actionsTaken":{"type":"array","minItems":1,"maxItems":8,"uniqueItems":true,"items":{"type":"integer","minimum":1,"maximum":8}},"loanPurposes":{"type":"array","minItems":1,"maxItems":6,"uniqueItems":true,"items":{"type":"integer","enum":[1,2,31,32,4,5]}},"loanTypes":{"type":"array","minItems":1,"maxItems":4,"uniqueItems":true,"items":{"type":"integer","enum":[1,2,3,4]}},"constructionMethods":{"type":"array","minItems":1,"maxItems":2,"uniqueItems":true,"items":{"type":"integer","minimum":1,"maximum":2}},"lienStatuses":{"type":"array","minItems":1,"maxItems":2,"uniqueItems":true,"items":{"type":"integer","minimum":1,"maximum":2}},"limit":{"type":"integer","minimum":1,"maximum":250}},"required":["year"],"additionalProperties":false},"access":{"classification":"read"},"freshness":{"status":"declared","value":{"mode":"scheduled","cadence":"P1Y","notes":"HMDA publishes annual data and may revise recent years."},"scope":"connector"},"entities":{"status":"not_declared"},"pagination":{"status":"not_declared"},"output":{"schema":{"status":"not_declared"},"units":{"status":"not_declared"},"coordinateReferenceSystem":{"status":"not_declared"}},"caveats":["HMDA describes covered mortgage applications and originations, not every property transaction or lender.","Application-level records are public-use data with privacy modifications and are not parcel, title, appraisal, or underwriting records."]},{"name":"getLoanApplications","description":"Retrieve a small public-use HMDA CSV slice for one county, lender, and action.","requiredParams":["year","countyFips","lei","actionTaken"],"inputSchema":{"type":"object","properties":{"year":{"type":"integer","minimum":2018,"maximum":2025},"countyFips":{"type":"string","pattern":"^\\d{5}$"},"lei":{"type":"string","pattern":"^[A-Za-z0-9]{20}$"},"actionTaken":{"type":"integer","minimum":1,"maximum":8},"loanPurpose":{"type":"integer","enum":[1,2,31,32,4,5]},"limit":{"type":"integer","minimum":1,"maximum":100}},"required":["year","countyFips","lei","actionTaken"],"additionalProperties":false},"access":{"classification":"read"},"freshness":{"status":"declared","value":{"mode":"scheduled","cadence":"P1Y","notes":"HMDA publishes annual data and may revise recent years."},"scope":"connector"},"entities":{"status":"not_declared"},"pagination":{"status":"not_declared"},"output":{"schema":{"status":"not_declared"},"units":{"status":"not_declared"},"coordinateReferenceSystem":{"status":"not_declared"}},"caveats":["HMDA describes covered mortgage applications and originations, not every property transaction or lender.","Application-level records are public-use data with privacy modifications and are not parcel, title, appraisal, or underwriting records."]},{"name":"getServiceInfo","description":"Return official source, supported years, filters, privacy treatment, and limitations.","inputSchema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"access":{"classification":"read"},"freshness":{"status":"declared","value":{"mode":"scheduled","cadence":"P1Y","notes":"HMDA publishes annual data and may revise recent years."},"scope":"connector"},"entities":{"status":"not_declared"},"pagination":{"status":"not_declared"},"output":{"schema":{"status":"not_declared"},"units":{"status":"not_declared"},"coordinateReferenceSystem":{"status":"not_declared"}},"caveats":["HMDA describes covered mortgage applications and originations, not every property transaction or lender.","Application-level records are public-use data with privacy modifications and are not parcel, title, appraisal, or underwriting records."]}]},"caveats":["HMDA describes covered mortgage applications and originations, not every property transaction or lender.","Application-level records are public-use data with privacy modifications and are not parcel, title, appraisal, or underwriting records."]}