# HMDA Mortgage Loan Data Scraper (`parseforge/hmda-mortgage-loan-data-scraper`) Actor

Mine CFPB Home Mortgage Disclosure Act records by year and state with action\_taken, race, loan type, and lender filters. Returns county, loan\_amount, income, and lender\_name. Useful for fair lending analysis, housing market research, and bank competitive intelligence.

- **URL**: https://apify.com/parseforge/hmda-mortgage-loan-data-scraper.md
- **Developed by:** [ParseForge](https://apify.com/parseforge) (community)
- **Categories:** Automation, Integrations
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks
- **User rating**: No ratings yet

## Pricing

from $7.50 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

![ParseForge Banner](https://github.com/ParseForge/apify-assets/blob/ad35ccc13ddd068b9d6cba33f323962e39aed5b2/banner.jpg?raw=true)

## 📊 HMDA Mortgage Loan Data Scraper

> 🚀 **Export HMDA loan aggregations data in seconds. Structured records direct from the public ffiec.cfpb.gov endpoint to CSV, Excel, JSON, or XML.**

> 🕒 **Last updated:** 2026-05-29 · **📊 11 fields** per record · Public REST API · HMDA loan aggregations

The HMDA Mortgage Loan Data Scraper turns the [ffiec.cfpb.gov](https://ffiec.cfpb.gov) public REST endpoint into a clean, structured dataset. It calls the endpoint with the parameters you supply, parses the JSON, and flattens each record into one row.

Dataset coverage depends on the upstream source. All field names are clean snake_case / camelCase, numeric strings are auto-cast to numbers, and upstream rate-limit notes are surfaced as a clean `error` record instead of crashing your pipeline.

| 🎯 Target Audience | 💡 Primary Use Cases |
|---|---|
| 📊 Analysts | Pull structured records for analysis |
| 🏢 Finance teams | Snapshot data for dashboards and reports |
| 🤖 ML engineers | Build training sets from public sources |
| 📰 Journalists | Verify numbers for stories with one click |
| 👩‍💻 Developers | Mirror upstream data into your own DB without writing client code |
| 🎓 Researchers | Run reproducible studies on public data |

### 📋 What the HMDA Mortgage Loan Data Scraper does

- Calls the public `ffiec.cfpb.gov` endpoint.
- Parses the JSON response and flattens each record into a clean row.
- Casts numeric fields to numbers so they import cleanly into Excel and BI tools.
- Surfaces upstream rate-limit or error notes as a single-row `error` record instead of crashing.
- Exports as CSV, Excel, JSON, JSONL, XML, RSS, or HTML.

> 💡 **Why it matters:** The raw HMDA loan aggregations JSON is verbose and hard to consume in spreadsheets. This actor normalizes the payload into one row per record so the data drops straight into pandas, BigQuery, or a Google Sheet.

### 🎬 Full Demo

_🚧 Coming soon._

### ⚙️ Input

<table>
<tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
<tr><td><code>years</code></td><td>string</td><td>Yes</td><td>e.g. 2023,2024.</td></tr>
<tr><td><code>states</code></td><td>string</td><td>Yes</td><td>e.g. CA,NY.</td></tr>
<tr><td><code>actionsTaken</code></td><td>string</td><td>No</td><td>Comma-list.</td></tr>
<tr><td><code>races</code></td><td>string</td><td>No</td><td>Comma-list.</td></tr>
<tr><td><code>loanTypes</code></td><td>string</td><td>No</td><td>Comma-list.</td></tr>
<tr><td><code>maxItems</code></td><td>integer</td><td>No</td><td>Free users: 10. Paid users: up to 1,000,000. Prefill: 10.</td></tr>
</table>

**Example 1:**
```json
{
  "years": "2023",
  "states": "CA",
  "maxItems": 100
}
````

**Example 2:**

```json
{
  "years": "2022,2023",
  "states": "NY,TX",
  "actionsTaken": "1,3",
  "maxItems": 200
}
```

> ⚠️ **Good to Know:** The HMDA loan aggregations API is rate-limited. This actor surfaces rate-limit notes as a clean `error` record so your downstream pipeline can decide how to retry.

### 📊 Output

Each record is a flat object. `error` is always last.

| Field | Type | Description |
|---|---|---|
| 📅 `year` | number | HMDA reporting year. |
| 🇺🇸 `state` | string | State code. |
| 🏛️ `county` | string | County code. |
| ⚡ `actionTaken` | string | Action code. |
| 🏠 `loanType` | string | Loan type. |
| 🎯 `loanPurpose` | string | Purpose. |
| 🧑 `race` | string | Applicant race code. |
| 🔢 `count` | number | Aggregated count. |
| 💰 `sumLoanAmount` | number | Aggregated dollar sum. |
| 🕒 `scrapedAt` | string | Fetch timestamp. |
| ❌ `error` | string | Set on upstream error. |

**Sample record:**

```json
{
  "year": 2023,
  "state": "CA",
  "county": null,
  "actionTaken": "1",
  "loanType": "1",
  "loanPurpose": "1",
  "race": "5",
  "count": 12453,
  "sumLoanAmount": 4823000000,
  "scrapedAt": "2026-05-29T12:00:00.000Z",
  "error": null
}
```

### ✨ Why choose this Actor

| 🆓 | Works with the free, public HMDA loan aggregations endpoint. |
| 🧹 | Clean snake\_case keys ready for BI. |
| 🔢 | Auto-casts numeric strings to real numbers. |
| 🛟 | Surfaces rate-limit notes as a clean `error` record. |
| 🔌 | Drop-in dataset replacement for the raw API. |
| 💾 | Push to dataset → instant CSV / Excel / JSON / XML / RSS / HTML export. |

### 📈 How it compares to alternatives

| Approach | Setup time | Clean keys? | Numeric casting? | Rate-limit handling? |
|---|---|---|---|---|
| Roll your own `fetch` | 30 min + | ❌ | ❌ | ❌ |
| Generic API client | 1 hr install + script | partial | partial | partial |
| **This Actor** | 5 sec, no install | ✅ | ✅ | ✅ |

### 🚀 How to use

1. Click **Try for free**.
2. Adjust input fields (or leave defaults).
3. Click **Start**. Within seconds, your dataset is ready — download as CSV, Excel, JSON, or XML, or pipe to your warehouse.

### 💼 Business use cases

**📊 Analytics & dashboards.** Pull HMDA loan aggregations data into a single CSV, feed BI tools, share with stakeholders.

**🤖 ML feature engineering.** Build clean training sets from HMDA loan aggregations for downstream models.

**📰 Newsroom fact-checking.** Verify numbers for stories in 30 seconds.

**🏢 Treasury / ops.** Schedule daily runs and pipe to your dashboard.

### 🔌 Automating HMDA Mortgage Loan Data Scraper

- **Make / Zapier**: trigger this actor on a schedule, push results to Airtable, Google Sheets, or Slack.
- **Cron schedule**: native Apify scheduler.
- **Webhooks**: POST to your endpoint the moment a run finishes.
- **Pipe to BigQuery / Snowflake / Postgres**: native Apify integrations.

### 🌟 Beyond business use cases

**🎓 Education.** Teach a class with real HMDA loan aggregations data instead of toy datasets.

**🧪 Personal research.** Track HMDA loan aggregations signals on your own schedule.

**🤝 Non-profit & open data.** Build public dashboards without writing client code.

**🧰 Tinkering & prototyping.** Spin up a feed in 5 seconds to test a new idea.

### 🤖 Ask an AI assistant about this scraper

Pop this README into ChatGPT, Claude, or any AI assistant and ask it to map your specific workflow to the actor's inputs.

### ❓ Frequently Asked Questions

**❓ Do I need an API key?** No. The CFPB HMDA browser API is open.

**❓ What years are available?** 2007 onward.

**❓ Can I aggregate by demographic?** Yes. Use the races, actionsTaken, loanTypes filters.

**❓ What is action taken?** Codes 1-8 (originated, approved-not-accepted, denied, etc.).

**❓ Is this loan-level?** No. This is the aggregations endpoint. Loan-level is a separate endpoint with much larger payloads.

**❓ What format can I download?** CSV, Excel, JSON, JSONL, XML, RSS, or HTML.

### 🔌 Integrate with any app

Apify ships native integrations with Make, Zapier, Slack, Discord, Google Drive, Google Sheets, Gmail, Airbyte, Keboola, Telegram, GitHub, and any REST API or webhook endpoint.

### 🔗 Recommended Actors

| Actor | What it does |
|---|---|
| [ParseForge Alpha Vantage Scraper](https://apify.com/parseforge/alpha-vantage-public-scraper) | Stocks, FX, crypto, indicators. |
| [ParseForge Yahoo Finance Scraper](https://apify.com/parseforge) | Equities, funds, indices. |
| [ParseForge OurAirports Scraper](https://apify.com/parseforge/ourairports-scraper) | Global airport database. |
| [ParseForge NBA Stats Scraper](https://apify.com/parseforge/nba-stats-scraper) | Player and team stats from NBA.com. |

> 💡 **Pro Tip:** browse the complete [ParseForge collection](https://apify.com/parseforge) for 900+ production-grade scrapers.

***

**Disclaimer:** This actor scrapes only publicly available data. ParseForge is not affiliated with, endorsed by, or sponsored by any of the third-party services referenced. Users are responsible for complying with the target site's terms of service and applicable law. [Create a free account w/ $5 credit](https://console.apify.com/sign-up?fpr=vmoqkp).

# Actor input Schema

## `years` (type: `string`):

Comma-separated years (e.g. 2023,2024).

## `states` (type: `string`):

Comma-separated state codes (e.g. CA,NY).

## `actionsTaken` (type: `string`):

Comma-separated action codes (1-8).

## `races` (type: `string`):

Comma-separated race codes.

## `loanTypes` (type: `string`):

Comma-separated loan type codes (1-4).

## `maxItems` (type: `integer`):

Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000

## Actor input object example

```json
{
  "years": "2023",
  "states": "CA",
  "maxItems": 10
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "years": "2023",
    "states": "CA",
    "maxItems": 10
};

// Run the Actor and wait for it to finish
const run = await client.actor("parseforge/hmda-mortgage-loan-data-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "years": "2023",
    "states": "CA",
    "maxItems": 10,
}

# Run the Actor and wait for it to finish
run = client.actor("parseforge/hmda-mortgage-loan-data-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "years": "2023",
  "states": "CA",
  "maxItems": 10
}' |
apify call parseforge/hmda-mortgage-loan-data-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=parseforge/hmda-mortgage-loan-data-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "HMDA Mortgage Loan Data Scraper",
        "description": "Mine CFPB Home Mortgage Disclosure Act records by year and state with action_taken, race, loan type, and lender filters. Returns county, loan_amount, income, and lender_name. Useful for fair lending analysis, housing market research, and bank competitive intelligence.",
        "version": "0.1",
        "x-build-id": "6T1rzP8GyAOSHNnQy"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/parseforge~hmda-mortgage-loan-data-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-parseforge-hmda-mortgage-loan-data-scraper",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/parseforge~hmda-mortgage-loan-data-scraper/runs": {
            "post": {
                "operationId": "runs-sync-parseforge-hmda-mortgage-loan-data-scraper",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/parseforge~hmda-mortgage-loan-data-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-parseforge-hmda-mortgage-loan-data-scraper",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {
                    "years": {
                        "title": "Years",
                        "type": "string",
                        "description": "Comma-separated years (e.g. 2023,2024)."
                    },
                    "states": {
                        "title": "States",
                        "type": "string",
                        "description": "Comma-separated state codes (e.g. CA,NY)."
                    },
                    "actionsTaken": {
                        "title": "Actions taken",
                        "type": "string",
                        "description": "Comma-separated action codes (1-8)."
                    },
                    "races": {
                        "title": "Races",
                        "type": "string",
                        "description": "Comma-separated race codes."
                    },
                    "loanTypes": {
                        "title": "Loan types",
                        "type": "string",
                        "description": "Comma-separated loan type codes (1-4)."
                    },
                    "maxItems": {
                        "title": "Max Items",
                        "minimum": 1,
                        "maximum": 1000000,
                        "type": "integer",
                        "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000"
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```