Loans

Configurable chart data (measure × slice)

POST
/v1/loans/analytics/chart

Buckets the filtered loans by slice and ranks them by measure, descending. Party slices (originator, broker, loanCompany) are pageable: send size (1–1000) and follow nextCursor via after to walk the whole ranking, with total giving the (approximate) number of distinct parties. Other slices return their fixed top-N. period accepts rolling windows (last30Days, last60Days, last90Days, previousMonth, currentMonth) resolved in UTC; /loans/analytics/summary with the same filters and period returns the matching population totals.

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/loans/analytics/chart" \  -H "Content-Type: application/json" \  -d '{    "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
}

Search individual loan records with filters POST

Search and list individual public-record mortgage and deed loan records — one row per loan (purchase, refinance, origination). Filter by geography (state, county, city, zip), lender, originator, loan amount, interest rate, loan type/purpose, and recording date, with sorting and cursor pagination. This is the discrete per-loan record search: use it to find specific loans or build a filtered loan list. Each row carries the property address, loan terms, the originating loan officer, and `borrowerStatus` — so this is also how you pull a loan officer's own funded production ("my closed loans", "my past clients", "my book of business"): filter by `originator` (their NMLS id), and add `borrowerStatus` for borrowers still in the home — that is the five current-owner codes (`Current`, `R_CWCLO`, `R_CWNLO`, `E_CWCLO`, `E_CWNLO`), NOT `"Current"` alone, which omits everyone who has since refinanced. That is market data, not CRM data — it does not require the loan officer to have added anything to a CRM workspace. (For aggregate market rates and volumes use the market search; for one loan by its ID use the loan detail endpoint.) If you only need how many loans match and not the records themselves, send the same request body to `countLoans`.

Market summary with previous-period comparison POST

Next Page