Instant multi-entity typeahead search

postapi.modelmatch.com/v1/instant-search

Fast typeahead/autocomplete search across agents, originators, companies, and offices. Returns top matches per entity type. A bare NMLS ID resolves directly to its originator, company, or branch — including an originator who is in the NMLS registry with no production record yet (returned with hasScoredData: false). Use this for quick name lookups, not for filtered searches (use the entity-specific list endpoints for those). If you already have an entity ID, prefer getOriginator / getCompany / getBranch.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

entitiesstring[]

Entity types to search (default: all)

filtersobject

Per-entity filter strings

Show child attributes

[key: string]string

limitinteger

Max results per entity (default: 5)

querystringrequired

Search query

Responses

200objectSearch results grouped by entity

Show attributes

resultsobjectrequired

Show child attributes

[key: string]null[]

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 backend not configured

curl -X POST "https://api.modelmatch.com/v1/instant-search" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "<string>",
    "limit": 50
  }'

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

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

const { data, error } = await client.search.instant({
  body: {
    query: "<string>",
    limit: 50
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/instant-search",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "query": "<string>",
        "limit": 50
    },
)
data = res.json()

200 response

{
  "results": {
    "key": [
      null
    ]
  }
}