Companies

Get company by NMLS ID

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

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Company NMLS ID

Query parameters

periodenum

Period for production metrics (default: last12Months)

Options:2017201820192020202120222023202420252026last3Monthslast6Monthslast12Monthslast14Monthslast16Monthslast18Monthslast24MonthsyearToDateallTime

Responses

200objectCompany detail

Show attributes

dataobjectrequired

Show child attributes

avgLoanAmountnumber | null

Mean loan size for the selected period, derived from the TOTAL volume and units across ALL markets — NOT scoped to any geographic filter (city/state/zip/zipCode/geoPoint) in this request. For production INSIDE the geography this request names, read scopedVolume/scopedUnits on the same row, and sort by them to rank companies by it. There are two ways to get production for a geography: POST /companies/{nmlsId}/markets breaks ONE company's production out by market, and POST /loans/analytics/chart with measure: "volume", slice: "loanCompany" and a geographic filter answers the reverse — the companies that actually produced in that geography, each with the volume they produced there.

citystring | null

companyTypestring | null

idstringrequired

Document ID

loCountnumber | null

namestring | null

nmlsIdstring | null

purchaseSharenumber | null

Purchase loans as a 0–100 percent of the company's period loan COUNT — the value sort: [{field: "purchaseShare"}] orders by. null when it made no purchase loans in the period (sorts as 0).

refinanceSharenumber | null

Refinance loans as a 0–100 percent of the company's period loan COUNT — the value sort: [{field: "refinanceShare"}] orders by. null when none (sorts as 0).

rosterJoinednumber | null

Loan officers who joined the company during the selected period — individuals whose sponsorship with the company 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 company during the selected period — individuals whose sponsorship with the company 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.

scopedUnitsnumber | null

The company's loan count INSIDE the geography this request names, on the same basis as scopedVolume. Sortable. When the request names no geography — or names one only inside an or group or a negation — the scope is everywhere, and this is identical to the unscoped figure beside it. Reconciles with POST /companies/{nmlsId}/markets for the same geography and period: both are computed from the same recorded transactions and neither excludes transactions with no identified loan officer.

scopedVolumenumber | null

The company's dollar production INSIDE the geography this request names — what a city/state/zip/zipCode/geoPoint filter was almost certainly asking for, and what the sibling volume is not. Sort by scopedVolume to rank companies by it. When the request names no geography — or names one only inside an or group or a negation — the scope is everywhere, and this is identical to the unscoped figure beside it. Reconciles with POST /companies/{nmlsId}/markets for the same geography and period: both are computed from the same recorded transactions and neither excludes transactions with no identified loan officer.

statestring | null

teamSizenumber | null

unitsnumber | null

The company's TOTAL loan count for the selected period across ALL markets — NOT scoped to any geographic filter (city/state/zip/zipCode/geoPoint) in this request, exactly as described on volume. For production INSIDE the geography this request names, read scopedVolume/scopedUnits on the same row, and sort by them to rank companies by it. There are two ways to get production for a geography: POST /companies/{nmlsId}/markets breaks ONE company's production out by market, and POST /loans/analytics/chart with measure: "volume", slice: "loanCompany" and a geographic filter answers the reverse — the companies that actually produced in that geography, each with the volume they produced there.

volumenumber | null

The company's TOTAL dollar production for the selected period across ALL markets — NOT scoped to any geographic filter (city/state/zip/zipCode/geoPoint) in this request. Those filters select WHICH companies are returned, by registered business address, and never change WHAT is summed here. Since the list sorts by volume descending by default, a geo-filtered search ranks companies by NATIONAL production, so the top row can be many times larger than that company's production inside the filtered area. For production INSIDE the geography this request names, read scopedVolume/scopedUnits on the same row, and sort by them to rank companies by it. There are two ways to get production for a geography: POST /companies/{nmlsId}/markets breaks ONE company's production out by market, and POST /loans/analytics/chart with measure: "volume", slice: "loanCompany" and a geographic filter answers the reverse — the companies that actually produced in that geography, each with the volume they produced there.

zipstring | null

buildersobject[]

Top home builders (up to 10) behind the company's period production — the builder of each sold property, ranked by loan count. Spellings of one builder (case, punctuation, legal suffixes, a trailing "of <State>", generic words such as Homes, letter typos) are one entry with units summed, named by its most common spelling. Units only (no volume is recorded). Empty when none.

Show child attributes

namestringrequired

unitsnumberrequired

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.

registrationobject | null

Show child attributes

activeLoCountnumber | null

avgTenureMonthsnumber | null

Average months the company's current loan officers have been there (earliest open employment record each), as of the last weekly registry refresh. Divide by 12 for years. Null when it has none.

branchCountnumber | null

businessStructurestring | null

citystring | null

dateFormedstring | null

formedInstring | null

hasAuthorizedLicenseboolean | null

At least one of licenses is currently authorized. Null when no license rows are on file.

licensedStatesstring[] | null

licensesobject[] | null

Every NMLS license / registration row on file for the company, authorized or not.

locationobject | null

postalCodestring | null

primaryFederalRegulatorstring | null

registrationStatusstring | null

regulatorCategoryenum | null

BANK (OCC / FDIC, or a Federal Reserve–regulated company whose name contains 'bank'), CU (NCUA), OTHER (every other company).

Options:BANKCUOTHERnull

statestring | null

stockSymbolstring | null

streetstring | null

tradeNamesstring[] | null

websitesstring[] | null

404objectCompany not found

413objectResponse payload too large

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

import os
import requests

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

200 response

{
  "data": {
    "avgLoanAmount": 123.45,
    "city": "<string>",
    "companyType": "<string>",
    "id": "<string>",
    "loCount": 123.45,
    "name": "<string>",
    "nmlsId": "<string>",
    "purchaseShare": 123.45,
    "refinanceShare": 123.45,
    "rosterJoined": 123.45,
    "rosterLeft": 123.45,
    "scopedUnits": 123.45,
    "scopedVolume": 123.45,
    "state": "<string>",
    "teamSize": 123.45,
    "units": 123.45,
    "volume": 123.45,
    "zip": "<string>",
    "builders": [
      {
        "name": "<string>",
        "units": 123.45
      }
    ],
    "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
    }
  }
}