Signals

Buyer's agent relationships to prioritize for this loan officer

getapi.modelmatch.com/v1/originators/{nmlsId}/signals/agent-pulse

Relationship Pulse: the buyer's agents this loan officer has worked with, ordered by priority (highest first, up to 50) for working toward another closed deal together in the next six months. Each row has the agent (agentLinked says whether its id can be looked up with the agent routes), a priority score (0–1, higher is higher priority), its priority percentile among all scored agent relationships, and up to three plain-language reasons. Returns an empty data list when the loan officer is scored but has no agent relationships in scope; 404 when the loan officer is not scored at all. 1 credit per row returned.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Loan officer NMLS ID

Query parameters

limitintegerdefault: 25

Rows per page (1–50, default 25)

Responses

200objectAgents, highest priority first

Show attributes

dataobject[]required

Show child attributes

agentIdstringrequired

Agent id. Pass it to the agent routes only when agentLinked is true.

agentLinkedbooleanrequired

Whether this agent has an agent profile. When false, agentId identifies the agent within this list only and cannot be looked up.

agentNamestring | nullrequired

percentilenumberrequired

Priority percentile, 0–100: where this priority score sits among everyone scored nationally for this signal (all scored loan officers, past clients, or agent relationships). 100 = highest priority. On the state list it is still the national percentile, not a within-state one.

rankintegerrequired

1 = highest priority.

reasonsstring[]required

Up to three plain-language reasons this row is a priority.

scorenumberrequired

Priority score (0–1) for this loan officer to work this buyer's agent relationship toward another closed deal in the next six months; higher is higher priority.

scoredAtstringrequired

When this score was computed (ISO 8601).

400objectInvalid parameters or cursor

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectThis loan officer has no predictive scores.

503objectSignals are temporarily unavailable. Retry later.

curl -X GET "https://api.modelmatch.com/v1/originators/7206/signals/agent-pulse" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

const res = await fetch("https://api.modelmatch.com/v1/originators/7206/signals/agent-pulse", {
  method: "GET",
  headers: {
    "x-api-key": process.env.MODEL_MATCH_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/originators/7206/signals/agent-pulse",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "data": [
    {
      "agentId": "<string>",
      "agentLinked": true,
      "agentName": "<string>",
      "percentile": 123.45,
      "rank": 123,
      "reasons": [
        "<string>"
      ],
      "score": 123.45,
      "scoredAt": "<string>"
    }
  ]
}