Offices

Search real-estate offices with filters

postapi.modelmatch.com/v1/offices

NOT NMLS mortgage branches — use /branches for those. Returns office name, address, agent count, coordinates, and office-level production for the selected period. Default sort is by agent count descending. If you only need how many offices match and not the records themselves, send the same request body to countOffices.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

advancedFiltersone of

Show child attributes

Option 1object

Show child attributes

childrenone of[]required

Array of filter expressions (AND)

Same shape as its parent.

typeenumrequired

Options:and

Option 2object

Show child attributes

childrenone of[]required

Array of filter expressions (OR)

Same shape as its parent.

typeenumrequired

Options:or

Option 3object

Show child attributes

childone ofrequired

Same shape as its parent.

typeenumrequired

Options:not

Option 4object

Show child attributes

fieldstringrequired

openumrequired

Comparison operator. exists means the field has a REAL value: on fields whose source records an unknown as an in-domain value (e.g. beds, squareFeet, lotSquareFeet, where an unrecorded measurement is stored as 0), those docs count as NOT existing. neq keeps docs with no value — it removes only what is known to equal the value, matching the reading of an exclusion.

Options:eqneqgtgteltltebetweeninmatchgeoDistanceexists

typeenumrequired

Options:filter

valuenull

Comparison value

builderShareobject

Share of the office's deals in the period that named a home builder, as a 0–100 percent (Σ builder units / total units). Implies builderCount > 0.

Show child attributes

gtenumber

ltenumber

crmListobject

Scope the result to the caller's CRM. Resolved against the caller's ACTIVE WORKSPACE at query time — list membership is read server-side, so the request never carries member ids. Only real-estate office members count; people, mortgage companies, branches and manual (unlinked) records on the same list are ignored. mode: "in" with no matching members returns an empty page (not an unfiltered one). Errors: 400 crm_list_requires_workspace when the caller has no active workspace (API-key / OAuth callers must select an organization), 403 / 404 when a named list is not visible to the caller or does not exist, and 400 crm_list_too_large when the selected lists hold more than 50,000 offices in total — narrow the selection rather than get a silently partial answer.

Show child attributes

listsone ofrequired

Which lists: "any" for every Company list the caller can see, or an array of list ids. Membership is the UNION across the selected lists.

Show child attributes

Option 1enum

Every list in the caller's workspace that the caller can see (own, org-wide, or shared with them) and that holds this kind of record — People lists for originators and agents, Company lists for companies.

Options:any

Option 2string[]

Specific CRM list ids (1–50).

modeenumrequired

in — only offices who are a member of the selected list(s). notIn — exclude every office who is a member of the selected list(s); everyone else passes, including offices on none of your lists.

Options:innotIn

filtersone of

Show child attributes

Option 1object

Show child attributes

childrenone of[]required

Array of filter expressions (AND)

Same shape as its parent.

typeenumrequired

Options:and

Option 2object

Show child attributes

childrenone of[]required

Array of filter expressions (OR)

Same shape as its parent.

typeenumrequired

Options:or

Option 3object

Show child attributes

childone ofrequired

Same shape as its parent.

typeenumrequired

Options:not

Option 4object

Show child attributes

fieldstringrequired

openumrequired

Options:eqneqgtgteltltebetweeninmatchgeoDistanceexists

typeenumrequired

Options:filter

valuenull

Comparison value

flatFiltersobject

Show child attributes

activeListingsone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

agentCountone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

avgListPriceone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

avgMortgagedBuyerLoanAmountone of | null

Mean loan size on the office's financed BUYER-side deals in the period.

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

avgMortgagedLoanAmountone of | null

Mean loan size on the office's financed deals in the period (either side).

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

avgMortgagedSellerLoanAmountone of | null

Mean loan size on the office's financed LISTING-side deals (the buyer's loan) in the period.

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

avgSalePriceone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

builderCountone of | null

Distinct home builders on the office's deals in the period — {gt: 0} = works with builders.

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

buyerUnitsone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

buyerVolumeone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

cityone of | null

Show child attributes

Option 1string

Option 2string[]

Match any value

Option 3object

Fuzzy text match

Show child attributes

matchstringrequired

companyone of | null

Show child attributes

Option 1string

Option 2string[]

Match any value

Option 3object

Fuzzy text match

Show child attributes

matchstringrequired

countyone of | null

Office address COUNTY: a name (Travis, with state when ambiguous), a 5-digit FIPS (48453) or a dictionary county id; an array matches any. Matches when the office's geocoded point lies inside the county boundary (no geocode = no match). Unknown county = 400.

Show child attributes

Option 1string

Option 2string[]

Match any value

Option 3object

Fuzzy text match

Show child attributes

matchstringrequired

dualUnitsone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

dualVolumeone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

geoPointobject | null

Radius search — { lat, lon, radius } (e.g. radius "15mi" or "24km") — around any office on the agent's record; with locationSource office the CURRENT office, production their transactions.

Show child attributes

latnumberrequired

lonnumberrequired

radiusstringrequired

modeenum

Options:andor

msaone of | null

Office address METRO (MSA / CBSA): 5-digit CBSA code (12420) or metro name (Austin Metro); an array matches any. The office point inside any member county. Unknown/ambiguous = 400 naming candidates.

Show child attributes

Option 1string

Option 2string[]

namePrefixstring

Prefix name search: every word must start a word of the name ("keller wil" → Keller Williams Realty). No fuzzy/nickname matching; relevance-ranked unless sort is set. Max 100 chars / 6 words (emails, URLs, phones ignored), else 400. Spelling variants of brokerage names also match ("remax" ↔ "Re/Max").

regionone of | null

Office address CENSUS REGION / DIVISION (<region>-division-<n>, 1–9) — offices in ANY state of it. An array matches any.

Show child attributes

Option 1enum

Options:northeastnortheast-division-1northeast-division-2midwestmidwest-division-3midwest-division-4southsouth-division-5south-division-6south-division-7westwest-division-8west-division-9

Option 2enum[]

Options:northeastnortheast-division-1northeast-division-2midwestmidwest-division-3midwest-division-4southsouth-division-5south-division-6south-division-7westwest-division-8west-division-9

sellerUnitsone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

sellerVolumeone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

stateone of | null

Show child attributes

Option 1string

Option 2string[]

Match any value

Option 3object

Fuzzy text match

Show child attributes

matchstringrequired

teamSizeone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

unitsone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

volumeone of | null

Show child attributes

Option 1number

Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes

gtnumber

gtenumber

includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber

ltenumber

zipone of | null

Show child attributes

Option 1string

Option 2string[]

Match any value

Option 3object

Fuzzy text match

Show child attributes

matchstringrequired

zipCodeone of | null

Show child attributes

Option 1string

Option 2string[]

Match any value

Option 3object

Fuzzy text match

Show child attributes

matchstringrequired

includeTopOriginatorboolean

Add topOriginator to every row (the LO on the most buyer-side deals in the period). Off by default — it reads each office's LO list.

lenderFiltersobject[]

Show child attributes

canonicalstring

Canonical lender name (the value from lender autocomplete). Resolved to a lender id server-side; pass id instead when you have one.

displayNamestringrequired

Label / typed search string

idstring

Lender-dictionary id — the id from instantSearch / listLenders (e.g. "mortgage_rocket" or "mortgage rocket"), and the same value the lender filter takes. PREFERRED: matched directly against the stored lender key with no name resolution. canonical is still accepted and resolved server-side.

modeenum

Options:includeexclude

percentMinnumber

Minimum percent_of_volume (0–100); 0/undefined = > 0%

typeenum

Options:canonicalfreetext

lenderMatchModeenum

Options:andor

paginationobject

Show child attributes

cursorstring

Opaque cursor from previous response for next page

sizeinteger

Page size (1-100, default 25)

periodenum

Pre-aggregated period block. Rolling windows (last30Days, last60Days, last90Days, previousMonth, currentMonth) are NOT accepted here and return 400; they are supported on the loans, sales and market endpoints (list, count, breakdowns, analytics summary / time-series / chart) (see DatedPeriod).

Options:2017201820192020202120222023202420252026last3Monthslast6Monthslast12Monthslast14Monthslast16Monthslast18Monthslast24MonthsyearToDateallTime

sortobject[]

Show child attributes

fieldenumrequired

Options:companycitystatezipagentCountactiveListingsvolumeunitsbuyerVolumebuyerUnitssellerVolumesellerUnitsdualVolumedualUnitsavgSalePriceavgListPriceteamSize

orderenum

Options:ascdesc

Responses

200objectPaginated list of offices

Show attributes

cursorstring

dataobject[]required

Show child attributes

activeListingsnumber | null

agentCountnumber | null

Number of agents at this office

avgListPricenumber | null

avgSalePricenumber | null

buyerUnitsnumber | null

buyerVolumenumber | null

citystring | null

City (stored lowercase on the source index)

companystring | null

coordinatesobject | null

Show child attributes

latnumberrequired

lonnumberrequired

countrystring | null

dualUnitsnumber | null

dualVolumenumber | null

emailstring | null

Office email (list rows since 2026-10-15; was detail-only)

idstringrequired

Office key (mm_office_key)

lastCountedAtstring | null

locationTypestring | null

phonestring | null

Office phone (list rows since 2026-10-15; was detail-only)

sellerUnitsnumber | null

sellerVolumenumber | null

statestring | null

State abbreviation (stored lowercase on the source index)

streetstring | null

teamSizenumber | null

topOriginatorobject | null

Present only when the request set includeTopOriginator: the loan officer on the most of this office's BUYER-side deals in the period (ties → more volume, then lower NMLS id), named from the LO's own profile with their current employer. null when no buyer-side deal had a tracked LO.

Show child attributes

buyerUnitsnumberrequired

buyerVolumenumberrequired

companyobject | nullrequired

namestringrequired

nmlsIdstringrequired

unitsnumber | null

volumenumber | null

zipstring | null

totalnumberrequired

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/offices" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lenderMatchMode": "and",
    "period": "2017",
    "includeTopOriginator": true
  }'

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

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

const { data, error } = await client.offices.list({
  body: {
    lenderMatchMode: "and",
    period: "2017",
    includeTopOriginator: true
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/offices",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "lenderMatchMode": "and",
        "period": "2017",
        "includeTopOriginator": True
    },
)
data = res.json()

200 response

{
  "cursor": "<string>",
  "data": [
    {
      "activeListings": 123.45,
      "agentCount": 123.45,
      "avgListPrice": 123.45,
      "avgSalePrice": 123.45,
      "buyerUnits": 123.45,
      "buyerVolume": 123.45,
      "city": "<string>",
      "company": "<string>",
      "coordinates": {
        "lat": 123.45,
        "lon": 123.45
      },
      "country": "<string>",
      "dualUnits": 123.45,
      "dualVolume": 123.45,
      "email": "<string>",
      "id": "<string>",
      "lastCountedAt": "<string>",
      "locationType": "<string>",
      "phone": "<string>",
      "sellerUnits": 123.45,
      "sellerVolume": 123.45,
      "state": "<string>"
    }
  ],
  "total": 123.45
}