CRM

Loan-type mix (percentage + top type) for a single LO (by NMLS)

postapi.modelmatch.com/v1/crm/lo-loan-mix

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

dateRangestring

Period key (default: last_14_months).

nmlsstringrequired

Bare NMLS id.

Responses

200objectLoan-type percentage breakdown + the top loan type (or null).

Show attributes

dataobjectrequired

Show child attributes

mixobject[]required

Show child attributes

percentagenumberrequired

typestringrequired

topstring | nullrequired

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 POST "https://api.modelmatch.com/v1/crm/lo-loan-mix" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nmls": "<string>",
    "dateRange": "<string>"
  }'

import { createClient, Crm } from "@model-match/api";

createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await Crm.crmLoLoanMix({
  body: {
    nmls: "<string>",
    dateRange: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/lo-loan-mix",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "nmls": "<string>",
        "dateRange": "<string>"
    },
)
data = res.json()

200 response

{
  "data": {
    "mix": [
      {
        "percentage": 123.45,
        "type": "<string>"
      }
    ],
    "top": "<string>"
  }
}