Count originators matching filters

Return the exact number of originators matching the given filters. Accepts the same request body as listOriginators (pagination and sort are ignored). Use this when you only need a total; to get the matching originators themselves, send the same request body to listOriginators.

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

advancedFilters?|||

crmList?

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 loan-officer members count; agents 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 loan officers in total — narrow the selection rather than get a silently partial answer.

filters?|||

flatFilters?

footprint?|array<>

Scoped market filter(s). Each entry names ONE market (city / county / state / zip / lender) and the metric bounds that must hold INSIDE it — {city:'Orlando', state:'FL', volume:{gte:15000000}} means '$15M of production in Orlando', not '$15M somewhere and a loan in Orlando'. Several entries AND together.

lenderFilters?array<>

lenderMatchMode?LenderMatchMode

Value in"and" | "or"

officeGeoPoint?

Originators whose NMLS-registered OFFICE is within radiusMiles of an anchor — the radius form of officeState / officeCity / officeZip, NOT production geography (that is state / city / county / zip / footprint). Anchor on a coordinate ({lat, lon, radiusMiles}) or on another originator's office ({nmlsId: "7206", radiusMiles: 25} — 'LOs near this LO'; that originator is excluded). Originators with no geocoded office never match. 400 when neither anchor form is complete or both are given; 404 office_geo_anchor_not_found for an unknown nmlsId; 400 office_geo_anchor_unlocated when that originator has no geocoded office.

pagination?

period?Period

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).

Value in

"2017" | "2018" | "2019" | "2020" | "2021" | "2022" | "2023" | "2024" | "2025" | "2026" | "last3Months" | "last6Months" | "last12Months" | "last14Months" | "last16Months" | "last18Months" | "last24Months" | "yearToDate" | "allTime"

productMix?array<>

Whole-book product-share / volume bands for the selected period, ANDed: [{product: "fha", minShare: 30}, {product: "va", maxShare: 10}] = FHA ≥ 30% of period volume AND VA ≤ 10%; {product:"fha", volume:{gte:10000000}} = ≥ $10M of FHA. Shares are 0–100 percents of TOTAL period production across all markets (not geography-scoped), as the row's fhaPct / vaPct / conventionalPct. No bucket = 0% (fails minShare > 0, passes maxShare). Pair with units: {gte: N} so a 100% share off two loans is not a specialty.

Items1 <= items <= 10

productionGeoPoint?

Production RADIUS (statute miles, 0 < r ≤ 500): originators who originated loans within the radius of the point during the selected period — where they PRODUCE, not their office. COUNTY-LEVEL APPROXIMATION: counties whose Census centroid lies within the radius (always including the nearest) are in with all their loans; a large county whose centroid is outside is out even where its border is close. Coarser than a true radius, especially under ~25 mi. Pair with sort: [{ field: "scopedVolume" }] to rank by production inside those counties.

sort?array<>

transactionMix?array<>

Transaction-type bands, same rules as productMix: [{transactionType:"purchase", minShare:60}] = purchases ≥ 60% of period volume.

Items1 <= items <= 10

Response Body

`application/json`

curl -X POST "https://example.com/v1/originators/count" \  -H "Content-Type: application/json" \  -d '{}'

{
  "lenderNormalizations": [
    {
      "aliasCount": 0,
      "displayName": "string",
      "id": "string",
      "matchedVia": "id",
      "original": "string",
      "totalDocuments": 0
    }
  ],
  "locationNormalizations": [
    {
      "candidates": [
        "string"
      ],
      "confidence": "normalized",
      "displayName": "Saint Louis, MO",
      "field": "city",
      "id": "city_mo_saint-louis",
      "normalized": "Saint Louis",
      "original": "St. Louis",
      "variants": [
        "string"
      ]
    }
  ],
  "previousTotal": 220836,
  "total": 48213,
  "totalIsLowerBound": true
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string",
  "limit": 0,
  "size": 0
}

Count originators matching filters

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

413application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`