Configurable chart (measure × slice) over a branch roster's loans

Scoped to loans written by the loan officers on this branch's CURRENT licensing roster (wherever they wrote them), matching the branch profile. For loans public record attributes to the branch itself, use the branch breakdown endpoints.

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

advancedFilters?|||

filters?|||

flatFilters?

measure?ChartMeasure

Which metric each bar reports, AND what the bars are ranked by — the list is ordered by the measure you ask for, descending. Defaults to units, so an unqualified "top originators" means the busiest; pass volume for the biggest by dollars, or an average to rank by that average. Two things to know about the averages specifically. Buckets built from fewer than 5 documents are dropped from an average chart entirely, because a mean says nothing about how many transactions produced it and a single-transaction bucket would otherwise outrank real ones; no floor is applied to units or volume, where a lone large transaction is a legitimate top bar. And ranking a bucket list by a sub-aggregated average is approximate in the search engine — each shard contributes its own local top-N before they are merged — so treat the ordering of an average chart as indicative near the boundary rather than exact. Every bucket publishes its own count, so the sample size behind a value is never implicit.

Default"units"

Value in"volume" | "units" | "avgSalePrice" | "avgListPrice"

nmlsId*string

Branch NMLS ID

Length1 <= length

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"

segment?string

slice*BranchSlice

Dimension to group by. Most are the loan's own field (loanType, transactionType, state, …). lender groups on the normalized lender (label = display name, id = filter key). propertyType is the recorder's land-use code of the collateral (SFR single-family, PUD planned unit development, CND condo, RES residential-other, MFD multi-family dwelling, 2ND second home, MFG manufactured, TWN townhouse, LAN land, COM commercial, …); loans with no code are not grouped (≈20% of recent loans). conforming splits on the conforming-loan-limit flag: conforming vs nonConforming (above the county conforming limit — i.e. jumbo, not Non-QM), raw true/false on id.

Response Body

`application/json`

curl -X POST "https://example.com/v1/branches/analytics/chart" \  -H "Content-Type: application/json" \  -d '{    "nmlsId": "string",    "slice": "transactionType"  }'

{
  "completeness": {
    "through": "2019-08-24"
  },
  "data": [
    {
      "count": 0,
      "excluded": 0,
      "id": "string",
      "label": "string",
      "segments": [
        {
          "count": 0,
          "id": "string",
          "label": "string",
          "value": 0
        }
      ],
      "segmentsOmittedCount": 0,
      "unattributed": true,
      "value": 0
    }
  ],
  "measure": "string",
  "nextCursor": "string",
  "omittedCount": 0,
  "segment": "string",
  "slice": "string",
  "total": 0,
  "totalApproximate": true
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

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

Configurable chart (measure × slice) over a branch roster's loans

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`