Companies

Monthly loan officer headcount, hires and exits for a company

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

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Company NMLS ID

Query parameters

periodenum

Preset window when from/to are not given (default last12Months). Rolling periods start on the FIRST day of the month N months back and end today; a year is Jan 1 – Dec 31; allTime starts 2017-01-01, the earliest reliable registration data. Also selects the production period for volume/units.

Options:2017201820192020202120222023202420252026last3Monthslast6Monthslast12Monthslast14Monthslast16Monthslast18Monthslast24MonthsyearToDateallTime

fromstring

Window start, inclusive (YYYY-MM-DD). Overrides period.

tostring

Window end, inclusive (YYYY-MM-DD). Overrides period.

intervalenum

Series granularity. Only month is supported.

Options:month

Responses

200objectHeadcount series and summary

Show attributes

seriesobject[]required

Monthly headcount, ending at the last COMPLETE month (the in-progress month always undercounts) and trimmed of trailing months with no movement yet. Counts PEOPLE, not license records: a loan officer licensed in many states counts once, and adding or dropping a state license is not a hire or an exit.

Show child attributes

activenumberrequired

Distinct loan officers with any employment record here overlapping the month.

enterednumberrequired

Hires in the month.

exitednumberrequired

Complete departures in the month.

netnumberrequired

periodstringrequired

Month, YYYY-MM.

summaryobjectrequired

Show child attributes

change1ynumberrequired

Hires minus exits over the last 365 days.

change30dnumberrequired

Hires minus exits over the last 30 days.

change90dnumberrequired

Hires minus exits over the last 90 days.

currentnumberrequired

Loan officers holding an open employment record here today.

enterednumberrequired

Hires in the window. A hire is a loan officer whose earliest employment record at this company still relevant to the window (open, or ended on/after the window start) starts inside it — so someone who fully left and came back inside the window counts, and an existing employee who adds a state license does not.

exitednumberrequired

Exits in the window. An exit is a loan officer whose latest record at this company ended inside the window and who holds NO open record there — a complete departure.

netnumberrequired

truncatedbooleanrequired

true when the company has more than 100,000 loan officers in scope and only the first 100,000 (by NMLS ID) were counted. false means every figure covers the full population.

windowobjectrequired

Show child attributes

fromstringrequired

tostringrequired

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>/headcount" \
  -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.headcount({
  path: {
    nmlsId: "<nmlsId>"
  }
});

import os
import requests

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

200 response

{
  "series": [
    {
      "active": 123.45,
      "entered": 123.45,
      "exited": 123.45,
      "net": 123.45,
      "period": "<string>"
    }
  ],
  "summary": {
    "change1y": 123.45,
    "change30d": 123.45,
    "change90d": 123.45,
    "current": 123.45,
    "entered": 123.45,
    "exited": 123.45,
    "net": 123.45
  },
  "truncated": true,
  "window": {
    "from": "<string>",
    "to": "<string>"
  }
}