Companies

Community Lending map: geocoded loans + per-tract counts

getapi.modelmatch.com/v1/companies/{nmlsId}/community-lending/map

Map points for loans naming this company on the loan document in the period that resolved to a Census tract, newest first (up to 4,000), plus a per-tract loan count keyed by 11-digit tract GEOID for a choropleth.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Company NMLS ID

Query parameters

periodenum

Period window (default: last12Months).

Options:2017201820192020202120222023202420252026last3Monthslast6Monthslast12Monthslast14Monthslast16Monthslast18Monthslast24MonthsyearToDateallTime

Responses

200objectMap feed

Show attributes

pointsobject[]required

Show child attributes

addressstring | nullrequired

idstringrequired

latnumberrequired

lonnumberrequired

mortgageAmountnumber | nullrequired

tractGeoIdstring | nullrequired

11-digit Census tract GEOID (state + county + tract FIPS) — the join key for a tract boundary layer.

transactionDatestring | nullrequired

transactionTypestring | nullrequired

totalnumberrequired

Every geocoded loan in scope for the period.

tractCountsobjectrequired

Plotted loans per tract GEOID. Values describe the U.S. Census tract (neighborhood) as a whole — tract-level aggregate statistics, never an individual, household or applicant attribute. Percentages are 0-100.

Show child attributes

[key: string]number

truncatedbooleanrequired

More than 4000 loans matched; the newest are returned.

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X GET "https://api.modelmatch.com/v1/companies/<nmlsId>/community-lending/map" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

import { createClient } from "@model-match/api";

const client = createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await client.companies.communityLendingMap({
  path: {
    nmlsId: "<nmlsId>"
  }
});

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/companies/<nmlsId>/community-lending/map",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "points": [
    {
      "address": "<string>",
      "id": "<string>",
      "lat": 123.45,
      "lon": 123.45,
      "mortgageAmount": 123.45,
      "tractGeoId": "<string>",
      "transactionDate": "<string>",
      "transactionType": "<string>"
    }
  ],
  "total": 123.45,
  "tractCounts": {
    "key": 123.45
  },
  "truncated": true
}