Companies

Retained borrowers listed for sale now (weekly)

getapi.modelmatch.com/v1/companies/{nmlsId}/retention/active-listings

The company's retained borrowers (their latest loan is still the company's) whose home is listed for sale right now, each with the company loan officer who wrote that loan — only LOs the company employed on the loan, not brokers' LOs on loans it only funded. Newest listing first; filter to one LO with originator. "Listed now" is the LO Borrower Retention tab's rule: an active listing event in the last 90 days, list price at least $20k, not under contract. Checked weekly with the retention snapshot — computedAt says when. 404 means not computed for this company yet.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Company NMLS ID

Query parameters

viewenum

company (default): loans written at the company. team: the company's CURRENT loan officers' borrowers — loans they wrote at the company or at a previous employer (writtenAt), e.g. a recruit's book.

Options:companyteam

originatorstring

Only rows whose loan was written by this LO (NMLS id) — e.g. one of activeListings.topOriginators.

sizeinteger

Page size (1-100, default 25).

cursorstring

Opaque cursor from the previous page's cursor.

Responses

200objectOne page of listing rows

Show attributes

companyNmlsIdstringrequired

computedAtstringrequired

When the weekly batch checked these listings (ISO-8601). Rows are as of this time, not live.

cursorstring

Cursor for the next page; absent on the last page.

dataobject[]required

Show child attributes

addressstringrequired

From the company's loan record on the parcel.

lenderstring | nullrequired

Lender on that loan — still the borrower's latest loan (retained), so the current lender of record.

listPricenumber | nullrequired

listedDatestringrequired

Date of the newest listing event (UTC).

listingStatusstringrequired

The status of the newest listing event (active).

loanAmountnumberrequired

loanDatestringrequired

Date of the company's latest loan on the parcel.

originatorNamestringrequired

originatorNmlsIdstringrequired

The LO who wrote the company's latest loan on the parcel — employed by the company on that loan.

propertyIdstringrequired

writtenAtstring | null

view=team only: the previous employer the LO wrote this loan at. Null on a loan written at the company (and on every view=company row).

statusenumrequired

timeout: the listing check did not finish in this run, so the previous run's rows and counts are kept (or none, on a first run).

Options:oktimeout

totalintegerrequired

Rows matching the filter, across all pages.

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

import os
import requests

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

200 response

{
  "companyNmlsId": "<string>",
  "computedAt": "<string>",
  "cursor": "<string>",
  "data": [
    {
      "address": "<string>",
      "lender": "<string>",
      "listPrice": 123.45,
      "listedDate": "<string>",
      "listingStatus": "<string>",
      "loanAmount": 123.45,
      "loanDate": "<string>",
      "originatorName": "<string>",
      "originatorNmlsId": "<string>",
      "propertyId": "<string>",
      "writtenAt": "<string>"
    }
  ],
  "status": "ok",
  "total": 123
}