Companies

Combined production of a company's hires and exits

getapi.modelmatch.com/v1/companies/{nmlsId}/mover-production

The window's hires and complete departures, each side's combined production across ALL employers recorded inside the production window (default: the same window). Pass a prior window's movers with the current production window to see how past hires and exits perform now.

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.

productionFromstring

Production window start, inclusive (YYYY-MM-DD). Defaults to the mover window's start.

productionTostring

Production window end, inclusive (YYYY-MM-DD). Defaults to the mover window's end.

Responses

200objectHires' and exits' production

Show attributes

arrivalsobjectrequired

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.

Show child attributes

countnumberrequired

Loan officers on this side.

unitsnumberrequired

Loans behind volume.

volumenumberrequired

Their combined production across ALL employers, recorded inside the production window.

departuresobjectrequired

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.

Show child attributes

countnumberrequired

Loan officers on this side.

unitsnumberrequired

Loans behind volume.

volumenumberrequired

Their combined production across ALL employers, recorded inside the production window.

productionWindowobjectrequired

Show child attributes

fromstringrequired

tostringrequired

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

import os
import requests

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

200 response

{
  "arrivals": {
    "count": 123.45,
    "units": 123.45,
    "volume": 123.45
  },
  "departures": {
    "count": 123.45,
    "units": 123.45,
    "volume": 123.45
  },
  "productionWindow": {
    "from": "<string>",
    "to": "<string>"
  },
  "truncated": true,
  "window": {
    "from": "<string>",
    "to": "<string>"
  }
}