Branches

Get branch by NMLS ID

getapi.modelmatch.com/v1/branches/{nmlsId}

Retrieve full details for a single NMLS mortgage branch including name, address, parent company, managers, trade names, licensing, and branch-level production for the selected period.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Branch NMLS ID

Query parameters

periodenum

Period for production metrics (default: last12Months). Does NOT apply to teamSize, which is a current snapshot and reads the same on every period.

Options:2017201820192020202120222023202420252026last3Monthslast6Monthslast12Monthslast14Monthslast16Monthslast18Monthslast24MonthsyearToDateallTime

Responses

200objectBranch detail

Show attributes

dataobjectrequired

Show child attributes

avgLoanAmountnumber | null

citystring | null

communityLendingobject | null

Community Lending — the neighborhood (U.S. Census tract) mix of the loans this entity produced in the selected period: program shares and counts, the averaged neighborhood profile, and the local mortgage market. 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. Every share is taken over loansWithCommunityData, NOT over the entity's total production. Two fields are deliberately not 0-100: avgIncomeVsMetroPct is a ratio where 100 means parity with the metro (it exceeds 100), and ruralGradient is an ordinal 1-10 code. null — not an all-null object — when the entity had no tract-resolved loans in the window. Returned by the entity DETAIL routes only (getOriginator / getCompany / getBranch); list rows omit the block. Every key here is also a filter key on the matching list route.

Show child attributes

affordableHousingTractCountnumber | nullrequired

Loans in qualified affordable-housing neighborhoods, as a count. 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.

affordableHousingTractPctnumber | nullrequired

Share of the entity's tract-resolved loans in qualified neighborhoods for affordable-housing programs, 0-100. 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.

avgAsianPctnumber | nullrequired

Mean Asian (non-Hispanic) share of the population in those neighborhoods, 0-100. 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.

avgBlackPctnumber | nullrequired

Mean Black (non-Hispanic) share of the population in those neighborhoods, 0-100. 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.

avgDenialRatenumber | nullrequired

Mean share of mortgage applications denied in those neighborhoods, 0-100. 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.

avgFamilyIncomenumber | nullrequired

Mean median family income of those neighborhoods, in whole dollars. 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.

avgHispanicPctnumber | nullrequired

Mean Hispanic or Latino share of the population in those neighborhoods, 0-100. 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.

avgHomeValuenumber | nullrequired

Mean median home value across those neighborhoods, in whole dollars — a neighborhood statistic, not the entity's average loan size (avgLoanAmount). 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.

avgHomeownershipRatenumber | nullrequired

Mean owner-occupied share of housing units in those neighborhoods, 0-100. 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.

avgHouseholdIncomenumber | nullrequired

Mean median household income of those neighborhoods, in whole dollars. 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.

avgIncomeVsMetroPctnumber | nullrequired

Mean neighborhood income relative to its metro area, where 100 is parity. Legitimately exceeds 100 — a ratio, not a share. 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.

avgLowModHouseholdPctnumber | nullrequired

Mean HUD block-group low/moderate-income HOUSEHOLD share across those neighborhoods, 0-100 — a finer measure than lowModIncomeTractPct, which counts whole neighborhoods. 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.

avgMedianAgenumber | nullrequired

Mean median age of the population in those neighborhoods, in years. 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.

avgMilesToCollegenumber | nullrequired

Mean straight-line distance to the nearest college, in miles. 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.

avgMilesToSchoolnumber | nullrequired

Mean straight-line distance to the nearest school, in miles. 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.

avgMilesToWorshipnumber | nullrequired

Mean straight-line distance to the nearest place of worship, in miles. 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.

avgMinorityPctnumber | nullrequired

Mean non-white share of the population in those neighborhoods, 0-100. majorityMinorityTractPct is the per-neighborhood-threshold form of the same question. 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.

avgPopulationnumber | nullrequired

Mean population of those neighborhoods. 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.

avgPovertyRatenumber | nullrequired

Mean share of the population below the poverty line in those neighborhoods, 0-100. 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.

avgTractApplicationsnumber | nullrequired

Mean number of mortgage applications reported in those neighborhoods, over the year. 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.

avgTractLoanVolumenumber | nullrequired

Mean mortgage dollar volume reported in those neighborhoods, over the year. 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.

avgTractOriginationsnumber | nullrequired

Mean number of mortgage originations reported in those neighborhoods, over the year. 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.

avgWhiteNonHispanicPctnumber | nullrequired

Mean White (non-Hispanic) share of the population in those neighborhoods, 0-100. 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.

difficultDevelopmentAreaCountnumber | nullrequired

Loans in HUD-designated difficult development areas, as a count. 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.

difficultDevelopmentAreaPctnumber | nullrequired

Share of the entity's tract-resolved loans in HUD-designated difficult development areas, 0-100. 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.

distressedTractCountnumber | nullrequired

Loans in distressed-or-underserved neighborhoods, as a count. 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.

distressedTractPctnumber | nullrequired

Share of the entity's tract-resolved loans in distressed-or-underserved nonmetropolitan middle-income neighborhoods, 0-100. 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.

floodHazardTractCountnumber | nullrequired

Loans in a FEMA special flood hazard area, as a count. 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.

floodHazardTractPctnumber | nullrequired

Share of the entity's tract-resolved loans in a FEMA special flood hazard area, 0-100. predominantFloodZone names the specific zone. 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.

loansWithCommunityDatanumber | nullrequired

How many of the entity's loans in the selected period resolved to a neighborhood — the DENOMINATOR every share in this block is taken over. Read it first: a 100% share off two loans is not a 100% share off two hundred. 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.

lowModIncomeTractCountnumber | nullrequired

Loans in low- or moderate-income neighborhoods, as a count. 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.

lowModIncomeTractPctnumber | nullrequired

Share of the entity's tract-resolved loans in low- or moderate-income neighborhoods under the Community Reinvestment Act, 0-100. 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.

majorityMinorityTractCountnumber | nullrequired

Loans in majority-minority neighborhoods, as a count. 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.

majorityMinorityTractPctnumber | nullrequired

Share of the entity's tract-resolved loans in majority-minority neighborhoods, 0-100. 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.

opportunityZoneCountnumber | nullrequired

Loans in Opportunity Zones, as a count. 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.

opportunityZonePctnumber | nullrequired

Share of the entity's tract-resolved loans in federally designated Opportunity Zones, 0-100. 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.

predominantFloodZonestring | nullrequired

FEMA flood-zone code most common across those neighborhoods (e.g. AE). Null means no special flood hazard area on file. 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.

predominantIncomeLevelenum | nullrequired

The relative-income classification most of the entity's loans landed in: low, moderate, middle or upper. 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.

Options:lowmoderatemiddleuppernull

ruralGradientnumber | nullrequired

Mean remoteness of those neighborhoods on an ORDINAL 1-10 scale (1 = metropolitan core, 10 = most remote). A code, not a percent. 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.

ruralTractCountnumber | nullrequired

Loans in rural neighborhoods, as a count. 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.

ruralTractPctnumber | nullrequired

Share of the entity's tract-resolved loans in rural neighborhoods, 0-100. ruralGradient is the finer, ordinal form. 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.

usdaEligibleTractCountnumber | nullrequired

Loans in USDA-eligible neighborhoods, as a count. 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.

usdaEligibleTractPctnumber | nullrequired

Share of the entity's tract-resolved loans in neighborhoods eligible for USDA rural housing programs, 0-100. Broader than ruralTractPct. 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.

companyNamestring | null

companyNmlsIdstring | null

companyTypestring | null

coordinatesobject | null

Show child attributes

latnumberrequired

lonnumberrequired

idstringrequired

isAuthorizedboolean | null

licensedStatesstring[] | null

Licensed states (populated on the detail route only)

licensesobject[] | null

Every NMLS license / registration on file for the branch, authorized or not. A current snapshot (refreshed weekly), not period-scoped. Null when the branch's licenses are not on file.

Show child attributes

authorizedSincestring | nullrequired

Start of the license's current authorized period (YYYY-MM-DD). Null when the license is not currently authorized.

isAuthorizedboolean | nullrequired

issueDatestring | nullrequired

Date the license was originally issued (YYYY-MM-DD).

licenseIdstring | nullrequired

licenseNumberstring | nullrequired

licenseTypestring | nullrequired

regulatorstring | nullrequired

Issuing state regulator.

statusstring | nullrequired

Current license status, e.g. "Approved", "Voluntary Surrender", "Expired".

statusDatestring | nullrequired

Date the license entered its current status (YYYY-MM-DD).

loCountnumber | null

managerCountnumber | null

managersobject[] | null

Branch managers. List rows carry NMLS ids only; the detail route adds manager names.

Show child attributes

namestring | null

nmlsIdstring | null

namestring | null

nmlsIdstring | null

purchasePctnumber | null

purchaseSharenumber | null

Purchase share (0–100) of the period's loan COUNT — what sort: purchaseShare orders by. null = none (sorts as 0).

refinancePctnumber | null

refinanceSharenumber | null

Refinance share (0–100) of the period's loan COUNT — what sort: refinanceShare orders by. null = none (sorts as 0).

rosterCountnumber | null

Loan officers on this branch's CURRENT licensing roster: registered to this branch location AND holding an active sponsorship or registration. A current snapshot (refreshed weekly), not period-scoped. Null when the roster is not on file. List rows also carry manager NAMES from the same lookup. See POST /v1/branches/{nmlsId}/roster for the people.

rosterJoinednumber | null

Loan officers who joined the branch during the selected period — individuals whose sponsorship with the branch began inside the window. IMPORTANT — this counts LICENSING EVENTS, not confirmed employer moves. A loan officer holds a separate license record for every state they are sponsored in, and this counts each individual whose sponsorship began or ended inside the window, so a single added or lapsed state license registers as an arrival or a departure even when the person's employment did not change. Measured on large lenders: 13-24% of a 12-month rosterLeft are still sponsored by the same employer today, and 33-50% of a 12-month rosterJoined were already sponsored by it before the window began. Treat both as directional indicators of movement, not as headcounts. rosterJoined and rosterLeft are measured from the same source on the same window basis, so unlike the retired loLoss — which had no arrivals figure computed the same way — the two can legitimately be combined into a churn rate. Both also grow with the window, so a longer period reports more than a shorter one and the periods are comparable in that direction.

rosterLeftnumber | null

Loan officers who left the branch during the selected period — individuals whose sponsorship with the branch ended inside the window. IMPORTANT — this counts LICENSING EVENTS, not confirmed employer moves. A loan officer holds a separate license record for every state they are sponsored in, and this counts each individual whose sponsorship began or ended inside the window, so a single added or lapsed state license registers as an arrival or a departure even when the person's employment did not change. Measured on large lenders: 13-24% of a 12-month rosterLeft are still sponsored by the same employer today, and 33-50% of a 12-month rosterJoined were already sponsored by it before the window began. Treat both as directional indicators of movement, not as headcounts. rosterJoined and rosterLeft are measured from the same source on the same window basis, so unlike the retired loLoss — which had no arrivals figure computed the same way — the two can legitimately be combined into a churn rate. Both also grow with the window, so a longer period reports more than a shorter one and the periods are comparable in that direction.

statestring | null

streetstring | null

teamSizenumber | null

Loan officers currently attributed to this branch. IMPORTANT — this is a CURRENT headcount snapshot, not a per-period measure. The same value is copied into effectively every period, so subtracting one period's teamSize from another's does not measure growth or attrition: it is zero for all but a handful of branches, and on those few it reflects a data artifact rather than a real change. Filtering and sorting on it likewise ignore the selected period. For headcount movement over a window, use rosterJoined / rosterLeft, which are genuinely per-period.

tradenamesstring[] | null

unitsnumber | null

Branch-level loan units for the selected period

volumenumber | null

Branch-level loan volume for the selected period

zipstring | null

404objectBranch not found

curl -X GET "https://api.modelmatch.com/v1/branches/<nmlsId>" \
  -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.branches.get({
  path: {
    nmlsId: "<nmlsId>"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "avgLoanAmount": 123.45,
    "city": "<string>",
    "communityLending": {
      "affordableHousingTractCount": 123.45,
      "affordableHousingTractPct": 123.45,
      "avgAsianPct": 123.45,
      "avgBlackPct": 123.45,
      "avgDenialRate": 123.45,
      "avgFamilyIncome": 123.45,
      "avgHispanicPct": 123.45,
      "avgHomeValue": 123.45,
      "avgHomeownershipRate": 123.45,
      "avgHouseholdIncome": 123.45,
      "avgIncomeVsMetroPct": 123.45,
      "avgLowModHouseholdPct": 123.45,
      "avgMedianAge": 123.45,
      "avgMilesToCollege": 123.45,
      "avgMilesToSchool": 123.45,
      "avgMilesToWorship": 123.45,
      "avgMinorityPct": 123.45,
      "avgPopulation": 123.45,
      "avgPovertyRate": 123.45,
      "avgTractApplications": 123.45
    },
    "companyName": "<string>",
    "companyNmlsId": "<string>",
    "companyType": "<string>",
    "coordinates": {
      "lat": 123.45,
      "lon": 123.45
    },
    "id": "<string>",
    "isAuthorized": true,
    "licensedStates": [
      "<string>"
    ],
    "licenses": [
      {
        "authorizedSince": "<string>",
        "isAuthorized": true,
        "issueDate": "<string>",
        "licenseId": "<string>",
        "licenseNumber": "<string>",
        "licenseType": "<string>",
        "regulator": "<string>",
        "status": "<string>",
        "statusDate": "<string>"
      }
    ],
    "loCount": 123.45,
    "managerCount": 123.45,
    "managers": [
      {
        "name": "<string>",
        "nmlsId": "<string>"
      }
    ],
    "name": "<string>",
    "nmlsId": "<string>",
    "purchasePct": 123.45,
    "purchaseShare": 123.45,
    "refinancePct": 123.45,
    "refinanceShare": 123.45
  }
}