Datasets:

xaheli
/

HMDA_LAR_2017-23

Tasks:

Text Classification

Modalities:

Formats:

Languages:

Size:

Tags:

Libraries:

License:

Dataset card Data Studio Files Files and versions

xet

Community

HMDA_LAR_2017-23 / README.md

xaheli

Update README.md

6b0c3c0 verified 10 months ago

preview code

raw

history blame contribute delete

20.4 kB

metadata

license: mit
task_categories:
  - text-classification
language:
  - en
tags:
  - finance
size_categories:
  - 1M<n<10M

Comprehensive HMDA Data Field Documentation

This document provides a structured, detailed description of all fields commonly found in a Home Mortgage Disclosure Act (HMDA) dataset, including their definitions, possible values, and any relevant notes. This documentation is intended to serve as a reference for analysts, developers, and data users working with HMDA data.

1. Submission and Entity Information

Field Name	Description	Values/Format
activity_year	The calendar year the data submission covers	2017, 2018, ..., 2024
lei	Legal Entity Identifier of the financial institution	Varying values

2. Geography

Field Name	Description	Values/Format
derived_msa-md	5-digit code for MSA (Metropolitan Statistical Area) or MD (Metropolitan Division)	Varying values
state_code	Two-letter state code	Varying values
county_code	State-county FIPS code	Varying values
census_tract	11-digit census tract number	Varying values

3. Loan and Property Details

Field Name	Description	Values/Format
derived_loan_product_type	Derived from Loan Type and Lien Status for easier querying	Conventional:First Lien, FHA:First Lien, VA:First Lien, FSA/RHS:First Lien, Conventional:Subordinate Lien, FHA:Subordinate Lien, VA:Subordinate Lien, FSA/RHS:Subordinate Lien
derived_dwelling_category	Derived from Construction Method and Total Units	Single Family (1-4 Units):Site-Built, Multifamily:Site-Built (5+ Units), Single Family (1-4 Units):Manufactured, Multifamily:Manufactured (5+ Units)
conforming_loan_limit	Whether the loan amount exceeds the GSE conforming loan limit	C (Conforming), NC (Nonconforming), U (Undetermined), NA (Not Applicable)
loan_type	Type of covered loan or application	1 - Conventional, 2 - FHA, 3 - VA, 4 - RHS/FSA
loan_purpose	Purpose of the loan or application	1 - Home purchase, 2 - Home improvement, 31 - Refinancing, 32 - Cash-out refinancing, 4 - Other, 5 - Not applicable
lien_status	Lien status of the property	1 - First lien, 2 - Subordinate lien
reverse_mortgage	Whether the loan/application is for a reverse mortgage	1 - Reverse mortgage, 2 - Not, 1111 - Exempt
open-end_line_of_credit	Whether the loan/application is for an open-end line of credit	1 - Open-end, 2 - Not, 1111 - Exempt
business_or_commercial_purpose	Whether the loan/application is primarily for business/commercial purpose	1 - Yes, 2 - No, 1111 - Exempt
loan_amount	Amount of the loan or applied-for amount	Varying values
combined_loan_to_value_ratio	Total debt secured by property / property value	Varying values
interest_rate	Interest rate for the loan/application	Varying values
rate_spread	Difference between APR and average prime offer rate (APOR)	Varying values
hoepa_status	Whether the loan is a high-cost mortgage	1 - High-cost, 2 - Not, 3 - Not applicable
total_loan_costs	Total loan costs in dollars	Varying values
total_points_and_fees	Total points and fees in dollars	Varying values
origination_charges	Total borrower-paid charges at/before closing	Varying values
discount_points	Points paid to reduce interest rate	Varying values
lender_credits	Lender credits in dollars	Varying values
loan_term	Number of months until maturity/termination	Varying values
prepayment_penalty_term	Term (months) of any prepayment penalty	Varying values
intro_rate_period	Months until first interest rate change after closing	Varying values
negative_amortization	Whether loan includes negative amortization	1 - Yes, 2 - No, 1111 - Exempt
interest_only_payment	Whether loan includes interest-only payments	1 - Yes, 2 - No, 1111 - Exempt
balloon_payment	Whether loan includes a balloon payment	1 - Yes, 2 - No, 1111 - Exempt
other_nonamortizing_features	Whether other non-fully amortizing features are present	1 - Yes, 2 - No, 1111 - Exempt
property_value	Value of the property, rounded to nearest $10,000 interval	Varying values
construction_method	Construction method for the dwelling	1 - Site-built, 2 - Manufactured home
occupancy_type	Occupancy type for the dwelling	1 - Principal, 2 - Second, 3 - Investment
manufactured_home_secured_property_type	Whether secured by manufactured home and land, or not	1 - Home and land, 2 - Home not land, 3 - NA, 1111 - Exempt
manufactured_home_land_property_interest	Land property interest for manufactured home	1 - Direct, 2 - Indirect, 3 - Paid leasehold, 4 - Unpaid leasehold, 5 - NA, 1111 - Exempt
total_units	Number of dwelling units	1, 2, 3, 4, 5-24, 25-49, 50-99, 100-149, >149

4. Applicant and Co-Applicant Demographics

Age

Field Name	Description	Values/Format
ageapplicant	Age of the applicant	<25, 25-34, 35-44, 45-54, 55-64, 65-74, 74, 8888 (NA)
co-applicant_age	Age of the first co-applicant	<25, 25-34, 35-44, 45-54, 55-64, 65-74, 74, 8888 (NA), 9999 (NA)
applicant_age_above_62	Whether applicant is 62 or above	Yes, No, NA
co-applicant_age_above_62	Whether co-applicant is 62 or above	Yes, No, NA

Income and Financials

Field Name	Description	Values/Format
income	Gross annual income in thousands of dollars	Varying values
debt_to_income_ratio	Monthly debt/income ratio (percentage, binned)	<20%, 20%-<30%, 30%-<36%, 36%, 37%, 38%, 39%, 40%, 41%, 42%, 43%, 44%, 45%, 46%, 47%, 48%, 49%, 50%-60%, >60%, NA, Exempt

Ethnicity

applicant_ethnicity-1 to applicant_ethnicity-5: Ethnicity of applicant/borrower (up to 5 responses)
co-applicant_ethnicity-1 to co-applicant_ethnicity-5: Ethnicity of first co-applicant/co-borrower (up to 5 responses)

Value	Description
1	Hispanic or Latino
11	Mexican
12	Puerto Rican
13	Cuban
14	Other Hispanic or Latino
2	Not Hispanic or Latino
3	Info not provided (mail/web)
4	Not applicable
5	No co-applicant (co-applicant fields only)

applicant_ethnicity_observed/co-applicant_ethnicity_observed: Whether ethnicity was collected by visual observation or surname (1: Yes, 2: No, 3: Not applicable, 4: No co-applicant)

Race

applicant_race-1 to applicant_race-5: Race of applicant/borrower (up to 5 responses)
co-applicant_race-1 to co-applicant_race-5: Race of first co-applicant/co-borrower (up to 5 responses)

Value	Description
1	American Indian or Alaska Native
2	Asian
21	Asian Indian
22	Chinese
23	Filipino
24	Japanese
25	Korean
26	Vietnamese
27	Other Asian
3	Black or African American
4	Native Hawaiian or Other Pacific Islander
41	Native Hawaiian
42	Guamanian or Chamorro
43	Samoan
44	Other Pacific Islander
5	White
6	Info not provided (mail/web)
7	Not applicable
8	No co-applicant (co-applicant fields only)

applicant_race_observed/co-applicant_race_observed: Whether race was collected by visual observation or surname (1: Yes, 2: No, 3: Not applicable, 4: No co-applicant)

Sex

Field Name	Description	Values/Format
applicant_sex	Sex of applicant/borrower	1 - Male, 2 - Female, 3 - Info not provided, 4 - Not applicable, 6 - Both selected
co-applicant_sex	Sex of first co-applicant/co-borrower	1 - Male, 2 - Female, 3 - Info not provided, 4 - Not applicable, 5 - No co-applicant, 6 - Both selected
applicant_sex_observed	Whether sex was collected by visual observation/surname	1 - Yes, 2 - No, 3 - Not applicable
co-applicant_sex_observed	Whether sex was collected by visual observation/surname	1 - Yes, 2 - No, 3 - Not applicable, 4 - No co-applicant

Aggregated Derived Fields

Field Name	Description	Values/Format
derived_ethnicity	Aggregated ethnicity (from all applicant/co-applicant fields)	Hispanic or Latino, Not Hispanic or Latino, Joint, Ethnicity Not Available, Free Form Text Only
derived_race	Aggregated race (from all applicant/co-applicant fields)	American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or Other Pacific Islander, White, 2 or more minority races, Joint, Free Form Text Only, Race Not Available
derived_sex	Aggregated sex (from all applicant/co-applicant fields)	Male, Female, Joint, Sex Not Available

5. Loan Processing and Underwriting

Field Name	Description	Values/Format
action_taken	Action taken on the loan/application	1 - Originated, 2 - Approved not accepted, 3 - Denied, 4 - Withdrawn, 5 - File closed, 6 - Purchased, 7 - Preapproval denied, 8 - Preapproval approved not accepted
purchaser_type	Entity purchasing the loan	0 - Not applicable, 1 - Fannie Mae, 2 - Ginnie Mae, 3 - Freddie Mac, 4 - Farmer Mac, 5 - Private securitizer, 6 - Bank/S&L, 71 - Credit union/mortgage/finance company, 72 - Life insurance, 8 - Affiliate, 9 - Other
preapproval	Whether preapproval was requested	1 - Requested, 2 - Not requested
submission_of_application	Whether application was submitted directly	1 - Submitted directly, 2 - Not submitted directly, 3 - Not applicable, 1111 - Exempt
initially_payable_to_institution	Whether the loan was initially payable to the institution	1 - Yes, 2 - No, 3 - Not applicable, 1111 - Exempt

Automated Underwriting System (AUS)

aus-1 to aus-5: AUS used for evaluation (up to 5 responses)

Value	Description
1	Desktop Underwriter (DU)
2	Loan Prospector/Loan Product Advisor
3	TOTAL Scorecard
4	Guaranteed Underwriting System (GUS)
5	Other
6	Not applicable
7	Internal Proprietary System
1111	Exempt

Denial Reasons

denial_reason-1 to denial_reason-4: Principal reason(s) for denial (up to 4 responses)

Value	Description
1	Debt-to-income ratio
2	Employment history
3	Credit history
4	Collateral
5	Insufficient cash
6	Unverifiable information
7	Credit application incomplete
8	Mortgage insurance denied
9	Other
10	Not applicable

Credit Score

Field Name	Description	Values/Format
applicant_credit_score_type	Credit scoring model used for applicant	1 - Equifax Beacon 5.0, 2 - Experian Fair Isaac, 3 - FICO Classic 04, 4 - FICO Classic 98, 5 - VantageScore 2.0, 6 - VantageScore 3.0, 7 - More than one, 8 - Other, 9 - Not applicable, 1111 - Exempt
co-applicant_credit_score_type	Credit scoring model used for co-applicant	1-9 as above, 10 - No co-applicant, 1111 - Exempt

6. Affordable Housing and Units

Field Name	Description	Values/Format
multifamily_affordable_units	Percentage of affordable units (rounded)	Varying values

7. Census and Tract Information (U.S. Census Bureau Appended Fields)

Field Name	Description	Values/Format
tract_population	Total population in tract	Varying values
tract_minority_population_percent	Percent minority population in tract	Varying values (rounded to two decimals)
ffiec_msa_md_median_family_income	FFIEC Median family income for MSA/MD	Varying values
tract_to_msa_income_percentage	Tract median family income as % of MSA/MD median	Varying values
tract_owner_occupied_units	Owner-occupied dwellings in tract	Varying values
tract_one_to_four_family_homes	Number of 1-4 family homes in tract	Varying values
tract_median_age_of_housing_units	Median age of homes in tract	Varying values

Notes

Field Naming: Some fields allow for multiple responses (e.g., applicant_ethnicity-1 to applicant_ethnicity-5).
Exempt Values: Some fields may use 1111 to indicate exemption from reporting.
Binned Values: Some numeric fields (e.g., age, debt-to-income ratio) are binned for privacy.
NA/Not Applicable: Many fields have codes for "Not Applicable" or "Not Available".

Usage

This documentation is designed to support:

Data ingestion and ETL processes
Data validation and cleaning
Analytical and reporting workflows
Regulatory compliance and audit activities

For further details or clarifications, refer to the official CFPB HMDA Filing Instructions Guide or your institution’s data governance documentation.