{ "openapi": "3.0.1", "info": { "title": "NMLS Scraper — Mortgage Loan Originators, Lenders & Branches", "description": "Pull MLO, lender, and branch records from NMLS Consumer Access. Auditable open-source actor with no survey-form gate. Returns one normalized row per entity with state licenses, disclosures, sponsor links, and computed risk-rollup flags.", "version": "0.1", "x-build-id": "iMu0b3UpgsenJOOzF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ws_tony~nmls-consumer-access/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ws_tony-nmls-consumer-access", "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/ws_tony~nmls-consumer-access/runs": { "post": { "operationId": "runs-sync-ws_tony-nmls-consumer-access", "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/ws_tony~nmls-consumer-access/run-sync": { "post": { "operationId": "run-sync-ws_tony-nmls-consumer-access", "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", "required": [ "mode" ], "properties": { "mode": { "title": "Query mode", "enum": [ "by_nmls_id", "by_name" ], "type": "string", "description": "How to find entities. 'by_nmls_id' is a direct lookup of one or more NMLS IDs (cheapest, fastest). 'by_name' runs a full-text search and pulls every matching detail page.", "default": "by_nmls_id" }, "nmlsIds": { "title": "NMLS IDs", "type": "array", "description": "List of NMLS IDs to fetch directly. Used when mode = by_nmls_id. Example: 3030 = Rocket Mortgage.", "items": { "type": "string" } }, "names": { "title": "Names", "type": "array", "description": "Names to search. Used when mode = by_name. Each name is searched separately; matches are followed to the detail page and parsed.", "items": { "type": "string" } }, "entityType": { "title": "Entity type filter", "enum": [ "", "INDIVIDUAL", "COMPANY", "BRANCH" ], "type": "string", "description": "Restrict results to a single entity type. Leave blank to include all.", "default": "" }, "includeDisclosures": { "title": "Include regulator disclosures", "type": "boolean", "description": "Parse regulator action history on each entity detail page. Slightly slower but compliance-grade.", "default": true }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on records pushed to the dataset. Protects you from unbounded runs.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is recommended. Default group works for most runs; switch to RESIDENTIAL for high-volume or if you see Cloudflare blocks." }, "capsolverApiKey": { "title": "CapSolver API key (optional)", "type": "string", "description": "If provided, used to solve the BotDetect CAPTCHA during session warmup. Without it, the actor logs a clear error and exits — you cannot reach detail pages without solving the warmup CAPTCHA at least once. Get a key at https://capsolver.com (pay-as-you-go, ~$0.0005/solve)." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel detail-page fetches. Keep low to be polite to NMLS.", "default": 4 } } }, "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 } } } } } } } } } }