Skip to content

Latest commit

 

History

History
26 lines (15 loc) · 2.15 KB

README.md

File metadata and controls

26 lines (15 loc) · 2.15 KB

Introduction

The Home Mortgage Disclosure Act (HMDA) Platform is a Regulatory technology application for financial institutions to submit mortgage information as described in the Filing Instruction Guide (FIG). The HMDA-Platform parses data as submitted by mortgage leading institutions and validates the information for edits (Syntactical, Validity, Quality, and Macro as-per the instructions in the FIG) before submitting the data. The HMDA-Platform supports quarterly and yearly filing periods. For detailed information on Home Mortgage Disclosure Act (HMDA), checkout the About HMDA page on the CFPB website.

The HMDA Data Browser (Public Facing) allows users to filter, analyze, and download HMDA datasets and visualize data through charts, graphs, and maps.

Technical Architecture

The image below shows the cloud vendor agnostic technical architecture for the HMDA Data Browser.

The multi-year data is stored in PostgreSQL and cached in Redis + Object Stores. The first time the user accesses the data, the cache is searched. If the data is found it the cache, it is served. However, if the data isn't found in the cache, the cache is updated and then the data is served so that the next time the data would be served from the cache.

API Documentation

The API documentation for the data-browser is available publicly. https://cfpb.github.io/hmda-platform/#data-browser-api

Redis Keys

Redis keys are supported for multiple years. Below is an example of redis key with states VA and MD and total_units 4 for year 2018 and 2019

GET 'AGG:state:VA|ME:total_units:4:year:2018'
GET 'AGG:state:VA|ME:total_units:4:year:2019'